Struct aws_sdk_elasticache::client::Client

pub struct Client { /* private fields */ }

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 Config 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.

Implementations

impl Client

pub fn add_tags_to_resource(&self) -> AddTagsToResourceFluentBuilder

Constructs a fluent builder for the AddTagsToResource operation.

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

    The Amazon Resource Name (ARN) of the resource to which the tags are to be added, for example arn:aws:elasticache:us-west-2:0123456789:cluster:myCluster or arn:aws:elasticache:us-west-2:0123456789:snapshot:mySnapshot. ElastiCache resources are cluster and snapshot.

    For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Service Namespaces.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: true
    

    A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.

    
    
• On success, responds with AddTagsToResourceOutput with field(s):
  • tag_list(Option<Vec::<Tag>>):

    A list of tags as key-value pairs.

• On failure, responds with SdkError<AddTagsToResourceError>

impl Client

pub fn authorize_cache_security_group_ingress( &self ) -> AuthorizeCacheSecurityGroupIngressFluentBuilder

Constructs a fluent builder for the AuthorizeCacheSecurityGroupIngress operation.

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

    The cache security group that allows network ingress.

    
    
  • ec2_security_group_name(impl Into<String>) / set_ec2_security_group_name(Option<String>):
    required: true
    

    The Amazon EC2 security group to be authorized for ingress to the cache security group.

    
    
  • ec2_security_group_owner_id(impl Into<String>) / set_ec2_security_group_owner_id(Option<String>):
    required: true
    

    The Amazon account number of the Amazon EC2 security group owner. Note that this is not the same thing as an Amazon access key ID - you must provide a valid Amazon account number for this parameter.

    
    
• On success, responds with AuthorizeCacheSecurityGroupIngressOutput with field(s):
  • cache_security_group(Option<CacheSecurityGroup>):

    Represents the output of one of the following operations:

    • AuthorizeCacheSecurityGroupIngress

    • CreateCacheSecurityGroup

    • RevokeCacheSecurityGroupIngress

• On failure, responds with SdkError<AuthorizeCacheSecurityGroupIngressError>

impl Client

pub fn batch_apply_update_action(&self) -> BatchApplyUpdateActionFluentBuilder

Constructs a fluent builder for the BatchApplyUpdateAction operation.

• The fluent builder is configurable:
  • replication_group_ids(impl Into<String>) / set_replication_group_ids(Option<Vec::<String>>):
    required: false
    

    The replication group IDs

    
    
  • cache_cluster_ids(impl Into<String>) / set_cache_cluster_ids(Option<Vec::<String>>):
    required: false
    

    The cache cluster IDs

    
    
  • service_update_name(impl Into<String>) / set_service_update_name(Option<String>):
    required: true
    

    The unique ID of the service update

    
    
• On success, responds with BatchApplyUpdateActionOutput with field(s):
  • processed_update_actions(Option<Vec::<ProcessedUpdateAction>>):

    Update actions that have been processed successfully

  • unprocessed_update_actions(Option<Vec::<UnprocessedUpdateAction>>):

    Update actions that haven’t been processed successfully

• On failure, responds with SdkError<BatchApplyUpdateActionError>

impl Client

pub fn batch_stop_update_action(&self) -> BatchStopUpdateActionFluentBuilder

Constructs a fluent builder for the BatchStopUpdateAction operation.

• The fluent builder is configurable:
  • replication_group_ids(impl Into<String>) / set_replication_group_ids(Option<Vec::<String>>):
    required: false
    

    The replication group IDs

    
    
  • cache_cluster_ids(impl Into<String>) / set_cache_cluster_ids(Option<Vec::<String>>):
    required: false
    

    The cache cluster IDs

    
    
  • service_update_name(impl Into<String>) / set_service_update_name(Option<String>):
    required: true
    

    The unique ID of the service update

    
    
• On success, responds with BatchStopUpdateActionOutput with field(s):
  • processed_update_actions(Option<Vec::<ProcessedUpdateAction>>):

    Update actions that have been processed successfully

  • unprocessed_update_actions(Option<Vec::<UnprocessedUpdateAction>>):

    Update actions that haven’t been processed successfully

• On failure, responds with SdkError<BatchStopUpdateActionError>

impl Client

pub fn complete_migration(&self) -> CompleteMigrationFluentBuilder

Constructs a fluent builder for the CompleteMigration operation.

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

    The ID of the replication group to which data is being migrated.

    
    
  • force(bool) / set_force(Option<bool>):
    required: false
    

    Forces the migration to stop without ensuring that data is in sync. It is recommended to use this option only to abort the migration and not recommended when application wants to continue migration to ElastiCache.

    
    
• On success, responds with CompleteMigrationOutput with field(s):
  • replication_group(Option<ReplicationGroup>):

    Contains all of the attributes of a specific Redis replication group.

• On failure, responds with SdkError<CompleteMigrationError>

impl Client

pub fn copy_serverless_cache_snapshot( &self ) -> CopyServerlessCacheSnapshotFluentBuilder

Constructs a fluent builder for the CopyServerlessCacheSnapshot operation.

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

    The identifier of the existing serverless cache’s snapshot to be copied. Available for Redis only.

    
    
  • target_serverless_cache_snapshot_name(impl Into<String>) / set_target_serverless_cache_snapshot_name(Option<String>):
    required: true
    

    The identifier for the snapshot to be created. Available for Redis only.

    
    
  • kms_key_id(impl Into<String>) / set_kms_key_id(Option<String>):
    required: false
    

    The identifier of the KMS key used to encrypt the target snapshot. Available for Redis only.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    A list of tags to be added to the target snapshot resource. A tag is a key-value pair. Available for Redis only. Default: NULL

    
    
• On success, responds with CopyServerlessCacheSnapshotOutput with field(s):
  • serverless_cache_snapshot(Option<ServerlessCacheSnapshot>):

    The response for the attempt to copy the serverless cache snapshot. Available for Redis only.

• On failure, responds with SdkError<CopyServerlessCacheSnapshotError>

impl Client

pub fn copy_snapshot(&self) -> CopySnapshotFluentBuilder

Constructs a fluent builder for the CopySnapshot operation.

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

    The name of an existing snapshot from which to make a copy.

    
    
  • target_snapshot_name(impl Into<String>) / set_target_snapshot_name(Option<String>):
    required: true
    

    A name for the snapshot copy. ElastiCache does not permit overwriting a snapshot, therefore this name must be unique within its context - ElastiCache or an Amazon S3 bucket if exporting.

    
    
  • target_bucket(impl Into<String>) / set_target_bucket(Option<String>):
    required: false
    

    The Amazon S3 bucket to which the snapshot is exported. This parameter is used only when exporting a snapshot for external access.

    When using this parameter to export a snapshot, be sure Amazon ElastiCache has the needed permissions to this S3 bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the Amazon ElastiCache User Guide.

    For more information, see Exporting a Snapshot in the Amazon ElastiCache User Guide.

    
    
  • kms_key_id(impl Into<String>) / set_kms_key_id(Option<String>):
    required: false
    

    The ID of the KMS key used to encrypt the target snapshot.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.

    
    
• On success, responds with CopySnapshotOutput with field(s):
  • snapshot(Option<Snapshot>):

    Represents a copy of an entire Redis cluster as of the time when the snapshot was taken.

• On failure, responds with SdkError<CopySnapshotError>

impl Client

pub fn create_cache_cluster(&self) -> CreateCacheClusterFluentBuilder

Constructs a fluent builder for the CreateCacheCluster operation.

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

    The node group (shard) identifier. This parameter is stored as a lowercase string.

    Constraints:

    • A name must contain from 1 to 50 alphanumeric characters or hyphens.

    • The first character must be a letter.

    • A name cannot end with a hyphen or contain two consecutive hyphens.

    
    
  • replication_group_id(impl Into<String>) / set_replication_group_id(Option<String>):
    required: false
    

    The ID of the replication group to which this cluster should belong. If this parameter is specified, the cluster is added to the specified replication group as a read replica; otherwise, the cluster is a standalone primary that is not part of any replication group.

    If the specified replication group is Multi-AZ enabled and the Availability Zone is not specified, the cluster is created in Availability Zones that provide the best spread of read replicas across Availability Zones.

    This parameter is only valid if the Engine parameter is redis.

    
    
  • az_mode(AzMode) / set_az_mode(Option<AzMode>):
    required: false
    

    Specifies whether the nodes in this Memcached cluster are created in a single Availability Zone or created across multiple Availability Zones in the cluster’s region.

    This parameter is only supported for Memcached clusters.

    If the AZMode and PreferredAvailabilityZones are not specified, ElastiCache assumes single-az mode.

    
    
  • preferred_availability_zone(impl Into<String>) / set_preferred_availability_zone(Option<String>):
    required: false
    

    The EC2 Availability Zone in which the cluster is created.

    All nodes belonging to this cluster are placed in the preferred Availability Zone. If you want to create your nodes across multiple Availability Zones, use PreferredAvailabilityZones.

    Default: System chosen Availability Zone.

    
    
  • preferred_availability_zones(impl Into<String>) / set_preferred_availability_zones(Option<Vec::<String>>):
    required: false
    

    A list of the Availability Zones in which cache nodes are created. The order of the zones in the list is not important.

    This option is only supported on Memcached.

    If you are creating your cluster in an Amazon VPC (recommended) you can only locate nodes in Availability Zones that are associated with the subnets in the selected subnet group.

    The number of Availability Zones listed must equal the value of NumCacheNodes.

    If you want all the nodes in the same Availability Zone, use PreferredAvailabilityZone instead, or repeat the Availability Zone multiple times in the list.

    Default: System chosen Availability Zones.

    
    
  • num_cache_nodes(i32) / set_num_cache_nodes(Option<i32>):
    required: false
    

    The initial number of cache nodes that the cluster has.

    For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 40.

    If you need more than 40 nodes for your Memcached cluster, please fill out the ElastiCache Limit Increase Request form at http://aws.amazon.com/contact-us/elasticache-node-limit-request/.

    
    
  • cache_node_type(impl Into<String>) / set_cache_node_type(Option<String>):
    required: false
    

    The compute and memory capacity of the nodes in the node group (shard).

    The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.

    • General purpose:

      • Current generation:

        M7g node types: cache.m7g.large, cache.m7g.xlarge, cache.m7g.2xlarge, cache.m7g.4xlarge, cache.m7g.8xlarge, cache.m7g.12xlarge, cache.m7g.16xlarge

        For region availability, see Supported Node Types

        M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.m6g.large, cache.m6g.xlarge, cache.m6g.2xlarge, cache.m6g.4xlarge, cache.m6g.8xlarge, cache.m6g.12xlarge, cache.m6g.16xlarge

        M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge

        M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge

        T4g node types (available only for Redis engine version 5.0.6 onward and Memcached engine version 1.5.16 onward): cache.t4g.micro, cache.t4g.small, cache.t4g.medium

        T3 node types: cache.t3.micro, cache.t3.small, cache.t3.medium

        T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium

      • Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)

        T1 node types: cache.t1.micro

        M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge

        M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge

    • Compute optimized:

      • Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)

        C1 node types: cache.c1.xlarge

    • Memory optimized:

      • Current generation:

        R7g node types: cache.r7g.large, cache.r7g.xlarge, cache.r7g.2xlarge, cache.r7g.4xlarge, cache.r7g.8xlarge, cache.r7g.12xlarge, cache.r7g.16xlarge

        For region availability, see Supported Node Types

        R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.r6g.large, cache.r6g.xlarge, cache.r6g.2xlarge, cache.r6g.4xlarge, cache.r6g.8xlarge, cache.r6g.12xlarge, cache.r6g.16xlarge

        R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge

        R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge

      • Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)

        M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge

        R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge

    Additional node type info

    • All current generation instance types are created in Amazon VPC by default.

    • Redis append-only files (AOF) are not supported for T1 or T2 instances.

    • Redis Multi-AZ with automatic failover is not supported on T1 instances.

    • Redis configuration variables appendonly and appendfsync are not supported on Redis version 2.8.22 and later.

    
    
  • engine(impl Into<String>) / set_engine(Option<String>):
    required: false
    

    The name of the cache engine to be used for this cluster.

    Valid values for this parameter are: memcached | redis

    
    
  • engine_version(impl Into<String>) / set_engine_version(Option<String>):
    required: false
    

    The version number of the cache engine to be used for this cluster. To view the supported cache engine versions, use the DescribeCacheEngineVersions operation.

    Important: You can upgrade to a newer engine version (see Selecting a Cache Engine and Version), but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing cluster or replication group and create it anew with the earlier engine version.

    
    
  • cache_parameter_group_name(impl Into<String>) / set_cache_parameter_group_name(Option<String>):
    required: false
    

    The name of the parameter group to associate with this cluster. If this argument is omitted, the default parameter group for the specified engine is used. You cannot use any parameter group which has cluster-enabled=‘yes’ when creating a cluster.

    
    
  • cache_subnet_group_name(impl Into<String>) / set_cache_subnet_group_name(Option<String>):
    required: false
    

    The name of the subnet group to be used for the cluster.

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

    If you’re going to launch your cluster in an Amazon VPC, you need to create a subnet group before you start creating a cluster. For more information, see Subnets and Subnet Groups.

    
    
  • cache_security_group_names(impl Into<String>) / set_cache_security_group_names(Option<Vec::<String>>):
    required: false
    

    A list of security group names to associate with this cluster.

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

    
    
  • security_group_ids(impl Into<String>) / set_security_group_ids(Option<Vec::<String>>):
    required: false
    

    One or more VPC security groups associated with the cluster.

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

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    A list of tags to be added to this resource.

    
    
  • snapshot_arns(impl Into<String>) / set_snapshot_arns(Option<Vec::<String>>):
    required: false
    

    A single-element string list containing an Amazon Resource Name (ARN) that uniquely identifies a Redis RDB snapshot file stored in Amazon S3. The snapshot file is used to populate the node group (shard). The Amazon S3 object name in the ARN cannot contain any commas.

    This parameter is only valid if the Engine parameter is redis.

    Example of an Amazon S3 ARN: arn:aws:s3:::my_bucket/snapshot1.rdb

    
    
  • snapshot_name(impl Into<String>) / set_snapshot_name(Option<String>):
    required: false
    

    The name of a Redis snapshot from which to restore data into the new node group (shard). The snapshot status changes to restoring while the new node group (shard) is being created.

    This parameter is only valid if the Engine parameter is redis.

    
    
  • preferred_maintenance_window(impl Into<String>) / set_preferred_maintenance_window(Option<String>):
    required: false
    

    Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period.

    
    
  • port(i32) / set_port(Option<i32>):
    required: false
    

    The port number on which each of the cache nodes accepts connections.

    
    
  • notification_topic_arn(impl Into<String>) / set_notification_topic_arn(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.

    The Amazon SNS topic owner must be the same as the cluster owner.

    
    
  • auto_minor_version_upgrade(bool) / set_auto_minor_version_upgrade(Option<bool>):
    required: false
    

     If you are running Redis engine version 6.0 or later, set this parameter to yes if you want to opt-in to the next auto minor version upgrade campaign. This parameter is disabled for previous versions. 

    
    
  • snapshot_retention_limit(i32) / set_snapshot_retention_limit(Option<i32>):
    required: false
    

    The number of days for which ElastiCache retains automatic snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot taken today is retained for 5 days before being deleted.

    This parameter is only valid if the Engine parameter is redis.

    Default: 0 (i.e., automatic backups are disabled for this cache cluster).

    
    
  • snapshot_window(impl Into<String>) / set_snapshot_window(Option<String>):
    required: false
    

    The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).

    Example: 05:00-09:00

    If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.

    This parameter is only valid if the Engine parameter is redis.

    
    
  • auth_token(impl Into<String>) / set_auth_token(Option<String>):
    required: false
    

    Reserved parameter. The password used to access a password protected server.

    Password constraints:

    • Must be only printable ASCII characters.

    • Must be at least 16 characters and no more than 128 characters in length.

    • The only permitted printable special characters are !, &, #, $, ^, <, >, and -. Other printable special characters cannot be used in the AUTH token.

    For more information, see AUTH password at http://redis.io/commands/AUTH.

    
    
  • outpost_mode(OutpostMode) / set_outpost_mode(Option<OutpostMode>):
    required: false
    

    Specifies whether the nodes in the cluster are created in a single outpost or across multiple outposts.

    
    
  • preferred_outpost_arn(impl Into<String>) / set_preferred_outpost_arn(Option<String>):
    required: false
    

    The outpost ARN in which the cache cluster is created.

    
    
  • preferred_outpost_arns(impl Into<String>) / set_preferred_outpost_arns(Option<Vec::<String>>):
    required: false
    

    The outpost ARNs in which the cache cluster is created.

    
    
  • log_delivery_configurations(LogDeliveryConfigurationRequest) / set_log_delivery_configurations(Option<Vec::<LogDeliveryConfigurationRequest>>):
    required: false
    

    Specifies the destination, format and type of the logs.

    
    
  • transit_encryption_enabled(bool) / set_transit_encryption_enabled(Option<bool>):
    required: false
    

    A flag that enables in-transit encryption when set to true.

    
    
  • network_type(NetworkType) / set_network_type(Option<NetworkType>):
    required: false
    

    Must be either ipv4 | ipv6 | dual_stack. IPv6 is supported for workloads using Redis engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the Nitro system.

    
    
  • ip_discovery(IpDiscovery) / set_ip_discovery(Option<IpDiscovery>):
    required: false
    

    The network type you choose when modifying a cluster, either ipv4 | ipv6. IPv6 is supported for workloads using Redis engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the Nitro system.

    
    
• On success, responds with CreateCacheClusterOutput with field(s):
  • cache_cluster(Option<CacheCluster>):

    Contains all of the attributes of a specific cluster.

• On failure, responds with SdkError<CreateCacheClusterError>

impl Client

pub fn create_cache_parameter_group( &self ) -> CreateCacheParameterGroupFluentBuilder

Constructs a fluent builder for the CreateCacheParameterGroup operation.

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

    A user-specified name for the cache parameter group.

    
    
  • cache_parameter_group_family(impl Into<String>) / set_cache_parameter_group_family(Option<String>):
    required: true
    

    The name of the cache parameter group family that the cache parameter group can be used with.

    Valid values are: memcached1.4 | memcached1.5 | memcached1.6 | redis2.6 | redis2.8 | redis3.2 | redis4.0 | redis5.0 | redis6.x | redis7

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: true
    

    A user-specified description for the cache parameter group.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.

    
    
• On success, responds with CreateCacheParameterGroupOutput with field(s):
  • cache_parameter_group(Option<CacheParameterGroup>):

    Represents the output of a CreateCacheParameterGroup operation.

• On failure, responds with SdkError<CreateCacheParameterGroupError>

impl Client

pub fn create_cache_security_group( &self ) -> CreateCacheSecurityGroupFluentBuilder

Constructs a fluent builder for the CreateCacheSecurityGroup operation.

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

    A name for the cache security group. This value is stored as a lowercase string.

    Constraints: Must contain no more than 255 alphanumeric characters. Cannot be the word “Default”.

    Example: mysecuritygroup

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: true
    

    A description for the cache security group.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.

    
    
• On success, responds with CreateCacheSecurityGroupOutput with field(s):
  • cache_security_group(Option<CacheSecurityGroup>):

    Represents the output of one of the following operations:

    • AuthorizeCacheSecurityGroupIngress

    • CreateCacheSecurityGroup

    • RevokeCacheSecurityGroupIngress

• On failure, responds with SdkError<CreateCacheSecurityGroupError>

impl Client

pub fn create_cache_subnet_group(&self) -> CreateCacheSubnetGroupFluentBuilder

Constructs a fluent builder for the CreateCacheSubnetGroup operation.

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

    A name for the cache subnet group. This value is stored as a lowercase string.

    Constraints: Must contain no more than 255 alphanumeric characters or hyphens.

    Example: mysubnetgroup

    
    
  • cache_subnet_group_description(impl Into<String>) / set_cache_subnet_group_description(Option<String>):
    required: true
    

    A description for the cache subnet group.

    
    
  • subnet_ids(impl Into<String>) / set_subnet_ids(Option<Vec::<String>>):
    required: true
    

    A list of VPC subnet IDs for the cache subnet group.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.

    
    
• On success, responds with CreateCacheSubnetGroupOutput with field(s):
  • cache_subnet_group(Option<CacheSubnetGroup>):

    Represents the output of one of the following operations:

    • CreateCacheSubnetGroup

    • ModifyCacheSubnetGroup

• On failure, responds with SdkError<CreateCacheSubnetGroupError>

impl Client

pub fn create_global_replication_group( &self ) -> CreateGlobalReplicationGroupFluentBuilder

Constructs a fluent builder for the CreateGlobalReplicationGroup operation.

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

    The suffix name of a Global datastore. Amazon ElastiCache automatically applies a prefix to the Global datastore ID when it is created. Each Amazon Region has its own prefix. For instance, a Global datastore ID created in the US-West-1 region will begin with “dsdfu” along with the suffix name you provide. The suffix, combined with the auto-generated prefix, guarantees uniqueness of the Global datastore name across multiple regions.

    For a full list of Amazon Regions and their respective Global datastore iD prefixes, see Using the Amazon CLI with Global datastores .

    
    
  • global_replication_group_description(impl Into<String>) / set_global_replication_group_description(Option<String>):
    required: false
    

    Provides details of the Global datastore

    
    
  • primary_replication_group_id(impl Into<String>) / set_primary_replication_group_id(Option<String>):
    required: true
    

    The name of the primary cluster that accepts writes and will replicate updates to the secondary cluster.

    
    
• On success, responds with CreateGlobalReplicationGroupOutput with field(s):
  • global_replication_group(Option<GlobalReplicationGroup>):

    Consists of a primary cluster that accepts writes and an associated secondary cluster that resides in a different Amazon region. The secondary cluster accepts only reads. The primary cluster automatically replicates updates to the secondary cluster.

    • The GlobalReplicationGroupIdSuffix represents the name of the Global datastore, which is what you use to associate a secondary cluster.

• On failure, responds with SdkError<CreateGlobalReplicationGroupError>

impl Client

pub fn create_replication_group(&self) -> CreateReplicationGroupFluentBuilder

Constructs a fluent builder for the CreateReplicationGroup operation.

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

    The replication group identifier. This parameter is stored as a lowercase string.

    Constraints:

    • A name must contain from 1 to 40 alphanumeric characters or hyphens.

    • The first character must be a letter.

    • A name cannot end with a hyphen or contain two consecutive hyphens.

    
    
  • replication_group_description(impl Into<String>) / set_replication_group_description(Option<String>):
    required: true
    

    A user-created description for the replication group.

    
    
  • global_replication_group_id(impl Into<String>) / set_global_replication_group_id(Option<String>):
    required: false
    

    The name of the Global datastore

    
    
  • primary_cluster_id(impl Into<String>) / set_primary_cluster_id(Option<String>):
    required: false
    

    The identifier of the cluster that serves as the primary for this replication group. This cluster must already exist and have a status of available.

    This parameter is not required if NumCacheClusters, NumNodeGroups, or ReplicasPerNodeGroup is specified.

    
    
  • automatic_failover_enabled(bool) / set_automatic_failover_enabled(Option<bool>):
    required: false
    

    Specifies whether a read-only replica is automatically promoted to read/write primary if the existing primary fails.

    AutomaticFailoverEnabled must be enabled for Redis (cluster mode enabled) replication groups.

    Default: false

    
    
  • multi_az_enabled(bool) / set_multi_az_enabled(Option<bool>):
    required: false
    

    A flag indicating if you have Multi-AZ enabled to enhance fault tolerance. For more information, see Minimizing Downtime: Multi-AZ.

    
    
  • num_cache_clusters(i32) / set_num_cache_clusters(Option<i32>):
    required: false
    

    The number of clusters this replication group initially has.

    This parameter is not used if there is more than one node group (shard). You should use ReplicasPerNodeGroup instead.

    If AutomaticFailoverEnabled is true, the value of this parameter must be at least 2. If AutomaticFailoverEnabled is false you can omit this parameter (it will default to 1), or you can explicitly set it to a value between 2 and 6.

    The maximum permitted value for NumCacheClusters is 6 (1 primary plus 5 replicas).

    
    
  • preferred_cache_cluster_azs(impl Into<String>) / set_preferred_cache_cluster_azs(Option<Vec::<String>>):
    required: false
    

    A list of EC2 Availability Zones in which the replication group’s clusters are created. The order of the Availability Zones in the list is the order in which clusters are allocated. The primary cluster is created in the first AZ in the list.

    This parameter is not used if there is more than one node group (shard). You should use NodeGroupConfiguration instead.

    If you are creating your replication group in an Amazon VPC (recommended), you can only locate clusters in Availability Zones associated with the subnets in the selected subnet group.

    The number of Availability Zones listed must equal the value of NumCacheClusters.

    Default: system chosen Availability Zones.

    
    
  • num_node_groups(i32) / set_num_node_groups(Option<i32>):
    required: false
    

    An optional parameter that specifies the number of node groups (shards) for this Redis (cluster mode enabled) replication group. For Redis (cluster mode disabled) either omit this parameter or set it to 1.

    Default: 1

    
    
  • replicas_per_node_group(i32) / set_replicas_per_node_group(Option<i32>):
    required: false
    

    An optional parameter that specifies the number of replica nodes in each node group (shard). Valid values are 0 to 5.

    
    
  • node_group_configuration(NodeGroupConfiguration) / set_node_group_configuration(Option<Vec::<NodeGroupConfiguration>>):
    required: false
    

    A list of node group (shard) configuration options. Each node group (shard) configuration has the following members: PrimaryAvailabilityZone, ReplicaAvailabilityZones, ReplicaCount, and Slots.

    If you’re creating a Redis (cluster mode disabled) or a Redis (cluster mode enabled) replication group, you can use this parameter to individually configure each node group (shard), or you can omit this parameter. However, it is required when seeding a Redis (cluster mode enabled) cluster from a S3 rdb file. You must configure each node group (shard) using this parameter because you must specify the slots for each node group.

    
    
  • cache_node_type(impl Into<String>) / set_cache_node_type(Option<String>):
    required: false
    

    The compute and memory capacity of the nodes in the node group (shard).

    The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.

    • General purpose:

      • Current generation:

        M7g node types: cache.m7g.large, cache.m7g.xlarge, cache.m7g.2xlarge, cache.m7g.4xlarge, cache.m7g.8xlarge, cache.m7g.12xlarge, cache.m7g.16xlarge

        For region availability, see Supported Node Types

        M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.m6g.large, cache.m6g.xlarge, cache.m6g.2xlarge, cache.m6g.4xlarge, cache.m6g.8xlarge, cache.m6g.12xlarge, cache.m6g.16xlarge

        M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge

        M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge

        T4g node types (available only for Redis engine version 5.0.6 onward and Memcached engine version 1.5.16 onward): cache.t4g.micro, cache.t4g.small, cache.t4g.medium

        T3 node types: cache.t3.micro, cache.t3.small, cache.t3.medium

        T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium

      • Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)

        T1 node types: cache.t1.micro

        M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge

        M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge

    • Compute optimized:

      • Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)

        C1 node types: cache.c1.xlarge

    • Memory optimized:

      • Current generation:

        R7g node types: cache.r7g.large, cache.r7g.xlarge, cache.r7g.2xlarge, cache.r7g.4xlarge, cache.r7g.8xlarge, cache.r7g.12xlarge, cache.r7g.16xlarge

        For region availability, see Supported Node Types

        R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.r6g.large, cache.r6g.xlarge, cache.r6g.2xlarge, cache.r6g.4xlarge, cache.r6g.8xlarge, cache.r6g.12xlarge, cache.r6g.16xlarge

        R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge

        R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge

      • Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)

        M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge

        R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge

    Additional node type info

    • All current generation instance types are created in Amazon VPC by default.

    • Redis append-only files (AOF) are not supported for T1 or T2 instances.

    • Redis Multi-AZ with automatic failover is not supported on T1 instances.

    • Redis configuration variables appendonly and appendfsync are not supported on Redis version 2.8.22 and later.

    
    
  • engine(impl Into<String>) / set_engine(Option<String>):
    required: false
    

    The name of the cache engine to be used for the clusters in this replication group. The value must be set to Redis.

    
    
  • engine_version(impl Into<String>) / set_engine_version(Option<String>):
    required: false
    

    The version number of the cache engine to be used for the clusters in this replication group. To view the supported cache engine versions, use the DescribeCacheEngineVersions operation.

    Important: You can upgrade to a newer engine version (see Selecting a Cache Engine and Version) in the ElastiCache User Guide, but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing cluster or replication group and create it anew with the earlier engine version.

    
    
  • cache_parameter_group_name(impl Into<String>) / set_cache_parameter_group_name(Option<String>):
    required: false
    

    The name of the parameter group to associate with this replication group. If this argument is omitted, the default cache parameter group for the specified engine is used.

    If you are running Redis version 3.2.4 or later, only one node group (shard), and want to use a default parameter group, we recommend that you specify the parameter group by name.

    • To create a Redis (cluster mode disabled) replication group, use CacheParameterGroupName=default.redis3.2.

    • To create a Redis (cluster mode enabled) replication group, use CacheParameterGroupName=default.redis3.2.cluster.on.

    
    
  • cache_subnet_group_name(impl Into<String>) / set_cache_subnet_group_name(Option<String>):
    required: false
    

    The name of the cache subnet group to be used for the replication group.

    If you’re going to launch your cluster in an Amazon VPC, you need to create a subnet group before you start creating a cluster. For more information, see Subnets and Subnet Groups.

    
    
  • cache_security_group_names(impl Into<String>) / set_cache_security_group_names(Option<Vec::<String>>):
    required: false
    

    A list of cache security group names to associate with this replication group.

    
    
  • security_group_ids(impl Into<String>) / set_security_group_ids(Option<Vec::<String>>):
    required: false
    

    One or more Amazon VPC security groups associated with this replication group.

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

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    A list of tags to be added to this resource. Tags are comma-separated key,value pairs (e.g. Key=myKey, Value=myKeyValue. You can include multiple tags as shown following: Key=myKey, Value=myKeyValue Key=mySecondKey, Value=mySecondKeyValue. Tags on replication groups will be replicated to all nodes.

    
    
  • snapshot_arns(impl Into<String>) / set_snapshot_arns(Option<Vec::<String>>):
    required: false
    

    A list of Amazon Resource Names (ARN) that uniquely identify the Redis RDB snapshot files stored in Amazon S3. The snapshot files are used to populate the new replication group. The Amazon S3 object name in the ARN cannot contain any commas. The new replication group will have the number of node groups (console: shards) specified by the parameter NumNodeGroups or the number of node groups configured by NodeGroupConfiguration regardless of the number of ARNs specified here.

    Example of an Amazon S3 ARN: arn:aws:s3:::my_bucket/snapshot1.rdb

    
    
  • snapshot_name(impl Into<String>) / set_snapshot_name(Option<String>):
    required: false
    

    The name of a snapshot from which to restore data into the new replication group. The snapshot status changes to restoring while the new replication group is being created.

    
    
  • preferred_maintenance_window(impl Into<String>) / set_preferred_maintenance_window(Option<String>):
    required: false
    

    Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period.

    Valid values for ddd are:

    • sun

    • mon

    • tue

    • wed

    • thu

    • fri

    • sat

    Example: sun:23:00-mon:01:30

    
    
  • port(i32) / set_port(Option<i32>):
    required: false
    

    The port number on which each member of the replication group accepts connections.

    
    
  • notification_topic_arn(impl Into<String>) / set_notification_topic_arn(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.

    The Amazon SNS topic owner must be the same as the cluster owner.

    
    
  • auto_minor_version_upgrade(bool) / set_auto_minor_version_upgrade(Option<bool>):
    required: false
    

     If you are running Redis engine version 6.0 or later, set this parameter to yes if you want to opt-in to the next auto minor version upgrade campaign. This parameter is disabled for previous versions. 

    
    
  • snapshot_retention_limit(i32) / set_snapshot_retention_limit(Option<i32>):
    required: false
    

    The number of days for which ElastiCache retains automatic snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.

    Default: 0 (i.e., automatic backups are disabled for this cluster).

    
    
  • snapshot_window(impl Into<String>) / set_snapshot_window(Option<String>):
    required: false
    

    The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).

    Example: 05:00-09:00

    If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.

    
    
  • auth_token(impl Into<String>) / set_auth_token(Option<String>):
    required: false
    

    Reserved parameter. The password used to access a password protected server.

    AuthToken can be specified only on replication groups where TransitEncryptionEnabled is true.

    For HIPAA compliance, you must specify TransitEncryptionEnabled as true, an AuthToken, and a CacheSubnetGroup.

    Password constraints:

    • Must be only printable ASCII characters.

    • Must be at least 16 characters and no more than 128 characters in length.

    • The only permitted printable special characters are !, &, #, $, ^, <, >, and -. Other printable special characters cannot be used in the AUTH token.

    For more information, see AUTH password at http://redis.io/commands/AUTH.

    
    
  • transit_encryption_enabled(bool) / set_transit_encryption_enabled(Option<bool>):
    required: false
    

    A flag that enables in-transit encryption when set to true.

    This parameter is valid only if the Engine parameter is redis, the EngineVersion parameter is 3.2.6, 4.x or later, and the cluster is being created in an Amazon VPC.

    If you enable in-transit encryption, you must also specify a value for CacheSubnetGroup.

    Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.

    Default: false

    For HIPAA compliance, you must specify TransitEncryptionEnabled as true, an AuthToken, and a CacheSubnetGroup.

    
    
  • at_rest_encryption_enabled(bool) / set_at_rest_encryption_enabled(Option<bool>):
    required: false
    

    A flag that enables encryption at rest when set to true.

    You cannot modify the value of AtRestEncryptionEnabled after the replication group is created. To enable encryption at rest on a replication group you must set AtRestEncryptionEnabled to true when you create the replication group.

    Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.

    Default: false

    
    
  • kms_key_id(impl Into<String>) / set_kms_key_id(Option<String>):
    required: false
    

    The ID of the KMS key used to encrypt the disk in the cluster.

    
    
  • user_group_ids(impl Into<String>) / set_user_group_ids(Option<Vec::<String>>):
    required: false
    

    The user group to associate with the replication group.

    
    
  • log_delivery_configurations(LogDeliveryConfigurationRequest) / set_log_delivery_configurations(Option<Vec::<LogDeliveryConfigurationRequest>>):
    required: false
    

    Specifies the destination, format and type of the logs.

    
    
  • data_tiering_enabled(bool) / set_data_tiering_enabled(Option<bool>):
    required: false
    

    Enables data tiering. Data tiering is only supported for replication groups using the r6gd node type. This parameter must be set to true when using r6gd nodes. For more information, see Data tiering.

    
    
  • network_type(NetworkType) / set_network_type(Option<NetworkType>):
    required: false
    

    Must be either ipv4 | ipv6 | dual_stack. IPv6 is supported for workloads using Redis engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the Nitro system.

    
    
  • ip_discovery(IpDiscovery) / set_ip_discovery(Option<IpDiscovery>):
    required: false
    

    The network type you choose when creating a replication group, either ipv4 | ipv6. IPv6 is supported for workloads using Redis engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the Nitro system.

    
    
  • transit_encryption_mode(TransitEncryptionMode) / set_transit_encryption_mode(Option<TransitEncryptionMode>):
    required: false
    

    A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.

    When setting TransitEncryptionEnabled to true, you can set your TransitEncryptionMode to preferred in the same request, to allow both encrypted and unencrypted connections at the same time. Once you migrate all your Redis clients to use encrypted connections you can modify the value to required to allow encrypted connections only.

    Setting TransitEncryptionMode to required is a two-step process that requires you to first set the TransitEncryptionMode to preferred, after that you can set TransitEncryptionMode to required.

    This process will not trigger the replacement of the replication group.

    
    
  • cluster_mode(ClusterMode) / set_cluster_mode(Option<ClusterMode>):
    required: false
    

    Enabled or Disabled. To modify cluster mode from Disabled to Enabled, you must first set the cluster mode to Compatible. Compatible mode allows your Redis clients to connect using both cluster mode enabled and cluster mode disabled. After you migrate all Redis clients to use cluster mode enabled, you can then complete cluster mode configuration and set the cluster mode to Enabled.

    
    
  • serverless_cache_snapshot_name(impl Into<String>) / set_serverless_cache_snapshot_name(Option<String>):
    required: false
    

    The name of the snapshot used to create a replication group. Available for Redis only.

    
    
• On success, responds with CreateReplicationGroupOutput with field(s):
  • replication_group(Option<ReplicationGroup>):

    Contains all of the attributes of a specific Redis replication group.

• On failure, responds with SdkError<CreateReplicationGroupError>

impl Client

pub fn create_serverless_cache(&self) -> CreateServerlessCacheFluentBuilder

Constructs a fluent builder for the CreateServerlessCache operation.

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

    User-provided identifier for the serverless cache. This parameter is stored as a lowercase string.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    User-provided description for the serverless cache. The default is NULL, i.e. if no description is provided then an empty string will be returned. The maximum length is 255 characters.

    
    
  • engine(impl Into<String>) / set_engine(Option<String>):
    required: true
    

    The name of the cache engine to be used for creating the serverless cache.

    
    
  • major_engine_version(impl Into<String>) / set_major_engine_version(Option<String>):
    required: false
    

    The version of the cache engine that will be used to create the serverless cache.

    
    
  • cache_usage_limits(CacheUsageLimits) / set_cache_usage_limits(Option<CacheUsageLimits>):
    required: false
    

    Sets the cache usage limits for storage and ElastiCache Processing Units for the cache.

    
    
  • kms_key_id(impl Into<String>) / set_kms_key_id(Option<String>):
    required: false
    

    ARN of the customer managed key for encrypting the data at rest. If no KMS key is provided, a default service key is used.

    
    
  • security_group_ids(impl Into<String>) / set_security_group_ids(Option<Vec::<String>>):
    required: false
    

    A list of the one or more VPC security groups to be associated with the serverless cache. The security group will authorize traffic access for the VPC end-point (private-link). If no other information is given this will be the VPC’s Default Security Group that is associated with the cluster VPC end-point.

    
    
  • snapshot_arns_to_restore(impl Into<String>) / set_snapshot_arns_to_restore(Option<Vec::<String>>):
    required: false
    

    The ARN(s) of the snapshot that the new serverless cache will be created from. Available for Redis only.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    The list of tags (key, value) pairs to be added to the serverless cache resource. Default is NULL.

    
    
  • user_group_id(impl Into<String>) / set_user_group_id(Option<String>):
    required: false
    

    The identifier of the UserGroup to be associated with the serverless cache. Available for Redis only. Default is NULL.

    
    
  • subnet_ids(impl Into<String>) / set_subnet_ids(Option<Vec::<String>>):
    required: false
    

    A list of the identifiers of the subnets where the VPC endpoint for the serverless cache will be deployed. All the subnetIds must belong to the same VPC.

    
    
  • snapshot_retention_limit(i32) / set_snapshot_retention_limit(Option<i32>):
    required: false
    

    The number of snapshots that will be retained for the serverless cache that is being created. As new snapshots beyond this limit are added, the oldest snapshots will be deleted on a rolling basis. Available for Redis only.

    
    
  • daily_snapshot_time(impl Into<String>) / set_daily_snapshot_time(Option<String>):
    required: false
    

    The daily time that snapshots will be created from the new serverless cache. By default this number is populated with 0, i.e. no snapshots will be created on an automatic daily basis. Available for Redis only.

    
    
• On success, responds with CreateServerlessCacheOutput with field(s):
  • serverless_cache(Option<ServerlessCache>):

    The response for the attempt to create the serverless cache.

• On failure, responds with SdkError<CreateServerlessCacheError>

impl Client

pub fn create_serverless_cache_snapshot( &self ) -> CreateServerlessCacheSnapshotFluentBuilder

Constructs a fluent builder for the CreateServerlessCacheSnapshot operation.

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

    The name for the snapshot being created. Must be unique for the customer account. Available for Redis only. Must be between 1 and 255 characters.

    
    
  • serverless_cache_name(impl Into<String>) / set_serverless_cache_name(Option<String>):
    required: true
    

    The name of an existing serverless cache. The snapshot is created from this cache. Available for Redis only.

    
    
  • kms_key_id(impl Into<String>) / set_kms_key_id(Option<String>):
    required: false
    

    The ID of the KMS key used to encrypt the snapshot. Available for Redis only. Default: NULL

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    A list of tags to be added to the snapshot resource. A tag is a key-value pair. Available for Redis only.

    
    
• On success, responds with CreateServerlessCacheSnapshotOutput with field(s):
  • serverless_cache_snapshot(Option<ServerlessCacheSnapshot>):

    The state of a serverless cache snapshot at a specific point in time, to the millisecond. Available for Redis only.

• On failure, responds with SdkError<CreateServerlessCacheSnapshotError>

impl Client

pub fn create_snapshot(&self) -> CreateSnapshotFluentBuilder

Constructs a fluent builder for the CreateSnapshot operation.

• The fluent builder is configurable:
  • replication_group_id(impl Into<String>) / set_replication_group_id(Option<String>):
    required: false
    

    The identifier of an existing replication group. The snapshot is created from this replication group.

    
    
  • cache_cluster_id(impl Into<String>) / set_cache_cluster_id(Option<String>):
    required: false
    

    The identifier of an existing cluster. The snapshot is created from this cluster.

    
    
  • snapshot_name(impl Into<String>) / set_snapshot_name(Option<String>):
    required: true
    

    A name for the snapshot being created.

    
    
  • kms_key_id(impl Into<String>) / set_kms_key_id(Option<String>):
    required: false
    

    The ID of the KMS key used to encrypt the snapshot.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.

    
    
• On success, responds with CreateSnapshotOutput with field(s):
  • snapshot(Option<Snapshot>):

    Represents a copy of an entire Redis cluster as of the time when the snapshot was taken.

• On failure, responds with SdkError<CreateSnapshotError>

impl Client

pub fn create_user(&self) -> CreateUserFluentBuilder

Constructs a fluent builder for the CreateUser operation.

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

    The ID of the user.

    
    
  • user_name(impl Into<String>) / set_user_name(Option<String>):
    required: true
    

    The username of the user.

    
    
  • engine(impl Into<String>) / set_engine(Option<String>):
    required: true
    

    The current supported value is Redis.

    
    
  • passwords(impl Into<String>) / set_passwords(Option<Vec::<String>>):
    required: false
    

    Passwords used for this user. You can create up to two passwords for each user.

    
    
  • access_string(impl Into<String>) / set_access_string(Option<String>):
    required: true
    

    Access permissions string used for this user.

    
    
  • no_password_required(bool) / set_no_password_required(Option<bool>):
    required: false
    

    Indicates a password is not required for this user.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.

    
    
  • authentication_mode(AuthenticationMode) / set_authentication_mode(Option<AuthenticationMode>):
    required: false
    

    Specifies how to authenticate the user.

    
    
• On success, responds with CreateUserOutput with field(s):
  • user_id(Option<String>):

    The ID of the user.

  • user_name(Option<String>):

    The username of the user.

  • status(Option<String>):

    Indicates the user status. Can be “active”, “modifying” or “deleting”.

  • engine(Option<String>):

    The current supported value is Redis.

  • minimum_engine_version(Option<String>):

    The minimum engine version required, which is Redis 6.0

  • access_string(Option<String>):

    Access permissions string used for this user.

  • user_group_ids(Option<Vec::<String>>):

    Returns a list of the user group IDs the user belongs to.

  • authentication(Option<Authentication>):

    Denotes whether the user requires a password to authenticate.

  • arn(Option<String>):

    The Amazon Resource Name (ARN) of the user.

• On failure, responds with SdkError<CreateUserError>

impl Client

pub fn create_user_group(&self) -> CreateUserGroupFluentBuilder

Constructs a fluent builder for the CreateUserGroup operation.

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

    The ID of the user group.

    
    
  • engine(impl Into<String>) / set_engine(Option<String>):
    required: true
    

    The current supported value is Redis.

    
    
  • user_ids(impl Into<String>) / set_user_ids(Option<Vec::<String>>):
    required: false
    

    The list of user IDs that belong to the user group.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted. Available for Redis only.

    
    
• On success, responds with CreateUserGroupOutput with field(s):
  • user_group_id(Option<String>):

    The ID of the user group.

  • status(Option<String>):

    Indicates user group status. Can be “creating”, “active”, “modifying”, “deleting”.

  • engine(Option<String>):

    The current supported value is Redis.

  • user_ids(Option<Vec::<String>>):

    The list of user IDs that belong to the user group.

  • minimum_engine_version(Option<String>):

    The minimum engine version required, which is Redis 6.0

  • pending_changes(Option<UserGroupPendingChanges>):

    A list of updates being applied to the user group.

  • replication_groups(Option<Vec::<String>>):

    A list of replication groups that the user group can access.

  • serverless_caches(Option<Vec::<String>>):

    Indicates which serverless caches the specified user group is associated with. Available for Redis only.

  • arn(Option<String>):

    The Amazon Resource Name (ARN) of the user group.

• On failure, responds with SdkError<CreateUserGroupError>

impl Client

pub fn decrease_node_groups_in_global_replication_group( &self ) -> DecreaseNodeGroupsInGlobalReplicationGroupFluentBuilder

Constructs a fluent builder for the DecreaseNodeGroupsInGlobalReplicationGroup operation.

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

    The name of the Global datastore

    
    
  • node_group_count(i32) / set_node_group_count(Option<i32>):
    required: true
    

    The number of node groups (shards) that results from the modification of the shard configuration

    
    
  • global_node_groups_to_remove(impl Into<String>) / set_global_node_groups_to_remove(Option<Vec::<String>>):
    required: false
    

    If the value of NodeGroupCount is less than the current number of node groups (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required. GlobalNodeGroupsToRemove is a list of NodeGroupIds to remove from the cluster. ElastiCache for Redis will attempt to remove all node groups listed by GlobalNodeGroupsToRemove from the cluster.

    
    
  • global_node_groups_to_retain(impl Into<String>) / set_global_node_groups_to_retain(Option<Vec::<String>>):
    required: false
    

    If the value of NodeGroupCount is less than the current number of node groups (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required. GlobalNodeGroupsToRetain is a list of NodeGroupIds to retain from the cluster. ElastiCache for Redis will attempt to retain all node groups listed by GlobalNodeGroupsToRetain from the cluster.

    
    
  • apply_immediately(bool) / set_apply_immediately(Option<bool>):
    required: true
    

    Indicates that the shard reconfiguration process begins immediately. At present, the only permitted value for this parameter is true.

    
    
• On success, responds with DecreaseNodeGroupsInGlobalReplicationGroupOutput with field(s):
  • global_replication_group(Option<GlobalReplicationGroup>):

    Consists of a primary cluster that accepts writes and an associated secondary cluster that resides in a different Amazon region. The secondary cluster accepts only reads. The primary cluster automatically replicates updates to the secondary cluster.

    • The GlobalReplicationGroupIdSuffix represents the name of the Global datastore, which is what you use to associate a secondary cluster.

• On failure, responds with SdkError<DecreaseNodeGroupsInGlobalReplicationGroupError>

impl Client

pub fn decrease_replica_count(&self) -> DecreaseReplicaCountFluentBuilder

Constructs a fluent builder for the DecreaseReplicaCount operation.

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

    The id of the replication group from which you want to remove replica nodes.

    
    
  • new_replica_count(i32) / set_new_replica_count(Option<i32>):
    required: false
    

    The number of read replica nodes you want at the completion of this operation. For Redis (cluster mode disabled) replication groups, this is the number of replica nodes in the replication group. For Redis (cluster mode enabled) replication groups, this is the number of replica nodes in each of the replication group’s node groups.

    The minimum number of replicas in a shard or replication group is:

    • Redis (cluster mode disabled)

      • If Multi-AZ is enabled: 1

      • If Multi-AZ is not enabled: 0

    • Redis (cluster mode enabled): 0 (though you will not be able to failover to a replica if your primary node fails)

    
    
  • replica_configuration(ConfigureShard) / set_replica_configuration(Option<Vec::<ConfigureShard>>):
    required: false
    

    A list of ConfigureShard objects that can be used to configure each shard in a Redis (cluster mode enabled) replication group. The ConfigureShard has three members: NewReplicaCount, NodeGroupId, and PreferredAvailabilityZones.

    
    
  • replicas_to_remove(impl Into<String>) / set_replicas_to_remove(Option<Vec::<String>>):
    required: false
    

    A list of the node ids to remove from the replication group or node group (shard).

    
    
  • apply_immediately(bool) / set_apply_immediately(Option<bool>):
    required: true
    

    If True, the number of replica nodes is decreased immediately. ApplyImmediately=False is not currently supported.

    
    
• On success, responds with DecreaseReplicaCountOutput with field(s):
  • replication_group(Option<ReplicationGroup>):

    Contains all of the attributes of a specific Redis replication group.

• On failure, responds with SdkError<DecreaseReplicaCountError>

impl Client

pub fn delete_cache_cluster(&self) -> DeleteCacheClusterFluentBuilder

Constructs a fluent builder for the DeleteCacheCluster operation.

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

    The cluster identifier for the cluster to be deleted. This parameter is not case sensitive.

    
    
  • final_snapshot_identifier(impl Into<String>) / set_final_snapshot_identifier(Option<String>):
    required: false
    

    The user-supplied name of a final cluster snapshot. This is the unique name that identifies the snapshot. ElastiCache creates the snapshot, and then deletes the cluster immediately afterward.

    
    
• On success, responds with DeleteCacheClusterOutput with field(s):
  • cache_cluster(Option<CacheCluster>):

    Contains all of the attributes of a specific cluster.

• On failure, responds with SdkError<DeleteCacheClusterError>

impl Client

pub fn delete_cache_parameter_group( &self ) -> DeleteCacheParameterGroupFluentBuilder

Constructs a fluent builder for the DeleteCacheParameterGroup operation.

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

    The name of the cache parameter group to delete.

    The specified cache security group must not be associated with any clusters.

    
    
• On success, responds with DeleteCacheParameterGroupOutput
• On failure, responds with SdkError<DeleteCacheParameterGroupError>

impl Client

pub fn delete_cache_security_group( &self ) -> DeleteCacheSecurityGroupFluentBuilder

Constructs a fluent builder for the DeleteCacheSecurityGroup operation.

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

    The name of the cache security group to delete.

    You cannot delete the default security group.

    
    
• On success, responds with DeleteCacheSecurityGroupOutput
• On failure, responds with SdkError<DeleteCacheSecurityGroupError>

impl Client

pub fn delete_cache_subnet_group(&self) -> DeleteCacheSubnetGroupFluentBuilder

Constructs a fluent builder for the DeleteCacheSubnetGroup operation.

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

    The name of the cache subnet group to delete.

    Constraints: Must contain no more than 255 alphanumeric characters or hyphens.

    
    
• On success, responds with DeleteCacheSubnetGroupOutput
• On failure, responds with SdkError<DeleteCacheSubnetGroupError>

impl Client

pub fn delete_global_replication_group( &self ) -> DeleteGlobalReplicationGroupFluentBuilder

Constructs a fluent builder for the DeleteGlobalReplicationGroup operation.

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

    The name of the Global datastore

    
    
  • retain_primary_replication_group(bool) / set_retain_primary_replication_group(Option<bool>):
    required: true
    

    The primary replication group is retained as a standalone replication group.

    
    
• On success, responds with DeleteGlobalReplicationGroupOutput with field(s):
  • global_replication_group(Option<GlobalReplicationGroup>):

    Consists of a primary cluster that accepts writes and an associated secondary cluster that resides in a different Amazon region. The secondary cluster accepts only reads. The primary cluster automatically replicates updates to the secondary cluster.

    • The GlobalReplicationGroupIdSuffix represents the name of the Global datastore, which is what you use to associate a secondary cluster.

• On failure, responds with SdkError<DeleteGlobalReplicationGroupError>

impl Client

pub fn delete_replication_group(&self) -> DeleteReplicationGroupFluentBuilder

Constructs a fluent builder for the DeleteReplicationGroup operation.

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

    The identifier for the cluster to be deleted. This parameter is not case sensitive.

    
    
  • retain_primary_cluster(bool) / set_retain_primary_cluster(Option<bool>):
    required: false
    

    If set to true, all of the read replicas are deleted, but the primary node is retained.

    
    
  • final_snapshot_identifier(impl Into<String>) / set_final_snapshot_identifier(Option<String>):
    required: false
    

    The name of a final node group (shard) snapshot. ElastiCache creates the snapshot from the primary node in the cluster, rather than one of the replicas; this is to ensure that it captures the freshest data. After the final snapshot is taken, the replication group is immediately deleted.

    
    
• On success, responds with DeleteReplicationGroupOutput with field(s):
  • replication_group(Option<ReplicationGroup>):

    Contains all of the attributes of a specific Redis replication group.

• On failure, responds with SdkError<DeleteReplicationGroupError>

impl Client

pub fn delete_serverless_cache(&self) -> DeleteServerlessCacheFluentBuilder

Constructs a fluent builder for the DeleteServerlessCache operation.

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

    The identifier of the serverless cache to be deleted.

    
    
  • final_snapshot_name(impl Into<String>) / set_final_snapshot_name(Option<String>):
    required: false
    

    Name of the final snapshot to be taken before the serverless cache is deleted. Available for Redis only. Default: NULL, i.e. a final snapshot is not taken.

    
    
• On success, responds with DeleteServerlessCacheOutput with field(s):
  • serverless_cache(Option<ServerlessCache>):

    Provides the details of the specified serverless cache that is about to be deleted.

• On failure, responds with SdkError<DeleteServerlessCacheError>

impl Client

pub fn delete_serverless_cache_snapshot( &self ) -> DeleteServerlessCacheSnapshotFluentBuilder

Constructs a fluent builder for the DeleteServerlessCacheSnapshot operation.

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

    Idenfitier of the snapshot to be deleted. Available for Redis only.

    
    
• On success, responds with DeleteServerlessCacheSnapshotOutput with field(s):
  • serverless_cache_snapshot(Option<ServerlessCacheSnapshot>):

    The snapshot to be deleted. Available for Redis only.

• On failure, responds with SdkError<DeleteServerlessCacheSnapshotError>

impl Client

pub fn delete_snapshot(&self) -> DeleteSnapshotFluentBuilder

Constructs a fluent builder for the DeleteSnapshot operation.

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

    The name of the snapshot to be deleted.

    
    
• On success, responds with DeleteSnapshotOutput with field(s):
  • snapshot(Option<Snapshot>):

    Represents a copy of an entire Redis cluster as of the time when the snapshot was taken.

• On failure, responds with SdkError<DeleteSnapshotError>

impl Client

pub fn delete_user(&self) -> DeleteUserFluentBuilder

Constructs a fluent builder for the DeleteUser operation.

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

    The ID of the user.

    
    
• On success, responds with DeleteUserOutput with field(s):
  • user_id(Option<String>):

    The ID of the user.

  • user_name(Option<String>):

    The username of the user.

  • status(Option<String>):

    Indicates the user status. Can be “active”, “modifying” or “deleting”.

  • engine(Option<String>):

    The current supported value is Redis.

  • minimum_engine_version(Option<String>):

    The minimum engine version required, which is Redis 6.0

  • access_string(Option<String>):

    Access permissions string used for this user.

  • user_group_ids(Option<Vec::<String>>):

    Returns a list of the user group IDs the user belongs to.

  • authentication(Option<Authentication>):

    Denotes whether the user requires a password to authenticate.

  • arn(Option<String>):

    The Amazon Resource Name (ARN) of the user.

• On failure, responds with SdkError<DeleteUserError>

impl Client

pub fn delete_user_group(&self) -> DeleteUserGroupFluentBuilder

Constructs a fluent builder for the DeleteUserGroup operation.

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

    The ID of the user group.

    
    
• On success, responds with DeleteUserGroupOutput with field(s):
  • user_group_id(Option<String>):

    The ID of the user group.

  • status(Option<String>):

    Indicates user group status. Can be “creating”, “active”, “modifying”, “deleting”.

  • engine(Option<String>):

    The current supported value is Redis.

  • user_ids(Option<Vec::<String>>):

    The list of user IDs that belong to the user group.

  • minimum_engine_version(Option<String>):

    The minimum engine version required, which is Redis 6.0

  • pending_changes(Option<UserGroupPendingChanges>):

    A list of updates being applied to the user group.

  • replication_groups(Option<Vec::<String>>):

    A list of replication groups that the user group can access.

  • serverless_caches(Option<Vec::<String>>):

    Indicates which serverless caches the specified user group is associated with. Available for Redis only.

  • arn(Option<String>):

    The Amazon Resource Name (ARN) of the user group.

• On failure, responds with SdkError<DeleteUserGroupError>

impl Client

pub fn describe_cache_clusters(&self) -> DescribeCacheClustersFluentBuilder

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

• The fluent builder is configurable:
  • cache_cluster_id(impl Into<String>) / set_cache_cluster_id(Option<String>):
    required: false
    

    The user-supplied cluster identifier. If this parameter is specified, only information about that specific cluster is returned. This parameter isn’t case sensitive.

    
    
  • max_records(i32) / set_max_records(Option<i32>):
    required: false
    

    The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

    Default: 100

    Constraints: minimum 20; maximum 100.

    
    
  • marker(impl Into<String>) / set_marker(Option<String>):
    required: false
    

    An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    
    
  • show_cache_node_info(bool) / set_show_cache_node_info(Option<bool>):
    required: false
    

    An optional flag that can be included in the DescribeCacheCluster request to retrieve information about the individual cache nodes.

    
    
  • show_cache_clusters_not_in_replication_groups(bool) / set_show_cache_clusters_not_in_replication_groups(Option<bool>):
    required: false
    

    An optional flag that can be included in the DescribeCacheCluster request to show only nodes (API/CLI: clusters) that are not members of a replication group. In practice, this mean Memcached and single node Redis clusters.

    
    
• On success, responds with DescribeCacheClustersOutput with field(s):
  • marker(Option<String>):

    Provides an identifier to allow retrieval of paginated results.

  • cache_clusters(Option<Vec::<CacheCluster>>):

    A list of clusters. Each item in the list contains detailed information about one cluster.

• On failure, responds with SdkError<DescribeCacheClustersError>

impl Client

pub fn describe_cache_engine_versions( &self ) -> DescribeCacheEngineVersionsFluentBuilder

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

• The fluent builder is configurable:
  • engine(impl Into<String>) / set_engine(Option<String>):
    required: false
    

    The cache engine to return. Valid values: memcached | redis

    
    
  • engine_version(impl Into<String>) / set_engine_version(Option<String>):
    required: false
    

    The cache engine version to return.

    Example: 1.4.14

    
    
  • cache_parameter_group_family(impl Into<String>) / set_cache_parameter_group_family(Option<String>):
    required: false
    

    The name of a specific cache parameter group family to return details for.

    Valid values are: memcached1.4 | memcached1.5 | memcached1.6 | redis2.6 | redis2.8 | redis3.2 | redis4.0 | redis5.0 | redis6.x | redis6.2 | redis7

    Constraints:

    • Must be 1 to 255 alphanumeric characters

    • First character must be a letter

    • Cannot end with a hyphen or contain two consecutive hyphens

    
    
  • max_records(i32) / set_max_records(Option<i32>):
    required: false
    

    The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

    Default: 100

    Constraints: minimum 20; maximum 100.

    
    
  • marker(impl Into<String>) / set_marker(Option<String>):
    required: false
    

    An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    
    
  • default_only(bool) / set_default_only(Option<bool>):
    required: false
    

    If true, specifies that only the default version of the specified engine or engine and major version combination is to be returned.

    
    
• On success, responds with DescribeCacheEngineVersionsOutput with field(s):
  • marker(Option<String>):

    Provides an identifier to allow retrieval of paginated results.

  • cache_engine_versions(Option<Vec::<CacheEngineVersion>>):

    A list of cache engine version details. Each element in the list contains detailed information about one cache engine version.

• On failure, responds with SdkError<DescribeCacheEngineVersionsError>

impl Client

pub fn describe_cache_parameter_groups( &self ) -> DescribeCacheParameterGroupsFluentBuilder

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

• The fluent builder is configurable:
  • cache_parameter_group_name(impl Into<String>) / set_cache_parameter_group_name(Option<String>):
    required: false
    

    The name of a specific cache parameter group to return details for.

    
    
  • max_records(i32) / set_max_records(Option<i32>):
    required: false
    

    The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

    Default: 100

    Constraints: minimum 20; maximum 100.

    
    
  • marker(impl Into<String>) / set_marker(Option<String>):
    required: false
    

    An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    
    
• On success, responds with DescribeCacheParameterGroupsOutput with field(s):
  • marker(Option<String>):

    Provides an identifier to allow retrieval of paginated results.

  • cache_parameter_groups(Option<Vec::<CacheParameterGroup>>):

    A list of cache parameter groups. Each element in the list contains detailed information about one cache parameter group.

• On failure, responds with SdkError<DescribeCacheParameterGroupsError>

impl Client

pub fn describe_cache_parameters(&self) -> DescribeCacheParametersFluentBuilder

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

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

    The name of a specific cache parameter group to return details for.

    
    
  • source(impl Into<String>) / set_source(Option<String>):
    required: false
    

    The parameter types to return.

    Valid values: user | system | engine-default

    
    
  • max_records(i32) / set_max_records(Option<i32>):
    required: false
    

    The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

    Default: 100

    Constraints: minimum 20; maximum 100.

    
    
  • marker(impl Into<String>) / set_marker(Option<String>):
    required: false
    

    An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    
    
• On success, responds with DescribeCacheParametersOutput with field(s):
  • marker(Option<String>):

    Provides an identifier to allow retrieval of paginated results.

  • parameters(Option<Vec::<Parameter>>):

    A list of Parameter instances.

  • cache_node_type_specific_parameters(Option<Vec::<CacheNodeTypeSpecificParameter>>):

    A list of parameters specific to a particular cache node type. Each element in the list contains detailed information about one parameter.

• On failure, responds with SdkError<DescribeCacheParametersError>

impl Client

pub fn describe_cache_security_groups( &self ) -> DescribeCacheSecurityGroupsFluentBuilder

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

• The fluent builder is configurable:
  • cache_security_group_name(impl Into<String>) / set_cache_security_group_name(Option<String>):
    required: false
    

    The name of the cache security group to return details for.

    
    
  • max_records(i32) / set_max_records(Option<i32>):
    required: false
    

    The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

    Default: 100

    Constraints: minimum 20; maximum 100.

    
    
  • marker(impl Into<String>) / set_marker(Option<String>):
    required: false
    

    An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    
    
• On success, responds with DescribeCacheSecurityGroupsOutput with field(s):
  • marker(Option<String>):

    Provides an identifier to allow retrieval of paginated results.

  • cache_security_groups(Option<Vec::<CacheSecurityGroup>>):

    A list of cache security groups. Each element in the list contains detailed information about one group.

• On failure, responds with SdkError<DescribeCacheSecurityGroupsError>

impl Client

pub fn describe_cache_subnet_groups( &self ) -> DescribeCacheSubnetGroupsFluentBuilder

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

• The fluent builder is configurable:
  • cache_subnet_group_name(impl Into<String>) / set_cache_subnet_group_name(Option<String>):
    required: false
    

    The name of the cache subnet group to return details for.

    
    
  • max_records(i32) / set_max_records(Option<i32>):
    required: false
    

    The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

    Default: 100

    Constraints: minimum 20; maximum 100.

    
    
  • marker(impl Into<String>) / set_marker(Option<String>):
    required: false
    

    An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    
    
• On success, responds with DescribeCacheSubnetGroupsOutput with field(s):
  • marker(Option<String>):

    Provides an identifier to allow retrieval of paginated results.

  • cache_subnet_groups(Option<Vec::<CacheSubnetGroup>>):

    A list of cache subnet groups. Each element in the list contains detailed information about one group.

• On failure, responds with SdkError<DescribeCacheSubnetGroupsError>

impl Client

pub fn describe_engine_default_parameters( &self ) -> DescribeEngineDefaultParametersFluentBuilder

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

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

    The name of the cache parameter group family.

    Valid values are: memcached1.4 | memcached1.5 | memcached1.6 | redis2.6 | redis2.8 | redis3.2 | redis4.0 | redis5.0 | redis6.x | redis6.2 | redis7

    
    
  • max_records(i32) / set_max_records(Option<i32>):
    required: false
    

    The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

    Default: 100

    Constraints: minimum 20; maximum 100.

    
    
  • marker(impl Into<String>) / set_marker(Option<String>):
    required: false
    

    An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    
    
• On success, responds with DescribeEngineDefaultParametersOutput with field(s):
  • engine_defaults(Option<EngineDefaults>):

    Represents the output of a DescribeEngineDefaultParameters operation.

• On failure, responds with SdkError<DescribeEngineDefaultParametersError>

impl Client

pub fn describe_events(&self) -> DescribeEventsFluentBuilder

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

• The fluent builder is configurable:
  • source_identifier(impl Into<String>) / set_source_identifier(Option<String>):
    required: false
    

    The identifier of the event source for which events are returned. If not specified, all sources are included in the response.

    
    
  • source_type(SourceType) / set_source_type(Option<SourceType>):
    required: false
    

    The event source to retrieve events for. If no value is specified, all events are returned.

    
    
  • start_time(DateTime) / set_start_time(Option<DateTime>):
    required: false
    

    The beginning of the time interval to retrieve events for, specified in ISO 8601 format.

    Example: 2017-03-30T07:03:49.555Z

    
    
  • end_time(DateTime) / set_end_time(Option<DateTime>):
    required: false
    

    The end of the time interval for which to retrieve events, specified in ISO 8601 format.

    Example: 2017-03-30T07:03:49.555Z

    
    
  • duration(i32) / set_duration(Option<i32>):
    required: false
    

    The number of minutes worth of events to retrieve.

    
    
  • max_records(i32) / set_max_records(Option<i32>):
    required: false
    

    The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

    Default: 100

    Constraints: minimum 20; maximum 100.

    
    
  • marker(impl Into<String>) / set_marker(Option<String>):
    required: false
    

    An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    
    
• On success, responds with DescribeEventsOutput with field(s):
  • marker(Option<String>):

    Provides an identifier to allow retrieval of paginated results.

  • events(Option<Vec::<Event>>):

    A list of events. Each element in the list contains detailed information about one event.

• On failure, responds with SdkError<DescribeEventsError>

impl Client

pub fn describe_global_replication_groups( &self ) -> DescribeGlobalReplicationGroupsFluentBuilder

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

• The fluent builder is configurable:
  • global_replication_group_id(impl Into<String>) / set_global_replication_group_id(Option<String>):
    required: false
    

    The name of the Global datastore

    
    
  • max_records(i32) / set_max_records(Option<i32>):
    required: false
    

    The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

    
    
  • marker(impl Into<String>) / set_marker(Option<String>):
    required: false
    

    An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    
    
  • show_member_info(bool) / set_show_member_info(Option<bool>):
    required: false
    

    Returns the list of members that comprise the Global datastore.

    
    
• On success, responds with DescribeGlobalReplicationGroupsOutput with field(s):
  • marker(Option<String>):

    An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. >

  • global_replication_groups(Option<Vec::<GlobalReplicationGroup>>):

    Indicates the slot configuration and global identifier for each slice group.

• On failure, responds with SdkError<DescribeGlobalReplicationGroupsError>

impl Client

pub fn describe_replication_groups( &self ) -> DescribeReplicationGroupsFluentBuilder

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

• The fluent builder is configurable:
  • replication_group_id(impl Into<String>) / set_replication_group_id(Option<String>):
    required: false
    

    The identifier for the replication group to be described. This parameter is not case sensitive.

    If you do not specify this parameter, information about all replication groups is returned.

    
    
  • max_records(i32) / set_max_records(Option<i32>):
    required: false
    

    The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

    Default: 100

    Constraints: minimum 20; maximum 100.

    
    
  • marker(impl Into<String>) / set_marker(Option<String>):
    required: false
    

    An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    
    
• On success, responds with DescribeReplicationGroupsOutput with field(s):
  • marker(Option<String>):

    Provides an identifier to allow retrieval of paginated results.

  • replication_groups(Option<Vec::<ReplicationGroup>>):

    A list of replication groups. Each item in the list contains detailed information about one replication group.

• On failure, responds with SdkError<DescribeReplicationGroupsError>

impl Client

pub fn describe_reserved_cache_nodes( &self ) -> DescribeReservedCacheNodesFluentBuilder

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

• The fluent builder is configurable:
  • reserved_cache_node_id(impl Into<String>) / set_reserved_cache_node_id(Option<String>):
    required: false
    

    The reserved cache node identifier filter value. Use this parameter to show only the reservation that matches the specified reservation ID.

    
    
  • reserved_cache_nodes_offering_id(impl Into<String>) / set_reserved_cache_nodes_offering_id(Option<String>):
    required: false
    

    The offering identifier filter value. Use this parameter to show only purchased reservations matching the specified offering identifier.

    
    
  • cache_node_type(impl Into<String>) / set_cache_node_type(Option<String>):
    required: false
    

    The cache node type filter value. Use this parameter to show only those reservations matching the specified cache node type.

    The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.

    • General purpose:

      • Current generation:

        M7g node types: cache.m7g.large, cache.m7g.xlarge, cache.m7g.2xlarge, cache.m7g.4xlarge, cache.m7g.8xlarge, cache.m7g.12xlarge, cache.m7g.16xlarge

        For region availability, see Supported Node Types

        M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.m6g.large, cache.m6g.xlarge, cache.m6g.2xlarge, cache.m6g.4xlarge, cache.m6g.8xlarge, cache.m6g.12xlarge, cache.m6g.16xlarge

        M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge

        M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge

        T4g node types (available only for Redis engine version 5.0.6 onward and Memcached engine version 1.5.16 onward): cache.t4g.micro, cache.t4g.small, cache.t4g.medium

        T3 node types: cache.t3.micro, cache.t3.small, cache.t3.medium

        T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium

      • Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)

        T1 node types: cache.t1.micro

        M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge

        M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge

    • Compute optimized:

      • Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)

        C1 node types: cache.c1.xlarge

    • Memory optimized:

      • Current generation:

        R7g node types: cache.r7g.large, cache.r7g.xlarge, cache.r7g.2xlarge, cache.r7g.4xlarge, cache.r7g.8xlarge, cache.r7g.12xlarge, cache.r7g.16xlarge

        For region availability, see Supported Node Types

        R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.r6g.large, cache.r6g.xlarge, cache.r6g.2xlarge, cache.r6g.4xlarge, cache.r6g.8xlarge, cache.r6g.12xlarge, cache.r6g.16xlarge

        R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge

        R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge

      • Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)

        M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge

        R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge

    Additional node type info

    • All current generation instance types are created in Amazon VPC by default.

    • Redis append-only files (AOF) are not supported for T1 or T2 instances.

    • Redis Multi-AZ with automatic failover is not supported on T1 instances.

    • Redis configuration variables appendonly and appendfsync are not supported on Redis version 2.8.22 and later.

    
    
  • duration(impl Into<String>) / set_duration(Option<String>):
    required: false
    

    The duration filter value, specified in years or seconds. Use this parameter to show only reservations for this duration.

    Valid Values: 1 | 3 | 31536000 | 94608000

    
    
  • product_description(impl Into<String>) / set_product_description(Option<String>):
    required: false
    

    The product description filter value. Use this parameter to show only those reservations matching the specified product description.

    
    
  • offering_type(impl Into<String>) / set_offering_type(Option<String>):
    required: false
    

    The offering type filter value. Use this parameter to show only the available offerings matching the specified offering type.

    Valid values: “Light Utilization”|“Medium Utilization”|“Heavy Utilization”|“All Upfront”|“Partial Upfront”| “No Upfront”

    
    
  • max_records(i32) / set_max_records(Option<i32>):
    required: false
    

    The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

    Default: 100

    Constraints: minimum 20; maximum 100.

    
    
  • marker(impl Into<String>) / set_marker(Option<String>):
    required: false
    

    An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    
    
• On success, responds with DescribeReservedCacheNodesOutput with field(s):
  • marker(Option<String>):

    Provides an identifier to allow retrieval of paginated results.

  • reserved_cache_nodes(Option<Vec::<ReservedCacheNode>>):

    A list of reserved cache nodes. Each element in the list contains detailed information about one node.

• On failure, responds with SdkError<DescribeReservedCacheNodesError>

impl Client

pub fn describe_reserved_cache_nodes_offerings( &self ) -> DescribeReservedCacheNodesOfferingsFluentBuilder

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

• The fluent builder is configurable:
  • reserved_cache_nodes_offering_id(impl Into<String>) / set_reserved_cache_nodes_offering_id(Option<String>):
    required: false
    

    The offering identifier filter value. Use this parameter to show only the available offering that matches the specified reservation identifier.

    Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706

    
    
  • cache_node_type(impl Into<String>) / set_cache_node_type(Option<String>):
    required: false
    

    The cache node type filter value. Use this parameter to show only the available offerings matching the specified cache node type.

    The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.

    • General purpose:

      • Current generation:

        M7g node types: cache.m7g.large, cache.m7g.xlarge, cache.m7g.2xlarge, cache.m7g.4xlarge, cache.m7g.8xlarge, cache.m7g.12xlarge, cache.m7g.16xlarge

        For region availability, see Supported Node Types

        M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.m6g.large, cache.m6g.xlarge, cache.m6g.2xlarge, cache.m6g.4xlarge, cache.m6g.8xlarge, cache.m6g.12xlarge, cache.m6g.16xlarge

        M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge

        M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge

        T4g node types (available only for Redis engine version 5.0.6 onward and Memcached engine version 1.5.16 onward): cache.t4g.micro, cache.t4g.small, cache.t4g.medium

        T3 node types: cache.t3.micro, cache.t3.small, cache.t3.medium

        T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium

      • Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)

        T1 node types: cache.t1.micro

        M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge

        M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge

    • Compute optimized:

      • Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)

        C1 node types: cache.c1.xlarge

    • Memory optimized:

      • Current generation:

        R7g node types: cache.r7g.large, cache.r7g.xlarge, cache.r7g.2xlarge, cache.r7g.4xlarge, cache.r7g.8xlarge, cache.r7g.12xlarge, cache.r7g.16xlarge

        For region availability, see Supported Node Types

        R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.r6g.large, cache.r6g.xlarge, cache.r6g.2xlarge, cache.r6g.4xlarge, cache.r6g.8xlarge, cache.r6g.12xlarge, cache.r6g.16xlarge

        R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge

        R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge

      • Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.)

        M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge

        R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge

    Additional node type info

    • All current generation instance types are created in Amazon VPC by default.

    • Redis append-only files (AOF) are not supported for T1 or T2 instances.

    • Redis Multi-AZ with automatic failover is not supported on T1 instances.

    • Redis configuration variables appendonly and appendfsync are not supported on Redis version 2.8.22 and later.

    
    
  • duration(impl Into<String>) / set_duration(Option<String>):
    required: false
    

    Duration filter value, specified in years or seconds. Use this parameter to show only reservations for a given duration.

    Valid Values: 1 | 3 | 31536000 | 94608000

    
    
  • product_description(impl Into<String>) / set_product_description(Option<String>):
    required: false
    

    The product description filter value. Use this parameter to show only the available offerings matching the specified product description.

    
    
  • offering_type(impl Into<String>) / set_offering_type(Option<String>):
    required: false
    

    The offering type filter value. Use this parameter to show only the available offerings matching the specified offering type.

    Valid Values: “Light Utilization”|“Medium Utilization”|“Heavy Utilization” |“All Upfront”|“Partial Upfront”| “No Upfront”

    
    
  • max_records(i32) / set_max_records(Option<i32>):
    required: false
    

    The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

    Default: 100

    Constraints: minimum 20; maximum 100.

    
    
  • marker(impl Into<String>) / set_marker(Option<String>):
    required: false
    

    An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    
    
• On success, responds with DescribeReservedCacheNodesOfferingsOutput with field(s):
  • marker(Option<String>):

    Provides an identifier to allow retrieval of paginated results.

  • reserved_cache_nodes_offerings(Option<Vec::<ReservedCacheNodesOffering>>):

    A list of reserved cache node offerings. Each element in the list contains detailed information about one offering.

• On failure, responds with SdkError<DescribeReservedCacheNodesOfferingsError>

impl Client

pub fn describe_serverless_cache_snapshots( &self ) -> DescribeServerlessCacheSnapshotsFluentBuilder

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

• The fluent builder is configurable:
  • serverless_cache_name(impl Into<String>) / set_serverless_cache_name(Option<String>):
    required: false
    

    The identifier of serverless cache. If this parameter is specified, only snapshots associated with that specific serverless cache are described. Available for Redis only.

    
    
  • serverless_cache_snapshot_name(impl Into<String>) / set_serverless_cache_snapshot_name(Option<String>):
    required: false
    

    The identifier of the serverless cache’s snapshot. If this parameter is specified, only this snapshot is described. Available for Redis only.

    
    
  • snapshot_type(impl Into<String>) / set_snapshot_type(Option<String>):
    required: false
    

    The type of snapshot that is being described. Available for Redis only.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    An optional marker returned from a prior request to support pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by max-results. Available for Redis only.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of records to include in the response. If more records exist than the specified max-results value, a market is included in the response so that remaining results can be retrieved. Available for Redis only.The default is 50. The Validation Constraints are a maximum of 50.

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

    An optional marker returned from a prior request to support pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by max-results. Available for Redis only.

  • serverless_cache_snapshots(Option<Vec::<ServerlessCacheSnapshot>>):

    The serverless caches snapshots associated with a given description request. Available for Redis only.

• On failure, responds with SdkError<DescribeServerlessCacheSnapshotsError>

impl Client

pub fn describe_serverless_caches( &self ) -> DescribeServerlessCachesFluentBuilder

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

• The fluent builder is configurable:
  • serverless_cache_name(impl Into<String>) / set_serverless_cache_name(Option<String>):
    required: false
    

    The identifier for the serverless cache. If this parameter is specified, only information about that specific serverless cache is returned. Default: NULL

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of records in the response. If more records exist than the specified max-records value, the next token is included in the response so that remaining results can be retrieved. The default is 50.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    An optional marker returned from a prior request to support pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxResults.

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

    An optional marker returned from a prior request to support pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxResults.

  • serverless_caches(Option<Vec::<ServerlessCache>>):

    The serverless caches associated with a given description request.

• On failure, responds with SdkError<DescribeServerlessCachesError>

impl Client

pub fn describe_service_updates(&self) -> DescribeServiceUpdatesFluentBuilder

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

• The fluent builder is configurable:
  • service_update_name(impl Into<String>) / set_service_update_name(Option<String>):
    required: false
    

    The unique ID of the service update

    
    
  • service_update_status(ServiceUpdateStatus) / set_service_update_status(Option<Vec::<ServiceUpdateStatus>>):
    required: false
    

    The status of the service update

    
    
  • max_records(i32) / set_max_records(Option<i32>):
    required: false
    

    The maximum number of records to include in the response

    
    
  • marker(impl Into<String>) / set_marker(Option<String>):
    required: false
    

    An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    
    
• On success, responds with DescribeServiceUpdatesOutput with field(s):
  • marker(Option<String>):

    An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

  • service_updates(Option<Vec::<ServiceUpdate>>):

    A list of service updates

• On failure, responds with SdkError<DescribeServiceUpdatesError>

impl Client

pub fn describe_snapshots(&self) -> DescribeSnapshotsFluentBuilder

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

• The fluent builder is configurable:
  • replication_group_id(impl Into<String>) / set_replication_group_id(Option<String>):
    required: false
    

    A user-supplied replication group identifier. If this parameter is specified, only snapshots associated with that specific replication group are described.

    
    
  • cache_cluster_id(impl Into<String>) / set_cache_cluster_id(Option<String>):
    required: false
    

    A user-supplied cluster identifier. If this parameter is specified, only snapshots associated with that specific cluster are described.

    
    
  • snapshot_name(impl Into<String>) / set_snapshot_name(Option<String>):
    required: false
    

    A user-supplied name of the snapshot. If this parameter is specified, only this snapshot are described.

    
    
  • snapshot_source(impl Into<String>) / set_snapshot_source(Option<String>):
    required: false
    

    If set to system, the output shows snapshots that were automatically created by ElastiCache. If set to user the output shows snapshots that were manually created. If omitted, the output shows both automatically and manually created snapshots.

    
    
  • marker(impl Into<String>) / set_marker(Option<String>):
    required: false
    

    An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    
    
  • max_records(i32) / set_max_records(Option<i32>):
    required: false
    

    The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

    Default: 50

    Constraints: minimum 20; maximum 50.

    
    
  • show_node_group_config(bool) / set_show_node_group_config(Option<bool>):
    required: false
    

    A Boolean value which if true, the node group (shard) configuration is included in the snapshot description.

    
    
• On success, responds with DescribeSnapshotsOutput with field(s):
  • marker(Option<String>):

    An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

  • snapshots(Option<Vec::<Snapshot>>):

    A list of snapshots. Each item in the list contains detailed information about one snapshot.

• On failure, responds with SdkError<DescribeSnapshotsError>

impl Client

pub fn describe_update_actions(&self) -> DescribeUpdateActionsFluentBuilder

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

• The fluent builder is configurable:
  • service_update_name(impl Into<String>) / set_service_update_name(Option<String>):
    required: false
    

    The unique ID of the service update

    
    
  • replication_group_ids(impl Into<String>) / set_replication_group_ids(Option<Vec::<String>>):
    required: false
    

    The replication group IDs

    
    
  • cache_cluster_ids(impl Into<String>) / set_cache_cluster_ids(Option<Vec::<String>>):
    required: false
    

    The cache cluster IDs

    
    
  • engine(impl Into<String>) / set_engine(Option<String>):
    required: false
    

    The Elasticache engine to which the update applies. Either Redis or Memcached

    
    
  • service_update_status(ServiceUpdateStatus) / set_service_update_status(Option<Vec::<ServiceUpdateStatus>>):
    required: false
    

    The status of the service update

    
    
  • service_update_time_range(TimeRangeFilter) / set_service_update_time_range(Option<TimeRangeFilter>):
    required: false
    

    The range of time specified to search for service updates that are in available status

    
    
  • update_action_status(UpdateActionStatus) / set_update_action_status(Option<Vec::<UpdateActionStatus>>):
    required: false
    

    The status of the update action.

    
    
  • show_node_level_update_status(bool) / set_show_node_level_update_status(Option<bool>):
    required: false
    

    Dictates whether to include node level update status in the response

    
    
  • max_records(i32) / set_max_records(Option<i32>):
    required: false
    

    The maximum number of records to include in the response

    
    
  • marker(impl Into<String>) / set_marker(Option<String>):
    required: false
    

    An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    
    
• On success, responds with DescribeUpdateActionsOutput with field(s):
  • marker(Option<String>):

    An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

  • update_actions(Option<Vec::<UpdateAction>>):

    Returns a list of update actions

• On failure, responds with SdkError<DescribeUpdateActionsError>

impl Client

pub fn describe_user_groups(&self) -> DescribeUserGroupsFluentBuilder

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

• The fluent builder is configurable:
  • user_group_id(impl Into<String>) / set_user_group_id(Option<String>):
    required: false
    

    The ID of the user group.

    
    
  • max_records(i32) / set_max_records(Option<i32>):
    required: false
    

    The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

    
    
  • marker(impl Into<String>) / set_marker(Option<String>):
    required: false
    

    An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. >

    
    
• On success, responds with DescribeUserGroupsOutput with field(s):
  • user_groups(Option<Vec::<UserGroup>>):

    Returns a list of user groups.

  • marker(Option<String>):

    An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. >

• On failure, responds with SdkError<DescribeUserGroupsError>

impl Client

pub fn describe_users(&self) -> DescribeUsersFluentBuilder

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

• The fluent builder is configurable:
  • engine(impl Into<String>) / set_engine(Option<String>):
    required: false
    

    The Redis engine.

    
    
  • user_id(impl Into<String>) / set_user_id(Option<String>):
    required: false
    

    The ID of the user.

    
    
  • filters(Filter) / set_filters(Option<Vec::<Filter>>):
    required: false
    

    Filter to determine the list of User IDs to return.

    
    
  • max_records(i32) / set_max_records(Option<i32>):
    required: false
    

    The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

    
    
  • marker(impl Into<String>) / set_marker(Option<String>):
    required: false
    

    An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. >

    
    
• On success, responds with DescribeUsersOutput with field(s):
  • users(Option<Vec::<User>>):

    A list of users.

  • marker(Option<String>):

    An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. >

• On failure, responds with SdkError<DescribeUsersError>

impl Client

pub fn disassociate_global_replication_group( &self ) -> DisassociateGlobalReplicationGroupFluentBuilder

Constructs a fluent builder for the DisassociateGlobalReplicationGroup operation.

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

    The name of the Global datastore

    
    
  • replication_group_id(impl Into<String>) / set_replication_group_id(Option<String>):
    required: true
    

    The name of the secondary cluster you wish to remove from the Global datastore

    
    
  • replication_group_region(impl Into<String>) / set_replication_group_region(Option<String>):
    required: true
    

    The Amazon region of secondary cluster you wish to remove from the Global datastore

    
    
• On success, responds with DisassociateGlobalReplicationGroupOutput with field(s):
  • global_replication_group(Option<GlobalReplicationGroup>):

    Consists of a primary cluster that accepts writes and an associated secondary cluster that resides in a different Amazon region. The secondary cluster accepts only reads. The primary cluster automatically replicates updates to the secondary cluster.

    • The GlobalReplicationGroupIdSuffix represents the name of the Global datastore, which is what you use to associate a secondary cluster.

• On failure, responds with SdkError<DisassociateGlobalReplicationGroupError>

impl Client

pub fn export_serverless_cache_snapshot( &self ) -> ExportServerlessCacheSnapshotFluentBuilder

Constructs a fluent builder for the ExportServerlessCacheSnapshot operation.

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

    The identifier of the serverless cache snapshot to be exported to S3. Available for Redis only.

    
    
  • s3_bucket_name(impl Into<String>) / set_s3_bucket_name(Option<String>):
    required: true
    

    Name of the Amazon S3 bucket to export the snapshot to. The Amazon S3 bucket must also be in same region as the snapshot. Available for Redis only.

    
    
• On success, responds with ExportServerlessCacheSnapshotOutput with field(s):
  • serverless_cache_snapshot(Option<ServerlessCacheSnapshot>):

    The state of a serverless cache at a specific point in time, to the millisecond. Available for Redis only.

• On failure, responds with SdkError<ExportServerlessCacheSnapshotError>

impl Client

pub fn failover_global_replication_group( &self ) -> FailoverGlobalReplicationGroupFluentBuilder

Constructs a fluent builder for the FailoverGlobalReplicationGroup operation.

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

    The name of the Global datastore

    
    
  • primary_region(impl Into<String>) / set_primary_region(Option<String>):
    required: true
    

    The Amazon region of the primary cluster of the Global datastore

    
    
  • primary_replication_group_id(impl Into<String>) / set_primary_replication_group_id(Option<String>):
    required: true
    

    The name of the primary replication group

    
    
• On success, responds with FailoverGlobalReplicationGroupOutput with field(s):
  • global_replication_group(Option<GlobalReplicationGroup>):

    Consists of a primary cluster that accepts writes and an associated secondary cluster that resides in a different Amazon region. The secondary cluster accepts only reads. The primary cluster automatically replicates updates to the secondary cluster.

    • The GlobalReplicationGroupIdSuffix represents the name of the Global datastore, which is what you use to associate a secondary cluster.

• On failure, responds with SdkError<FailoverGlobalReplicationGroupError>

impl Client

pub fn increase_node_groups_in_global_replication_group( &self ) -> IncreaseNodeGroupsInGlobalReplicationGroupFluentBuilder

Constructs a fluent builder for the IncreaseNodeGroupsInGlobalReplicationGroup operation.

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

    The name of the Global datastore

    
    
  • node_group_count(i32) / set_node_group_count(Option<i32>):
    required: true
    

    Total number of node groups you want

    
    
  • regional_configurations(RegionalConfiguration) / set_regional_configurations(Option<Vec::<RegionalConfiguration>>):
    required: false
    

    Describes the replication group IDs, the Amazon regions where they are stored and the shard configuration for each that comprise the Global datastore

    
    
  • apply_immediately(bool) / set_apply_immediately(Option<bool>):
    required: true
    

    Indicates that the process begins immediately. At present, the only permitted value for this parameter is true.

    
    
• On success, responds with IncreaseNodeGroupsInGlobalReplicationGroupOutput with field(s):
  • global_replication_group(Option<GlobalReplicationGroup>):

    Consists of a primary cluster that accepts writes and an associated secondary cluster that resides in a different Amazon region. The secondary cluster accepts only reads. The primary cluster automatically replicates updates to the secondary cluster.

    • The GlobalReplicationGroupIdSuffix represents the name of the Global datastore, which is what you use to associate a secondary cluster.

• On failure, responds with SdkError<IncreaseNodeGroupsInGlobalReplicationGroupError>

impl Client

pub fn increase_replica_count(&self) -> IncreaseReplicaCountFluentBuilder

Constructs a fluent builder for the IncreaseReplicaCount operation.

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

    The id of the replication group to which you want to add replica nodes.

    
    
  • new_replica_count(i32) / set_new_replica_count(Option<i32>):
    required: false
    

    The number of read replica nodes you want at the completion of this operation. For Redis (cluster mode disabled) replication groups, this is the number of replica nodes in the replication group. For Redis (cluster mode enabled) replication groups, this is the number of replica nodes in each of the replication group’s node groups.

    
    
  • replica_configuration(ConfigureShard) / set_replica_configuration(Option<Vec::<ConfigureShard>>):
    required: false
    

    A list of ConfigureShard objects that can be used to configure each shard in a Redis (cluster mode enabled) replication group. The ConfigureShard has three members: NewReplicaCount, NodeGroupId, and PreferredAvailabilityZones.

    
    
  • apply_immediately(bool) / set_apply_immediately(Option<bool>):
    required: true
    

    If True, the number of replica nodes is increased immediately. ApplyImmediately=False is not currently supported.

    
    
• On success, responds with IncreaseReplicaCountOutput with field(s):
  • replication_group(Option<ReplicationGroup>):

    Contains all of the attributes of a specific Redis replication group.

• On failure, responds with SdkError<IncreaseReplicaCountError>

impl Client

pub fn list_allowed_node_type_modifications( &self ) -> ListAllowedNodeTypeModificationsFluentBuilder

Constructs a fluent builder for the ListAllowedNodeTypeModifications operation.

• The fluent builder is configurable:
  • cache_cluster_id(impl Into<String>) / set_cache_cluster_id(Option<String>):
    required: false
    

    The name of the cluster you want to scale up to a larger node instanced type. ElastiCache uses the cluster id to identify the current node type of this cluster and from that to create a list of node types you can scale up to.

    You must provide a value for either the CacheClusterId or the ReplicationGroupId.

    
    
  • replication_group_id(impl Into<String>) / set_replication_group_id(Option<String>):
    required: false
    

    The name of the replication group want to scale up to a larger node type. ElastiCache uses the replication group id to identify the current node type being used by this replication group, and from that to create a list of node types you can scale up to.

    You must provide a value for either the CacheClusterId or the ReplicationGroupId.

    
    
• On success, responds with ListAllowedNodeTypeModificationsOutput with field(s):
  • scale_up_modifications(Option<Vec::<String>>):

    A string list, each element of which specifies a cache node type which you can use to scale your cluster or replication group.

    When scaling up a Redis cluster or replication group using ModifyCacheCluster or ModifyReplicationGroup, use a value from this list for the CacheNodeType parameter.

  • scale_down_modifications(Option<Vec::<String>>):

    A string list, each element of which specifies a cache node type which you can use to scale your cluster or replication group. When scaling down a Redis cluster or replication group using ModifyCacheCluster or ModifyReplicationGroup, use a value from this list for the CacheNodeType parameter.

• On failure, responds with SdkError<ListAllowedNodeTypeModificationsError>

impl Client

pub fn list_tags_for_resource(&self) -> ListTagsForResourceFluentBuilder

Constructs a fluent builder for the ListTagsForResource operation.

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

    The Amazon Resource Name (ARN) of the resource for which you want the list of tags, for example arn:aws:elasticache:us-west-2:0123456789:cluster:myCluster or arn:aws:elasticache:us-west-2:0123456789:snapshot:mySnapshot.

    For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.

    
    
• On success, responds with ListTagsForResourceOutput with field(s):
  • tag_list(Option<Vec::<Tag>>):

    A list of tags as key-value pairs.

• On failure, responds with SdkError<ListTagsForResourceError>

impl Client

pub fn modify_cache_cluster(&self) -> ModifyCacheClusterFluentBuilder

Constructs a fluent builder for the ModifyCacheCluster operation.

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

    The cluster identifier. This value is stored as a lowercase string.

    
    
  • num_cache_nodes(i32) / set_num_cache_nodes(Option<i32>):
    required: false
    

    The number of cache nodes that the cluster should have. If the value for NumCacheNodes is greater than the sum of the number of current cache nodes and the number of cache nodes pending creation (which may be zero), more nodes are added. If the value is less than the number of existing cache nodes, nodes are removed. If the value is equal to the number of current cache nodes, any pending add or remove requests are canceled.

    If you are removing cache nodes, you must use the CacheNodeIdsToRemove parameter to provide the IDs of the specific cache nodes to remove.

    For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 40.

    Adding or removing Memcached cache nodes can be applied immediately or as a pending operation (see ApplyImmediately).

    A pending operation to modify the number of cache nodes in a cluster during its maintenance window, whether by adding or removing nodes in accordance with the scale out architecture, is not queued. The customer’s latest request to add or remove nodes to the cluster overrides any previous pending operations to modify the number of cache nodes in the cluster. For example, a request to remove 2 nodes would override a previous pending operation to remove 3 nodes. Similarly, a request to add 2 nodes would override a previous pending operation to remove 3 nodes and vice versa. As Memcached cache nodes may now be provisioned in different Availability Zones with flexible cache node placement, a request to add nodes does not automatically override a previous pending operation to add nodes. The customer can modify the previous pending operation to add more nodes or explicitly cancel the pending request and retry the new request. To cancel pending operations to modify the number of cache nodes in a cluster, use the ModifyCacheCluster request and set NumCacheNodes equal to the number of cache nodes currently in the cluster.

    
    
  • cache_node_ids_to_remove(impl Into<String>) / set_cache_node_ids_to_remove(Option<Vec::<String>>):
    required: false
    

    A list of cache node IDs to be removed. A node ID is a numeric identifier (0001, 0002, etc.). This parameter is only valid when NumCacheNodes is less than the existing number of cache nodes. The number of cache node IDs supplied in this parameter must match the difference between the existing number of cache nodes in the cluster or pending cache nodes, whichever is greater, and the value of NumCacheNodes in the request.

    For example: If you have 3 active cache nodes, 7 pending cache nodes, and the number of cache nodes in this ModifyCacheCluster call is 5, you must list 2 (7 - 5) cache node IDs to remove.

    
    
  • az_mode(AzMode) / set_az_mode(Option<AzMode>):
    required: false
    

    Specifies whether the new nodes in this Memcached cluster are all created in a single Availability Zone or created across multiple Availability Zones.

    Valid values: single-az | cross-az.

    This option is only supported for Memcached clusters.

    You cannot specify single-az if the Memcached cluster already has cache nodes in different Availability Zones. If cross-az is specified, existing Memcached nodes remain in their current Availability Zone.

    Only newly created nodes are located in different Availability Zones.

    
    
  • new_availability_zones(impl Into<String>) / set_new_availability_zones(Option<Vec::<String>>):
    required: false
    

    This option is only supported on Memcached clusters.

    The list of Availability Zones where the new Memcached cache nodes are created.

    This parameter is only valid when NumCacheNodes in the request is greater than the sum of the number of active cache nodes and the number of cache nodes pending creation (which may be zero). The number of Availability Zones supplied in this list must match the cache nodes being added in this request.

    Scenarios:

    • Scenario 1: You have 3 active nodes and wish to add 2 nodes. Specify NumCacheNodes=5 (3 + 2) and optionally specify two Availability Zones for the two new nodes.

    • Scenario 2: You have 3 active nodes and 2 nodes pending creation (from the scenario 1 call) and want to add 1 more node. Specify NumCacheNodes=6 ((3 + 2) + 1) and optionally specify an Availability Zone for the new node.

    • Scenario 3: You want to cancel all pending operations. Specify NumCacheNodes=3 to cancel all pending operations.

    The Availability Zone placement of nodes pending creation cannot be modified. If you wish to cancel any nodes pending creation, add 0 nodes by setting NumCacheNodes to the number of current nodes.

    If cross-az is specified, existing Memcached nodes remain in their current Availability Zone. Only newly created nodes can be located in different Availability Zones. For guidance on how to move existing Memcached nodes to different Availability Zones, see the Availability Zone Considerations section of Cache Node Considerations for Memcached.

    Impact of new add/remove requests upon pending requests

    • Scenario-1

      • Pending Action: Delete

      • New Request: Delete

      • Result: The new delete, pending or immediate, replaces the pending delete.

    • Scenario-2

      • Pending Action: Delete

      • New Request: Create

      • Result: The new create, pending or immediate, replaces the pending delete.

    • Scenario-3

      • Pending Action: Create

      • New Request: Delete

      • Result: The new delete, pending or immediate, replaces the pending create.

    • Scenario-4

      • Pending Action: Create

      • New Request: Create

      • Result: The new create is added to the pending create.

        Important: If the new create request is Apply Immediately - Yes, all creates are performed immediately. If the new create request is Apply Immediately - No, all creates are pending.

    
    
  • cache_security_group_names(impl Into<String>) / set_cache_security_group_names(Option<Vec::<String>>):
    required: false
    

    A list of cache security group names to authorize on this cluster. This change is asynchronously applied as soon as possible.

    You can use this parameter only with clusters that are created outside of an Amazon Virtual Private Cloud (Amazon VPC).

    Constraints: Must contain no more than 255 alphanumeric characters. Must not be “Default”.

    
    
  • security_group_ids(impl Into<String>) / set_security_group_ids(Option<Vec::<String>>):
    required: false
    

    Specifies the VPC Security Groups associated with the cluster.

    This parameter can be used only with clusters that are created in an Amazon Virtual Private Cloud (Amazon VPC).

    
    
  • preferred_maintenance_window(impl Into<String>) / set_preferred_maintenance_window(Option<String>):
    required: false
    

    Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period.

    Valid values for ddd are:

    • sun

    • mon

    • tue

    • wed

    • thu

    • fri

    • sat

    Example: sun:23:00-mon:01:30

    
    
  • notification_topic_arn(impl Into<String>) / set_notification_topic_arn(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications are sent.

    The Amazon SNS topic owner must be same as the cluster owner.

    
    
  • cache_parameter_group_name(impl Into<String>) / set_cache_parameter_group_name(Option<String>):
    required: false
    

    The name of the cache parameter group to apply to this cluster. This change is asynchronously applied as soon as possible for parameters when the ApplyImmediately parameter is specified as true for this request.

    
    
  • notification_topic_status(impl Into<String>) / set_notification_topic_status(Option<String>):
    required: false
    

    The status of the Amazon SNS notification topic. Notifications are sent only if the status is active.

    Valid values: active | inactive

    
    
  • apply_immediately(bool) / set_apply_immediately(Option<bool>):
    required: false
    

    If true, this parameter causes the modifications in this request and any pending modifications to be applied, asynchronously and as soon as possible, regardless of the PreferredMaintenanceWindow setting for the cluster.

    If false, changes to the cluster are applied on the next maintenance reboot, or the next failure reboot, whichever occurs first.

    If you perform a ModifyCacheCluster before a pending modification is applied, the pending modification is replaced by the newer modification.

    Valid values: true | false

    Default: false

    
    
  • engine_version(impl Into<String>) / set_engine_version(Option<String>):
    required: false
    

    The upgraded version of the cache engine to be run on the cache nodes.

    Important: You can upgrade to a newer engine version (see Selecting a Cache Engine and Version), but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing cluster and create it anew with the earlier engine version.

    
    
  • auto_minor_version_upgrade(bool) / set_auto_minor_version_upgrade(Option<bool>):
    required: false
    

     If you are running Redis engine version 6.0 or later, set this parameter to yes if you want to opt-in to the next auto minor version upgrade campaign. This parameter is disabled for previous versions. 

    
    
  • snapshot_retention_limit(i32) / set_snapshot_retention_limit(Option<i32>):
    required: false
    

    The number of days for which ElastiCache retains automatic cluster snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.

    If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.

    
    
  • snapshot_window(impl Into<String>) / set_snapshot_window(Option<String>):
    required: false
    

    The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your cluster.

    
    
  • cache_node_type(impl Into<String>) / set_cache_node_type(Option<String>):
    required: false
    

    A valid cache node type that you want to scale this cluster up to.

    
    
  • auth_token(impl Into<String>) / set_auth_token(Option<String>):
    required: false
    

    Reserved parameter. The password used to access a password protected server. This parameter must be specified with the auth-token-update parameter. Password constraints:

    • Must be only printable ASCII characters

    • Must be at least 16 characters and no more than 128 characters in length

    • Cannot contain any of the following characters: ‘/’, ‘“’, or ‘@’, ‘%’

    For more information, see AUTH password at AUTH.

    
    
  • auth_token_update_strategy(AuthTokenUpdateStrategyType) / set_auth_token_update_strategy(Option<AuthTokenUpdateStrategyType>):
    required: false
    

    Specifies the strategy to use to update the AUTH token. This parameter must be specified with the auth-token parameter. Possible values:

    • Rotate

    • Set

    For more information, see Authenticating Users with Redis AUTH

    
    
  • log_delivery_configurations(LogDeliveryConfigurationRequest) / set_log_delivery_configurations(Option<Vec::<LogDeliveryConfigurationRequest>>):
    required: false
    

    Specifies the destination, format and type of the logs.

    
    
  • ip_discovery(IpDiscovery) / set_ip_discovery(Option<IpDiscovery>):
    required: false
    

    The network type you choose when modifying a cluster, either ipv4 | ipv6. IPv6 is supported for workloads using Redis engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the Nitro system.

    
    
• On success, responds with ModifyCacheClusterOutput with field(s):
  • cache_cluster(Option<CacheCluster>):

    Contains all of the attributes of a specific cluster.

• On failure, responds with SdkError<ModifyCacheClusterError>

impl Client

pub fn modify_cache_parameter_group( &self ) -> ModifyCacheParameterGroupFluentBuilder

Constructs a fluent builder for the ModifyCacheParameterGroup operation.

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

    The name of the cache parameter group to modify.

    
    
  • parameter_name_values(ParameterNameValue) / set_parameter_name_values(Option<Vec::<ParameterNameValue>>):
    required: true
    

    An array of parameter names and values for the parameter update. You must supply at least one parameter name and value; subsequent arguments are optional. A maximum of 20 parameters may be modified per request.

    
    
• On success, responds with ModifyCacheParameterGroupOutput with field(s):
  • cache_parameter_group_name(Option<String>):

    The name of the cache parameter group.

• On failure, responds with SdkError<ModifyCacheParameterGroupError>

impl Client

pub fn modify_cache_subnet_group(&self) -> ModifyCacheSubnetGroupFluentBuilder

Constructs a fluent builder for the ModifyCacheSubnetGroup operation.

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

    The name for the cache subnet group. This value is stored as a lowercase string.

    Constraints: Must contain no more than 255 alphanumeric characters or hyphens.

    Example: mysubnetgroup

    
    
  • cache_subnet_group_description(impl Into<String>) / set_cache_subnet_group_description(Option<String>):
    required: false
    

    A description of the cache subnet group.

    
    
  • subnet_ids(impl Into<String>) / set_subnet_ids(Option<Vec::<String>>):
    required: false
    

    The EC2 subnet IDs for the cache subnet group.

    
    
• On success, responds with ModifyCacheSubnetGroupOutput with field(s):
  • cache_subnet_group(Option<CacheSubnetGroup>):

    Represents the output of one of the following operations:

    • CreateCacheSubnetGroup

    • ModifyCacheSubnetGroup

• On failure, responds with SdkError<ModifyCacheSubnetGroupError>

impl Client

pub fn modify_global_replication_group( &self ) -> ModifyGlobalReplicationGroupFluentBuilder

Constructs a fluent builder for the ModifyGlobalReplicationGroup operation.

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

    The name of the Global datastore

    
    
  • apply_immediately(bool) / set_apply_immediately(Option<bool>):
    required: true
    

    This parameter causes the modifications in this request and any pending modifications to be applied, asynchronously and as soon as possible. Modifications to Global Replication Groups cannot be requested to be applied in PreferredMaintenceWindow.

    
    
  • cache_node_type(impl Into<String>) / set_cache_node_type(Option<String>):
    required: false
    

    A valid cache node type that you want to scale this Global datastore to.

    
    
  • engine_version(impl Into<String>) / set_engine_version(Option<String>):
    required: false
    

    The upgraded version of the cache engine to be run on the clusters in the Global datastore.

    
    
  • cache_parameter_group_name(impl Into<String>) / set_cache_parameter_group_name(Option<String>):
    required: false
    

    The name of the cache parameter group to use with the Global datastore. It must be compatible with the major engine version used by the Global datastore.

    
    
  • global_replication_group_description(impl Into<String>) / set_global_replication_group_description(Option<String>):
    required: false
    

    A description of the Global datastore

    
    
  • automatic_failover_enabled(bool) / set_automatic_failover_enabled(Option<bool>):
    required: false
    

    Determines whether a read replica is automatically promoted to read/write primary if the existing primary encounters a failure.

    
    
• On success, responds with ModifyGlobalReplicationGroupOutput with field(s):
  • global_replication_group(Option<GlobalReplicationGroup>):

    Consists of a primary cluster that accepts writes and an associated secondary cluster that resides in a different Amazon region. The secondary cluster accepts only reads. The primary cluster automatically replicates updates to the secondary cluster.

    • The GlobalReplicationGroupIdSuffix represents the name of the Global datastore, which is what you use to associate a secondary cluster.

• On failure, responds with SdkError<ModifyGlobalReplicationGroupError>

impl Client

pub fn modify_replication_group(&self) -> ModifyReplicationGroupFluentBuilder

Constructs a fluent builder for the ModifyReplicationGroup operation.

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

    The identifier of the replication group to modify.

    
    
  • replication_group_description(impl Into<String>) / set_replication_group_description(Option<String>):
    required: false
    

    A description for the replication group. Maximum length is 255 characters.

    
    
  • primary_cluster_id(impl Into<String>) / set_primary_cluster_id(Option<String>):
    required: false
    

    For replication groups with a single primary, if this parameter is specified, ElastiCache promotes the specified cluster in the specified replication group to the primary role. The nodes of all other clusters in the replication group are read replicas.

    
    
  • snapshotting_cluster_id(impl Into<String>) / set_snapshotting_cluster_id(Option<String>):
    required: false
    

    The cluster ID that is used as the daily snapshot source for the replication group. This parameter cannot be set for Redis (cluster mode enabled) replication groups.

    
    
  • automatic_failover_enabled(bool) / set_automatic_failover_enabled(Option<bool>):
    required: false
    

    Determines whether a read replica is automatically promoted to read/write primary if the existing primary encounters a failure.

    Valid values: true | false

    
    
  • multi_az_enabled(bool) / set_multi_az_enabled(Option<bool>):
    required: false
    

    A flag to indicate MultiAZ is enabled.

    
    
  • node_group_id(impl Into<String>) / set_node_group_id(Option<String>):
    required: false
    

    Deprecated. This parameter is not used.

    
    
  • cache_security_group_names(impl Into<String>) / set_cache_security_group_names(Option<Vec::<String>>):
    required: false
    

    A list of cache security group names to authorize for the clusters in this replication group. This change is asynchronously applied as soon as possible.

    This parameter can be used only with replication group containing clusters running outside of an Amazon Virtual Private Cloud (Amazon VPC).

    Constraints: Must contain no more than 255 alphanumeric characters. Must not be Default.

    
    
  • security_group_ids(impl Into<String>) / set_security_group_ids(Option<Vec::<String>>):
    required: false
    

    Specifies the VPC Security Groups associated with the clusters in the replication group.

    This parameter can be used only with replication group containing clusters running in an Amazon Virtual Private Cloud (Amazon VPC).

    
    
  • preferred_maintenance_window(impl Into<String>) / set_preferred_maintenance_window(Option<String>):
    required: false
    

    Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period.

    Valid values for ddd are:

    • sun

    • mon

    • tue

    • wed

    • thu

    • fri

    • sat

    Example: sun:23:00-mon:01:30

    
    
  • notification_topic_arn(impl Into<String>) / set_notification_topic_arn(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications are sent.

    The Amazon SNS topic owner must be same as the replication group owner.

    
    
  • cache_parameter_group_name(impl Into<String>) / set_cache_parameter_group_name(Option<String>):
    required: false
    

    The name of the cache parameter group to apply to all of the clusters in this replication group. This change is asynchronously applied as soon as possible for parameters when the ApplyImmediately parameter is specified as true for this request.

    
    
  • notification_topic_status(impl Into<String>) / set_notification_topic_status(Option<String>):
    required: false
    

    The status of the Amazon SNS notification topic for the replication group. Notifications are sent only if the status is active.

    Valid values: active | inactive

    
    
  • apply_immediately(bool) / set_apply_immediately(Option<bool>):
    required: false
    

    If true, this parameter causes the modifications in this request and any pending modifications to be applied, asynchronously and as soon as possible, regardless of the PreferredMaintenanceWindow setting for the replication group.

    If false, changes to the nodes in the replication group are applied on the next maintenance reboot, or the next failure reboot, whichever occurs first.

    Valid values: true | false

    Default: false

    
    
  • engine_version(impl Into<String>) / set_engine_version(Option<String>):
    required: false
    

    The upgraded version of the cache engine to be run on the clusters in the replication group.

    Important: You can upgrade to a newer engine version (see Selecting a Cache Engine and Version), but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing replication group and create it anew with the earlier engine version.

    
    
  • auto_minor_version_upgrade(bool) / set_auto_minor_version_upgrade(Option<bool>):
    required: false
    

     If you are running Redis engine version 6.0 or later, set this parameter to yes if you want to opt-in to the next auto minor version upgrade campaign. This parameter is disabled for previous versions. 

    
    
  • snapshot_retention_limit(i32) / set_snapshot_retention_limit(Option<i32>):
    required: false
    

    The number of days for which ElastiCache retains automatic node group (shard) snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.

    Important If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.

    
    
  • snapshot_window(impl Into<String>) / set_snapshot_window(Option<String>):
    required: false
    

    The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of the node group (shard) specified by SnapshottingClusterId.

    Example: 05:00-09:00

    If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.

    
    
  • cache_node_type(impl Into<String>) / set_cache_node_type(Option<String>):
    required: false
    

    A valid cache node type that you want to scale this replication group to.

    
    
  • auth_token(impl Into<String>) / set_auth_token(Option<String>):
    required: false
    

    Reserved parameter. The password used to access a password protected server. This parameter must be specified with the auth-token-update-strategy parameter. Password constraints:

    • Must be only printable ASCII characters

    • Must be at least 16 characters and no more than 128 characters in length

    • Cannot contain any of the following characters: ‘/’, ‘“’, or ‘@’, ‘%’

    For more information, see AUTH password at AUTH.

    
    
  • auth_token_update_strategy(AuthTokenUpdateStrategyType) / set_auth_token_update_strategy(Option<AuthTokenUpdateStrategyType>):
    required: false
    

    Specifies the strategy to use to update the AUTH token. This parameter must be specified with the auth-token parameter. Possible values:

    • Rotate

    • Set

    For more information, see Authenticating Users with Redis AUTH

    
    
  • user_group_ids_to_add(impl Into<String>) / set_user_group_ids_to_add(Option<Vec::<String>>):
    required: false
    

    The ID of the user group you are associating with the replication group.

    
    
  • user_group_ids_to_remove(impl Into<String>) / set_user_group_ids_to_remove(Option<Vec::<String>>):
    required: false
    

    The ID of the user group to disassociate from the replication group, meaning the users in the group no longer can access the replication group.

    
    
  • remove_user_groups(bool) / set_remove_user_groups(Option<bool>):
    required: false
    

    Removes the user group associated with this replication group.

    
    
  • log_delivery_configurations(LogDeliveryConfigurationRequest) / set_log_delivery_configurations(Option<Vec::<LogDeliveryConfigurationRequest>>):
    required: false
    

    Specifies the destination, format and type of the logs.

    
    
  • ip_discovery(IpDiscovery) / set_ip_discovery(Option<IpDiscovery>):
    required: false
    

    The network type you choose when modifying a cluster, either ipv4 | ipv6. IPv6 is supported for workloads using Redis engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the Nitro system.

    
    
  • transit_encryption_enabled(bool) / set_transit_encryption_enabled(Option<bool>):
    required: false
    

    A flag that enables in-transit encryption when set to true. If you are enabling in-transit encryption for an existing cluster, you must also set TransitEncryptionMode to preferred.

    
    
  • transit_encryption_mode(TransitEncryptionMode) / set_transit_encryption_mode(Option<TransitEncryptionMode>):
    required: false
    

    A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.

    You must set TransitEncryptionEnabled to true, for your existing cluster, and set TransitEncryptionMode to preferred in the same request to allow both encrypted and unencrypted connections at the same time. Once you migrate all your Redis clients to use encrypted connections you can set the value to required to allow encrypted connections only.

    Setting TransitEncryptionMode to required is a two-step process that requires you to first set the TransitEncryptionMode to preferred, after that you can set TransitEncryptionMode to required.

    
    
  • cluster_mode(ClusterMode) / set_cluster_mode(Option<ClusterMode>):
    required: false
    

    Enabled or Disabled. To modify cluster mode from Disabled to Enabled, you must first set the cluster mode to Compatible. Compatible mode allows your Redis clients to connect using both cluster mode enabled and cluster mode disabled. After you migrate all Redis clients to use cluster mode enabled, you can then complete cluster mode configuration and set the cluster mode to Enabled.

    
    
• On success, responds with ModifyReplicationGroupOutput with field(s):
  • replication_group(Option<ReplicationGroup>):

    Contains all of the attributes of a specific Redis replication group.

• On failure, responds with SdkError<ModifyReplicationGroupError>

impl Client

pub fn modify_replication_group_shard_configuration( &self ) -> ModifyReplicationGroupShardConfigurationFluentBuilder

Constructs a fluent builder for the ModifyReplicationGroupShardConfiguration operation.

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

    The name of the Redis (cluster mode enabled) cluster (replication group) on which the shards are to be configured.

    
    
  • node_group_count(i32) / set_node_group_count(Option<i32>):
    required: true
    

    The number of node groups (shards) that results from the modification of the shard configuration.

    
    
  • apply_immediately(bool) / set_apply_immediately(Option<bool>):
    required: true
    

    Indicates that the shard reconfiguration process begins immediately. At present, the only permitted value for this parameter is true.

    Value: true

    
    
  • resharding_configuration(ReshardingConfiguration) / set_resharding_configuration(Option<Vec::<ReshardingConfiguration>>):
    required: false
    

    Specifies the preferred availability zones for each node group in the cluster. If the value of NodeGroupCount is greater than the current number of node groups (shards), you can use this parameter to specify the preferred availability zones of the cluster’s shards. If you omit this parameter ElastiCache selects availability zones for you.

    You can specify this parameter only if the value of NodeGroupCount is greater than the current number of node groups (shards).

    
    
  • node_groups_to_remove(impl Into<String>) / set_node_groups_to_remove(Option<Vec::<String>>):
    required: false
    

    If the value of NodeGroupCount is less than the current number of node groups (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required. NodeGroupsToRemove is a list of NodeGroupIds to remove from the cluster.

    ElastiCache for Redis will attempt to remove all node groups listed by NodeGroupsToRemove from the cluster.

    
    
  • node_groups_to_retain(impl Into<String>) / set_node_groups_to_retain(Option<Vec::<String>>):
    required: false
    

    If the value of NodeGroupCount is less than the current number of node groups (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required. NodeGroupsToRetain is a list of NodeGroupIds to retain in the cluster.

    ElastiCache for Redis will attempt to remove all node groups except those listed by NodeGroupsToRetain from the cluster.

    
    
• On success, responds with ModifyReplicationGroupShardConfigurationOutput with field(s):
  • replication_group(Option<ReplicationGroup>):

    Contains all of the attributes of a specific Redis replication group.

• On failure, responds with SdkError<ModifyReplicationGroupShardConfigurationError>

impl Client

pub fn modify_serverless_cache(&self) -> ModifyServerlessCacheFluentBuilder

Constructs a fluent builder for the ModifyServerlessCache operation.

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

    User-provided identifier for the serverless cache to be modified.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    User provided description for the serverless cache. Default = NULL, i.e. the existing description is not removed/modified. The description has a maximum length of 255 characters.

    
    
  • cache_usage_limits(CacheUsageLimits) / set_cache_usage_limits(Option<CacheUsageLimits>):
    required: false
    

    Modify the cache usage limit for the serverless cache.

    
    
  • remove_user_group(bool) / set_remove_user_group(Option<bool>):
    required: false
    

    The identifier of the UserGroup to be removed from association with the Redis serverless cache. Available for Redis only. Default is NULL.

    
    
  • user_group_id(impl Into<String>) / set_user_group_id(Option<String>):
    required: false
    

    The identifier of the UserGroup to be associated with the serverless cache. Available for Redis only. Default is NULL - the existing UserGroup is not removed.

    
    
  • security_group_ids(impl Into<String>) / set_security_group_ids(Option<Vec::<String>>):
    required: false
    

    The new list of VPC security groups to be associated with the serverless cache. Populating this list means the current VPC security groups will be removed. This security group is used to authorize traffic access for the VPC end-point (private-link). Default = NULL - the existing list of VPC security groups is not removed.

    
    
  • snapshot_retention_limit(i32) / set_snapshot_retention_limit(Option<i32>):
    required: false
    

    The number of days for which Elasticache retains automatic snapshots before deleting them. Available for Redis only. Default = NULL, i.e. the existing snapshot-retention-limit will not be removed or modified. The maximum value allowed is 35 days.

    
    
  • daily_snapshot_time(impl Into<String>) / set_daily_snapshot_time(Option<String>):
    required: false
    

    The daily time during which Elasticache begins taking a daily snapshot of the serverless cache. Available for Redis only. The default is NULL, i.e. the existing snapshot time configured for the cluster is not removed.

    
    
• On success, responds with ModifyServerlessCacheOutput with field(s):
  • serverless_cache(Option<ServerlessCache>):

    The response for the attempt to modify the serverless cache.

• On failure, responds with SdkError<ModifyServerlessCacheError>

impl Client

pub fn modify_user(&self) -> ModifyUserFluentBuilder

Constructs a fluent builder for the ModifyUser operation.

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

    The ID of the user.

    
    
  • access_string(impl Into<String>) / set_access_string(Option<String>):
    required: false
    

    Access permissions string used for this user.

    
    
  • append_access_string(impl Into<String>) / set_append_access_string(Option<String>):
    required: false
    

    Adds additional user permissions to the access string.

    
    
  • passwords(impl Into<String>) / set_passwords(Option<Vec::<String>>):
    required: false
    

    The passwords belonging to the user. You are allowed up to two.

    
    
  • no_password_required(bool) / set_no_password_required(Option<bool>):
    required: false
    

    Indicates no password is required for the user.

    
    
  • authentication_mode(AuthenticationMode) / set_authentication_mode(Option<AuthenticationMode>):
    required: false
    

    Specifies how to authenticate the user.

    
    
• On success, responds with ModifyUserOutput with field(s):
  • user_id(Option<String>):

    The ID of the user.

  • user_name(Option<String>):

    The username of the user.

  • status(Option<String>):

    Indicates the user status. Can be “active”, “modifying” or “deleting”.

  • engine(Option<String>):

    The current supported value is Redis.

  • minimum_engine_version(Option<String>):

    The minimum engine version required, which is Redis 6.0

  • access_string(Option<String>):

    Access permissions string used for this user.

  • user_group_ids(Option<Vec::<String>>):

    Returns a list of the user group IDs the user belongs to.

  • authentication(Option<Authentication>):

    Denotes whether the user requires a password to authenticate.

  • arn(Option<String>):

    The Amazon Resource Name (ARN) of the user.

• On failure, responds with SdkError<ModifyUserError>

impl Client

pub fn modify_user_group(&self) -> ModifyUserGroupFluentBuilder

Constructs a fluent builder for the ModifyUserGroup operation.

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

    The ID of the user group.

    
    
  • user_ids_to_add(impl Into<String>) / set_user_ids_to_add(Option<Vec::<String>>):
    required: false
    

    The list of user IDs to add to the user group.

    
    
  • user_ids_to_remove(impl Into<String>) / set_user_ids_to_remove(Option<Vec::<String>>):
    required: false
    

    The list of user IDs to remove from the user group.

    
    
• On success, responds with ModifyUserGroupOutput with field(s):
  • user_group_id(Option<String>):

    The ID of the user group.

  • status(Option<String>):

    Indicates user group status. Can be “creating”, “active”, “modifying”, “deleting”.

  • engine(Option<String>):

    The current supported value is Redis.

  • user_ids(Option<Vec::<String>>):

    The list of user IDs that belong to the user group.

  • minimum_engine_version(Option<String>):

    The minimum engine version required, which is Redis 6.0

  • pending_changes(Option<UserGroupPendingChanges>):

    A list of updates being applied to the user group.

  • replication_groups(Option<Vec::<String>>):

    A list of replication groups that the user group can access.

  • serverless_caches(Option<Vec::<String>>):

    Indicates which serverless caches the specified user group is associated with. Available for Redis only.

  • arn(Option<String>):

    The Amazon Resource Name (ARN) of the user group.

• On failure, responds with SdkError<ModifyUserGroupError>

impl Client

pub fn purchase_reserved_cache_nodes_offering( &self ) -> PurchaseReservedCacheNodesOfferingFluentBuilder

Constructs a fluent builder for the PurchaseReservedCacheNodesOffering operation.

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

    The ID of the reserved cache node offering to purchase.

    Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706

    
    
  • reserved_cache_node_id(impl Into<String>) / set_reserved_cache_node_id(Option<String>):
    required: false
    

    A customer-specified identifier to track this reservation.

    The Reserved Cache Node ID is an unique customer-specified identifier to track this reservation. If this parameter is not specified, ElastiCache automatically generates an identifier for the reservation.

    Example: myreservationID

    
    
  • cache_node_count(i32) / set_cache_node_count(Option<i32>):
    required: false
    

    The number of cache node instances to reserve.

    Default: 1

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.

    
    
• On success, responds with PurchaseReservedCacheNodesOfferingOutput with field(s):
  • reserved_cache_node(Option<ReservedCacheNode>):

    Represents the output of a PurchaseReservedCacheNodesOffering operation.

• On failure, responds with SdkError<PurchaseReservedCacheNodesOfferingError>

impl Client

pub fn rebalance_slots_in_global_replication_group( &self ) -> RebalanceSlotsInGlobalReplicationGroupFluentBuilder

Constructs a fluent builder for the RebalanceSlotsInGlobalReplicationGroup operation.

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

    The name of the Global datastore

    
    
  • apply_immediately(bool) / set_apply_immediately(Option<bool>):
    required: true
    

    If True, redistribution is applied immediately.

    
    
• On success, responds with RebalanceSlotsInGlobalReplicationGroupOutput with field(s):
  • global_replication_group(Option<GlobalReplicationGroup>):

    Consists of a primary cluster that accepts writes and an associated secondary cluster that resides in a different Amazon region. The secondary cluster accepts only reads. The primary cluster automatically replicates updates to the secondary cluster.

    • The GlobalReplicationGroupIdSuffix represents the name of the Global datastore, which is what you use to associate a secondary cluster.

• On failure, responds with SdkError<RebalanceSlotsInGlobalReplicationGroupError>

impl Client

pub fn reboot_cache_cluster(&self) -> RebootCacheClusterFluentBuilder

Constructs a fluent builder for the RebootCacheCluster operation.

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

    The cluster identifier. This parameter is stored as a lowercase string.

    
    
  • cache_node_ids_to_reboot(impl Into<String>) / set_cache_node_ids_to_reboot(Option<Vec::<String>>):
    required: true
    

    A list of cache node IDs to reboot. A node ID is a numeric identifier (0001, 0002, etc.). To reboot an entire cluster, specify all of the cache node IDs.

    
    
• On success, responds with RebootCacheClusterOutput with field(s):
  • cache_cluster(Option<CacheCluster>):

    Contains all of the attributes of a specific cluster.

• On failure, responds with SdkError<RebootCacheClusterError>

impl Client

pub fn remove_tags_from_resource(&self) -> RemoveTagsFromResourceFluentBuilder

Constructs a fluent builder for the RemoveTagsFromResource operation.

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

    The Amazon Resource Name (ARN) of the resource from which you want the tags removed, for example arn:aws:elasticache:us-west-2:0123456789:cluster:myCluster or arn:aws:elasticache:us-west-2:0123456789:snapshot:mySnapshot.

    For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Service Namespaces.

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

    A list of TagKeys identifying the tags you want removed from the named resource.

    
    
• On success, responds with RemoveTagsFromResourceOutput with field(s):
  • tag_list(Option<Vec::<Tag>>):

    A list of tags as key-value pairs.

• On failure, responds with SdkError<RemoveTagsFromResourceError>

impl Client

pub fn reset_cache_parameter_group( &self ) -> ResetCacheParameterGroupFluentBuilder

Constructs a fluent builder for the ResetCacheParameterGroup operation.

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

    The name of the cache parameter group to reset.

    
    
  • reset_all_parameters(bool) / set_reset_all_parameters(Option<bool>):
    required: false
    

    If true, all parameters in the cache parameter group are reset to their default values. If false, only the parameters listed by ParameterNameValues are reset to their default values.

    Valid values: true | false

    
    
  • parameter_name_values(ParameterNameValue) / set_parameter_name_values(Option<Vec::<ParameterNameValue>>):
    required: false
    

    An array of parameter names to reset to their default values. If ResetAllParameters is true, do not use ParameterNameValues. If ResetAllParameters is false, you must specify the name of at least one parameter to reset.

    
    
• On success, responds with ResetCacheParameterGroupOutput with field(s):
  • cache_parameter_group_name(Option<String>):

    The name of the cache parameter group.

• On failure, responds with SdkError<ResetCacheParameterGroupError>

impl Client

pub fn revoke_cache_security_group_ingress( &self ) -> RevokeCacheSecurityGroupIngressFluentBuilder

Constructs a fluent builder for the RevokeCacheSecurityGroupIngress operation.

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

    The name of the cache security group to revoke ingress from.

    
    
  • ec2_security_group_name(impl Into<String>) / set_ec2_security_group_name(Option<String>):
    required: true
    

    The name of the Amazon EC2 security group to revoke access from.

    
    
  • ec2_security_group_owner_id(impl Into<String>) / set_ec2_security_group_owner_id(Option<String>):
    required: true
    

    The Amazon account number of the Amazon EC2 security group owner. Note that this is not the same thing as an Amazon access key ID - you must provide a valid Amazon account number for this parameter.

    
    
• On success, responds with RevokeCacheSecurityGroupIngressOutput with field(s):
  • cache_security_group(Option<CacheSecurityGroup>):

    Represents the output of one of the following operations:

    • AuthorizeCacheSecurityGroupIngress

    • CreateCacheSecurityGroup

    • RevokeCacheSecurityGroupIngress

• On failure, responds with SdkError<RevokeCacheSecurityGroupIngressError>

impl Client

pub fn start_migration(&self) -> StartMigrationFluentBuilder

Constructs a fluent builder for the StartMigration operation.

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

    The ID of the replication group to which data should be migrated.

    
    
  • customer_node_endpoint_list(CustomerNodeEndpoint) / set_customer_node_endpoint_list(Option<Vec::<CustomerNodeEndpoint>>):
    required: true
    

    List of endpoints from which data should be migrated. For Redis (cluster mode disabled), list should have only one element.

    
    
• On success, responds with StartMigrationOutput with field(s):
  • replication_group(Option<ReplicationGroup>):

    Contains all of the attributes of a specific Redis replication group.

• On failure, responds with SdkError<StartMigrationError>

impl Client

pub fn test_failover(&self) -> TestFailoverFluentBuilder

Constructs a fluent builder for the TestFailover operation.

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

    The name of the replication group (console: cluster) whose automatic failover is being tested by this operation.

    
    
  • node_group_id(impl Into<String>) / set_node_group_id(Option<String>):
    required: true
    

    The name of the node group (called shard in the console) in this replication group on which automatic failover is to be tested. You may test automatic failover on up to 5 node groups in any rolling 24-hour period.

    
    
• On success, responds with TestFailoverOutput with field(s):
  • replication_group(Option<ReplicationGroup>):

    Contains all of the attributes of a specific Redis replication group.

• On failure, responds with SdkError<TestFailoverError>

impl Client

pub fn test_migration(&self) -> TestMigrationFluentBuilder

Constructs a fluent builder for the TestMigration operation.

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

    The ID of the replication group to which data is to be migrated.

    
    
  • customer_node_endpoint_list(CustomerNodeEndpoint) / set_customer_node_endpoint_list(Option<Vec::<CustomerNodeEndpoint>>):
    required: true
    

    List of endpoints from which data should be migrated. List should have only one element.

    
    
• On success, responds with TestMigrationOutput with field(s):
  • replication_group(Option<ReplicationGroup>):

    Contains all of the attributes of a specific Redis replication group.

• On failure, responds with SdkError<TestMigrationError>

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 copy 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.