@Generated(value="software.amazon.awssdk:codegen") public final class CreateReplicationGroupRequest extends ElastiCacheRequest implements ToCopyableBuilder<CreateReplicationGroupRequest.Builder,CreateReplicationGroupRequest>
Represents the input of a CreateReplicationGroup
operation.
Modifier and Type | Class and Description |
---|---|
static interface |
CreateReplicationGroupRequest.Builder |
Modifier and Type | Method and Description |
---|---|
Boolean |
atRestEncryptionEnabled()
A flag that enables encryption at rest when set to
true . |
String |
authToken()
Reserved parameter. The password used to access a password protected server.
|
Boolean |
automaticFailoverEnabled()
Specifies whether a read-only replica is automatically promoted to read/write primary if the existing primary
fails.
|
Boolean |
autoMinorVersionUpgrade()
This parameter is currently disabled.
|
static CreateReplicationGroupRequest.Builder |
builder() |
String |
cacheNodeType()
The compute and memory capacity of the nodes in the node group (shard).
|
String |
cacheParameterGroupName()
The name of the parameter group to associate with this replication group.
|
List<String> |
cacheSecurityGroupNames()
A list of cache security group names to associate with this replication group.
|
String |
cacheSubnetGroupName()
The name of the cache subnet group to be used for the replication group.
|
String |
engine()
The name of the cache engine to be used for the clusters in this replication group.
|
String |
engineVersion()
The version number of the cache engine to be used for the clusters in this replication group.
|
boolean |
equals(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest . |
int |
hashCode() |
List<NodeGroupConfiguration> |
nodeGroupConfiguration()
A list of node group (shard) configuration options.
|
String |
notificationTopicArn()
The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are
sent.
|
Integer |
numCacheClusters()
The number of clusters this replication group initially has.
|
Integer |
numNodeGroups()
An optional parameter that specifies the number of node groups (shards) for this Redis (cluster mode enabled)
replication group.
|
Integer |
port()
The port number on which each member of the replication group accepts connections.
|
List<String> |
preferredCacheClusterAZs()
A list of EC2 Availability Zones in which the replication group's clusters are created.
|
String |
preferredMaintenanceWindow()
Specifies the weekly time range during which maintenance on the cluster is performed.
|
String |
primaryClusterId()
The identifier of the cluster that serves as the primary for this replication group.
|
Integer |
replicasPerNodeGroup()
An optional parameter that specifies the number of replica nodes in each node group (shard).
|
String |
replicationGroupDescription()
A user-created description for the replication group.
|
String |
replicationGroupId()
The replication group identifier.
|
List<String> |
securityGroupIds()
One or more Amazon VPC security groups associated with this replication group.
|
static Class<? extends CreateReplicationGroupRequest.Builder> |
serializableBuilderClass() |
List<String> |
snapshotArns()
A list of Amazon Resource Names (ARN) that uniquely identify the Redis RDB snapshot files stored in Amazon S3.
|
String |
snapshotName()
The name of a snapshot from which to restore data into the new replication group.
|
Integer |
snapshotRetentionLimit()
The number of days for which ElastiCache retains automatic snapshots before deleting them.
|
String |
snapshotWindow()
The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).
|
List<Tag> |
tags()
A list of cost allocation tags to be added to this resource.
|
CreateReplicationGroupRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
Boolean |
transitEncryptionEnabled()
A flag that enables in-transit encryption when set to
true . |
overrideConfiguration
copy
public String replicationGroupId()
The replication group identifier. This parameter is stored as a lowercase string.
Constraints:
A name must contain from 1 to 20 alphanumeric characters or hyphens.
The first character must be a letter.
A name cannot end with a hyphen or contain two consecutive hyphens.
Constraints:
A name must contain from 1 to 20 alphanumeric characters or hyphens.
The first character must be a letter.
A name cannot end with a hyphen or contain two consecutive hyphens.
public String replicationGroupDescription()
A user-created description for the replication group.
public String primaryClusterId()
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.
available
.
This parameter is not required if NumCacheClusters
, NumNodeGroups
, or
ReplicasPerNodeGroup
is specified.
public Boolean automaticFailoverEnabled()
Specifies whether a read-only replica is automatically promoted to read/write primary if the existing primary fails.
If true
, Multi-AZ is enabled for this replication group. If false
, Multi-AZ is disabled
for this replication group.
AutomaticFailoverEnabled
must be enabled for Redis (cluster mode enabled) replication groups.
Default: false
Amazon ElastiCache for Redis does not support Multi-AZ with automatic failover on:
Redis versions earlier than 2.8.6.
Redis (cluster mode disabled): T1 and T2 cache node types.
Redis (cluster mode enabled): T1 node types.
If true
, Multi-AZ is enabled for this replication group. If false
, Multi-AZ is
disabled for this replication group.
AutomaticFailoverEnabled
must be enabled for Redis (cluster mode enabled) replication
groups.
Default: false
Amazon ElastiCache for Redis does not support Multi-AZ with automatic failover on:
Redis versions earlier than 2.8.6.
Redis (cluster mode disabled): T1 and T2 cache node types.
Redis (cluster mode enabled): T1 node types.
public Integer numCacheClusters()
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 (primary plus 5 replicas).
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 (primary plus 5 replicas).
public List<String> preferredCacheClusterAZs()
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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
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.
public Integer numNodeGroups()
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
Default: 1
public Integer replicasPerNodeGroup()
An optional parameter that specifies the number of replica nodes in each node group (shard). Valid values are 0 to 5.
public List<NodeGroupConfiguration> nodeGroupConfiguration()
A list of node group (shard) configuration options. Each node group (shard) configuration has the following: Slots, PrimaryAvailabilityZone, ReplicaAvailabilityZones, ReplicaCount.
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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
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.
public String cacheNodeType()
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:
T2 node types: cache.t2.micro
, cache.t2.small
, cache.t2.medium
M3 node types: cache.m3.medium
, cache.m3.large
, cache.m3.xlarge
,
cache.m3.2xlarge
M4 node types: cache.m4.large
, cache.m4.xlarge
, cache.m4.2xlarge
,
cache.m4.4xlarge
, cache.m4.10xlarge
Previous generation: (not recommended)
T1 node types: cache.t1.micro
M1 node types: cache.m1.small
, cache.m1.medium
, cache.m1.large
,
cache.m1.xlarge
Compute optimized:
Previous generation: (not recommended)
C1 node types: cache.c1.xlarge
Memory optimized:
Current generation:
R3 node types: cache.r3.large
, cache.r3.xlarge
, cache.r3.2xlarge
,
cache.r3.4xlarge
, cache.r3.8xlarge
Previous generation: (not recommended)
M2 node types: cache.m2.xlarge
, cache.m2.2xlarge
, cache.m2.4xlarge
Notes:
All T2 instances are created in an Amazon Virtual Private Cloud (Amazon VPC).
Redis (cluster mode disabled): Redis backup/restore is not supported on T1 and T2 instances.
Redis (cluster mode enabled): Backup/restore is not supported on T1 instances.
Redis Append-only files (AOF) functionality is not supported for T1 or T2 instances.
For a complete listing of node types and specifications, see Amazon ElastiCache Product Features and Details and either Cache Node Type-Specific Parameters for Memcached or Cache Node Type-Specific Parameters for Redis.
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:
T2 node types: cache.t2.micro
, cache.t2.small
,
cache.t2.medium
M3 node types: cache.m3.medium
, cache.m3.large
,
cache.m3.xlarge
, cache.m3.2xlarge
M4 node types: cache.m4.large
, cache.m4.xlarge
,
cache.m4.2xlarge
, cache.m4.4xlarge
, cache.m4.10xlarge
Previous generation: (not recommended)
T1 node types: cache.t1.micro
M1 node types: cache.m1.small
, cache.m1.medium
,
cache.m1.large
, cache.m1.xlarge
Compute optimized:
Previous generation: (not recommended)
C1 node types: cache.c1.xlarge
Memory optimized:
Current generation:
R3 node types: cache.r3.large
, cache.r3.xlarge
,
cache.r3.2xlarge
, cache.r3.4xlarge
, cache.r3.8xlarge
Previous generation: (not recommended)
M2 node types: cache.m2.xlarge
, cache.m2.2xlarge
,
cache.m2.4xlarge
Notes:
All T2 instances are created in an Amazon Virtual Private Cloud (Amazon VPC).
Redis (cluster mode disabled): Redis backup/restore is not supported on T1 and T2 instances.
Redis (cluster mode enabled): Backup/restore is not supported on T1 instances.
Redis Append-only files (AOF) functionality is not supported for T1 or T2 instances.
For a complete listing of node types and specifications, see Amazon ElastiCache Product Features and Details and either Cache Node Type-Specific Parameters for Memcached or Cache Node Type-Specific Parameters for Redis.
public String engine()
The name of the cache engine to be used for the clusters in this replication group.
public String engineVersion()
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.
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.
public String cacheParameterGroupName()
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
.
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
.
public String cacheSubnetGroupName()
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.
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.
public List<String> cacheSecurityGroupNames()
A list of cache security group names to associate with this replication group.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public List<String> securityGroupIds()
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).
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
Use this parameter only when you are creating a replication group in an Amazon Virtual Private Cloud (Amazon VPC).
public List<Tag> tags()
A list of cost allocation tags to be added to this resource. A tag is a key-value pair. A tag key does not have to be accompanied by a tag value.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public List<String> snapshotArns()
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
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
Example of an Amazon S3 ARN: arn:aws:s3:::my_bucket/snapshot1.rdb
public String snapshotName()
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.
restoring
while the new replication group is being created.public String preferredMaintenanceWindow()
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
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
public Integer port()
The port number on which each member of the replication group accepts connections.
public String notificationTopicArn()
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.
The Amazon SNS topic owner must be the same as the cluster owner.
public Boolean autoMinorVersionUpgrade()
This parameter is currently disabled.
public Integer snapshotRetentionLimit()
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).
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).
public String snapshotWindow()
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.
Example: 05:00-09:00
If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.
public String authToken()
Reserved parameter. The password used to access a password protected server.
This parameter is valid only if:
The parameter TransitEncryptionEnabled
was set to true
when the cluster was created.
The line requirepass
was added to the database configuration file.
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 http://redis.io/commands/AUTH.
This parameter is valid only if:
The parameter TransitEncryptionEnabled
was set to true
when the cluster was
created.
The line requirepass
was added to the database configuration file.
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 http://redis.io/commands/AUTH.
public Boolean transitEncryptionEnabled()
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.4
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
.
Default: false
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.4
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
.
Default: false
public Boolean atRestEncryptionEnabled()
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.
This parameter is valid only if the Engine
parameter is redis
and the cluster is being
created in an Amazon VPC.
Default: false
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.
This parameter is valid only if the Engine
parameter is redis
and the cluster
is being created in an Amazon VPC.
Default: false
public CreateReplicationGroupRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<CreateReplicationGroupRequest.Builder,CreateReplicationGroupRequest>
toBuilder
in class ElastiCacheRequest
public static CreateReplicationGroupRequest.Builder builder()
public static Class<? extends CreateReplicationGroupRequest.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
SdkRequest
. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.