Struct aws_sdk_elasticache::Client

source · 
pub struct Client { /* private fields */ }
Expand description

Client for Amazon ElastiCache

Client for invoking operations on Amazon ElastiCache. Each operation on Amazon ElastiCache is a method on this this struct. .send() MUST be invoked on the generated operations to dispatch the request to the service.

Examples

Constructing a client and invoking an operation

    // create a shared configuration. This can be used & shared between multiple service clients.
    let shared_config = aws_config::load_from_env().await;
    let client = aws_sdk_elasticache::Client::new(&shared_config);
    // invoke an operation
    /* let rsp = client
        .<operation_name>().
        .<param>("some value")
        .send().await; */

Constructing a client with custom configuration

use aws_config::retry::RetryConfig;
let shared_config = aws_config::load_from_env().await;
let config = aws_sdk_elasticache::config::Builder::from(&shared_config)
  .retry_config(RetryConfig::disabled())
  .build();
let client = aws_sdk_elasticache::Client::from_conf(config);

Implementations§

Creates a client with the given service configuration.

Examples found in repository?
src/client.rs (line 70)
64
65
66
67
68
69
70
71

    fn from(
        client: aws_smithy_client::Client<
            aws_smithy_client::erase::DynConnector,
            aws_smithy_client::erase::DynMiddleware<aws_smithy_client::erase::DynConnector>,
        >,
    ) -> Self {
        Self::with_config(client, crate::Config::builder().build())
    }

Returns the client’s configuration.

Constructs a fluent builder for the AddTagsToResource operation.

Constructs a fluent builder for the AuthorizeCacheSecurityGroupIngress operation.

Constructs a fluent builder for the BatchApplyUpdateAction operation.

Constructs a fluent builder for the BatchStopUpdateAction operation.

Constructs a fluent builder for the CompleteMigration operation.

Constructs a fluent builder for the CopySnapshot operation.

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>):

      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>):

      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>):

      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>):

      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(Vec<String>) / set_preferred_availability_zones(Option<Vec<String>>):

      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>):

      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>):

      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:

          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

          For region availability, see Supported Node Types

          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:

          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

          For region availability, see Supported Node Types

          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>):

      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>):

      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>):

      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>):

      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(Vec<String>) / set_cache_security_group_names(Option<Vec<String>>):

      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(Vec<String>) / set_security_group_ids(Option<Vec<String>>):

      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(Vec<Tag>) / set_tags(Option<Vec<Tag>>):

      A list of tags to be added to this resource.

    • snapshot_arns(Vec<String>) / set_snapshot_arns(Option<Vec<String>>):

      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>):

      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>):

      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>):

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

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

      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>):

       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>):

      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>):

      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>):

      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>):

      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>):

      The outpost ARN in which the cache cluster is created.

    • preferred_outpost_arns(Vec<String>) / set_preferred_outpost_arns(Option<Vec<String>>):

      The outpost ARNs in which the cache cluster is created.

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

      Specifies the destination, format and type of the logs.

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

      A flag that enables in-transit encryption when set to true. You cannot modify the value of TransitEncryptionEnabled after the cluster is created. To enable in-transit encryption on a cluster you must set TransitEncryptionEnabled to true when you create a cluster.

      Required: Only available when creating a cache cluster in an Amazon VPC using Memcached version 1.6.12 or later.

  • On success, responds with CreateCacheClusterOutput with field(s):
  • On failure, responds with SdkError<CreateCacheClusterError>

Constructs a fluent builder for the CreateCacheParameterGroup operation.

Constructs a fluent builder for the CreateCacheSecurityGroup operation.

Constructs a fluent builder for the CreateCacheSubnetGroup operation.

Constructs a fluent builder for the CreateGlobalReplicationGroup operation.

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>):

      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>):

      A user-created description for the replication group.

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

      The name of the Global datastore

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

      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>):

      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>):

      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>):

      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_a_zs(Vec<String>) / set_preferred_cache_cluster_a_zs(Option<Vec<String>>):

      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>):

      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>):

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

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

      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>):

      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:

          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

          For region availability, see Supported Node Types

          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 with data tiering:

        • Current generation:

          R6gd node types (available only for Redis engine version 6.2 onward).

          cache.r6gd.xlarge, cache.r6gd.2xlarge, cache.r6gd.4xlarge, cache.r6gd.8xlarge, cache.r6gd.12xlarge, cache.r6gd.16xlarge

      • Memory optimized:

        • Current generation:

          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

          For region availability, see Supported Node Types

          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>):

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

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

      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>):

      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>):

      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(Vec<String>) / set_cache_security_group_names(Option<Vec<String>>):

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

    • security_group_ids(Vec<String>) / set_security_group_ids(Option<Vec<String>>):

      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(Vec<Tag>) / set_tags(Option<Vec<Tag>>):

      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(Vec<String>) / set_snapshot_arns(Option<Vec<String>>):

      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>):

      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>):

      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:

      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>):

      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>):

      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>):

       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>):

      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>):

      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>):

      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>):

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

      You cannot modify the value of TransitEncryptionEnabled after the cluster is created. To enable in-transit encryption on a cluster you must set TransitEncryptionEnabled to true when you create a cluster.

      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>):

      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>):

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

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

      The user group to associate with the replication group.

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

      Specifies the destination, format and type of the logs.

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

      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.

  • On success, responds with CreateReplicationGroupOutput with field(s):
  • On failure, responds with SdkError<CreateReplicationGroupError>

Constructs a fluent builder for the CreateSnapshot operation.

Constructs a fluent builder for the CreateUser operation.

Constructs a fluent builder for the CreateUserGroup operation.

Constructs a fluent builder for the DecreaseNodeGroupsInGlobalReplicationGroup operation.

Constructs a fluent builder for the DecreaseReplicaCount operation.

Constructs a fluent builder for the DeleteCacheCluster operation.

Constructs a fluent builder for the DeleteCacheParameterGroup operation.

Constructs a fluent builder for the DeleteCacheSecurityGroup operation.

Constructs a fluent builder for the DeleteCacheSubnetGroup operation.

Constructs a fluent builder for the DeleteGlobalReplicationGroup operation.

Constructs a fluent builder for the DeleteReplicationGroup operation.

Constructs a fluent builder for the DeleteSnapshot operation.

Constructs a fluent builder for the DeleteUser operation.

Constructs a fluent builder for the DeleteUserGroup operation.

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

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

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

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

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

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

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

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

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

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

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>):

      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>):

      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>):

      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:

          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

          For region availability, see Supported Node Types

          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 for 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 with data tiering:

        • Current generation:

          R6gd node types (available only for Redis engine version 6.2 onward).

          cache.r6gd.xlarge, cache.r6gd.2xlarge, cache.r6gd.4xlarge, cache.r6gd.8xlarge, cache.r6gd.12xlarge, cache.r6gd.16xlarge

      • Memory optimized:

        • Current generation:

          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

          For region availability, see Supported Node Types

          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>):

      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>):

      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>):

      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>):

      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>):

      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):
  • On failure, responds with SdkError<DescribeReservedCacheNodesError>

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>):

      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>):

      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:

          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

          For region availability, see Supported Node Types

          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 for 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 with data tiering:

        • Current generation:

          R6gd node types (available only for Redis engine version 6.2 onward).

          cache.r6gd.xlarge, cache.r6gd.2xlarge, cache.r6gd.4xlarge, cache.r6gd.8xlarge, cache.r6gd.12xlarge, cache.r6gd.16xlarge

      • Memory optimized:

        • Current generation:

          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

          For region availability, see Supported Node Types

          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>):

      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>):

      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>):

      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>):

      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>):

      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):
  • On failure, responds with SdkError<DescribeReservedCacheNodesOfferingsError>

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

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

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

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

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

Constructs a fluent builder for the DisassociateGlobalReplicationGroup operation.

Constructs a fluent builder for the FailoverGlobalReplicationGroup operation.

Constructs a fluent builder for the IncreaseNodeGroupsInGlobalReplicationGroup operation.

Constructs a fluent builder for the IncreaseReplicaCount operation.

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>):

      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>):

      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>

Constructs a fluent builder for the ListTagsForResource operation.

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>):

      The cluster identifier. This value is stored as a lowercase string.

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

      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(Vec<String>) / set_cache_node_ids_to_remove(Option<Vec<String>>):

      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>):

      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(Vec<String>) / set_new_availability_zones(Option<Vec<String>>):

      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(Vec<String>) / set_cache_security_group_names(Option<Vec<String>>):

      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(Vec<String>) / set_security_group_ids(Option<Vec<String>>):

      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>):

      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>):

      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>):

      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>):

      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(bool):

      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>):

      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>):

       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>):

      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>):

      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>):

      A valid cache node type that you want to scale this cluster up to.

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

      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>):

      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(Vec<LogDeliveryConfigurationRequest>) / set_log_delivery_configurations(Option<Vec<LogDeliveryConfigurationRequest>>):

      Specifies the destination, format and type of the logs.

  • On success, responds with ModifyCacheClusterOutput with field(s):
  • On failure, responds with SdkError<ModifyCacheClusterError>

Constructs a fluent builder for the ModifyCacheParameterGroup operation.

Constructs a fluent builder for the ModifyCacheSubnetGroup operation.

Constructs a fluent builder for the ModifyGlobalReplicationGroup operation.

Constructs a fluent builder for the ModifyReplicationGroup operation.

Constructs a fluent builder for the ModifyReplicationGroupShardConfiguration operation.

Constructs a fluent builder for the ModifyUser operation.

Constructs a fluent builder for the ModifyUserGroup operation.

Constructs a fluent builder for the PurchaseReservedCacheNodesOffering operation.

Constructs a fluent builder for the RebalanceSlotsInGlobalReplicationGroup operation.

Constructs a fluent builder for the RebootCacheCluster operation.

Constructs a fluent builder for the RemoveTagsFromResource operation.

Constructs a fluent builder for the ResetCacheParameterGroup operation.

Constructs a fluent builder for the RevokeCacheSecurityGroupIngress operation.

Constructs a fluent builder for the StartMigration operation.

Constructs a fluent builder for the TestFailover operation.

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.

Creates a new client from the service Config.

Panics
  • This method will panic if the conf 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 conf is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.
Examples found in repository?
src/client.rs (line 10707)
10706
10707
10708

    pub fn new(sdk_config: &aws_types::sdk_config::SdkConfig) -> Self {
        Self::from_conf(sdk_config.into())
    }

Trait Implementations§

Returns a copy of the value. Read more
Performs copy-assignment from source. Read more
Formats the value using the given formatter. Read more
Converts to this type from the input type.

Auto Trait Implementations§

Blanket Implementations§

Gets the TypeId of self. Read more
Immutably borrows from an owned value. Read more
Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Should always be Self
The resulting type after obtaining ownership.
Creates owned data from borrowed data, usually by cloning. Read more
Uses borrowed data to replace owned data, usually by cloning. Read more
The type returned in the event of a conversion error.
Performs the conversion.
The type returned in the event of a conversion error.
Performs the conversion.
Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more