Struct Client

Source

pub struct Client { /* private fields */ }

Expand description

Client for Amazon ElastiCache

Client for invoking operations on Amazon ElastiCache. Each operation on Amazon ElastiCache 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_elasticache::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_elasticache::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 AddTagsToResource operation has a Client::add_tags_to_resource, 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_tags_to_resource()
    .resource_name("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;

Struct ClientCopy item path

§Constructing a Client

§Using the Client

§Waiters

Implementations§

impl Client

pub fn add_tags_to_resource(&self) -> AddTagsToResourceFluentBuilder

impl Client

pub fn authorize_cache_security_group_ingress( &self, ) -> AuthorizeCacheSecurityGroupIngressFluentBuilder

impl Client

pub fn batch_apply_update_action(&self) -> BatchApplyUpdateActionFluentBuilder

impl Client

pub fn batch_stop_update_action(&self) -> BatchStopUpdateActionFluentBuilder

impl Client

pub fn complete_migration(&self) -> CompleteMigrationFluentBuilder

impl Client

pub fn copy_serverless_cache_snapshot( &self, ) -> CopyServerlessCacheSnapshotFluentBuilder

impl Client

pub fn copy_snapshot(&self) -> CopySnapshotFluentBuilder

impl Client

pub fn create_cache_cluster(&self) -> CreateCacheClusterFluentBuilder

impl Client

pub fn create_cache_parameter_group( &self, ) -> CreateCacheParameterGroupFluentBuilder

impl Client

pub fn create_cache_security_group( &self, ) -> CreateCacheSecurityGroupFluentBuilder

impl Client

pub fn create_cache_subnet_group(&self) -> CreateCacheSubnetGroupFluentBuilder

impl Client

pub fn create_global_replication_group( &self, ) -> CreateGlobalReplicationGroupFluentBuilder

impl Client

pub fn create_replication_group(&self) -> CreateReplicationGroupFluentBuilder

impl Client

pub fn create_serverless_cache(&self) -> CreateServerlessCacheFluentBuilder

impl Client

pub fn create_serverless_cache_snapshot( &self, ) -> CreateServerlessCacheSnapshotFluentBuilder

impl Client

pub fn create_snapshot(&self) -> CreateSnapshotFluentBuilder

impl Client

pub fn create_user(&self) -> CreateUserFluentBuilder

impl Client

pub fn create_user_group(&self) -> CreateUserGroupFluentBuilder

impl Client

pub fn decrease_node_groups_in_global_replication_group( &self, ) -> DecreaseNodeGroupsInGlobalReplicationGroupFluentBuilder

impl Client

pub fn decrease_replica_count(&self) -> DecreaseReplicaCountFluentBuilder

impl Client

pub fn delete_cache_cluster(&self) -> DeleteCacheClusterFluentBuilder

impl Client

pub fn delete_cache_parameter_group( &self, ) -> DeleteCacheParameterGroupFluentBuilder

impl Client

pub fn delete_cache_security_group( &self, ) -> DeleteCacheSecurityGroupFluentBuilder

impl Client

pub fn delete_cache_subnet_group(&self) -> DeleteCacheSubnetGroupFluentBuilder

impl Client

pub fn delete_global_replication_group( &self, ) -> DeleteGlobalReplicationGroupFluentBuilder

impl Client

pub fn delete_replication_group(&self) -> DeleteReplicationGroupFluentBuilder

impl Client

pub fn delete_serverless_cache(&self) -> DeleteServerlessCacheFluentBuilder

impl Client

pub fn delete_serverless_cache_snapshot( &self, ) -> DeleteServerlessCacheSnapshotFluentBuilder

impl Client

pub fn delete_snapshot(&self) -> DeleteSnapshotFluentBuilder

impl Client

pub fn delete_user(&self) -> DeleteUserFluentBuilder

impl Client

pub fn delete_user_group(&self) -> DeleteUserGroupFluentBuilder

impl Client

pub fn describe_cache_clusters(&self) -> DescribeCacheClustersFluentBuilder

impl Client

pub fn describe_cache_engine_versions( &self, ) -> DescribeCacheEngineVersionsFluentBuilder

impl Client

pub fn describe_cache_parameter_groups( &self, ) -> DescribeCacheParameterGroupsFluentBuilder

impl Client

pub fn describe_cache_parameters(&self) -> DescribeCacheParametersFluentBuilder

impl Client

pub fn describe_cache_security_groups( &self, ) -> DescribeCacheSecurityGroupsFluentBuilder

impl Client

pub fn describe_cache_subnet_groups( &self, ) -> DescribeCacheSubnetGroupsFluentBuilder

impl Client

Struct Client

§Constructing a `Client`

§Using the `Client`