Skip to main content

Update

Update specified HBA rule for the specified Greenplum cluster without changind it order.

import {
  cloudApi,
  serviceClients,
  Session,
  waitForOperation,
} from "@yandex-cloud/nodejs-sdk";

const HBARule_AuthMethod = cloudApi.mdb.greenplum_hba_rule.HBARule_AuthMethod;
const HBARule_ConnectionType =
  cloudApi.mdb.greenplum_hba_rule.HBARule_ConnectionType;
const UpdateHBARuleRequest =
  cloudApi.mdb.greenplum_hba_rule_service.UpdateHBARuleRequest;

(async () => {
  const authToken = process.env["YC_OAUTH_TOKEN"];
  const session = new Session({ oauthToken: authToken });
  const client = session.client(serviceClients.HBARuleServiceClient);

  const operation = await client.update(
    UpdateHBARuleRequest.fromPartial({
      clusterId: "clusterId",
      hbaRule: {
        // priority: 0,
        // connectionType: HBARule_ConnectionType.HOST,
        database: "database",
        user: "user",
        address: "address",
        // authMethod: HBARule_AuthMethod.MD5
      },
    })
  );
  await waitForOperation(operation, session);
})();

UpdateHBARuleRequest​

clusterId : string​

ID of the Greenplum cluster. To get the Greenplum cluster ID use a ClusterService.List request.

hbaRule : HBARule​

Updated hba rule for the cluster.

HBARule​

ConnectionType​
  • CONNECTION_TYPE_UNSPECIFIED

  • HOST

    Matches connection attempts made using TCP/IP.

  • HOSTSSL

    Matches connection attempts made using TCP/IP, but only when the connection is made with SSL encryption.

  • HOSTNOSSL

    Matches connection attempts made over TCP/IP that do not use SSL.

AuthMethod​
  • AUTH_METHOD_UNSPECIFIED

  • MD5

    Perform SCRAM-SHA-256 or MD5 authentication to verify the user's password.

  • LDAP

    Perform LDAP authentication, if MDB_GREENPLUM_LDAP flag is set

  • REJECT

    Disable authentication

priority : int64​

Priority of the Greenplum cluster rule.

connectionType : ConnectionType​
database : string​

Specifies which database names this record matches.

user : string​

Specifies which database role names this user matches.

address : string​

Specifies the client machine addresses that this record matches.

authMethod : AuthMethod​

Specifies the authentication method to use when a connection matches this record. https://gpdb.docs.pivotal.io/6-6/security-guide/topics/Authenticate.html

Operation​

An Operation resource. For more information, see Operation.

id : string​

ID of the operation.

description : string​

Description of the operation. 0-256 characters long.

createdAt : google.protobuf.Timestamp​

Creation timestamp.

createdBy : string​

ID of the user or service account who initiated the operation.

modifiedAt : google.protobuf.Timestamp​

The time when the Operation resource was last modified.

done : bool​

If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.

metadata : google.protobuf.Any​

Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.

One of result​

The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true, exactly one of error or response is set.

  • error : google.rpc.Status​

    The error result of the operation in case of failure or cancellation.

  • response : google.protobuf.Any​
    The normal response of the operation in case of success.

    If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is the standard Create/Update, the response should be the target resource of the operation. Any method that returns a long-running operation should document the response type, if any.