CfnReplicationGroup.Builder (software.amazon.awscdk:aws-cdk-lib 2.42.1 API)

java.lang.Object
- software.amazon.awscdk.services.elasticache.CfnReplicationGroup.Builder

All Implemented Interfaces:: software.amazon.jsii.Builder<CfnReplicationGroup>

Enclosing class:: CfnReplicationGroup

@Stability(value=Stable)
public static final class CfnReplicationGroup.Builder
extends Object
implements software.amazon.jsii.Builder<CfnReplicationGroup>

A fluent builder for CfnReplicationGroup.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CfnReplicationGroup.Builder`	`atRestEncryptionEnabled(Boolean atRestEncryptionEnabled)` A flag that enables encryption at rest when set to `true` .
`CfnReplicationGroup.Builder`	`atRestEncryptionEnabled(IResolvable atRestEncryptionEnabled)` A flag that enables encryption at rest when set to `true` .
`CfnReplicationGroup.Builder`	`authToken(String authToken)` Reserved parameter. The password used to access a password protected server.
`CfnReplicationGroup.Builder`	`automaticFailoverEnabled(Boolean automaticFailoverEnabled)` Specifies whether a read-only replica is automatically promoted to read/write primary if the existing primary fails.
`CfnReplicationGroup.Builder`	`automaticFailoverEnabled(IResolvable automaticFailoverEnabled)` Specifies whether a read-only replica is automatically promoted to read/write primary if the existing primary fails.
`CfnReplicationGroup.Builder`	`autoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)` 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.
`CfnReplicationGroup.Builder`	`autoMinorVersionUpgrade(IResolvable autoMinorVersionUpgrade)` 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.
`CfnReplicationGroup`	`build()`
`CfnReplicationGroup.Builder`	`cacheNodeType(String cacheNodeType)` The compute and memory capacity of the nodes in the node group (shard).
`CfnReplicationGroup.Builder`	`cacheParameterGroupName(String cacheParameterGroupName)` The name of the parameter group to associate with this replication group.
`CfnReplicationGroup.Builder`	`cacheSecurityGroupNames(List<String> cacheSecurityGroupNames)` A list of cache security group names to associate with this replication group.
`CfnReplicationGroup.Builder`	`cacheSubnetGroupName(String cacheSubnetGroupName)` The name of the cache subnet group to be used for the replication group.
`static CfnReplicationGroup.Builder`	`create(software.constructs.Construct scope, String id)`
`CfnReplicationGroup.Builder`	`dataTieringEnabled(Boolean dataTieringEnabled)` Enables data tiering.
`CfnReplicationGroup.Builder`	`dataTieringEnabled(IResolvable dataTieringEnabled)` Enables data tiering.
`CfnReplicationGroup.Builder`	`engine(String engine)` The name of the cache engine to be used for the clusters in this replication group.
`CfnReplicationGroup.Builder`	`engineVersion(String engineVersion)` The version number of the cache engine to be used for the clusters in this replication group.
`CfnReplicationGroup.Builder`	`globalReplicationGroupId(String globalReplicationGroupId)` The name of the Global datastore.
`CfnReplicationGroup.Builder`	`kmsKeyId(String kmsKeyId)` The ID of the KMS key used to encrypt the disk on the cluster.
`CfnReplicationGroup.Builder`	`logDeliveryConfigurations(IResolvable logDeliveryConfigurations)` Specifies the destination, format and type of the logs.
`CfnReplicationGroup.Builder`	`logDeliveryConfigurations(List<? extends Object> logDeliveryConfigurations)` Specifies the destination, format and type of the logs.
`CfnReplicationGroup.Builder`	`multiAzEnabled(Boolean multiAzEnabled)` A flag indicating if you have Multi-AZ enabled to enhance fault tolerance.
`CfnReplicationGroup.Builder`	`multiAzEnabled(IResolvable multiAzEnabled)` A flag indicating if you have Multi-AZ enabled to enhance fault tolerance.
`CfnReplicationGroup.Builder`	`nodeGroupConfiguration(IResolvable nodeGroupConfiguration)` `NodeGroupConfiguration` is a property of the `AWS::ElastiCache::ReplicationGroup` resource that configures an Amazon ElastiCache (ElastiCache) Redis cluster node group.
`CfnReplicationGroup.Builder`	`nodeGroupConfiguration(List<? extends Object> nodeGroupConfiguration)` `NodeGroupConfiguration` is a property of the `AWS::ElastiCache::ReplicationGroup` resource that configures an Amazon ElastiCache (ElastiCache) Redis cluster node group.
`CfnReplicationGroup.Builder`	`notificationTopicArn(String notificationTopicArn)` The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.
`CfnReplicationGroup.Builder`	`numCacheClusters(Number numCacheClusters)` The number of clusters this replication group initially has.
`CfnReplicationGroup.Builder`	`numNodeGroups(Number numNodeGroups)` An optional parameter that specifies the number of node groups (shards) for this Redis (cluster mode enabled) replication group.
`CfnReplicationGroup.Builder`	`port(Number port)` The port number on which each member of the replication group accepts connections.
`CfnReplicationGroup.Builder`	`preferredCacheClusterAZs(List<String> preferredCacheClusterAZs)` A list of EC2 Availability Zones in which the replication group's clusters are created.
`CfnReplicationGroup.Builder`	`preferredMaintenanceWindow(String preferredMaintenanceWindow)` Specifies the weekly time range during which maintenance on the cluster is performed.
`CfnReplicationGroup.Builder`	`primaryClusterId(String primaryClusterId)` The identifier of the cluster that serves as the primary for this replication group.
`CfnReplicationGroup.Builder`	`replicasPerNodeGroup(Number replicasPerNodeGroup)` An optional parameter that specifies the number of replica nodes in each node group (shard).
`CfnReplicationGroup.Builder`	`replicationGroupDescription(String replicationGroupDescription)` A user-created description for the replication group.
`CfnReplicationGroup.Builder`	`replicationGroupId(String replicationGroupId)` The replication group identifier.
`CfnReplicationGroup.Builder`	`securityGroupIds(List<String> securityGroupIds)` One or more Amazon VPC security groups associated with this replication group.
`CfnReplicationGroup.Builder`	`snapshotArns(List<String> snapshotArns)` A list of Amazon Resource Names (ARN) that uniquely identify the Redis RDB snapshot files stored in Amazon S3.
`CfnReplicationGroup.Builder`	`snapshotName(String snapshotName)` The name of a snapshot from which to restore data into the new replication group.
`CfnReplicationGroup.Builder`	`snapshotRetentionLimit(Number snapshotRetentionLimit)` The number of days for which ElastiCache retains automatic snapshots before deleting them.
`CfnReplicationGroup.Builder`	`snapshottingClusterId(String snapshottingClusterId)` The cluster ID that is used as the daily snapshot source for the replication group.
`CfnReplicationGroup.Builder`	`snapshotWindow(String snapshotWindow)` The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).
`CfnReplicationGroup.Builder`	`tags(List<? extends CfnTag> tags)` A list of tags to be added to this resource.
`CfnReplicationGroup.Builder`	`transitEncryptionEnabled(Boolean transitEncryptionEnabled)` A flag that enables in-transit encryption when set to `true` .
`CfnReplicationGroup.Builder`	`transitEncryptionEnabled(IResolvable transitEncryptionEnabled)` A flag that enables in-transit encryption when set to `true` .
`CfnReplicationGroup.Builder`	`userGroupIds(List<String> userGroupIds)` The list of user groups to associate with the replication group.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - create
```
@Stability(value=Stable)
public static CfnReplicationGroup.Builder create(software.constructs.Construct scope,
                                                                          String id)
```
    Parameters:
    
    scope - - scope in which this resource is defined. This parameter is required.
    
    id - - scoped id of the resource. This parameter is required.
    
    Returns:
    
    a new instance of CfnReplicationGroup.CloudWatchLogsDestinationDetailsProperty.Builder.
  - replicationGroupDescription
```
@Stability(value=Stable)
public CfnReplicationGroup.Builder replicationGroupDescription(String replicationGroupDescription)
```
    A user-created description for the replication group.
    
    Parameters:
    
    replicationGroupDescription - A user-created description for the replication group. This parameter is required.
    
    Returns:
    
    this
  - atRestEncryptionEnabled
```
@Stability(value=Stable)
public CfnReplicationGroup.Builder atRestEncryptionEnabled(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.
    Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6 or 4.x onward.
    Default: false
    
    Parameters:
    
    atRestEncryptionEnabled - A flag that enables encryption at rest when set to `true` . This parameter is required.
    
    Returns:
    
    this
  - atRestEncryptionEnabled
```
@Stability(value=Stable)
public CfnReplicationGroup.Builder atRestEncryptionEnabled(IResolvable 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.
    Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6 or 4.x onward.
    Default: false
    
    Parameters:
    
    atRestEncryptionEnabled - A flag that enables encryption at rest when set to `true` . This parameter is required.
    
    Returns:
    
    this
  - authToken
```
@Stability(value=Stable)
public CfnReplicationGroup.Builder authToken(String authToken)
```
    *Reserved parameter.* The password used to access a password protected server.
    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 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.
    - Nonalphanumeric characters are restricted to (!, &, #, $, ^, <, >, -, ).
    For more information, see AUTH password at http://redis.io/commands/AUTH.
    Parameters:
    
    authToken - *Reserved parameter.* The password used to access a password protected server. This parameter is required.
    
    Returns:
    
    this
  - automaticFailoverEnabled
```
@Stability(value=Stable)
public CfnReplicationGroup.Builder automaticFailoverEnabled(Boolean automaticFailoverEnabled)
```
    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
    
    Parameters:
    
    automaticFailoverEnabled - Specifies whether a read-only replica is automatically promoted to read/write primary if the existing primary fails. This parameter is required.
    
    Returns:
    
    this
  - automaticFailoverEnabled
```
@Stability(value=Stable)
public CfnReplicationGroup.Builder automaticFailoverEnabled(IResolvable automaticFailoverEnabled)
```
    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
    
    Parameters:
    
    automaticFailoverEnabled - Specifies whether a read-only replica is automatically promoted to read/write primary if the existing primary fails. This parameter is required.
    
    Returns:
    
    this
  - autoMinorVersionUpgrade
```
@Stability(value=Stable)
public CfnReplicationGroup.Builder autoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
```
    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. This parameter is disabled for previous versions.
    
    Parameters:
    
    autoMinorVersionUpgrade - 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. This parameter is disabled for previous versions. This parameter is required.
    
    Returns:
    
    this
  - autoMinorVersionUpgrade
```
@Stability(value=Stable)
public CfnReplicationGroup.Builder autoMinorVersionUpgrade(IResolvable autoMinorVersionUpgrade)
```
    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. This parameter is disabled for previous versions.
    
    Parameters:
    
    autoMinorVersionUpgrade - 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. This parameter is disabled for previous versions. This parameter is required.
    
    Returns:
    
    this
  - cacheNodeType
```
@Stability(value=Stable)
public CfnReplicationGroup.Builder cacheNodeType(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:
    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
    - 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
    M3 node types: cache.m3.medium , cache.m3.large , cache.m3.xlarge , cache.m3.2xlarge
    - Compute optimized:
    - Previous generation: (not recommended)
    C1 node types: cache.c1.xlarge
    - Memory optimized:
    - Current generation:
    R6gd node types: cache.r6gd.xlarge , cache.r6gd.2xlarge , cache.r6gd.4xlarge , cache.r6gd.8xlarge , cache.r6gd.12xlarge , cache.r6gd.16xlarge
    
    The r6gd family 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
    - Previous generation: (not recommended)
    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
    Parameters:
    
    cacheNodeType - The compute and memory capacity of the nodes in the node group (shard). This parameter is required.
    
    Returns:
    
    this
  - cacheParameterGroupName
```
@Stability(value=Stable)
public CfnReplicationGroup.Builder cacheParameterGroupName(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 .
    Parameters:
    
    cacheParameterGroupName - The name of the parameter group to associate with this replication group. This parameter is required.
    
    Returns:
    
    this
  - cacheSecurityGroupNames
```
@Stability(value=Stable)
public CfnReplicationGroup.Builder cacheSecurityGroupNames(List<String> cacheSecurityGroupNames)
```
    A list of cache security group names to associate with this replication group.
    
    Parameters:
    
    cacheSecurityGroupNames - A list of cache security group names to associate with this replication group. This parameter is required.
    
    Returns:
    
    this
  - cacheSubnetGroupName
```
@Stability(value=Stable)
public CfnReplicationGroup.Builder cacheSubnetGroupName(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 AWS::ElastiCache::SubnetGroup .
    
    Parameters:
    
    cacheSubnetGroupName - The name of the cache subnet group to be used for the replication group. This parameter is required.
    
    Returns:
    
    this
  - dataTieringEnabled
```
@Stability(value=Stable)
public CfnReplicationGroup.Builder dataTieringEnabled(Boolean dataTieringEnabled)
```
    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 .
    
    Parameters:
    
    dataTieringEnabled - Enables data tiering. This parameter is required.
    
    Returns:
    
    this
  - dataTieringEnabled
```
@Stability(value=Stable)
public CfnReplicationGroup.Builder dataTieringEnabled(IResolvable dataTieringEnabled)
```
    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 .
    
    Parameters:
    
    dataTieringEnabled - Enables data tiering. This parameter is required.
    
    Returns:
    
    this
  - engine
```
@Stability(value=Stable)
public CfnReplicationGroup.Builder engine(String engine)
```
    The name of the cache engine to be used for the clusters in this replication group.
    Must be Redis.
    
    Parameters:
    
    engine - The name of the cache engine to be used for the clusters in this replication group. This parameter is required.
    
    Returns:
    
    this
  - engineVersion
```
@Stability(value=Stable)
public CfnReplicationGroup.Builder engineVersion(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.
    
    Parameters:
    
    engineVersion - The version number of the cache engine to be used for the clusters in this replication group. This parameter is required.
    
    Returns:
    
    this
  - globalReplicationGroupId
```
@Stability(value=Stable)
public CfnReplicationGroup.Builder globalReplicationGroupId(String globalReplicationGroupId)
```
    The name of the Global datastore.
    
    Parameters:
    
    globalReplicationGroupId - The name of the Global datastore. This parameter is required.
    
    Returns:
    
    this
  - kmsKeyId
```
@Stability(value=Stable)
public CfnReplicationGroup.Builder kmsKeyId(String kmsKeyId)
```
    The ID of the KMS key used to encrypt the disk on the cluster.
    
    Parameters:
    
    kmsKeyId - The ID of the KMS key used to encrypt the disk on the cluster. This parameter is required.
    
    Returns:
    
    this
  - logDeliveryConfigurations
```
@Stability(value=Stable)
public CfnReplicationGroup.Builder logDeliveryConfigurations(IResolvable logDeliveryConfigurations)
```
    Specifies the destination, format and type of the logs.
    
    Parameters:
    
    logDeliveryConfigurations - Specifies the destination, format and type of the logs. This parameter is required.
    
    Returns:
    
    this
  - logDeliveryConfigurations
```
@Stability(value=Stable)
public CfnReplicationGroup.Builder logDeliveryConfigurations(List<? extends Object> logDeliveryConfigurations)
```
    Specifies the destination, format and type of the logs.
    
    Parameters:
    
    logDeliveryConfigurations - Specifies the destination, format and type of the logs. This parameter is required.
    
    Returns:
    
    this
  - multiAzEnabled
```
@Stability(value=Stable)
public CfnReplicationGroup.Builder multiAzEnabled(Boolean multiAzEnabled)
```
    A flag indicating if you have Multi-AZ enabled to enhance fault tolerance.
    For more information, see Minimizing Downtime: Multi-AZ .
    
    Parameters:
    
    multiAzEnabled - A flag indicating if you have Multi-AZ enabled to enhance fault tolerance. This parameter is required.
    
    Returns:
    
    this
  - multiAzEnabled
```
@Stability(value=Stable)
public CfnReplicationGroup.Builder multiAzEnabled(IResolvable multiAzEnabled)
```
    A flag indicating if you have Multi-AZ enabled to enhance fault tolerance.
    For more information, see Minimizing Downtime: Multi-AZ .
    
    Parameters:
    
    multiAzEnabled - A flag indicating if you have Multi-AZ enabled to enhance fault tolerance. This parameter is required.
    
    Returns:
    
    this
  - nodeGroupConfiguration
```
@Stability(value=Stable)
public CfnReplicationGroup.Builder nodeGroupConfiguration(IResolvable nodeGroupConfiguration)
```
    `NodeGroupConfiguration` is a property of the `AWS::ElastiCache::ReplicationGroup` resource that configures an Amazon ElastiCache (ElastiCache) Redis cluster node group.
    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 .
    
    Parameters:
    
    nodeGroupConfiguration - `NodeGroupConfiguration` is a property of the `AWS::ElastiCache::ReplicationGroup` resource that configures an Amazon ElastiCache (ElastiCache) Redis cluster node group. This parameter is required.
    
    Returns:
    
    this
  - nodeGroupConfiguration
```
@Stability(value=Stable)
public CfnReplicationGroup.Builder nodeGroupConfiguration(List<? extends Object> nodeGroupConfiguration)
```
    `NodeGroupConfiguration` is a property of the `AWS::ElastiCache::ReplicationGroup` resource that configures an Amazon ElastiCache (ElastiCache) Redis cluster node group.
    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 .
    
    Parameters:
    
    nodeGroupConfiguration - `NodeGroupConfiguration` is a property of the `AWS::ElastiCache::ReplicationGroup` resource that configures an Amazon ElastiCache (ElastiCache) Redis cluster node group. This parameter is required.
    
    Returns:
    
    this
  - notificationTopicArn
```
@Stability(value=Stable)
public CfnReplicationGroup.Builder notificationTopicArn(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.
    
    Parameters:
    
    notificationTopicArn - The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent. This parameter is required.
    
    Returns:
    
    this
  - numCacheClusters
```
@Stability(value=Stable)
public CfnReplicationGroup.Builder numCacheClusters(Number 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 (1 primary plus 5 replicas).
    
    Parameters:
    
    numCacheClusters - The number of clusters this replication group initially has. This parameter is required.
    
    Returns:
    
    this
  - numNodeGroups
```
@Stability(value=Stable)
public CfnReplicationGroup.Builder numNodeGroups(Number 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.
    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
    
    Parameters:
    
    numNodeGroups - An optional parameter that specifies the number of node groups (shards) for this Redis (cluster mode enabled) replication group. This parameter is required.
    
    Returns:
    
    this
  - port
```
@Stability(value=Stable)
public CfnReplicationGroup.Builder port(Number port)
```
    The port number on which each member of the replication group accepts connections.
    
    Parameters:
    
    port - The port number on which each member of the replication group accepts connections. This parameter is required.
    
    Returns:
    
    this
  - preferredCacheClusterAZs
```
@Stability(value=Stable)
public CfnReplicationGroup.Builder preferredCacheClusterAZs(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.
    
    Parameters:
    
    preferredCacheClusterAZs - A list of EC2 Availability Zones in which the replication group's clusters are created. This parameter is required.
    
    Returns:
    
    this
  - preferredMaintenanceWindow
```
@Stability(value=Stable)
public CfnReplicationGroup.Builder preferredMaintenanceWindow(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:
    - sun
    - mon
    - tue
    - wed
    - thu
    - fri
    - sat
    Example: sun:23:00-mon:01:30
    Parameters:
    
    preferredMaintenanceWindow - Specifies the weekly time range during which maintenance on the cluster is performed. This parameter is required.
    
    Returns:
    
    this
  - primaryClusterId
```
@Stability(value=Stable)
public CfnReplicationGroup.Builder primaryClusterId(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.
    
    Parameters:
    
    primaryClusterId - The identifier of the cluster that serves as the primary for this replication group. This parameter is required.
    
    Returns:
    
    this
  - replicasPerNodeGroup
```
@Stability(value=Stable)
public CfnReplicationGroup.Builder replicasPerNodeGroup(Number replicasPerNodeGroup)
```
    An optional parameter that specifies the number of replica nodes in each node group (shard).
    Valid values are 0 to 5.
    
    Parameters:
    
    replicasPerNodeGroup - An optional parameter that specifies the number of replica nodes in each node group (shard). This parameter is required.
    
    Returns:
    
    this
  - replicationGroupId
```
@Stability(value=Stable)
public CfnReplicationGroup.Builder replicationGroupId(String replicationGroupId)
```
    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.
    Parameters:
    
    replicationGroupId - The replication group identifier. This parameter is stored as a lowercase string. This parameter is required.
    
    Returns:
    
    this
  - securityGroupIds
```
@Stability(value=Stable)
public CfnReplicationGroup.Builder securityGroupIds(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).
    
    Parameters:
    
    securityGroupIds - One or more Amazon VPC security groups associated with this replication group. This parameter is required.
    
    Returns:
    
    this
  - snapshotArns
```
@Stability(value=Stable)
public CfnReplicationGroup.Builder snapshotArns(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
    
    Parameters:
    
    snapshotArns - A list of Amazon Resource Names (ARN) that uniquely identify the Redis RDB snapshot files stored in Amazon S3. This parameter is required.
    
    Returns:
    
    this
  - snapshotName
```
@Stability(value=Stable)
public CfnReplicationGroup.Builder snapshotName(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.
    
    Parameters:
    
    snapshotName - The name of a snapshot from which to restore data into the new replication group. This parameter is required.
    
    Returns:
    
    this
  - snapshotRetentionLimit
```
@Stability(value=Stable)
public CfnReplicationGroup.Builder snapshotRetentionLimit(Number 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).
    
    Parameters:
    
    snapshotRetentionLimit - The number of days for which ElastiCache retains automatic snapshots before deleting them. This parameter is required.
    
    Returns:
    
    this
  - snapshottingClusterId
```
@Stability(value=Stable)
public CfnReplicationGroup.Builder snapshottingClusterId(String snapshottingClusterId)
```
    The cluster ID that is used as the daily snapshot source for the replication group.
    This parameter cannot be set for Redis (cluster mode enabled) replication groups.
    
    Parameters:
    
    snapshottingClusterId - The cluster ID that is used as the daily snapshot source for the replication group. This parameter is required.
    
    Returns:
    
    this
  - snapshotWindow
```
@Stability(value=Stable)
public CfnReplicationGroup.Builder snapshotWindow(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.
    
    Parameters:
    
    snapshotWindow - The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard). This parameter is required.
    
    Returns:
    
    this
  - tags
```
@Stability(value=Stable)
public CfnReplicationGroup.Builder tags(List<? extends CfnTag> 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.
    
    Parameters:
    
    tags - A list of tags to be added to this resource. This parameter is required.
    
    Returns:
    
    this
  - transitEncryptionEnabled
```
@Stability(value=Stable)
public CfnReplicationGroup.Builder transitEncryptionEnabled(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.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 TransitEncryptionEnabled as true , an AuthToken , and a CacheSubnetGroup .
    
    Parameters:
    
    transitEncryptionEnabled - A flag that enables in-transit encryption when set to `true` . This parameter is required.
    
    Returns:
    
    this
  - transitEncryptionEnabled
```
@Stability(value=Stable)
public CfnReplicationGroup.Builder transitEncryptionEnabled(IResolvable 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.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 TransitEncryptionEnabled as true , an AuthToken , and a CacheSubnetGroup .
    
    Parameters:
    
    transitEncryptionEnabled - A flag that enables in-transit encryption when set to `true` . This parameter is required.
    
    Returns:
    
    this
  - userGroupIds
```
@Stability(value=Stable)
public CfnReplicationGroup.Builder userGroupIds(List<String> userGroupIds)
```
    The list of user groups to associate with the replication group.
    
    Parameters:
    
    userGroupIds - The list of user groups to associate with the replication group. This parameter is required.
    
    Returns:
    
    this
  - build
```
@Stability(value=Stable)
public CfnReplicationGroup build()
```
    Specified by:
    
    build in interface software.amazon.jsii.Builder<CfnReplicationGroup>

Class CfnReplicationGroup.Builder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

create

replicationGroupDescription

atRestEncryptionEnabled

atRestEncryptionEnabled

authToken

automaticFailoverEnabled

automaticFailoverEnabled

autoMinorVersionUpgrade

autoMinorVersionUpgrade

cacheNodeType

cacheParameterGroupName

cacheSecurityGroupNames

cacheSubnetGroupName

dataTieringEnabled

dataTieringEnabled

engine

engineVersion

globalReplicationGroupId

kmsKeyId

logDeliveryConfigurations

logDeliveryConfigurations

multiAzEnabled

multiAzEnabled

nodeGroupConfiguration

nodeGroupConfiguration

notificationTopicArn

numCacheClusters

numNodeGroups

port

preferredCacheClusterAZs

preferredMaintenanceWindow

primaryClusterId

replicasPerNodeGroup

replicationGroupId

securityGroupIds

snapshotArns

snapshotName

snapshotRetentionLimit

snapshottingClusterId

snapshotWindow

tags

transitEncryptionEnabled

transitEncryptionEnabled

userGroupIds

build