Class: Aws::DSQL::Client

Inherits:
Seahorse::Client::Base show all
Includes:
ClientStubs
Defined in:
gems/aws-sdk-dsql/lib/aws-sdk-dsql/client.rb

Overview

An API client for DSQL. To construct a client, you need to configure a :region and :credentials.

client = Aws::DSQL::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

For details on configuring region and credentials see the developer guide.

See #initialize for a full list of supported configuration options.

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations collapse

Instance Method Summary collapse

Methods included from ClientStubs

#api_requests, #stub_data, #stub_responses

Methods inherited from Seahorse::Client::Base

add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

  • :plugins (Array<Seahorse::Client::Plugin>) — default: []] —

    A list of plugins to apply to the client. Each plugin is either a class name or an instance of a plugin class.

  • :credentials (required, Aws::CredentialProvider) —

    Your AWS credentials used for authentication. This can be any class that includes and implements Aws::CredentialProvider, or instance of any one of the following classes:

    • Aws::Credentials - Used for configuring static, non-refreshing credentials.

    • Aws::SharedCredentials - Used for loading static credentials from a shared file, such as ~/.aws/config.

    • Aws::AssumeRoleCredentials - Used when you need to assume a role.

    • Aws::AssumeRoleWebIdentityCredentials - Used when you need to assume a role after providing credentials via the web.

    • Aws::SSOCredentials - Used for loading credentials from AWS SSO using an access token generated from aws login.

    • Aws::ProcessCredentials - Used for loading credentials from a process that outputs to stdout.

    • Aws::InstanceProfileCredentials - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • Aws::ECSCredentials - Used for loading credentials from instances running in ECS.

    • Aws::CognitoIdentityCredentials - Used for loading credentials from the Cognito Identity service.

    When :credentials are not configured directly, the following locations will be searched for credentials:

    • Aws.config[:credentials]

    • The :access_key_id, :secret_access_key, :session_token, and :account_id options.

    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY'], ENV['AWS_SESSION_TOKEN'], and ENV['AWS_ACCOUNT_ID'].

    • ~/.aws/credentials

    • ~/.aws/config

    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentials or Aws::ECSCredentials to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED'] to true.

  • :region (required, String) —

    The AWS region to connect to. The configured :region is used to determine the service :endpoint. When not passed, a default :region is searched for in the following locations:

    • Aws.config[:region]
    • ENV['AWS_REGION']
    • ENV['AMAZON_REGION']
    • ENV['AWS_DEFAULT_REGION']
    • ~/.aws/credentials
    • ~/.aws/config
  • :access_key_id (String)
  • :account_id (String)
  • :active_endpoint_cache (Boolean) — default: false —

    When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

    Used only in adaptive retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a RetryCapacityNotAvailableError and will not retry instead of sleeping.

  • :auth_scheme_preference (Array<String>) —

    A list of preferred authentication schemes to use when making a request. Supported values are: sigv4, sigv4a, httpBearerAuth, and noAuth. When set using ENV['AWS_AUTH_SCHEME_PREFERENCE'] or in shared config as auth_scheme_preference, the value should be a comma-separated list.

  • :client_side_monitoring (Boolean) — default: false —

    When true, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: "" —

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1" —

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000 —

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true —

    When true, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true —

    Used only in standard and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :defaults_mode (String) — default: "legacy" —

    See Aws::DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :disable_host_prefix_injection (Boolean) — default: false —

    When true, the SDK will not prepend the modeled host prefix to the endpoint.

  • :disable_request_compression (Boolean) — default: false —

    When set to 'true' the request body will not be compressed for supported operations.

  • :endpoint (String, URI::HTTPS, URI::HTTP) —

    Normally you should not configure the :endpoint option directly. This is normally constructed from the :region option. Configuring :endpoint is normally reserved for connecting to test or custom endpoints. The endpoint should be a URI formatted like:

    'http://example.com'
'https://example.com'
'http://example.com:123'
  • :endpoint_cache_max_entries (Integer) — default: 1000 —

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10 —

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60 —

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.

  • :endpoint_discovery (Boolean) — default: false —

    When set to true, endpoint discovery will be enabled for operations when available.

  • :ignore_configured_endpoint_urls (Boolean) —

    Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —

    The log formatter.

  • :log_level (Symbol) — default: :info —

    The log level to send messages to the :logger at.

  • :logger (Logger) —

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 3 —

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in standard and adaptive retry modes.

  • :profile (String) — default: "default" —

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used.

  • :request_checksum_calculation (String) — default: "when_supported" —

    Determines when a checksum will be calculated for request payloads. Values are:

    • when_supported - (default) When set, a checksum will be calculated for all request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true and/or a requestAlgorithmMember is modeled.
    • when_required - When set, a checksum will only be calculated for request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true or where a requestAlgorithmMember is modeled and supplied.
  • :request_min_compression_size_bytes (Integer) — default: 10240 —

    The minimum size in bytes that triggers compression for request bodies. The value must be non-negative integer value between 0 and 10485780 bytes inclusive.

  • :response_checksum_validation (String) — default: "when_supported" —

    Determines when checksum validation will be performed on response payloads. Values are:

    • when_supported - (default) When set, checksum validation is performed on all response payloads of operations modeled with the httpChecksum trait where responseAlgorithms is modeled, except when no modeled checksum algorithms are supported.
    • when_required - When set, checksum validation is not performed on response payloads of operations unless the checksum algorithm is supported and the requestValidationModeMember member is set to ENABLED.
  • :retry_backoff (Proc) —

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the legacy retry mode.

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_jitter (Symbol) — default: :none —

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the legacy retry mode.

    @see https://www.awsarchitectureblog.com/2015/03/backoff.html

  • :retry_limit (Integer) — default: 3 —

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the legacy retry mode.

  • :retry_max_delay (Integer) — default: 0 —

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_mode (String) — default: "legacy" —

    Specifies which retry algorithm to use. Values are:

    • legacy - The pre-existing retry behavior. This is default value if no retry mode is provided.

    • standard - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • adaptive - An experimental retry mode that includes all the functionality of standard mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.

  • :sdk_ua_app_id (String) —

    A unique and opaque application ID that is appended to the User-Agent header as app/sdk_ua_app_id. It should have a maximum length of 50. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.

  • :secret_access_key (String)
  • :session_token (String)
  • :sigv4a_signing_region_set (Array) —

    A list of regions that should be signed with SigV4a signing. When not passed, a default :sigv4a_signing_region_set is searched for in the following locations:

    • Aws.config[:sigv4a_signing_region_set]
    • ENV['AWS_SIGV4A_SIGNING_REGION_SET']
    • ~/.aws/config
  • :stub_responses (Boolean) — default: false —

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

    Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

  • :telemetry_provider (Aws::Telemetry::TelemetryProviderBase) — default: Aws::Telemetry::NoOpTelemetryProvider —

    Allows you to provide a telemetry provider, which is used to emit telemetry data. By default, uses NoOpTelemetryProvider which will not record or emit any telemetry data. The SDK supports the following telemetry providers:

    • OpenTelemetry (OTel) - To use the OTel provider, install and require the opentelemetry-sdk gem and then, pass in an instance of a Aws::Telemetry::OTelProvider for telemetry provider.
  • :token_provider (Aws::TokenProvider) —

    Your Bearer token used for authentication. This can be any class that includes and implements Aws::TokenProvider, or instance of any one of the following classes:

    • Aws::StaticTokenProvider - Used for configuring static, non-refreshing tokens.

    • Aws::SSOTokenProvider - Used for loading tokens from AWS SSO using an access token generated from aws login.

    When :token_provider is not configured directly, the Aws::TokenProviderChain will be used to search for tokens configured for your profile in shared configuration files.

  • :use_dualstack_endpoint (Boolean) —

    When set to true, dualstack enabled endpoints (with .aws TLD) will be used if available.

  • :use_fips_endpoint (Boolean) —

    When set to true, fips compatible endpoints will be used if available. When a fips region is used, the region is normalized and this config is set to true.

  • :validate_params (Boolean) — default: true —

    When true, request parameters are validated before sending the request.

  • :endpoint_provider (Aws::DSQL::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to #resolve_endpoint(parameters) where parameters is a Struct similar to Aws::DSQL::EndpointParameters.

  • :http_continue_timeout (Float) — default: 1 —

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has "Expect" header set to "100-continue". Defaults to nil which disables this behaviour. This value can safely be set per request on the session.

  • :http_idle_timeout (Float) — default: 5 —

    The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_open_timeout (Float) — default: 15 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_proxy (URI::HTTP, String) —

    A proxy to send requests through. Formatted like 'http://proxy.com:123'.

  • :http_read_timeout (Float) — default: 60 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_wire_trace (Boolean) — default: false —

    When true, HTTP debug output will be sent to the :logger.

  • :on_chunk_received (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the response body is received. It provides three arguments: the chunk, the number of bytes received, and the total number of bytes in the response (or nil if the server did not send a content-length).

  • :on_chunk_sent (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the request body is sent. It provides three arguments: the chunk, the number of bytes read from the body, and the total number of bytes in the body.

  • :raise_response_errors (Boolean) — default: true —

    When true, response errors are raised.

  • :ssl_ca_bundle (String) —

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_directory (String) —

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_store (String) —

    Sets the X509::Store to verify peer certificate.

  • :ssl_cert (OpenSSL::X509::Certificate) —

    Sets a client certificate when creating http connections.

  • :ssl_key (OpenSSL::PKey) —

    Sets a client key when creating http connections.

  • :ssl_timeout (Float) —

    Sets the SSL timeout in seconds

  • :ssl_verify_peer (Boolean) — default: true —

    When true, SSL peer certificates are verified when establishing a connection.



473
474
475
 
# File 'gems/aws-sdk-dsql/lib/aws-sdk-dsql/client.rb', line 473

def initialize(*args)
  super
end

Instance Method Details

#create_cluster(params = {}) ⇒ Types::CreateClusterOutput

The CreateCluster API allows you to create both single-Region clusters and multi-Region clusters. With the addition of the multiRegionProperties parameter, you can create a cluster with witness Region support and establish peer relationships with clusters in other Regions during creation.

Creating multi-Region clusters requires additional IAM permissions beyond those needed for single-Region clusters, as detailed in the Required permissions section below.

Required permissions

dsql:CreateCluster

Required to create a cluster.

Resources: arn:aws:dsql:region:account-id:cluster/*

dsql:TagResource

Permission to add tags to a resource.

Resources: arn:aws:dsql:region:account-id:cluster/*

dsql:PutMultiRegionProperties

Permission to configure multi-Region properties for a cluster.

Resources: arn:aws:dsql:region:account-id:cluster/*

dsql:AddPeerCluster

When specifying multiRegionProperties.clusters, permission to add peer clusters.

Resources:

  • Local cluster: arn:aws:dsql:region:account-id:cluster/*

  • Each peer cluster: exact ARN of each specified peer cluster

dsql:PutWitnessRegion

When specifying multiRegionProperties.witnessRegion, permission to set a witness Region. This permission is checked both in the cluster Region and in the witness Region.

Resources: arn:aws:dsql:region:account-id:cluster/*

Condition Keys: dsql:WitnessRegion (matching the specified witness region)

  • The witness Region specified in multiRegionProperties.witnessRegion cannot be the same as the cluster's Region.

^

Examples:

Example: Create Cluster


resp = client.create_cluster({
  deletion_protection_enabled: false, 
  tags: {
    "MyKey" => "MyValue", 
  }, 
})

Request syntax with placeholder values


resp = client.create_cluster({
  deletion_protection_enabled: false,
  kms_encryption_key: "KmsEncryptionKey",
  tags: {
    "TagKey" => "TagValue",
  },
  client_token: "ClientToken",
  multi_region_properties: {
    witness_region: "Region",
    clusters: ["ClusterArn"],
  },
  policy: "PolicyDocument",
  bypass_policy_lockout_safety_check: false,
})

Response structure


resp.identifier #=> String
resp.arn #=> String
resp.status #=> String, one of "CREATING", "ACTIVE", "IDLE", "INACTIVE", "UPDATING", "DELETING", "DELETED", "FAILED", "PENDING_SETUP", "PENDING_DELETE"
resp.creation_time #=> Time
resp.multi_region_properties.witness_region #=> String
resp.multi_region_properties.clusters #=> Array
resp.multi_region_properties.clusters[0] #=> String
resp.encryption_details.encryption_type #=> String, one of "AWS_OWNED_KMS_KEY", "CUSTOMER_MANAGED_KMS_KEY"
resp.encryption_details.kms_key_arn #=> String
resp.encryption_details.encryption_status #=> String, one of "ENABLED", "UPDATING", "KMS_KEY_INACCESSIBLE", "ENABLING"
resp.deletion_protection_enabled #=> Boolean
resp.endpoint #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :deletion_protection_enabled (Boolean) —

    If enabled, you can't delete your cluster. You must first disable this property before you can delete your cluster.

  • :kms_encryption_key (String) —

    The KMS key that encrypts and protects the data on your cluster. You can specify the ARN, ID, or alias of an existing key or have Amazon Web Services create a default key for you.

  • :tags (Hash<String,String>) —

    A map of key and value pairs to use to tag your cluster.

  • :client_token (String) —

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, the subsequent retries with the same client token return the result from the original successful request and they have no additional effect.

    If you don't specify a client token, the Amazon Web Services SDK automatically generates one.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :multi_region_properties (Types::MultiRegionProperties) —

    The configuration settings when creating a multi-Region cluster, including the witness region and linked cluster properties.

  • :policy (String) —

    An optional resource-based policy document in JSON format that defines access permissions for the cluster.

  • :bypass_policy_lockout_safety_check (Boolean) —

    An optional field that controls whether to bypass the lockout prevention check. When set to true, this parameter allows you to apply a policy that might lock you out of the cluster. Use with caution.

Returns:

See Also:



635
636
637
638
 
# File 'gems/aws-sdk-dsql/lib/aws-sdk-dsql/client.rb', line 635

def create_cluster(params = {}, options = {})
  req = build_request(:create_cluster, params)
  req.send_request(options)
end

#create_stream(params = {}) ⇒ Types::CreateStreamOutput

Creates a new change data capture (CDC) stream for a cluster. The stream captures database changes and delivers them to the specified target destination.

Required permissions

dsql:CreateStream

Permission to create a new stream.

Resources: arn:aws:dsql:region:account-id:cluster/cluster-id

iam:PassRole

Permission to pass the IAM role specified in the target definition to the service.

Resources: ARN of the IAM role specified in targetDefinition.kinesis.roleArn

kms:Decrypt

Required when the cluster uses a customer managed KMS key (CMK). Permission to decrypt data using the cluster's CMK.

Resources: ARN of the KMS key used by the cluster

Examples:

Request syntax with placeholder values


resp = client.create_stream({
  cluster_identifier: "ClusterId", # required
  target_definition: { # required
    kinesis: {
      stream_arn: "KinesisStreamArn", # required
      role_arn: "RoleArn", # required
    },
  },
  ordering: "UNORDERED", # required, accepts UNORDERED
  format: "JSON", # required, accepts JSON
  tags: {
    "TagKey" => "TagValue",
  },
  client_token: "ClientToken",
})

Response structure


resp.cluster_identifier #=> String
resp.stream_identifier #=> String
resp.arn #=> String
resp.status #=> String, one of "CREATING", "ACTIVE", "DELETING", "DELETED", "FAILED", "IMPAIRED"
resp.creation_time #=> Time
resp.ordering #=> String, one of "UNORDERED"
resp.format #=> String, one of "JSON"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :cluster_identifier (required, String) —

    The ID of the cluster for which to create the stream.

  • :target_definition (required, Types::TargetDefinition) —

    The target destination configuration for the stream. Contains Kinesis stream configuration including stream ARN and IAM role ARN.

  • :ordering (required, String) —

    The ordering mode for the stream. Determines how change events are ordered when delivered to the target.

  • :format (required, String) —

    The format of the stream records.

  • :tags (Hash<String,String>) —

    A map of key and value pairs to use to tag your stream.

  • :client_token (String) —

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, the subsequent retries with the same client token return the result from the original successful request and they have no additional effect.

    If you don't specify a client token, the Amazon Web Services SDK automatically generates one.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

See Also:



740
741
742
743
 
# File 'gems/aws-sdk-dsql/lib/aws-sdk-dsql/client.rb', line 740

def create_stream(params = {}, options = {})
  req = build_request(:create_stream, params)
  req.send_request(options)
end

#delete_cluster(params = {}) ⇒ Types::DeleteClusterOutput

Deletes a cluster in Amazon Aurora DSQL.

Examples:

Example: Delete Cluster


resp = client.delete_cluster({
  identifier: "kiqenqglxyl2snyvkvnj2c3s2e", 
})

Request syntax with placeholder values


resp = client.delete_cluster({
  identifier: "ClusterId", # required
  client_token: "ClientToken",
})

Response structure


resp.identifier #=> String
resp.arn #=> String
resp.status #=> String, one of "CREATING", "ACTIVE", "IDLE", "INACTIVE", "UPDATING", "DELETING", "DELETED", "FAILED", "PENDING_SETUP", "PENDING_DELETE"
resp.creation_time #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :identifier (required, String) —

    The ID of the cluster to delete.

  • :client_token (String) —

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully. The subsequent retries with the same client token return the result from the original successful request and they have no additional effect.

    If you don't specify a client token, the Amazon Web Services SDK automatically generates one.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

See Also:



796
797
798
799
 
# File 'gems/aws-sdk-dsql/lib/aws-sdk-dsql/client.rb', line 796

def delete_cluster(params = {}, options = {})
  req = build_request(:delete_cluster, params)
  req.send_request(options)
end

#delete_cluster_policy(params = {}) ⇒ Types::DeleteClusterPolicyOutput

Deletes the resource-based policy attached to a cluster. This removes all access permissions defined by the policy, reverting to default access controls.

Examples:

Request syntax with placeholder values


resp = client.delete_cluster_policy({
  identifier: "ClusterId", # required
  expected_policy_version: "PolicyVersion",
  client_token: "ClientToken",
})

Response structure


resp.policy_version #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :identifier (required, String) —

    The ID of the cluster.

  • :expected_policy_version (String) —

    The expected version of the policy to delete. This parameter ensures that you're deleting the correct version of the policy and helps prevent accidental deletions.

  • :client_token (String) —

    Idempotency token so a request is only processed once.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

See Also:



839
840
841
842
 
# File 'gems/aws-sdk-dsql/lib/aws-sdk-dsql/client.rb', line 839

def delete_cluster_policy(params = {}, options = {})
  req = build_request(:delete_cluster_policy, params)
  req.send_request(options)
end

#delete_stream(params = {}) ⇒ Types::DeleteStreamOutput

Deletes a stream from a cluster.

Examples:

Request syntax with placeholder values


resp = client.delete_stream({
  cluster_identifier: "ClusterId", # required
  stream_identifier: "StreamId", # required
  client_token: "ClientToken",
})

Response structure


resp.cluster_identifier #=> String
resp.stream_identifier #=> String
resp.arn #=> String
resp.status #=> String, one of "CREATING", "ACTIVE", "DELETING", "DELETED", "FAILED", "IMPAIRED"
resp.creation_time #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :cluster_identifier (required, String) —

    The ID of the cluster containing the stream to delete.

  • :stream_identifier (required, String) —

    The ID of the stream to delete.

  • :client_token (String) —

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, the subsequent retries with the same client token return the result from the original successful request and they have no additional effect.

    If you don't specify a client token, the Amazon Web Services SDK automatically generates one.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

See Also:



894
895
896
897
 
# File 'gems/aws-sdk-dsql/lib/aws-sdk-dsql/client.rb', line 894

def delete_stream(params = {}, options = {})
  req = build_request(:delete_stream, params)
  req.send_request(options)
end

#get_cluster(params = {}) ⇒ Types::GetClusterOutput

Retrieves information about a cluster.

The following waiters are defined for this operation (see #wait_until for detailed usage):

  • cluster_active
  • cluster_not_exists

Examples:

Example: Get Cluster


resp = client.get_cluster({
  identifier: "kiqenqglxyl2snyvkvnj2c3s2e", 
})

Request syntax with placeholder values


resp = client.get_cluster({
  identifier: "ClusterId", # required
})

Response structure


resp.identifier #=> String
resp.arn #=> String
resp.status #=> String, one of "CREATING", "ACTIVE", "IDLE", "INACTIVE", "UPDATING", "DELETING", "DELETED", "FAILED", "PENDING_SETUP", "PENDING_DELETE"
resp.creation_time #=> Time
resp.deletion_protection_enabled #=> Boolean
resp.multi_region_properties.witness_region #=> String
resp.multi_region_properties.clusters #=> Array
resp.multi_region_properties.clusters[0] #=> String
resp.tags #=> Hash
resp.tags["TagKey"] #=> String
resp.encryption_details.encryption_type #=> String, one of "AWS_OWNED_KMS_KEY", "CUSTOMER_MANAGED_KMS_KEY"
resp.encryption_details.kms_key_arn #=> String
resp.encryption_details.encryption_status #=> String, one of "ENABLED", "UPDATING", "KMS_KEY_INACCESSIBLE", "ENABLING"
resp.endpoint #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :identifier (required, String) —

    The ID of the cluster to retrieve.

Returns:

See Also:



956
957
958
959
 
# File 'gems/aws-sdk-dsql/lib/aws-sdk-dsql/client.rb', line 956

def get_cluster(params = {}, options = {})
  req = build_request(:get_cluster, params)
  req.send_request(options)
end

#get_cluster_policy(params = {}) ⇒ Types::GetClusterPolicyOutput

Retrieves the resource-based policy document attached to a cluster. This policy defines the access permissions and conditions for the cluster.

Examples:

Request syntax with placeholder values


resp = client.get_cluster_policy({
  identifier: "ClusterId", # required
})

Response structure


resp.policy #=> String
resp.policy_version #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :identifier (required, String) —

    The ID of the cluster to retrieve the policy from.

Returns:

See Also:



988
989
990
991
 
# File 'gems/aws-sdk-dsql/lib/aws-sdk-dsql/client.rb', line 988

def get_cluster_policy(params = {}, options = {})
  req = build_request(:get_cluster_policy, params)
  req.send_request(options)
end

#get_stream(params = {}) ⇒ Types::GetStreamOutput

Retrieves information about a stream.

The following waiters are defined for this operation (see #wait_until for detailed usage):

  • stream_active
  • stream_not_exists

Examples:

Request syntax with placeholder values


resp = client.get_stream({
  cluster_identifier: "ClusterId", # required
  stream_identifier: "StreamId", # required
})

Response structure


resp.cluster_identifier #=> String
resp.stream_identifier #=> String
resp.arn #=> String
resp.status #=> String, one of "CREATING", "ACTIVE", "DELETING", "DELETED", "FAILED", "IMPAIRED"
resp.creation_time #=> Time
resp.ordering #=> String, one of "UNORDERED"
resp.format #=> String, one of "JSON"
resp.target_definition.kinesis.stream_arn #=> String
resp.target_definition.kinesis.role_arn #=> String
resp.status_reason.error #=> String, one of "KINESIS_THROUGHPUT_EXCEEDED", "KINESIS_STREAM_NOT_FOUND", "ROLE_ACCESS_DENIED", "KINESIS_ACCESS_DENIED", "KINESIS_KMS_ACCESS_DENIED", "KINESIS_OVERSIZE_RECORD", "CLUSTER_CMK_INACCESSIBLE", "INTERNAL_ERROR"
resp.status_reason.updated_at #=> Time
resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :cluster_identifier (required, String) —

    The ID of the cluster containing the stream to retrieve.

  • :stream_identifier (required, String) —

    The ID of the stream to retrieve.

Returns:

See Also:



1047
1048
1049
1050
 
# File 'gems/aws-sdk-dsql/lib/aws-sdk-dsql/client.rb', line 1047

def get_stream(params = {}, options = {})
  req = build_request(:get_stream, params)
  req.send_request(options)
end

#get_vpc_endpoint_service_name(params = {}) ⇒ Types::GetVpcEndpointServiceNameOutput

Retrieves the VPC endpoint service name.

Examples:

Example: Get VPC Endpoint Service Name


resp = client.get_vpc_endpoint_service_name({
  identifier: "kiqenqglxyl2snyvkvnj2c3s2e", 
})

Request syntax with placeholder values


resp = client.get_vpc_endpoint_service_name({
  identifier: "ClusterId", # required
})

Response structure


resp.service_name #=> String
resp.cluster_vpc_endpoint #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :identifier (required, String) —

    The ID of the cluster to retrieve.

Returns:

See Also:



1084
1085
1086
1087
 
# File 'gems/aws-sdk-dsql/lib/aws-sdk-dsql/client.rb', line 1084

def get_vpc_endpoint_service_name(params = {}, options = {})
  req = build_request(:get_vpc_endpoint_service_name, params)
  req.send_request(options)
end

#list_clusters(params = {}) ⇒ Types::ListClustersOutput

Retrieves information about a list of clusters.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Example: List Clusters


resp = client.list_clusters({
  max_results: 20, 
})

Request syntax with placeholder values


resp = client.list_clusters({
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.next_token #=> String
resp.clusters #=> Array
resp.clusters[0].identifier #=> String
resp.clusters[0].arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :max_results (Integer) —

    An optional parameter that specifies the maximum number of results to return. You can use nextToken to display the next page of results.

  • :next_token (String) —

    If your initial ListClusters operation returns a nextToken, you can include the returned nextToken in following ListClusters operations, which returns results in the next page.

Returns:

See Also:



1132
1133
1134
1135
 
# File 'gems/aws-sdk-dsql/lib/aws-sdk-dsql/client.rb', line 1132

def list_clusters(params = {}, options = {})
  req = build_request(:list_clusters, params)
  req.send_request(options)
end

#list_streams(params = {}) ⇒ Types::ListStreamsOutput

Retrieves information about a list of streams for a cluster.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_streams({
  cluster_identifier: "ClusterId", # required
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.next_token #=> String
resp.streams #=> Array
resp.streams[0].cluster_identifier #=> String
resp.streams[0].stream_identifier #=> String
resp.streams[0].arn #=> String
resp.streams[0].creation_time #=> Time
resp.streams[0].status #=> String, one of "CREATING", "ACTIVE", "DELETING", "DELETED", "FAILED", "IMPAIRED"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :cluster_identifier (required, String) —

    The ID of the cluster for which to list streams.

  • :max_results (Integer) —

    An optional parameter that specifies the maximum number of results to return. You can use nextToken to display the next page of results. Default: 10.

  • :next_token (String) —

    If your initial ListStreams operation returns a nextToken, you can include the returned nextToken in following ListStreams operations, which returns results in the next page.

Returns:

See Also:



1181
1182
1183
1184
 
# File 'gems/aws-sdk-dsql/lib/aws-sdk-dsql/client.rb', line 1181

def list_streams(params = {}, options = {})
  req = build_request(:list_streams, params)
  req.send_request(options)
end

#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceOutput

Lists all of the tags for a resource.

Examples:

Example: List Tags For Resource


resp = client.list_tags_for_resource({
  resource_arn: "arn:aws:dsql:us-east-1:111111222222:cluster/kiqenqglxyl2snyvkvnj2c3s2e", 
})

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  resource_arn: "Arn", # required
})

Response structure


resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The ARN of the resource for which you want to list the tags.

Returns:

See Also:



1217
1218
1219
1220
 
# File 'gems/aws-sdk-dsql/lib/aws-sdk-dsql/client.rb', line 1217

def list_tags_for_resource(params = {}, options = {})
  req = build_request(:list_tags_for_resource, params)
  req.send_request(options)
end

#put_cluster_policy(params = {}) ⇒ Types::PutClusterPolicyOutput

Attaches a resource-based policy to a cluster. This policy defines access permissions and conditions for the cluster, allowing you to control which principals can perform actions on the cluster.

Examples:

Request syntax with placeholder values


resp = client.put_cluster_policy({
  identifier: "ClusterId", # required
  policy: "PolicyDocument", # required
  bypass_policy_lockout_safety_check: false,
  expected_policy_version: "PolicyVersion",
  client_token: "ClientToken",
})

Response structure


resp.policy_version #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :identifier (required, String) —

    The ID of the cluster.

  • :policy (required, String) —

    The resource-based policy document to attach to the cluster. This should be a valid JSON policy document that defines permissions and conditions.

  • :bypass_policy_lockout_safety_check (Boolean) —

    A flag that allows you to bypass the policy lockout safety check. When set to true, this parameter allows you to apply a policy that might lock you out of the cluster. Use with caution.

  • :expected_policy_version (String) —

    The expected version of the current policy. This parameter ensures that you're updating the correct version of the policy and helps prevent concurrent modification conflicts.

  • :client_token (String) —

    Idempotency token so a request is only processed once.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

See Also:



1272
1273
1274
1275
 
# File 'gems/aws-sdk-dsql/lib/aws-sdk-dsql/client.rb', line 1272

def put_cluster_policy(params = {}, options = {})
  req = build_request(:put_cluster_policy, params)
  req.send_request(options)
end

#tag_resource(params = {}) ⇒ Struct

Tags a resource with a map of key and value pairs.

Examples:

Example: Tag Resource


resp = client.tag_resource({
  resource_arn: "arn:aws:dsql:us-east-1:111111222222:cluster/kiqenqglxyl2snyvkvnj2c3s2e", 
  tags: {
    "MyKey" => "MyValue", 
  }, 
})

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "Arn", # required
  tags: { # required
    "TagKey" => "TagValue",
  },
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The ARN of the resource that you want to tag.

  • :tags (required, Hash<String,String>) —

    A map of key and value pairs to use to tag your resource.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1310
1311
1312
1313
 
# File 'gems/aws-sdk-dsql/lib/aws-sdk-dsql/client.rb', line 1310

def tag_resource(params = {}, options = {})
  req = build_request(:tag_resource, params)
  req.send_request(options)
end

#untag_resource(params = {}) ⇒ Struct

Removes a tag from a resource.

Examples:

Example: Untag Resource


resp = client.untag_resource({
  resource_arn: "arn:aws:dsql:us-east-1:111111222222:cluster/kiqenqglxyl2snyvkvnj2c3s2e", 
  tag_keys: [
    "MyKeyA", 
    "MyKeyB", 
  ], 
})

Request syntax with placeholder values


resp = client.untag_resource({
  resource_arn: "Arn", # required
  tag_keys: ["TagKey"], # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The ARN of the resource from which to remove tags.

  • :tag_keys (required, Array<String>) —

    The array of keys of the tags that you want to remove.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1347
1348
1349
1350
 
# File 'gems/aws-sdk-dsql/lib/aws-sdk-dsql/client.rb', line 1347

def untag_resource(params = {}, options = {})
  req = build_request(:untag_resource, params)
  req.send_request(options)
end

#update_cluster(params = {}) ⇒ Types::UpdateClusterOutput

The UpdateCluster API allows you to modify both single-Region and multi-Region cluster configurations. With the multiRegionProperties parameter, you can add or modify witness Region support and manage peer relationships with clusters in other Regions.

Note that updating multi-Region clusters requires additional IAM permissions beyond those needed for standard cluster updates, as detailed in the Permissions section.

Required permissions

dsql:UpdateCluster

Permission to update a DSQL cluster.

Resources: arn:aws:dsql:region:account-id:cluster/cluster-id ^

dsql:PutMultiRegionProperties

Permission to configure multi-Region properties for a cluster.

Resources: arn:aws:dsql:region:account-id:cluster/cluster-id ^

dsql:GetCluster

Permission to retrieve cluster information.

Resources: arn:aws:dsql:region:account-id:cluster/cluster-id

dsql:AddPeerCluster

Permission to add peer clusters.

Resources:

  • Local cluster: arn:aws:dsql:region:account-id:cluster/cluster-id

  • Each peer cluster: exact ARN of each specified peer cluster

dsql:RemovePeerCluster

Permission to remove peer clusters. The dsql:RemovePeerCluster permission uses a wildcard ARN pattern to simplify permission management during updates.

Resources: arn:aws:dsql:*:account-id:cluster/* ^

dsql:PutWitnessRegion

Permission to set a witness Region.

Resources: arn:aws:dsql:region:account-id:cluster/cluster-id

Condition Keys: dsql:WitnessRegion (matching the specified witness Region)

This permission is checked both in the cluster Region and in the witness Region.

  • The witness region specified in multiRegionProperties.witnessRegion cannot be the same as the cluster's Region.

  • When updating clusters with peer relationships, permissions are checked for both adding and removing peers.

  • The dsql:RemovePeerCluster permission uses a wildcard ARN pattern to simplify permission management during updates.

Examples:

Example: Update Cluster


resp = client.update_cluster({
  deletion_protection_enabled: false, 
  identifier: "kiqenqglxyl2snyvkvnj2c3s2e", 
})

Request syntax with placeholder values


resp = client.update_cluster({
  identifier: "ClusterId", # required
  deletion_protection_enabled: false,
  kms_encryption_key: "KmsEncryptionKey",
  client_token: "ClientToken",
  multi_region_properties: {
    witness_region: "Region",
    clusters: ["ClusterArn"],
  },
})

Response structure


resp.identifier #=> String
resp.arn #=> String
resp.status #=> String, one of "CREATING", "ACTIVE", "IDLE", "INACTIVE", "UPDATING", "DELETING", "DELETED", "FAILED", "PENDING_SETUP", "PENDING_DELETE"
resp.creation_time #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :identifier (required, String) —

    The ID of the cluster you want to update.

  • :deletion_protection_enabled (Boolean) —

    Specifies whether to enable deletion protection in your cluster.

  • :kms_encryption_key (String) —

    The KMS key that encrypts and protects the data on your cluster. You can specify the ARN, ID, or alias of an existing key or have Amazon Web Services create a default key for you.

  • :client_token (String) —

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully. The subsequent retries with the same client token return the result from the original successful request and they have no additional effect.

    If you don't specify a client token, the Amazon Web Services SDK automatically generates one.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :multi_region_properties (Types::MultiRegionProperties) —

    The new multi-Region cluster configuration settings to be applied during an update operation.

Returns:

See Also:



1495
1496
1497
1498
 
# File 'gems/aws-sdk-dsql/lib/aws-sdk-dsql/client.rb', line 1495

def update_cluster(params = {}, options = {})
  req = build_request(:update_cluster, params)
  req.send_request(options)
end

#wait_until(waiter_name, params = {}, options = {}) {|w.waiter| ... } ⇒ Boolean

Polls an API operation until a resource enters a desired state.

Basic Usage

A waiter will call an API operation until:

  • It is successful
  • It enters a terminal state
  • It makes the maximum number of attempts

In between attempts, the waiter will sleep.

# polls in a loop, sleeping between attempts
client.wait_until(waiter_name, params)

Configuration

You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. You can pass configuration as the final arguments hash.

# poll for ~25 seconds
client.wait_until(waiter_name, params, {
  max_attempts: 5,
  delay: 5,
})

Callbacks

You can be notified before each polling attempt and before each delay. If you throw :success or :failure from these callbacks, it will terminate the waiter.

started_at = Time.now
client.wait_until(waiter_name, params, {

  # disable max attempts
  max_attempts: nil,

  # poll for 1 hour, instead of a number of attempts
  before_wait: -> (attempts, response) do
    throw :failure if Time.now - started_at > 3600
  end
})

Handling Errors

When a waiter is unsuccessful, it will raise an error. All of the failure errors extend from Waiters::Errors::WaiterFailed.

begin
  client.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
  # resource did not enter the desired state in time
end

Valid Waiters

The following table lists the valid waiter names, the operations they call, and the default :delay and :max_attempts values.

waiter_name params :delay :max_attempts
cluster_active #get_cluster 2 60
cluster_not_exists #get_cluster 2 60
stream_active #get_stream 2 60
stream_not_exists #get_stream 2 60

Parameters:

  • waiter_name (Symbol)
  • params (Hash) (defaults to: {}) —

    ({})

  • options (Hash) (defaults to: {}) —

    ({})

Options Hash (options):

  • :max_attempts (Integer)
  • :delay (Integer)
  • :before_attempt (Proc)
  • :before_wait (Proc)

Yields:

  • (w.waiter)

Returns:

  • (Boolean) —

    Returns true if the waiter was successful.

Raises:

  • (Errors::FailureStateError) —

    Raised when the waiter terminates because the waiter has entered a state that it will not transition out of, preventing success.

  • (Errors::TooManyAttemptsError) —

    Raised when the configured maximum number of attempts have been made, and the waiter is not yet successful.

  • (Errors::UnexpectedError) —

    Raised when an error is encounted while polling for a resource that is not expected.

  • (Errors::NoSuchWaiterError) —

    Raised when you request to wait for an unknown state.



1613
1614
1615
1616
1617
 
# File 'gems/aws-sdk-dsql/lib/aws-sdk-dsql/client.rb', line 1613

def wait_until(waiter_name, params = {}, options = {})
  w = waiter(waiter_name, options)
  yield(w.waiter) if block_given? # deprecated
  w.wait(params)
end