Struct Client 

pub struct Client { /* private fields */ }

Client for Amazon Aurora DSQL

Client for invoking operations on Amazon Aurora DSQL. Each operation on Amazon Aurora DSQL is a method on this this struct. .send() MUST be invoked on the generated operations to dispatch the request to the service.

Constructing a Client

A Config is required to construct a client. For most use cases, the aws-config crate should be used to automatically resolve this config using aws_config::load_from_env(), since this will resolve an SdkConfig which can be shared across multiple different AWS SDK clients. This config resolution process can be customized by calling aws_config::from_env() instead, which returns a ConfigLoader that uses the builder pattern to customize the default config.

In the simplest case, creating a client looks as follows:

let config = aws_config::load_from_env().await;
let client = aws_sdk_dsql::Client::new(&config);

Occasionally, SDKs may have additional service-specific values that can be set on the Config that is absent from SdkConfig, or slightly different settings for a specific client may be desired. The Builder struct implements From<&SdkConfig>, so setting these specific settings can be done as follows:

let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_dsql::config::Builder::from(&sdk_config)
    .some_service_specific_setting("value")
    .build();

See the aws-config docs and Config for more information on customizing configuration.

Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.

Using the Client

A client has a function for every operation that can be performed by the service. For example, the CreateCluster operation has a Client::create_cluster, function which returns a builder for that operation. The fluent builder ultimately has a send() function that returns an async future that returns a result, as illustrated below:

let result = client.create_cluster()
    .kms_encryption_key("example")
    .send()
    .await;

The underlying HTTP requests that get made by this can be modified with the customize_operation function on the fluent builder. See the customize module for more information.

Waiters

This client provides wait_until methods behind the Waiters trait. To use them, simply import the trait, and then call one of the wait_until methods. This will return a waiter fluent builder that takes various parameters, which are documented on the builder type. Once parameters have been provided, the wait method can be called to initiate waiting.

For example, if there was a wait_until_thing method, it could look like:

let result = client.wait_until_thing()
    .thing_id("someId")
    .wait(Duration::from_secs(120))
    .await;

Implementations

impl Client

pub fn create_cluster(&self) -> CreateClusterFluentBuilder

Constructs a fluent builder for the CreateCluster operation.

• The fluent builder is configurable:
  • deletion_protection_enabled(bool) / set_deletion_protection_enabled(Option<bool>):
    required: false
    

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

    
    
  • kms_encryption_key(impl Into<String>) / set_kms_encryption_key(Option<String>):
    required: false
    

    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(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

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

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    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.

    
    
  • multi_region_properties(MultiRegionProperties) / set_multi_region_properties(Option<MultiRegionProperties>):
    required: false
    

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

    
    
  • policy(impl Into<String>) / set_policy(Option<String>):
    required: false
    

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

    
    
  • bypass_policy_lockout_safety_check(bool) / set_bypass_policy_lockout_safety_check(Option<bool>):
    required: false
    

    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.

    
    
• On success, responds with CreateClusterOutput with field(s):
  • identifier(String):

    The ID of the created cluster.

  • arn(String):

    The ARN of the created cluster.

  • status(ClusterStatus):

    The status of the created cluster.

  • creation_time(DateTime):

    The time of when created the cluster.

  • multi_region_properties(Option<MultiRegionProperties>):

    The multi-Region cluster configuration details that were set during cluster creation

  • encryption_details(Option<EncryptionDetails>):

    The encryption configuration for the cluster that was specified during the creation process, including the KMS key identifier and encryption state.

  • deletion_protection_enabled(bool):

    Whether deletion protection is enabled on this cluster.

• On failure, responds with SdkError<CreateClusterError>

impl Client

pub fn delete_cluster(&self) -> DeleteClusterFluentBuilder

Constructs a fluent builder for the DeleteCluster operation.

• The fluent builder is configurable:
  • identifier(impl Into<String>) / set_identifier(Option<String>):
    required: true
    

    The ID of the cluster to delete.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    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.

    
    
• On success, responds with DeleteClusterOutput with field(s):
  • identifier(String):

    The ID of the deleted cluster.

  • arn(String):

    The ARN of the deleted cluster.

  • status(ClusterStatus):

    The status of the cluster.

  • creation_time(DateTime):

    The time of when the cluster was created.

• On failure, responds with SdkError<DeleteClusterError>

impl Client

pub fn delete_cluster_policy(&self) -> DeleteClusterPolicyFluentBuilder

Constructs a fluent builder for the DeleteClusterPolicy operation.

• The fluent builder is configurable:
  • identifier(impl Into<String>) / set_identifier(Option<String>):
    required: true
    

    The ID of the cluster.

    
    
  • expected_policy_version(impl Into<String>) / set_expected_policy_version(Option<String>):
    required: false
    

    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(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    Idempotency token so a request is only processed once.

    
    
• On success, responds with DeleteClusterPolicyOutput with field(s):
  • policy_version(String):

    The version of the policy that was deleted.

• On failure, responds with SdkError<DeleteClusterPolicyError>

impl Client

pub fn get_cluster(&self) -> GetClusterFluentBuilder

Constructs a fluent builder for the GetCluster operation.

• The fluent builder is configurable:
  • identifier(impl Into<String>) / set_identifier(Option<String>):
    required: true
    

    The ID of the cluster to retrieve.

    
    
• On success, responds with GetClusterOutput with field(s):
  • identifier(String):

    The ID of the retrieved cluster.

  • arn(String):

    The ARN of the retrieved cluster.

  • status(ClusterStatus):

    The status of the retrieved cluster.

  • creation_time(DateTime):

    The time of when the cluster was created.

  • deletion_protection_enabled(bool):

    Whether deletion protection is enabled in this cluster.

  • multi_region_properties(Option<MultiRegionProperties>):

    Returns the current multi-Region cluster configuration, including witness region and linked cluster information.

  • tags(Option<HashMap::<String, String>>):

    Map of tags.

  • encryption_details(Option<EncryptionDetails>):

    The current encryption configuration details for the cluster.

• On failure, responds with SdkError<GetClusterError>

impl Client

pub fn get_cluster_policy(&self) -> GetClusterPolicyFluentBuilder

Constructs a fluent builder for the GetClusterPolicy operation.

• The fluent builder is configurable:
  • identifier(impl Into<String>) / set_identifier(Option<String>):
    required: true
    

    The ID of the cluster to retrieve the policy from.

    
    
• On success, responds with GetClusterPolicyOutput with field(s):
  • policy(String):

    The resource-based policy document attached to the cluster, returned as a JSON string.

  • policy_version(String):

    The version of the policy document. This version number is incremented each time the policy is updated.

• On failure, responds with SdkError<GetClusterPolicyError>

impl Client

pub fn get_vpc_endpoint_service_name( &self, ) -> GetVpcEndpointServiceNameFluentBuilder

Constructs a fluent builder for the GetVpcEndpointServiceName operation.

• The fluent builder is configurable:
  • identifier(impl Into<String>) / set_identifier(Option<String>):
    required: true
    

    The ID of the cluster to retrieve.

    
    
• On success, responds with GetVpcEndpointServiceNameOutput with field(s):
  • service_name(String):

    The VPC endpoint service name.

• On failure, responds with SdkError<GetVpcEndpointServiceNameError>

impl Client

pub fn list_clusters(&self) -> ListClustersFluentBuilder

Constructs a fluent builder for the ListClusters operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    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(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    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.

    
    
• On success, responds with ListClustersOutput with field(s):
  • next_token(Option<String>):

    If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. To retrieve the next page, make the call again using the returned token.

  • clusters(Vec::<ClusterSummary>):

    An array of the returned clusters.

• On failure, responds with SdkError<ListClustersError>

impl Client

pub fn list_tags_for_resource(&self) -> ListTagsForResourceFluentBuilder

Constructs a fluent builder for the ListTagsForResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

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

    
    
• On success, responds with ListTagsForResourceOutput with field(s):
  • tags(Option<HashMap::<String, String>>):

    A map of key and value pairs that you used to tag your resource.

• On failure, responds with SdkError<ListTagsForResourceError>

impl Client

pub fn put_cluster_policy(&self) -> PutClusterPolicyFluentBuilder

Constructs a fluent builder for the PutClusterPolicy operation.

• The fluent builder is configurable:
  • identifier(impl Into<String>) / set_identifier(Option<String>):
    required: true
    

    The ID of the cluster.

    
    
  • policy(impl Into<String>) / set_policy(Option<String>):
    required: true
    

    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(bool) / set_bypass_policy_lockout_safety_check(Option<bool>):
    required: false
    

    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(impl Into<String>) / set_expected_policy_version(Option<String>):
    required: false
    

    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(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    Idempotency token so a request is only processed once.

    
    
• On success, responds with PutClusterPolicyOutput with field(s):
  • policy_version(String):

    The version of the policy after it has been updated or created.

• On failure, responds with SdkError<PutClusterPolicyError>

impl Client

pub fn tag_resource(&self) -> TagResourceFluentBuilder

Constructs a fluent builder for the TagResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The ARN of the resource that you want to tag.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: true
    

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

    
    
• On success, responds with TagResourceOutput
• On failure, responds with SdkError<TagResourceError>

impl Client

pub fn untag_resource(&self) -> UntagResourceFluentBuilder

Constructs a fluent builder for the UntagResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The ARN of the resource from which to remove tags.

    
    
  • tag_keys(impl Into<String>) / set_tag_keys(Option<Vec::<String>>):
    required: true
    

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

    
    
• On success, responds with UntagResourceOutput
• On failure, responds with SdkError<UntagResourceError>

impl Client

pub fn update_cluster(&self) -> UpdateClusterFluentBuilder

Constructs a fluent builder for the UpdateCluster operation.

• The fluent builder is configurable:
  • identifier(impl Into<String>) / set_identifier(Option<String>):
    required: true
    

    The ID of the cluster you want to update.

    
    
  • deletion_protection_enabled(bool) / set_deletion_protection_enabled(Option<bool>):
    required: false
    

    Specifies whether to enable deletion protection in your cluster.

    
    
  • kms_encryption_key(impl Into<String>) / set_kms_encryption_key(Option<String>):
    required: false
    

    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(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    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.

    
    
  • multi_region_properties(MultiRegionProperties) / set_multi_region_properties(Option<MultiRegionProperties>):
    required: false
    

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

    
    
• On success, responds with UpdateClusterOutput with field(s):
  • identifier(String):

    The ID of the cluster to update.

  • arn(String):

    The ARN of the updated cluster.

  • status(ClusterStatus):

    The status of the updated cluster.

  • creation_time(DateTime):

    The time of when the cluster was created.

• On failure, responds with SdkError<UpdateClusterError>

impl Client

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Panics

This method will panic in the following cases:

• Retries or timeouts are enabled without a sleep_impl configured.
• Identity caching is enabled without a sleep_impl and time_source configured.
• No behavior_version is provided.

The panic message for each of these will have instructions on how to resolve them.

pub fn config(&self) -> &Config

Returns the client’s configuration.

impl Client

pub fn new(sdk_config: &SdkConfig) -> Self

Creates a new client from an SDK Config.

Panics

• This method will panic if the sdk_config is missing an async sleep implementation. If you experience this panic, set the sleep_impl on the Config passed into this function to fix it.
• This method will panic if the sdk_config is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.
• This method will panic if no BehaviorVersion is provided. If you experience this panic, set behavior_version on the Config or enable the behavior-version-latest Cargo feature.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Client

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Waiters for Client

fn wait_until_cluster_active(&self) -> ClusterActiveFluentBuilder

Wait until a Cluster is ACTIVE

fn wait_until_cluster_not_exists(&self) -> ClusterNotExistsFluentBuilder

Wait until a Cluster is gone