pub struct CreateReplicationGroup { /* private fields */ }
Expand description
Fluent builder constructing a request to CreateReplicationGroup
.
Creates a Redis (cluster mode disabled) or a Redis (cluster mode enabled) replication group.
This API can be used to create a standalone regional replication group or a secondary replication group associated with a Global datastore.
A Redis (cluster mode disabled) replication group is a collection of clusters, where one of the clusters is a read/write primary and the others are read-only replicas. Writes to the primary are asynchronously propagated to the replicas.
A Redis cluster-mode enabled cluster is comprised of from 1 to 90 shards (API/CLI: node groups). Each shard has a primary node and up to 5 read-only replica nodes. The configuration can range from 90 shards and 0 replicas to 15 shards and 5 replicas, which is the maximum number or replicas allowed.
The node or shard limit can be increased to a maximum of 500 per cluster if the Redis engine version is 5.0.6 or higher. For example, you can choose to configure a 500 node cluster that ranges between 83 shards (one primary and 5 replicas per shard) and 500 shards (single primary and no replicas). Make sure there are enough available IP addresses to accommodate the increase. Common pitfalls include the subnets in the subnet group have too small a CIDR range or the subnets are shared and heavily used by other clusters. For more information, see Creating a Subnet Group. For versions below 5.0.6, the limit is 250 per cluster.
To request a limit increase, see Amazon Service Limits and choose the limit type Nodes per cluster per instance type.
When a Redis (cluster mode disabled) replication group has been successfully created, you can add one or more read replicas to it, up to a total of 5 read replicas. If you need to increase or decrease the number of node groups (console: shards), you can avail yourself of ElastiCache for Redis' scaling. For more information, see Scaling ElastiCache for Redis Clusters in the ElastiCache User Guide.
This operation is valid for Redis only.
Implementations§
source§impl CreateReplicationGroup
impl CreateReplicationGroup
sourcepub async fn customize(
self
) -> Result<CustomizableOperation<CreateReplicationGroup, AwsResponseRetryClassifier>, SdkError<CreateReplicationGroupError>>
pub async fn customize(
self
) -> Result<CustomizableOperation<CreateReplicationGroup, AwsResponseRetryClassifier>, SdkError<CreateReplicationGroupError>>
Consume this builder, creating a customizable operation that can be modified before being sent. The operation’s inner http::Request can be modified as well.
sourcepub async fn send(
self
) -> Result<CreateReplicationGroupOutput, SdkError<CreateReplicationGroupError>>
pub async fn send(
self
) -> Result<CreateReplicationGroupOutput, SdkError<CreateReplicationGroupError>>
Sends the request and returns the response.
If an error occurs, an SdkError
will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
sourcepub fn replication_group_id(self, input: impl Into<String>) -> Self
pub fn replication_group_id(self, input: impl Into<String>) -> Self
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.
sourcepub fn set_replication_group_id(self, input: Option<String>) -> Self
pub fn set_replication_group_id(self, input: Option<String>) -> Self
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.
sourcepub fn replication_group_description(self, input: impl Into<String>) -> Self
pub fn replication_group_description(self, input: impl Into<String>) -> Self
A user-created description for the replication group.
sourcepub fn set_replication_group_description(self, input: Option<String>) -> Self
pub fn set_replication_group_description(self, input: Option<String>) -> Self
A user-created description for the replication group.
sourcepub fn global_replication_group_id(self, input: impl Into<String>) -> Self
pub fn global_replication_group_id(self, input: impl Into<String>) -> Self
The name of the Global datastore
sourcepub fn set_global_replication_group_id(self, input: Option<String>) -> Self
pub fn set_global_replication_group_id(self, input: Option<String>) -> Self
The name of the Global datastore
sourcepub fn primary_cluster_id(self, input: impl Into<String>) -> Self
pub fn primary_cluster_id(self, input: impl Into<String>) -> Self
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.
sourcepub fn set_primary_cluster_id(self, input: Option<String>) -> Self
pub fn set_primary_cluster_id(self, input: Option<String>) -> Self
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.
sourcepub fn automatic_failover_enabled(self, input: bool) -> Self
pub fn automatic_failover_enabled(self, input: bool) -> Self
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
sourcepub fn set_automatic_failover_enabled(self, input: Option<bool>) -> Self
pub fn set_automatic_failover_enabled(self, input: Option<bool>) -> Self
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
sourcepub fn multi_az_enabled(self, input: bool) -> Self
pub fn multi_az_enabled(self, input: bool) -> Self
A flag indicating if you have Multi-AZ enabled to enhance fault tolerance. For more information, see Minimizing Downtime: Multi-AZ.
sourcepub fn set_multi_az_enabled(self, input: Option<bool>) -> Self
pub fn set_multi_az_enabled(self, input: Option<bool>) -> Self
A flag indicating if you have Multi-AZ enabled to enhance fault tolerance. For more information, see Minimizing Downtime: Multi-AZ.
sourcepub fn num_cache_clusters(self, input: i32) -> Self
pub fn num_cache_clusters(self, input: i32) -> Self
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).
sourcepub fn set_num_cache_clusters(self, input: Option<i32>) -> Self
pub fn set_num_cache_clusters(self, input: Option<i32>) -> Self
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).
sourcepub fn preferred_cache_cluster_a_zs(self, input: impl Into<String>) -> Self
pub fn preferred_cache_cluster_a_zs(self, input: impl Into<String>) -> Self
Appends an item to PreferredCacheClusterAZs
.
To override the contents of this collection use set_preferred_cache_cluster_a_zs
.
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.
sourcepub fn set_preferred_cache_cluster_a_zs(self, input: Option<Vec<String>>) -> Self
pub fn set_preferred_cache_cluster_a_zs(self, input: Option<Vec<String>>) -> Self
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.
sourcepub fn num_node_groups(self, input: i32) -> Self
pub fn num_node_groups(self, input: i32) -> Self
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
sourcepub fn set_num_node_groups(self, input: Option<i32>) -> Self
pub fn set_num_node_groups(self, input: Option<i32>) -> Self
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
sourcepub fn replicas_per_node_group(self, input: i32) -> Self
pub fn replicas_per_node_group(self, input: i32) -> Self
An optional parameter that specifies the number of replica nodes in each node group (shard). Valid values are 0 to 5.
sourcepub fn set_replicas_per_node_group(self, input: Option<i32>) -> Self
pub fn set_replicas_per_node_group(self, input: Option<i32>) -> Self
An optional parameter that specifies the number of replica nodes in each node group (shard). Valid values are 0 to 5.
sourcepub fn node_group_configuration(self, input: NodeGroupConfiguration) -> Self
pub fn node_group_configuration(self, input: NodeGroupConfiguration) -> Self
Appends an item to NodeGroupConfiguration
.
To override the contents of this collection use set_node_group_configuration
.
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.
sourcepub fn set_node_group_configuration(
self,
input: Option<Vec<NodeGroupConfiguration>>
) -> Self
pub fn set_node_group_configuration(
self,
input: Option<Vec<NodeGroupConfiguration>>
) -> Self
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.
sourcepub fn cache_node_type(self, input: impl Into<String>) -> Self
pub fn cache_node_type(self, input: impl Into<String>) -> Self
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
andappendfsync
are not supported on Redis version 2.8.22 and later.
sourcepub fn set_cache_node_type(self, input: Option<String>) -> Self
pub fn set_cache_node_type(self, input: Option<String>) -> Self
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
andappendfsync
are not supported on Redis version 2.8.22 and later.
sourcepub fn engine(self, input: impl Into<String>) -> Self
pub fn engine(self, input: impl Into<String>) -> Self
The name of the cache engine to be used for the clusters in this replication group. The value must be set to Redis
.
sourcepub fn set_engine(self, input: Option<String>) -> Self
pub fn set_engine(self, input: Option<String>) -> Self
The name of the cache engine to be used for the clusters in this replication group. The value must be set to Redis
.
sourcepub fn engine_version(self, input: impl Into<String>) -> Self
pub fn engine_version(self, input: impl Into<String>) -> Self
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.
sourcepub fn set_engine_version(self, input: Option<String>) -> Self
pub fn set_engine_version(self, input: Option<String>) -> Self
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.
sourcepub fn cache_parameter_group_name(self, input: impl Into<String>) -> Self
pub fn cache_parameter_group_name(self, input: impl Into<String>) -> Self
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
.
sourcepub fn set_cache_parameter_group_name(self, input: Option<String>) -> Self
pub fn set_cache_parameter_group_name(self, input: Option<String>) -> Self
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
.
sourcepub fn cache_subnet_group_name(self, input: impl Into<String>) -> Self
pub fn cache_subnet_group_name(self, input: impl Into<String>) -> Self
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.
sourcepub fn set_cache_subnet_group_name(self, input: Option<String>) -> Self
pub fn set_cache_subnet_group_name(self, input: Option<String>) -> Self
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.
sourcepub fn cache_security_group_names(self, input: impl Into<String>) -> Self
pub fn cache_security_group_names(self, input: impl Into<String>) -> Self
Appends an item to CacheSecurityGroupNames
.
To override the contents of this collection use set_cache_security_group_names
.
A list of cache security group names to associate with this replication group.
sourcepub fn set_cache_security_group_names(self, input: Option<Vec<String>>) -> Self
pub fn set_cache_security_group_names(self, input: Option<Vec<String>>) -> Self
A list of cache security group names to associate with this replication group.
sourcepub fn security_group_ids(self, input: impl Into<String>) -> Self
pub fn security_group_ids(self, input: impl Into<String>) -> Self
Appends an item to SecurityGroupIds
.
To override the contents of this collection use set_security_group_ids
.
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).
sourcepub fn set_security_group_ids(self, input: Option<Vec<String>>) -> Self
pub fn set_security_group_ids(self, input: Option<Vec<String>>) -> Self
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).
Appends an item to Tags
.
To override the contents of this collection use set_tags
.
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.
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.
sourcepub fn snapshot_arns(self, input: impl Into<String>) -> Self
pub fn snapshot_arns(self, input: impl Into<String>) -> Self
Appends an item to SnapshotArns
.
To override the contents of this collection use set_snapshot_arns
.
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
sourcepub fn set_snapshot_arns(self, input: Option<Vec<String>>) -> Self
pub fn set_snapshot_arns(self, input: Option<Vec<String>>) -> Self
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
sourcepub fn snapshot_name(self, input: impl Into<String>) -> Self
pub fn snapshot_name(self, input: impl Into<String>) -> Self
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.
sourcepub fn set_snapshot_name(self, input: Option<String>) -> Self
pub fn set_snapshot_name(self, input: Option<String>) -> Self
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.
sourcepub fn preferred_maintenance_window(self, input: impl Into<String>) -> Self
pub fn preferred_maintenance_window(self, input: impl Into<String>) -> Self
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
sourcepub fn set_preferred_maintenance_window(self, input: Option<String>) -> Self
pub fn set_preferred_maintenance_window(self, input: Option<String>) -> Self
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
sourcepub fn port(self, input: i32) -> Self
pub fn port(self, input: i32) -> Self
The port number on which each member of the replication group accepts connections.
sourcepub fn set_port(self, input: Option<i32>) -> Self
pub fn set_port(self, input: Option<i32>) -> Self
The port number on which each member of the replication group accepts connections.
sourcepub fn notification_topic_arn(self, input: impl Into<String>) -> Self
pub fn notification_topic_arn(self, input: impl Into<String>) -> Self
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.
sourcepub fn set_notification_topic_arn(self, input: Option<String>) -> Self
pub fn set_notification_topic_arn(self, input: Option<String>) -> Self
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.
sourcepub fn auto_minor_version_upgrade(self, input: bool) -> Self
pub fn auto_minor_version_upgrade(self, input: bool) -> Self
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.
sourcepub fn set_auto_minor_version_upgrade(self, input: Option<bool>) -> Self
pub fn set_auto_minor_version_upgrade(self, input: Option<bool>) -> Self
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.
sourcepub fn snapshot_retention_limit(self, input: i32) -> Self
pub fn snapshot_retention_limit(self, input: i32) -> Self
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).
sourcepub fn set_snapshot_retention_limit(self, input: Option<i32>) -> Self
pub fn set_snapshot_retention_limit(self, input: Option<i32>) -> Self
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).
sourcepub fn snapshot_window(self, input: impl Into<String>) -> Self
pub fn snapshot_window(self, input: impl Into<String>) -> Self
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.
sourcepub fn set_snapshot_window(self, input: Option<String>) -> Self
pub fn set_snapshot_window(self, input: Option<String>) -> Self
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.
sourcepub fn auth_token(self, input: impl Into<String>) -> Self
pub fn auth_token(self, input: impl Into<String>) -> Self
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.
sourcepub fn set_auth_token(self, input: Option<String>) -> Self
pub fn set_auth_token(self, input: Option<String>) -> Self
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.
sourcepub fn transit_encryption_enabled(self, input: bool) -> Self
pub fn transit_encryption_enabled(self, input: bool) -> Self
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
.
sourcepub fn set_transit_encryption_enabled(self, input: Option<bool>) -> Self
pub fn set_transit_encryption_enabled(self, input: Option<bool>) -> Self
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
.
sourcepub fn at_rest_encryption_enabled(self, input: bool) -> Self
pub fn at_rest_encryption_enabled(self, input: bool) -> Self
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
sourcepub fn set_at_rest_encryption_enabled(self, input: Option<bool>) -> Self
pub fn set_at_rest_encryption_enabled(self, input: Option<bool>) -> Self
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
sourcepub fn kms_key_id(self, input: impl Into<String>) -> Self
pub fn kms_key_id(self, input: impl Into<String>) -> Self
The ID of the KMS key used to encrypt the disk in the cluster.
sourcepub fn set_kms_key_id(self, input: Option<String>) -> Self
pub fn set_kms_key_id(self, input: Option<String>) -> Self
The ID of the KMS key used to encrypt the disk in the cluster.
sourcepub fn user_group_ids(self, input: impl Into<String>) -> Self
pub fn user_group_ids(self, input: impl Into<String>) -> Self
Appends an item to UserGroupIds
.
To override the contents of this collection use set_user_group_ids
.
The user group to associate with the replication group.
sourcepub fn set_user_group_ids(self, input: Option<Vec<String>>) -> Self
pub fn set_user_group_ids(self, input: Option<Vec<String>>) -> Self
The user group to associate with the replication group.
sourcepub fn log_delivery_configurations(
self,
input: LogDeliveryConfigurationRequest
) -> Self
pub fn log_delivery_configurations(
self,
input: LogDeliveryConfigurationRequest
) -> Self
Appends an item to LogDeliveryConfigurations
.
To override the contents of this collection use set_log_delivery_configurations
.
Specifies the destination, format and type of the logs.
sourcepub fn set_log_delivery_configurations(
self,
input: Option<Vec<LogDeliveryConfigurationRequest>>
) -> Self
pub fn set_log_delivery_configurations(
self,
input: Option<Vec<LogDeliveryConfigurationRequest>>
) -> Self
Specifies the destination, format and type of the logs.
sourcepub fn data_tiering_enabled(self, input: bool) -> Self
pub fn data_tiering_enabled(self, input: bool) -> Self
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.
sourcepub fn set_data_tiering_enabled(self, input: Option<bool>) -> Self
pub fn set_data_tiering_enabled(self, input: Option<bool>) -> Self
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.
sourcepub fn network_type(self, input: NetworkType) -> Self
pub fn network_type(self, input: NetworkType) -> Self
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.
sourcepub fn set_network_type(self, input: Option<NetworkType>) -> Self
pub fn set_network_type(self, input: Option<NetworkType>) -> Self
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.
sourcepub fn ip_discovery(self, input: IpDiscovery) -> Self
pub fn ip_discovery(self, input: IpDiscovery) -> Self
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.
sourcepub fn set_ip_discovery(self, input: Option<IpDiscovery>) -> Self
pub fn set_ip_discovery(self, input: Option<IpDiscovery>) -> Self
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.
sourcepub fn transit_encryption_mode(self, input: TransitEncryptionMode) -> Self
pub fn transit_encryption_mode(self, input: TransitEncryptionMode) -> Self
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
first, after that you can set TransitEncryptionMode
to required
.
sourcepub fn set_transit_encryption_mode(
self,
input: Option<TransitEncryptionMode>
) -> Self
pub fn set_transit_encryption_mode(
self,
input: Option<TransitEncryptionMode>
) -> Self
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
first, after that you can set TransitEncryptionMode
to required
.
Trait Implementations§
source§impl Clone for CreateReplicationGroup
impl Clone for CreateReplicationGroup
source§fn clone(&self) -> CreateReplicationGroup
fn clone(&self) -> CreateReplicationGroup
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more