Struct Client

Source

pub struct Client { /* private fields */ }

Expand description

Client for Amazon MemoryDB

Client for invoking operations on Amazon MemoryDB. Each operation on Amazon MemoryDB 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_memorydb::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_memorydb::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 CopySnapshot operation has a Client::copy_snapshot, 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.copy_snapshot()
    .source_snapshot_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.

Struct ClientCopy item path

§Constructing a Client

§Using the Client

Implementations§

impl Client

pub fn batch_update_cluster(&self) -> BatchUpdateClusterFluentBuilder

impl Client

pub fn copy_snapshot(&self) -> CopySnapshotFluentBuilder

impl Client

pub fn create_acl(&self) -> CreateACLFluentBuilder

impl Client

pub fn create_cluster(&self) -> CreateClusterFluentBuilder

impl Client

pub fn create_multi_region_cluster( &self, ) -> CreateMultiRegionClusterFluentBuilder

impl Client

pub fn create_parameter_group(&self) -> CreateParameterGroupFluentBuilder

impl Client

pub fn create_snapshot(&self) -> CreateSnapshotFluentBuilder

impl Client

pub fn create_subnet_group(&self) -> CreateSubnetGroupFluentBuilder

impl Client

pub fn create_user(&self) -> CreateUserFluentBuilder

impl Client

pub fn delete_acl(&self) -> DeleteACLFluentBuilder

impl Client

pub fn delete_cluster(&self) -> DeleteClusterFluentBuilder

impl Client

pub fn delete_multi_region_cluster( &self, ) -> DeleteMultiRegionClusterFluentBuilder

impl Client

pub fn delete_parameter_group(&self) -> DeleteParameterGroupFluentBuilder

impl Client

pub fn delete_snapshot(&self) -> DeleteSnapshotFluentBuilder

impl Client

pub fn delete_subnet_group(&self) -> DeleteSubnetGroupFluentBuilder

impl Client

pub fn delete_user(&self) -> DeleteUserFluentBuilder

impl Client

pub fn describe_acls(&self) -> DescribeACLsFluentBuilder

impl Client

pub fn describe_clusters(&self) -> DescribeClustersFluentBuilder

impl Client

pub fn describe_engine_versions(&self) -> DescribeEngineVersionsFluentBuilder

impl Client

pub fn describe_events(&self) -> DescribeEventsFluentBuilder

impl Client

pub fn describe_multi_region_clusters( &self, ) -> DescribeMultiRegionClustersFluentBuilder

impl Client

pub fn describe_parameter_groups(&self) -> DescribeParameterGroupsFluentBuilder

impl Client

pub fn describe_parameters(&self) -> DescribeParametersFluentBuilder

impl Client

pub fn describe_reserved_nodes(&self) -> DescribeReservedNodesFluentBuilder

impl Client

pub fn describe_reserved_nodes_offerings( &self, ) -> DescribeReservedNodesOfferingsFluentBuilder

impl Client

pub fn describe_service_updates(&self) -> DescribeServiceUpdatesFluentBuilder

impl Client

pub fn describe_snapshots(&self) -> DescribeSnapshotsFluentBuilder

impl Client

pub fn describe_subnet_groups(&self) -> DescribeSubnetGroupsFluentBuilder

impl Client

pub fn describe_users(&self) -> DescribeUsersFluentBuilder

impl Client

pub fn failover_shard(&self) -> FailoverShardFluentBuilder

impl Client

pub fn list_allowed_multi_region_cluster_updates( &self, ) -> ListAllowedMultiRegionClusterUpdatesFluentBuilder

impl Client

pub fn list_allowed_node_type_updates( &self, ) -> ListAllowedNodeTypeUpdatesFluentBuilder

impl Client

pub fn list_tags(&self) -> ListTagsFluentBuilder

impl Client

pub fn purchase_reserved_nodes_offering( &self, ) -> PurchaseReservedNodesOfferingFluentBuilder

impl Client

pub fn reset_parameter_group(&self) -> ResetParameterGroupFluentBuilder

impl Client

pub fn tag_resource(&self) -> TagResourceFluentBuilder

impl Client

pub fn untag_resource(&self) -> UntagResourceFluentBuilder

impl Client

pub fn update_acl(&self) -> UpdateACLFluentBuilder

Struct Client

§Constructing a `Client`

§Using the `Client`

impl<T> Any for T
where T: 'static + ?Sized,

impl<T> Borrow<T> for T
where T: ?Sized,

impl<T> BorrowMut<T> for T
where T: ?Sized,

impl<T> CloneToUninit for T
where T: Clone,

impl<T, U> Into<U> for T
where U: From<T>,

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

impl<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

impl<T> Paint for T
where T: ?Sized,