Struct rusoto_elasticache::ElastiCacheClient

pub struct ElastiCacheClient { /* fields omitted */ }

A client for the Amazon ElastiCache API.

Methods

impl ElastiCacheClient

pub fn new(region: Region) -> ElastiCacheClient

Creates a client backed by the default tokio event loop.

The client will use the default credentials provider and tls client.

pub fn new_with<P, D>(
    request_dispatcher: D,
    credentials_provider: P,
    region: Region
) -> ElastiCacheClient where
    P: ProvideAwsCredentials + Send + Sync + 'static,
    P::Future: Send,
    D: DispatchSignedRequest + Send + Sync + 'static,
    D::Future: Send, 

Trait Implementations

impl ElastiCache for ElastiCacheClient

fn add_tags_to_resource(
    &self,
    input: AddTagsToResourceMessage
) -> RusotoFuture<TagListMessage, AddTagsToResourceError>

Adds up to 50 cost allocation tags to the named resource. A cost allocation tag is a key-value pair where the key and value are case-sensitive. You can use cost allocation tags to categorize and track your AWS costs.

When you apply tags to your ElastiCache resources, AWS generates a cost allocation report as a comma-separated value (CSV) file with your usage and costs aggregated by your tags. You can apply tags that represent business categories (such as cost centers, application names, or owners) to organize your costs across multiple services. For more information, see Using Cost Allocation Tags in Amazon ElastiCache in the ElastiCache User Guide.

fn authorize_cache_security_group_ingress(
    &self,
    input: AuthorizeCacheSecurityGroupIngressMessage
) -> RusotoFuture<AuthorizeCacheSecurityGroupIngressResult, AuthorizeCacheSecurityGroupIngressError>

Allows network ingress to a cache security group. Applications using ElastiCache must be running on Amazon EC2, and Amazon EC2 security groups are used as the authorization mechanism.

You cannot authorize ingress from an Amazon EC2 security group in one region to an ElastiCache cluster in another region.

fn copy_snapshot(
    &self,
    input: CopySnapshotMessage
) -> RusotoFuture<CopySnapshotResult, CopySnapshotError>

Makes a copy of an existing snapshot.

This operation is valid for Redis only.

Users or groups that have permissions to use the CopySnapshot operation can create their own Amazon S3 buckets and copy snapshots to it. To control access to your snapshots, use an IAM policy to control who has the ability to use the CopySnapshot operation. For more information about using IAM to control the use of ElastiCache operations, see Exporting Snapshots and Authentication & Access Control.

You could receive the following error messages.

Error Messages

• Error Message: The S3 bucket %s is outside of the region.

  Solution: Create an Amazon S3 bucket in the same region as your snapshot. For more information, see Step 1: Create an Amazon S3 Bucket in the ElastiCache User Guide.

• Error Message: The S3 bucket %s does not exist.

  Solution: Create an Amazon S3 bucket in the same region as your snapshot. For more information, see Step 1: Create an Amazon S3 Bucket in the ElastiCache User Guide.

• Error Message: The S3 bucket %s is not owned by the authenticated user.

  Solution: Create an Amazon S3 bucket in the same region as your snapshot. For more information, see Step 1: Create an Amazon S3 Bucket in the ElastiCache User Guide.

• Error Message: The authenticated user does not have sufficient permissions to perform the desired activity.

  Solution: Contact your system administrator to get the needed permissions.

• Error Message: The S3 bucket %s already contains an object with key %s.

  Solution: Give the TargetSnapshotName a new and unique value. If exporting a snapshot, you could alternatively create a new Amazon S3 bucket and use this same value for TargetSnapshotName.

• Error Message: ElastiCache has not been granted READ permissions %s on the S3 Bucket.

  Solution: Add List and Read permissions on the bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the ElastiCache User Guide.

• Error Message: ElastiCache has not been granted WRITE permissions %s on the S3 Bucket.

  Solution: Add Upload/Delete permissions on the bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the ElastiCache User Guide.

• Error Message: ElastiCache has not been granted READ_ACP permissions %s on the S3 Bucket.

  Solution: Add View Permissions on the bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the ElastiCache User Guide.

fn create_cache_cluster(
    &self,
    input: CreateCacheClusterMessage
) -> RusotoFuture<CreateCacheClusterResult, CreateCacheClusterError>

Creates a cluster. All nodes in the cluster run the same protocol-compliant cache engine software, either Memcached or Redis.

This operation is not supported for Redis (cluster mode enabled) clusters.

fn create_cache_parameter_group(
    &self,
    input: CreateCacheParameterGroupMessage
) -> RusotoFuture<CreateCacheParameterGroupResult, CreateCacheParameterGroupError>

Creates a new Amazon ElastiCache cache parameter group. An ElastiCache cache parameter group is a collection of parameters and their values that are applied to all of the nodes in any cluster or replication group using the CacheParameterGroup.

A newly created CacheParameterGroup is an exact duplicate of the default parameter group for the CacheParameterGroupFamily. To customize the newly created CacheParameterGroup you can change the values of specific parameters. For more information, see:

• ModifyCacheParameterGroup in the ElastiCache API Reference.

• Parameters and Parameter Groups in the ElastiCache User Guide.

fn create_cache_security_group(
    &self,
    input: CreateCacheSecurityGroupMessage
) -> RusotoFuture<CreateCacheSecurityGroupResult, CreateCacheSecurityGroupError>

Creates a new cache security group. Use a cache security group to control access to one or more clusters.

Cache security groups are only used when you are creating a cluster outside of an Amazon Virtual Private Cloud (Amazon VPC). If you are creating a cluster inside of a VPC, use a cache subnet group instead. For more information, see CreateCacheSubnetGroup.

fn create_cache_subnet_group(
    &self,
    input: CreateCacheSubnetGroupMessage
) -> RusotoFuture<CreateCacheSubnetGroupResult, CreateCacheSubnetGroupError>

Creates a new cache subnet group.

Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (Amazon VPC).

fn create_replication_group(
    &self,
    input: CreateReplicationGroupMessage
) -> RusotoFuture<CreateReplicationGroupResult, CreateReplicationGroupError>

Creates a Redis (cluster mode disabled) or a Redis (cluster mode enabled) replication group.

A Redis (cluster mode disabled) replication group is a collection of clusters, where one of the clusters is a read/write primary and the others are read-only replicas. Writes to the primary are asynchronously propagated to the replicas.

A Redis (cluster mode enabled) replication group is a collection of 1 to 15 node groups (shards). Each node group (shard) has one read/write primary node and up to 5 read-only replica nodes. Writes to the primary are asynchronously propagated to the replicas. Redis (cluster mode enabled) replication groups partition the data across node groups (shards).

When a Redis (cluster mode disabled) replication group has been successfully created, you can add one or more read replicas to it, up to a total of 5 read replicas. You cannot alter a Redis (cluster mode enabled) replication group after it has been created. However, if you need to increase or decrease the number of node groups (console: shards), you can avail yourself of ElastiCache for Redis' enhanced backup and restore. For more information, see Restoring From a Backup with Cluster Resizing in the ElastiCache User Guide.

This operation is valid for Redis only.

fn create_snapshot(
    &self,
    input: CreateSnapshotMessage
) -> RusotoFuture<CreateSnapshotResult, CreateSnapshotError>

Creates a copy of an entire cluster or replication group at a specific moment in time.

This operation is valid for Redis only.

fn decrease_replica_count(
    &self,
    input: DecreaseReplicaCountMessage
) -> RusotoFuture<DecreaseReplicaCountResult, DecreaseReplicaCountError>

Dynamically decreases the number of replics in a Redis (cluster mode disabled) replication group or the number of replica nodes in one or more node groups (shards) of a Redis (cluster mode enabled) replication group. This operation is performed with no cluster down time.

fn delete_cache_cluster(
    &self,
    input: DeleteCacheClusterMessage
) -> RusotoFuture<DeleteCacheClusterResult, DeleteCacheClusterError>

Deletes a previously provisioned cluster. DeleteCacheCluster deletes all associated cache nodes, node endpoints and the cluster itself. When you receive a successful response from this operation, Amazon ElastiCache immediately begins deleting the cluster; you cannot cancel or revert this operation.

This operation cannot be used to delete a cluster that is the last read replica of a replication group or node group (shard) that has Multi-AZ mode enabled or a cluster from a Redis (cluster mode enabled) replication group.

This operation is not valid for Redis (cluster mode enabled) clusters.

fn delete_cache_parameter_group(
    &self,
    input: DeleteCacheParameterGroupMessage
) -> RusotoFuture<(), DeleteCacheParameterGroupError>

Deletes the specified cache parameter group. You cannot delete a cache parameter group if it is associated with any cache clusters.

fn delete_cache_security_group(
    &self,
    input: DeleteCacheSecurityGroupMessage
) -> RusotoFuture<(), DeleteCacheSecurityGroupError>

Deletes a cache security group.

You cannot delete a cache security group if it is associated with any clusters.

fn delete_cache_subnet_group(
    &self,
    input: DeleteCacheSubnetGroupMessage
) -> RusotoFuture<(), DeleteCacheSubnetGroupError>

Deletes a cache subnet group.

You cannot delete a cache subnet group if it is associated with any clusters.

fn delete_replication_group(
    &self,
    input: DeleteReplicationGroupMessage
) -> RusotoFuture<DeleteReplicationGroupResult, DeleteReplicationGroupError>

Deletes an existing replication group. By default, this operation deletes the entire replication group, including the primary/primaries and all of the read replicas. If the replication group has only one primary, you can optionally delete only the read replicas, while retaining the primary by setting RetainPrimaryCluster=true.

When you receive a successful response from this operation, Amazon ElastiCache immediately begins deleting the selected resources; you cannot cancel or revert this operation.

This operation is valid for Redis only.

fn delete_snapshot(
    &self,
    input: DeleteSnapshotMessage
) -> RusotoFuture<DeleteSnapshotResult, DeleteSnapshotError>

Deletes an existing snapshot. When you receive a successful response from this operation, ElastiCache immediately begins deleting the snapshot; you cannot cancel or revert this operation.

This operation is valid for Redis only.

fn describe_cache_clusters(
    &self,
    input: DescribeCacheClustersMessage
) -> RusotoFuture<CacheClusterMessage, DescribeCacheClustersError>

Returns information about all provisioned clusters if no cluster identifier is specified, or about a specific cache cluster if a cluster identifier is supplied.

By default, abbreviated information about the clusters is returned. You can use the optional ShowCacheNodeInfo flag to retrieve detailed information about the cache nodes associated with the clusters. These details include the DNS address and port for the cache node endpoint.

If the cluster is in the creating state, only cluster-level information is displayed until all of the nodes are successfully provisioned.

If the cluster is in the deleting state, only cluster-level information is displayed.

If cache nodes are currently being added to the cluster, node endpoint information and creation time for the additional nodes are not displayed until they are completely provisioned. When the cluster state is available, the cluster is ready for use.

If cache nodes are currently being removed from the cluster, no endpoint information for the removed nodes is displayed.

fn describe_cache_engine_versions(
    &self,
    input: DescribeCacheEngineVersionsMessage
) -> RusotoFuture<CacheEngineVersionMessage, DescribeCacheEngineVersionsError>

Returns a list of the available cache engines and their versions.

fn describe_cache_parameter_groups(
    &self,
    input: DescribeCacheParameterGroupsMessage
) -> RusotoFuture<CacheParameterGroupsMessage, DescribeCacheParameterGroupsError>

Returns a list of cache parameter group descriptions. If a cache parameter group name is specified, the list contains only the descriptions for that group.

fn describe_cache_parameters(
    &self,
    input: DescribeCacheParametersMessage
) -> RusotoFuture<CacheParameterGroupDetails, DescribeCacheParametersError>

Returns the detailed parameter list for a particular cache parameter group.

fn describe_cache_security_groups(
    &self,
    input: DescribeCacheSecurityGroupsMessage
) -> RusotoFuture<CacheSecurityGroupMessage, DescribeCacheSecurityGroupsError>

Returns a list of cache security group descriptions. If a cache security group name is specified, the list contains only the description of that group.

fn describe_cache_subnet_groups(
    &self,
    input: DescribeCacheSubnetGroupsMessage
) -> RusotoFuture<CacheSubnetGroupMessage, DescribeCacheSubnetGroupsError>

Returns a list of cache subnet group descriptions. If a subnet group name is specified, the list contains only the description of that group.

fn describe_engine_default_parameters(
    &self,
    input: DescribeEngineDefaultParametersMessage
) -> RusotoFuture<DescribeEngineDefaultParametersResult, DescribeEngineDefaultParametersError>

Returns the default engine and system parameter information for the specified cache engine.

fn describe_events(
    &self,
    input: DescribeEventsMessage
) -> RusotoFuture<EventsMessage, DescribeEventsError>

Returns events related to clusters, cache security groups, and cache parameter groups. You can obtain events specific to a particular cluster, cache security group, or cache parameter group by providing the name as a parameter.

By default, only the events occurring within the last hour are returned; however, you can retrieve up to 14 days' worth of events if necessary.

fn describe_replication_groups(
    &self,
    input: DescribeReplicationGroupsMessage
) -> RusotoFuture<ReplicationGroupMessage, DescribeReplicationGroupsError>

Returns information about a particular replication group. If no identifier is specified, DescribeReplicationGroups returns information about all replication groups.

This operation is valid for Redis only.

fn describe_reserved_cache_nodes(
    &self,
    input: DescribeReservedCacheNodesMessage
) -> RusotoFuture<ReservedCacheNodeMessage, DescribeReservedCacheNodesError>

Returns information about reserved cache nodes for this account, or about a specified reserved cache node.

fn describe_reserved_cache_nodes_offerings(
    &self,
    input: DescribeReservedCacheNodesOfferingsMessage
) -> RusotoFuture<ReservedCacheNodesOfferingMessage, DescribeReservedCacheNodesOfferingsError>

Lists available reserved cache node offerings.

fn describe_snapshots(
    &self,
    input: DescribeSnapshotsMessage
) -> RusotoFuture<DescribeSnapshotsListMessage, DescribeSnapshotsError>

Returns information about cluster or replication group snapshots. By default, DescribeSnapshots lists all of your snapshots; it can optionally describe a single snapshot, or just the snapshots associated with a particular cache cluster.

This operation is valid for Redis only.

fn increase_replica_count(
    &self,
    input: IncreaseReplicaCountMessage
) -> RusotoFuture<IncreaseReplicaCountResult, IncreaseReplicaCountError>

Dynamically increases the number of replics in a Redis (cluster mode disabled) replication group or the number of replica nodes in one or more node groups (shards) of a Redis (cluster mode enabled) replication group. This operation is performed with no cluster down time.

fn list_allowed_node_type_modifications(
    &self,
    input: ListAllowedNodeTypeModificationsMessage
) -> RusotoFuture<AllowedNodeTypeModificationsMessage, ListAllowedNodeTypeModificationsError>

Lists all available node types that you can scale your Redis cluster's or replication group's current node type up to.

When you use the ModifyCacheCluster or ModifyReplicationGroup operations to scale up your cluster or replication group, the value of the CacheNodeType parameter must be one of the node types returned by this operation.

fn list_tags_for_resource(
    &self,
    input: ListTagsForResourceMessage
) -> RusotoFuture<TagListMessage, ListTagsForResourceError>

Lists all cost allocation tags currently on the named resource. A cost allocation tag is a key-value pair where the key is case-sensitive and the value is optional. You can use cost allocation tags to categorize and track your AWS costs.

If the cluster is not in the available state, ListTagsForResource returns an error.

You can have a maximum of 50 cost allocation tags on an ElastiCache resource. For more information, see Monitoring Costs with Tags.

fn modify_cache_cluster(
    &self,
    input: ModifyCacheClusterMessage
) -> RusotoFuture<ModifyCacheClusterResult, ModifyCacheClusterError>

Modifies the settings for a cluster. You can use this operation to change one or more cluster configuration parameters by specifying the parameters and the new values.

fn modify_cache_parameter_group(
    &self,
    input: ModifyCacheParameterGroupMessage
) -> RusotoFuture<CacheParameterGroupNameMessage, ModifyCacheParameterGroupError>

Modifies the parameters of a cache parameter group. You can modify up to 20 parameters in a single request by submitting a list parameter name and value pairs.

fn modify_cache_subnet_group(
    &self,
    input: ModifyCacheSubnetGroupMessage
) -> RusotoFuture<ModifyCacheSubnetGroupResult, ModifyCacheSubnetGroupError>

Modifies an existing cache subnet group.

fn modify_replication_group(
    &self,
    input: ModifyReplicationGroupMessage
) -> RusotoFuture<ModifyReplicationGroupResult, ModifyReplicationGroupError>

Modifies the settings for a replication group.

For Redis (cluster mode enabled) clusters, this operation cannot be used to change a cluster's node type or engine version. For more information, see:

• Scaling for Amazon ElastiCache for Redis—Redis (cluster mode enabled) in the ElastiCache User Guide

• ModifyReplicationGroupShardConfiguration in the ElastiCache API Reference

This operation is valid for Redis only.

fn modify_replication_group_shard_configuration(
    &self,
    input: ModifyReplicationGroupShardConfigurationMessage
) -> RusotoFuture<ModifyReplicationGroupShardConfigurationResult, ModifyReplicationGroupShardConfigurationError>

Modifies a replication group's shards (node groups) by allowing you to add shards, remove shards, or rebalance the keyspaces among exisiting shards.

fn purchase_reserved_cache_nodes_offering(
    &self,
    input: PurchaseReservedCacheNodesOfferingMessage
) -> RusotoFuture<PurchaseReservedCacheNodesOfferingResult, PurchaseReservedCacheNodesOfferingError>

Allows you to purchase a reserved cache node offering.

fn reboot_cache_cluster(
    &self,
    input: RebootCacheClusterMessage
) -> RusotoFuture<RebootCacheClusterResult, RebootCacheClusterError>

Reboots some, or all, of the cache nodes within a provisioned cluster. This operation applies any modified cache parameter groups to the cluster. The reboot operation takes place as soon as possible, and results in a momentary outage to the cluster. During the reboot, the cluster status is set to REBOOTING.

The reboot causes the contents of the cache (for each cache node being rebooted) to be lost.

When the reboot is complete, a cluster event is created.

Rebooting a cluster is currently supported on Memcached and Redis (cluster mode disabled) clusters. Rebooting is not supported on Redis (cluster mode enabled) clusters.

If you make changes to parameters that require a Redis (cluster mode enabled) cluster reboot for the changes to be applied, see Rebooting a Cluster for an alternate process.

fn remove_tags_from_resource(
    &self,
    input: RemoveTagsFromResourceMessage
) -> RusotoFuture<TagListMessage, RemoveTagsFromResourceError>

Removes the tags identified by the TagKeys list from the named resource.

fn reset_cache_parameter_group(
    &self,
    input: ResetCacheParameterGroupMessage
) -> RusotoFuture<CacheParameterGroupNameMessage, ResetCacheParameterGroupError>

Modifies the parameters of a cache parameter group to the engine or system default value. You can reset specific parameters by submitting a list of parameter names. To reset the entire cache parameter group, specify the ResetAllParameters and CacheParameterGroupName parameters.

fn revoke_cache_security_group_ingress(
    &self,
    input: RevokeCacheSecurityGroupIngressMessage
) -> RusotoFuture<RevokeCacheSecurityGroupIngressResult, RevokeCacheSecurityGroupIngressError>

Revokes ingress from a cache security group. Use this operation to disallow access from an Amazon EC2 security group that had been previously authorized.

fn test_failover(
    &self,
    input: TestFailoverMessage
) -> RusotoFuture<TestFailoverResult, TestFailoverError>

Represents the input of a TestFailover operation which test automatic failover on a specified node group (called shard in the console) in a replication group (called cluster in the console).

Note the following

• A customer can use this operation to test automatic failover on up to 5 shards (called node groups in the ElastiCache API and AWS CLI) in any rolling 24-hour period.

• If calling this operation on shards in different clusters (called replication groups in the API and CLI), the calls can be made concurrently.

• If calling this operation multiple times on different shards in the same Redis (cluster mode enabled) replication group, the first node replacement must complete before a subsequent call can be made.

• To determine whether the node replacement is complete you can check Events using the Amazon ElastiCache console, the AWS CLI, or the ElastiCache API. Look for the following automatic failover related events, listed here in order of occurrance:

  1. Replication group message: Test Failover API called for node group <node-group-id>

  2. Cache cluster message: Failover from master node <primary-node-id> to replica node <node-id> completed

  3. Replication group message: Failover from master node <primary-node-id> to replica node <node-id> completed

  4. Cache cluster message: Recovering cache nodes <node-id>

  5. Cache cluster message: Finished recovery for cache nodes <node-id>

  For more information see:

  • Viewing ElastiCache Events in the ElastiCache User Guide

  • DescribeEvents in the ElastiCache API Reference

Also see, Testing Multi-AZ with Automatic Failover in the ElastiCache User Guide.

impl Clone for ElastiCacheClient

fn clone(&self) -> ElastiCacheClient

Returns a copy of the value.

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

Performs copy-assignment from source.