Struct Client

Source

pub struct Client { /* private fields */ }

Expand description

Client for Amazon Relational Database Service

Client for invoking operations on Amazon Relational Database Service. Each operation on Amazon Relational Database Service 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_rds::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_rds::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 AddRoleToDBCluster operation has a Client::add_role_to_db_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.add_role_to_db_cluster()
    .db_cluster_identifier("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;

The fluent builder is configurable:
- db_instance_identifier(impl Into<String>) /

Struct ClientCopy item path

§Constructing a Client

§Using the Client

§Waiters

Implementations§

impl Client

pub fn add_role_to_db_cluster(&self) -> AddRoleToDBClusterFluentBuilder

impl Client

pub fn add_role_to_db_instance(&self) -> AddRoleToDBInstanceFluentBuilder

impl Client

pub fn add_source_identifier_to_subscription( &self, ) -> AddSourceIdentifierToSubscriptionFluentBuilder

impl Client

pub fn add_tags_to_resource(&self) -> AddTagsToResourceFluentBuilder

impl Client

pub fn apply_pending_maintenance_action( &self, ) -> ApplyPendingMaintenanceActionFluentBuilder

impl Client

pub fn authorize_db_security_group_ingress( &self, ) -> AuthorizeDBSecurityGroupIngressFluentBuilder

impl Client

pub fn backtrack_db_cluster(&self) -> BacktrackDBClusterFluentBuilder

impl Client

pub fn cancel_export_task(&self) -> CancelExportTaskFluentBuilder

impl Client

pub fn copy_db_cluster_parameter_group( &self, ) -> CopyDBClusterParameterGroupFluentBuilder

impl Client

pub fn copy_db_cluster_snapshot(&self) -> CopyDBClusterSnapshotFluentBuilder

impl Client

pub fn copy_db_parameter_group(&self) -> CopyDBParameterGroupFluentBuilder

impl Client

pub fn copy_db_snapshot(&self) -> CopyDBSnapshotFluentBuilder

impl Client

pub fn copy_option_group(&self) -> CopyOptionGroupFluentBuilder

impl Client

pub fn create_blue_green_deployment( &self, ) -> CreateBlueGreenDeploymentFluentBuilder

impl Client

pub fn create_custom_db_engine_version( &self, ) -> CreateCustomDBEngineVersionFluentBuilder

impl Client

pub fn create_db_cluster(&self) -> CreateDBClusterFluentBuilder

impl Client

pub fn create_db_cluster_endpoint(&self) -> CreateDBClusterEndpointFluentBuilder

impl Client

pub fn create_db_cluster_parameter_group( &self, ) -> CreateDBClusterParameterGroupFluentBuilder

impl Client

pub fn create_db_cluster_snapshot(&self) -> CreateDBClusterSnapshotFluentBuilder

impl Client

pub fn create_db_instance(&self) -> CreateDBInstanceFluentBuilder

impl Client

pub fn create_db_instance_read_replica( &self, ) -> CreateDBInstanceReadReplicaFluentBuilder

impl Client

pub fn create_db_parameter_group(&self) -> CreateDBParameterGroupFluentBuilder

impl Client

pub fn create_db_proxy(&self) -> CreateDBProxyFluentBuilder

impl Client

pub fn create_db_proxy_endpoint(&self) -> CreateDBProxyEndpointFluentBuilder

impl Client

pub fn create_db_security_group(&self) -> CreateDBSecurityGroupFluentBuilder

impl Client

pub fn create_db_shard_group(&self) -> CreateDBShardGroupFluentBuilder

impl Client

pub fn create_db_snapshot(&self) -> CreateDBSnapshotFluentBuilder

impl Client

pub fn create_db_subnet_group(&self) -> CreateDBSubnetGroupFluentBuilder

impl Client

pub fn create_event_subscription(&self) -> CreateEventSubscriptionFluentBuilder

impl Client

pub fn create_global_cluster(&self) -> CreateGlobalClusterFluentBuilder

impl Client

pub fn create_integration(&self) -> CreateIntegrationFluentBuilder

impl Client

pub fn create_option_group(&self) -> CreateOptionGroupFluentBuilder

impl Client

pub fn create_tenant_database(&self) -> CreateTenantDatabaseFluentBuilder

impl Client

pub fn delete_blue_green_deployment( &self, ) -> DeleteBlueGreenDeploymentFluentBuilder

impl Client

pub fn delete_custom_db_engine_version( &self, ) -> DeleteCustomDBEngineVersionFluentBuilder

impl Client

pub fn delete_db_cluster(&self) -> DeleteDBClusterFluentBuilder

impl Client

pub fn delete_db_cluster_automated_backup( &self, ) -> DeleteDBClusterAutomatedBackupFluentBuilder

impl Client

Struct Client

§Constructing a `Client`

§Using the `Client`