@Stability(value=Stable) @Internal public static final class CfnReplicationGroupProps.Jsii$Proxy extends software.amazon.jsii.JsiiObject implements CfnReplicationGroupProps
CfnReplicationGroupPropssoftware.amazon.jsii.JsiiObject.InitializationModeCfnReplicationGroupProps.Builder, CfnReplicationGroupProps.Jsii$Proxy| Modifier | Constructor and Description |
|---|---|
protected |
Jsii$Proxy(CfnReplicationGroupProps.Builder builder)
Constructor that initializes the object based on literal property values passed by the
CfnReplicationGroupProps.Builder. |
protected |
Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
Constructor that initializes the object based on values retrieved from the JsiiObject.
|
| Modifier and Type | Method and Description |
|---|---|
com.fasterxml.jackson.databind.JsonNode |
$jsii$toJson() |
boolean |
equals(Object o) |
Object |
getAtRestEncryptionEnabled()
A flag that enables encryption at rest when set to `true` .
|
String |
getAuthToken()
*Reserved parameter.* The password used to access a password protected server.
|
Object |
getAutomaticFailoverEnabled()
Specifies whether a read-only replica is automatically promoted to read/write primary if the existing primary fails.
|
Object |
getAutoMinorVersionUpgrade()
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 minor version upgrade campaign.
|
String |
getCacheNodeType()
The compute and memory capacity of the nodes in the node group (shard).
|
String |
getCacheParameterGroupName()
The name of the parameter group to associate with this replication group.
|
List<String> |
getCacheSecurityGroupNames()
A list of cache security group names to associate with this replication group.
|
String |
getCacheSubnetGroupName()
The name of the cache subnet group to be used for the replication group.
|
Object |
getDataTieringEnabled()
Enables data tiering.
|
String |
getEngine()
The name of the cache engine to be used for the clusters in this replication group.
|
String |
getEngineVersion()
The version number of the cache engine to be used for the clusters in this replication group.
|
String |
getGlobalReplicationGroupId()
The name of the Global datastore.
|
String |
getKmsKeyId()
The ID of the KMS key used to encrypt the disk on the cluster.
|
Object |
getLogDeliveryConfigurations()
Specifies the destination, format and type of the logs.
|
Object |
getMultiAzEnabled()
A flag indicating if you have Multi-AZ enabled to enhance fault tolerance.
|
Object |
getNodeGroupConfiguration()
`NodeGroupConfiguration` is a property of the `AWS::ElastiCache::ReplicationGroup` resource that configures an Amazon ElastiCache (ElastiCache) Redis cluster node group.
|
String |
getNotificationTopicArn()
The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.
|
Number |
getNumCacheClusters()
The number of clusters this replication group initially has.
|
Number |
getNumNodeGroups()
An optional parameter that specifies the number of node groups (shards) for this Redis (cluster mode enabled) replication group.
|
Number |
getPort()
The port number on which each member of the replication group accepts connections.
|
List<String> |
getPreferredCacheClusterAZs()
A list of EC2 Availability Zones in which the replication group's clusters are created.
|
String |
getPreferredMaintenanceWindow()
Specifies the weekly time range during which maintenance on the cluster is performed.
|
String |
getPrimaryClusterId()
The identifier of the cluster that serves as the primary for this replication group.
|
Number |
getReplicasPerNodeGroup()
An optional parameter that specifies the number of replica nodes in each node group (shard).
|
String |
getReplicationGroupDescription()
A user-created description for the replication group.
|
String |
getReplicationGroupId()
The replication group identifier.
|
List<String> |
getSecurityGroupIds()
One or more Amazon VPC security groups associated with this replication group.
|
List<String> |
getSnapshotArns()
A list of Amazon Resource Names (ARN) that uniquely identify the Redis RDB snapshot files stored in Amazon S3.
|
String |
getSnapshotName()
The name of a snapshot from which to restore data into the new replication group.
|
Number |
getSnapshotRetentionLimit()
The number of days for which ElastiCache retains automatic snapshots before deleting them.
|
String |
getSnapshottingClusterId()
The cluster ID that is used as the daily snapshot source for the replication group.
|
String |
getSnapshotWindow()
The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).
|
List<CfnTag> |
getTags()
A list of tags to be added to this resource.
|
Object |
getTransitEncryptionEnabled()
A flag that enables in-transit encryption when set to `true` .
|
List<String> |
getUserGroupIds()
The list of user groups to associate with the replication group.
|
int |
hashCode() |
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSetclone, finalize, getClass, notify, notifyAll, toString, wait, wait, waitbuilderprotected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
objRef - Reference to the JSII managed object.protected Jsii$Proxy(CfnReplicationGroupProps.Builder builder)
CfnReplicationGroupProps.Builder.public final String getReplicationGroupDescription()
CfnReplicationGroupPropsgetReplicationGroupDescription in interface CfnReplicationGroupPropspublic final Object getAtRestEncryptionEnabled()
CfnReplicationGroupProps
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 or 4.x onward.
Default: false
getAtRestEncryptionEnabled in interface CfnReplicationGroupPropspublic final String getAuthToken()
CfnReplicationGroupProps
AuthToken can be specified only on replication groups where TransitEncryptionEnabled is true . For more information, see Authenticating Users with the Redis AUTH Command .
For HIPAA compliance, you must specify
TransitEncryptionEnabledastrue, anAuthToken, and aCacheSubnetGroup.
Password constraints:
For more information, see AUTH password at http://redis.io/commands/AUTH.
getAuthToken in interface CfnReplicationGroupPropspublic final Object getAutomaticFailoverEnabled()
CfnReplicationGroupProps
AutomaticFailoverEnabled must be enabled for Redis (cluster mode enabled) replication groups.
Default: false
getAutomaticFailoverEnabled in interface CfnReplicationGroupPropspublic final Object getAutoMinorVersionUpgrade()
CfnReplicationGroupPropsgetAutoMinorVersionUpgrade in interface CfnReplicationGroupPropspublic final String getCacheNodeType()
CfnReplicationGroupPropsThe 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.
M6g node types: cache.m6g.large , cache.m6g.xlarge , cache.m6g.2xlarge , cache.m6g.4xlarge , cache.m6g.12xlarge , cache.m6g.24xlarge
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: 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
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
C1 node types: cache.c1.xlarge
R6gd node types: cache.r6gd.xlarge , cache.r6gd.2xlarge , cache.r6gd.4xlarge , cache.r6gd.8xlarge , cache.r6gd.12xlarge , cache.r6gd.16xlarge
The
r6gdfamily is available in the following regions:us-east-2,us-east-1,us-west-2,us-west-1,eu-west-1,eu-central-1,ap-northeast-1,ap-southeast-1,ap-southeast-2.
R6g node types: cache.r6g.large , cache.r6g.xlarge , cache.r6g.2xlarge , cache.r6g.4xlarge , cache.r6g.12xlarge , cache.r6g.24xlarge
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
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
For region availability, see Supported Node Types by Amazon Region
getCacheNodeType in interface CfnReplicationGroupPropspublic final String getCacheParameterGroupName()
CfnReplicationGroupPropsIf 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.
CacheParameterGroupName=default.redis3.2 .CacheParameterGroupName=default.redis3.2.cluster.on .getCacheParameterGroupName in interface CfnReplicationGroupPropspublic final List<String> getCacheSecurityGroupNames()
CfnReplicationGroupPropsgetCacheSecurityGroupNames in interface CfnReplicationGroupPropspublic final String getCacheSubnetGroupName()
CfnReplicationGroupProps
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 AWS::ElastiCache::SubnetGroup .
getCacheSubnetGroupName in interface CfnReplicationGroupPropspublic final Object getDataTieringEnabled()
CfnReplicationGroupPropsData 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 .
getDataTieringEnabled in interface CfnReplicationGroupPropspublic final String getEngine()
CfnReplicationGroupPropsMust be Redis.
getEngine in interface CfnReplicationGroupPropspublic final String getEngineVersion()
CfnReplicationGroupProps
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.
getEngineVersion in interface CfnReplicationGroupPropspublic final String getGlobalReplicationGroupId()
CfnReplicationGroupPropsgetGlobalReplicationGroupId in interface CfnReplicationGroupPropspublic final String getKmsKeyId()
CfnReplicationGroupPropsgetKmsKeyId in interface CfnReplicationGroupPropspublic final Object getLogDeliveryConfigurations()
CfnReplicationGroupPropsgetLogDeliveryConfigurations in interface CfnReplicationGroupPropspublic final Object getMultiAzEnabled()
CfnReplicationGroupPropsFor more information, see Minimizing Downtime: Multi-AZ .
getMultiAzEnabled in interface CfnReplicationGroupPropspublic final Object getNodeGroupConfiguration()
CfnReplicationGroupProps
If you set UseOnlineResharding to true , you can update NodeGroupConfiguration without interruption. When UseOnlineResharding is set to false , or is not specified, updating NodeGroupConfiguration results in replacement .
getNodeGroupConfiguration in interface CfnReplicationGroupPropspublic final String getNotificationTopicArn()
CfnReplicationGroupProps
The Amazon SNS topic owner must be the same as the cluster owner.
getNotificationTopicArn in interface CfnReplicationGroupPropspublic final Number getNumCacheClusters()
CfnReplicationGroupProps
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).
getNumCacheClusters in interface CfnReplicationGroupPropspublic final Number getNumNodeGroups()
CfnReplicationGroupPropsFor Redis (cluster mode disabled) either omit this parameter or set it to 1.
If you set UseOnlineResharding to true , you can update NumNodeGroups without interruption. When UseOnlineResharding is set to false , or is not specified, updating NumNodeGroups results in replacement .
Default: 1
getNumNodeGroups in interface CfnReplicationGroupPropspublic final Number getPort()
CfnReplicationGroupPropsgetPort in interface CfnReplicationGroupPropspublic final List<String> getPreferredCacheClusterAZs()
CfnReplicationGroupPropsThe 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.
getPreferredCacheClusterAZs in interface CfnReplicationGroupPropspublic final String getPreferredMaintenanceWindow()
CfnReplicationGroupPropsIt 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:
sunmontuewedthufrisat
Example: sun:23:00-mon:01:30
getPreferredMaintenanceWindow in interface CfnReplicationGroupPropspublic final String getPrimaryClusterId()
CfnReplicationGroupProps
This cluster must already exist and have a status of available .
This parameter is not required if NumCacheClusters , NumNodeGroups , or ReplicasPerNodeGroup is specified.
getPrimaryClusterId in interface CfnReplicationGroupPropspublic final Number getReplicasPerNodeGroup()
CfnReplicationGroupPropsValid values are 0 to 5.
getReplicasPerNodeGroup in interface CfnReplicationGroupPropspublic final String getReplicationGroupId()
CfnReplicationGroupPropsConstraints:
getReplicationGroupId in interface CfnReplicationGroupPropspublic final List<String> getSecurityGroupIds()
CfnReplicationGroupPropsUse this parameter only when you are creating a replication group in an Amazon Virtual Private Cloud (Amazon VPC).
getSecurityGroupIds in interface CfnReplicationGroupPropspublic final List<String> getSnapshotArns()
CfnReplicationGroupPropsThe 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
getSnapshotArns in interface CfnReplicationGroupPropspublic final String getSnapshotName()
CfnReplicationGroupProps
The snapshot status changes to restoring while the new replication group is being created.
getSnapshotName in interface CfnReplicationGroupPropspublic final Number getSnapshotRetentionLimit()
CfnReplicationGroupProps
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).
getSnapshotRetentionLimit in interface CfnReplicationGroupPropspublic final String getSnapshottingClusterId()
CfnReplicationGroupPropsThis parameter cannot be set for Redis (cluster mode enabled) replication groups.
getSnapshottingClusterId in interface CfnReplicationGroupPropspublic final String getSnapshotWindow()
CfnReplicationGroupProps
Example: 05:00-09:00
If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.
getSnapshotWindow in interface CfnReplicationGroupPropspublic final List<CfnTag> getTags()
CfnReplicationGroupProps
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.
getTags in interface CfnReplicationGroupPropspublic final Object getTransitEncryptionEnabled()
CfnReplicationGroupProps
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 or 4.x onward, 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 or 4.x onward.
Default: false
For HIPAA compliance, you must specify
TransitEncryptionEnabledastrue, anAuthToken, and aCacheSubnetGroup.
getTransitEncryptionEnabled in interface CfnReplicationGroupPropspublic final List<String> getUserGroupIds()
CfnReplicationGroupPropsgetUserGroupIds in interface CfnReplicationGroupProps@Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()
$jsii$toJson in interface software.amazon.jsii.JsiiSerializableCopyright © 2022. All rights reserved.