1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. elasticache
  5. ReplicationGroup

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.59.0
published on Monday, Mar 30, 2026 by Pulumi
aws-native logo

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.59.0
published on Monday, Mar 30, 2026 by Pulumi

    Resource type definition for AWS::ElastiCache::ReplicationGroup

    Create ReplicationGroup Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new ReplicationGroup(name: string, args: ReplicationGroupArgs, opts?: CustomResourceOptions);
    @overload
    def ReplicationGroup(resource_name: str,
                         args: ReplicationGroupArgs,
                         opts: Optional[ResourceOptions] = None)
    
    @overload
    def ReplicationGroup(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         replication_group_description: Optional[str] = None,
                         data_tiering_enabled: Optional[bool] = None,
                         num_cache_clusters: Optional[int] = None,
                         automatic_failover_enabled: Optional[bool] = None,
                         cache_node_type: Optional[str] = None,
                         cache_parameter_group_name: Optional[str] = None,
                         cache_security_group_names: Optional[Sequence[str]] = None,
                         cache_subnet_group_name: Optional[str] = None,
                         cluster_mode: Optional[str] = None,
                         at_rest_encryption_enabled: Optional[bool] = None,
                         num_node_groups: Optional[int] = None,
                         engine_version: Optional[str] = None,
                         global_replication_group_id: Optional[str] = None,
                         ip_discovery: Optional[str] = None,
                         kms_key_id: Optional[str] = None,
                         log_delivery_configurations: Optional[Sequence[ReplicationGroupLogDeliveryConfigurationRequestArgs]] = None,
                         multi_az_enabled: Optional[bool] = None,
                         network_type: Optional[str] = None,
                         node_group_configuration: Optional[Sequence[ReplicationGroupNodeGroupConfigurationArgs]] = None,
                         auto_minor_version_upgrade: Optional[bool] = None,
                         notification_topic_arn: Optional[str] = None,
                         engine: Optional[str] = None,
                         port: Optional[int] = None,
                         preferred_cache_cluster_azs: Optional[Sequence[str]] = None,
                         preferred_maintenance_window: Optional[str] = None,
                         primary_cluster_id: Optional[str] = None,
                         replicas_per_node_group: Optional[int] = None,
                         auth_token: Optional[str] = None,
                         replication_group_id: Optional[str] = None,
                         security_group_ids: Optional[Sequence[str]] = None,
                         snapshot_arns: Optional[Sequence[str]] = None,
                         snapshot_name: Optional[str] = None,
                         snapshot_retention_limit: Optional[int] = None,
                         snapshot_window: Optional[str] = None,
                         snapshotting_cluster_id: Optional[str] = None,
                         tags: Optional[Sequence[_root_inputs.TagArgs]] = None,
                         transit_encryption_enabled: Optional[bool] = None,
                         transit_encryption_mode: Optional[str] = None,
                         user_group_ids: Optional[Sequence[str]] = None)
    func NewReplicationGroup(ctx *Context, name string, args ReplicationGroupArgs, opts ...ResourceOption) (*ReplicationGroup, error)
    public ReplicationGroup(string name, ReplicationGroupArgs args, CustomResourceOptions? opts = null)
    public ReplicationGroup(String name, ReplicationGroupArgs args)
    public ReplicationGroup(String name, ReplicationGroupArgs args, CustomResourceOptions options)
    
    type: aws-native:elasticache:ReplicationGroup
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args ReplicationGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ReplicationGroupArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ReplicationGroupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ReplicationGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ReplicationGroupArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    ReplicationGroup Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The ReplicationGroup resource accepts the following input properties:

    ReplicationGroupDescription string
    A user-created description for the replication group.
    AtRestEncryptionEnabled bool
    A flag that enables encryption at rest when set to true.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.
    AuthToken string
    Reserved parameter. The password used to access a password protected server.AuthToken can be specified only on replication groups where TransitEncryptionEnabled is true. For more information.
    AutoMinorVersionUpgrade bool
    This parameter is currently disabled.
    AutomaticFailoverEnabled bool
    Specifies whether a read-only replica is automatically promoted to read/write primary if the existing primary fails. AutomaticFailoverEnabled must be enabled for Redis (cluster mode enabled) replication groups.
    CacheNodeType string
    The compute and memory capacity of the nodes in the node group (shard).
    CacheParameterGroupName string
    The name of the parameter group to associate with this replication group. If this argument is omitted, the default cache parameter group for the specified engine is used.
    CacheSecurityGroupNames List<string>
    A list of cache security group names to associate with this replication group.
    CacheSubnetGroupName string
    The name of the cache subnet group to be used for the replication group.
    ClusterMode string
    Enabled or Disabled. To modify cluster mode from Disabled to Enabled, you must first set the cluster mode to Compatible. Compatible mode allows your Redis OSS clients to connect using both cluster mode enabled and cluster mode disabled. After you migrate all Redis OSS clients to use cluster mode enabled, you can then complete cluster mode configuration and set the cluster mode to Enabled. For more information, see Modify cluster mode.
    DataTieringEnabled bool
    Enables data tiering. Data tiering is only supported for replication groups using the r6gd node type. This parameter must be set to true when using r6gd nodes.
    Engine string
    The name of the cache engine to be used for the clusters in this replication group.
    EngineVersion string
    The version number of the cache engine to be used for the clusters in this replication group. To view the supported cache engine versions, use the DescribeCacheEngineVersions operation.
    GlobalReplicationGroupId string
    The name of the Global datastore
    IpDiscovery string
    The network type you choose when creating a replication group, either ipv4 | ipv6. IPv6 is supported for workloads using Redis OSS engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the Nitro system.
    KmsKeyId string
    The ID of the KMS key used to encrypt the disk on the cluster.
    LogDeliveryConfigurations List<Pulumi.AwsNative.ElastiCache.Inputs.ReplicationGroupLogDeliveryConfigurationRequest>
    Specifies the destination, format and type of the logs.
    MultiAzEnabled bool
    A flag indicating if you have Multi-AZ enabled to enhance fault tolerance. For more information, see Minimizing Downtime: Multi-AZ.
    NetworkType string
    Must be either ipv4 | ipv6 | dual_stack. IPv6 is supported for workloads using Redis OSS engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the Nitro system
    NodeGroupConfiguration List<Pulumi.AwsNative.ElastiCache.Inputs.ReplicationGroupNodeGroupConfiguration>
    NodeGroupConfiguration is a property of the AWS::ElastiCache::ReplicationGroup resource that configures an Amazon ElastiCache (ElastiCache) Redis cluster node group.
    NotificationTopicArn string
    The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.
    NumCacheClusters int
    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.
    NumNodeGroups int
    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.
    Port int
    The port number on which each member of the replication group accepts connections.
    PreferredCacheClusterAzs List<string>
    A list of EC2 Availability Zones in which the replication group's clusters are created. The order of the Availability Zones in the list is the order in which clusters are allocated. The primary cluster is created in the first AZ in the list. This parameter is not used if there is more than one node group (shard). You should use NodeGroupConfiguration instead.
    PreferredMaintenanceWindow string
    Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period.
    PrimaryClusterId string
    The identifier of the cluster that serves as the primary for this replication group. This cluster must already exist and have a status of available.
    ReplicasPerNodeGroup int
    An optional parameter that specifies the number of replica nodes in each node group (shard). Valid values are 0 to 5.
    ReplicationGroupId string
    The replication group identifier. This parameter is stored as a lowercase string.
    SecurityGroupIds List<string>
    One or more Amazon VPC security groups associated with this replication group.
    SnapshotArns List<string>
    A list of Amazon Resource Names (ARN) that uniquely identify the Redis RDB snapshot files stored in Amazon S3.
    SnapshotName string
    The name of a snapshot from which to restore data into the new replication group. The snapshot status changes to restoring while the new replication group is being created.
    SnapshotRetentionLimit int
    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.
    SnapshotWindow string
    The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).
    SnapshottingClusterId string
    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.
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    A list of cost allocation 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.
    TransitEncryptionEnabled bool
    A flag that enables in-transit encryption when set to true.
    TransitEncryptionMode string
    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 OSS 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, after that you can set TransitEncryptionMode to required. This process will not trigger the replacement of the replication group.
    UserGroupIds List<string>
    The ID of user group to associate with the replication group.
    ReplicationGroupDescription string
    A user-created description for the replication group.
    AtRestEncryptionEnabled bool
    A flag that enables encryption at rest when set to true.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.
    AuthToken string
    Reserved parameter. The password used to access a password protected server.AuthToken can be specified only on replication groups where TransitEncryptionEnabled is true. For more information.
    AutoMinorVersionUpgrade bool
    This parameter is currently disabled.
    AutomaticFailoverEnabled bool
    Specifies whether a read-only replica is automatically promoted to read/write primary if the existing primary fails. AutomaticFailoverEnabled must be enabled for Redis (cluster mode enabled) replication groups.
    CacheNodeType string
    The compute and memory capacity of the nodes in the node group (shard).
    CacheParameterGroupName string
    The name of the parameter group to associate with this replication group. If this argument is omitted, the default cache parameter group for the specified engine is used.
    CacheSecurityGroupNames []string
    A list of cache security group names to associate with this replication group.
    CacheSubnetGroupName string
    The name of the cache subnet group to be used for the replication group.
    ClusterMode string
    Enabled or Disabled. To modify cluster mode from Disabled to Enabled, you must first set the cluster mode to Compatible. Compatible mode allows your Redis OSS clients to connect using both cluster mode enabled and cluster mode disabled. After you migrate all Redis OSS clients to use cluster mode enabled, you can then complete cluster mode configuration and set the cluster mode to Enabled. For more information, see Modify cluster mode.
    DataTieringEnabled bool
    Enables data tiering. Data tiering is only supported for replication groups using the r6gd node type. This parameter must be set to true when using r6gd nodes.
    Engine string
    The name of the cache engine to be used for the clusters in this replication group.
    EngineVersion string
    The version number of the cache engine to be used for the clusters in this replication group. To view the supported cache engine versions, use the DescribeCacheEngineVersions operation.
    GlobalReplicationGroupId string
    The name of the Global datastore
    IpDiscovery string
    The network type you choose when creating a replication group, either ipv4 | ipv6. IPv6 is supported for workloads using Redis OSS engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the Nitro system.
    KmsKeyId string
    The ID of the KMS key used to encrypt the disk on the cluster.
    LogDeliveryConfigurations []ReplicationGroupLogDeliveryConfigurationRequestArgs
    Specifies the destination, format and type of the logs.
    MultiAzEnabled bool
    A flag indicating if you have Multi-AZ enabled to enhance fault tolerance. For more information, see Minimizing Downtime: Multi-AZ.
    NetworkType string
    Must be either ipv4 | ipv6 | dual_stack. IPv6 is supported for workloads using Redis OSS engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the Nitro system
    NodeGroupConfiguration []ReplicationGroupNodeGroupConfigurationArgs
    NodeGroupConfiguration is a property of the AWS::ElastiCache::ReplicationGroup resource that configures an Amazon ElastiCache (ElastiCache) Redis cluster node group.
    NotificationTopicArn string
    The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.
    NumCacheClusters int
    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.
    NumNodeGroups int
    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.
    Port int
    The port number on which each member of the replication group accepts connections.
    PreferredCacheClusterAzs []string
    A list of EC2 Availability Zones in which the replication group's clusters are created. The order of the Availability Zones in the list is the order in which clusters are allocated. The primary cluster is created in the first AZ in the list. This parameter is not used if there is more than one node group (shard). You should use NodeGroupConfiguration instead.
    PreferredMaintenanceWindow string
    Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period.
    PrimaryClusterId string
    The identifier of the cluster that serves as the primary for this replication group. This cluster must already exist and have a status of available.
    ReplicasPerNodeGroup int
    An optional parameter that specifies the number of replica nodes in each node group (shard). Valid values are 0 to 5.
    ReplicationGroupId string
    The replication group identifier. This parameter is stored as a lowercase string.
    SecurityGroupIds []string
    One or more Amazon VPC security groups associated with this replication group.
    SnapshotArns []string
    A list of Amazon Resource Names (ARN) that uniquely identify the Redis RDB snapshot files stored in Amazon S3.
    SnapshotName string
    The name of a snapshot from which to restore data into the new replication group. The snapshot status changes to restoring while the new replication group is being created.
    SnapshotRetentionLimit int
    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.
    SnapshotWindow string
    The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).
    SnapshottingClusterId string
    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.
    Tags TagArgs
    A list of cost allocation 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.
    TransitEncryptionEnabled bool
    A flag that enables in-transit encryption when set to true.
    TransitEncryptionMode string
    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 OSS 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, after that you can set TransitEncryptionMode to required. This process will not trigger the replacement of the replication group.
    UserGroupIds []string
    The ID of user group to associate with the replication group.
    replicationGroupDescription String
    A user-created description for the replication group.
    atRestEncryptionEnabled Boolean
    A flag that enables encryption at rest when set to true.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.
    authToken String
    Reserved parameter. The password used to access a password protected server.AuthToken can be specified only on replication groups where TransitEncryptionEnabled is true. For more information.
    autoMinorVersionUpgrade Boolean
    This parameter is currently disabled.
    automaticFailoverEnabled Boolean
    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.
    cacheNodeType String
    The compute and memory capacity of the nodes in the node group (shard).
    cacheParameterGroupName String
    The name of the parameter group to associate with this replication group. If this argument is omitted, the default cache parameter group for the specified engine is used.
    cacheSecurityGroupNames List<String>
    A list of cache security group names to associate with this replication group.
    cacheSubnetGroupName String
    The name of the cache subnet group to be used for the replication group.
    clusterMode String
    Enabled or Disabled. To modify cluster mode from Disabled to Enabled, you must first set the cluster mode to Compatible. Compatible mode allows your Redis OSS clients to connect using both cluster mode enabled and cluster mode disabled. After you migrate all Redis OSS clients to use cluster mode enabled, you can then complete cluster mode configuration and set the cluster mode to Enabled. For more information, see Modify cluster mode.
    dataTieringEnabled Boolean
    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.
    engine String
    The name of the cache engine to be used for the clusters in this replication group.
    engineVersion String
    The version number of the cache engine to be used for the clusters in this replication group. To view the supported cache engine versions, use the DescribeCacheEngineVersions operation.
    globalReplicationGroupId String
    The name of the Global datastore
    ipDiscovery String
    The network type you choose when creating a replication group, either ipv4 | ipv6. IPv6 is supported for workloads using Redis OSS engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the Nitro system.
    kmsKeyId String
    The ID of the KMS key used to encrypt the disk on the cluster.
    logDeliveryConfigurations List<ReplicationGroupLogDeliveryConfigurationRequest>
    Specifies the destination, format and type of the logs.
    multiAzEnabled Boolean
    A flag indicating if you have Multi-AZ enabled to enhance fault tolerance. For more information, see Minimizing Downtime: Multi-AZ.
    networkType String
    Must be either ipv4 | ipv6 | dual_stack. IPv6 is supported for workloads using Redis OSS engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the Nitro system
    nodeGroupConfiguration List<ReplicationGroupNodeGroupConfiguration>
    NodeGroupConfiguration is a property of the AWS::ElastiCache::ReplicationGroup resource that configures an Amazon ElastiCache (ElastiCache) Redis cluster node group.
    notificationTopicArn String
    The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.
    numCacheClusters Integer
    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.
    numNodeGroups Integer
    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.
    port Integer
    The port number on which each member of the replication group accepts connections.
    preferredCacheClusterAzs List<String>
    A list of EC2 Availability Zones in which the replication group's clusters are created. The order of the Availability Zones in the list is the order in which clusters are allocated. The primary cluster is created in the first AZ in the list. This parameter is not used if there is more than one node group (shard). You should use NodeGroupConfiguration instead.
    preferredMaintenanceWindow String
    Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period.
    primaryClusterId String
    The identifier of the cluster that serves as the primary for this replication group. This cluster must already exist and have a status of available.
    replicasPerNodeGroup Integer
    An optional parameter that specifies the number of replica nodes in each node group (shard). Valid values are 0 to 5.
    replicationGroupId String
    The replication group identifier. This parameter is stored as a lowercase string.
    securityGroupIds List<String>
    One or more Amazon VPC security groups associated with this replication group.
    snapshotArns List<String>
    A list of Amazon Resource Names (ARN) that uniquely identify the Redis RDB snapshot files stored in Amazon S3.
    snapshotName String
    The name of a snapshot from which to restore data into the new replication group. The snapshot status changes to restoring while the new replication group is being created.
    snapshotRetentionLimit Integer
    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.
    snapshotWindow String
    The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).
    snapshottingClusterId String
    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.
    tags List<Tag>
    A list of cost allocation 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.
    transitEncryptionEnabled Boolean
    A flag that enables in-transit encryption when set to true.
    transitEncryptionMode String
    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 OSS 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, after that you can set TransitEncryptionMode to required. This process will not trigger the replacement of the replication group.
    userGroupIds List<String>
    The ID of user group to associate with the replication group.
    replicationGroupDescription string
    A user-created description for the replication group.
    atRestEncryptionEnabled boolean
    A flag that enables encryption at rest when set to true.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.
    authToken string
    Reserved parameter. The password used to access a password protected server.AuthToken can be specified only on replication groups where TransitEncryptionEnabled is true. For more information.
    autoMinorVersionUpgrade boolean
    This parameter is currently disabled.
    automaticFailoverEnabled boolean
    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.
    cacheNodeType string
    The compute and memory capacity of the nodes in the node group (shard).
    cacheParameterGroupName string
    The name of the parameter group to associate with this replication group. If this argument is omitted, the default cache parameter group for the specified engine is used.
    cacheSecurityGroupNames string[]
    A list of cache security group names to associate with this replication group.
    cacheSubnetGroupName string
    The name of the cache subnet group to be used for the replication group.
    clusterMode string
    Enabled or Disabled. To modify cluster mode from Disabled to Enabled, you must first set the cluster mode to Compatible. Compatible mode allows your Redis OSS clients to connect using both cluster mode enabled and cluster mode disabled. After you migrate all Redis OSS clients to use cluster mode enabled, you can then complete cluster mode configuration and set the cluster mode to Enabled. For more information, see Modify cluster mode.
    dataTieringEnabled boolean
    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.
    engine string
    The name of the cache engine to be used for the clusters in this replication group.
    engineVersion string
    The version number of the cache engine to be used for the clusters in this replication group. To view the supported cache engine versions, use the DescribeCacheEngineVersions operation.
    globalReplicationGroupId string
    The name of the Global datastore
    ipDiscovery string
    The network type you choose when creating a replication group, either ipv4 | ipv6. IPv6 is supported for workloads using Redis OSS engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the Nitro system.
    kmsKeyId string
    The ID of the KMS key used to encrypt the disk on the cluster.
    logDeliveryConfigurations ReplicationGroupLogDeliveryConfigurationRequest[]
    Specifies the destination, format and type of the logs.
    multiAzEnabled boolean
    A flag indicating if you have Multi-AZ enabled to enhance fault tolerance. For more information, see Minimizing Downtime: Multi-AZ.
    networkType string
    Must be either ipv4 | ipv6 | dual_stack. IPv6 is supported for workloads using Redis OSS engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the Nitro system
    nodeGroupConfiguration ReplicationGroupNodeGroupConfiguration[]
    NodeGroupConfiguration is a property of the AWS::ElastiCache::ReplicationGroup resource that configures an Amazon ElastiCache (ElastiCache) Redis cluster node group.
    notificationTopicArn string
    The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.
    numCacheClusters number
    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.
    numNodeGroups number
    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.
    port number
    The port number on which each member of the replication group accepts connections.
    preferredCacheClusterAzs string[]
    A list of EC2 Availability Zones in which the replication group's clusters are created. The order of the Availability Zones in the list is the order in which clusters are allocated. The primary cluster is created in the first AZ in the list. This parameter is not used if there is more than one node group (shard). You should use NodeGroupConfiguration instead.
    preferredMaintenanceWindow string
    Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period.
    primaryClusterId string
    The identifier of the cluster that serves as the primary for this replication group. This cluster must already exist and have a status of available.
    replicasPerNodeGroup number
    An optional parameter that specifies the number of replica nodes in each node group (shard). Valid values are 0 to 5.
    replicationGroupId string
    The replication group identifier. This parameter is stored as a lowercase string.
    securityGroupIds string[]
    One or more Amazon VPC security groups associated with this replication group.
    snapshotArns string[]
    A list of Amazon Resource Names (ARN) that uniquely identify the Redis RDB snapshot files stored in Amazon S3.
    snapshotName string
    The name of a snapshot from which to restore data into the new replication group. The snapshot status changes to restoring while the new replication group is being created.
    snapshotRetentionLimit number
    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.
    snapshotWindow string
    The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).
    snapshottingClusterId string
    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.
    tags Tag[]
    A list of cost allocation 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.
    transitEncryptionEnabled boolean
    A flag that enables in-transit encryption when set to true.
    transitEncryptionMode string
    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 OSS 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, after that you can set TransitEncryptionMode to required. This process will not trigger the replacement of the replication group.
    userGroupIds string[]
    The ID of user group to associate with the replication group.
    replication_group_description str
    A user-created description for the replication group.
    at_rest_encryption_enabled bool
    A flag that enables encryption at rest when set to true.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.
    auth_token str
    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.
    auto_minor_version_upgrade bool
    This parameter is currently disabled.
    automatic_failover_enabled bool
    Specifies whether a read-only replica is automatically promoted to read/write primary if the existing primary fails. AutomaticFailoverEnabled must be enabled for Redis (cluster mode enabled) replication groups.
    cache_node_type str
    The compute and memory capacity of the nodes in the node group (shard).
    cache_parameter_group_name str
    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.
    cache_security_group_names Sequence[str]
    A list of cache security group names to associate with this replication group.
    cache_subnet_group_name str
    The name of the cache subnet group to be used for the replication group.
    cluster_mode str
    Enabled or Disabled. To modify cluster mode from Disabled to Enabled, you must first set the cluster mode to Compatible. Compatible mode allows your Redis OSS clients to connect using both cluster mode enabled and cluster mode disabled. After you migrate all Redis OSS clients to use cluster mode enabled, you can then complete cluster mode configuration and set the cluster mode to Enabled. For more information, see Modify cluster mode.
    data_tiering_enabled bool
    Enables data tiering. Data tiering is only supported for replication groups using the r6gd node type. This parameter must be set to true when using r6gd nodes.
    engine str
    The name of the cache engine to be used for the clusters in this replication group.
    engine_version str
    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.
    global_replication_group_id str
    The name of the Global datastore
    ip_discovery str
    The network type you choose when creating a replication group, either ipv4 | ipv6. IPv6 is supported for workloads using Redis OSS engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the Nitro system.
    kms_key_id str
    The ID of the KMS key used to encrypt the disk on the cluster.
    log_delivery_configurations Sequence[ReplicationGroupLogDeliveryConfigurationRequestArgs]
    Specifies the destination, format and type of the logs.
    multi_az_enabled bool
    A flag indicating if you have Multi-AZ enabled to enhance fault tolerance. For more information, see Minimizing Downtime: Multi-AZ.
    network_type str
    Must be either ipv4 | ipv6 | dual_stack. IPv6 is supported for workloads using Redis OSS engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the Nitro system
    node_group_configuration Sequence[ReplicationGroupNodeGroupConfigurationArgs]
    NodeGroupConfiguration is a property of the AWS::ElastiCache::ReplicationGroup resource that configures an Amazon ElastiCache (ElastiCache) Redis cluster node group.
    notification_topic_arn str
    The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.
    num_cache_clusters int
    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.
    num_node_groups int
    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.
    port int
    The port number on which each member of the replication group accepts connections.
    preferred_cache_cluster_azs Sequence[str]
    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.
    preferred_maintenance_window str
    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.
    primary_cluster_id str
    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.
    replicas_per_node_group int
    An optional parameter that specifies the number of replica nodes in each node group (shard). Valid values are 0 to 5.
    replication_group_id str
    The replication group identifier. This parameter is stored as a lowercase string.
    security_group_ids Sequence[str]
    One or more Amazon VPC security groups associated with this replication group.
    snapshot_arns Sequence[str]
    A list of Amazon Resource Names (ARN) that uniquely identify the Redis RDB snapshot files stored in Amazon S3.
    snapshot_name str
    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.
    snapshot_retention_limit int
    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.
    snapshot_window str
    The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).
    snapshotting_cluster_id str
    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.
    tags Sequence[TagArgs]
    A list of cost allocation 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.
    transit_encryption_enabled bool
    A flag that enables in-transit encryption when set to true.
    transit_encryption_mode str
    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 OSS 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, after that you can set TransitEncryptionMode to required. This process will not trigger the replacement of the replication group.
    user_group_ids Sequence[str]
    The ID of user group to associate with the replication group.
    replicationGroupDescription String
    A user-created description for the replication group.
    atRestEncryptionEnabled Boolean
    A flag that enables encryption at rest when set to true.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.
    authToken String
    Reserved parameter. The password used to access a password protected server.AuthToken can be specified only on replication groups where TransitEncryptionEnabled is true. For more information.
    autoMinorVersionUpgrade Boolean
    This parameter is currently disabled.
    automaticFailoverEnabled Boolean
    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.
    cacheNodeType String
    The compute and memory capacity of the nodes in the node group (shard).
    cacheParameterGroupName String
    The name of the parameter group to associate with this replication group. If this argument is omitted, the default cache parameter group for the specified engine is used.
    cacheSecurityGroupNames List<String>
    A list of cache security group names to associate with this replication group.
    cacheSubnetGroupName String
    The name of the cache subnet group to be used for the replication group.
    clusterMode String
    Enabled or Disabled. To modify cluster mode from Disabled to Enabled, you must first set the cluster mode to Compatible. Compatible mode allows your Redis OSS clients to connect using both cluster mode enabled and cluster mode disabled. After you migrate all Redis OSS clients to use cluster mode enabled, you can then complete cluster mode configuration and set the cluster mode to Enabled. For more information, see Modify cluster mode.
    dataTieringEnabled Boolean
    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.
    engine String
    The name of the cache engine to be used for the clusters in this replication group.
    engineVersion String
    The version number of the cache engine to be used for the clusters in this replication group. To view the supported cache engine versions, use the DescribeCacheEngineVersions operation.
    globalReplicationGroupId String
    The name of the Global datastore
    ipDiscovery String
    The network type you choose when creating a replication group, either ipv4 | ipv6. IPv6 is supported for workloads using Redis OSS engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the Nitro system.
    kmsKeyId String
    The ID of the KMS key used to encrypt the disk on the cluster.
    logDeliveryConfigurations List<Property Map>
    Specifies the destination, format and type of the logs.
    multiAzEnabled Boolean
    A flag indicating if you have Multi-AZ enabled to enhance fault tolerance. For more information, see Minimizing Downtime: Multi-AZ.
    networkType String
    Must be either ipv4 | ipv6 | dual_stack. IPv6 is supported for workloads using Redis OSS engine version 6.2 onward or Memcached engine version 1.6.6 on all instances built on the Nitro system
    nodeGroupConfiguration List<Property Map>
    NodeGroupConfiguration is a property of the AWS::ElastiCache::ReplicationGroup resource that configures an Amazon ElastiCache (ElastiCache) Redis cluster node group.
    notificationTopicArn String
    The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.
    numCacheClusters Number
    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.
    numNodeGroups Number
    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.
    port Number
    The port number on which each member of the replication group accepts connections.
    preferredCacheClusterAzs List<String>
    A list of EC2 Availability Zones in which the replication group's clusters are created. The order of the Availability Zones in the list is the order in which clusters are allocated. The primary cluster is created in the first AZ in the list. This parameter is not used if there is more than one node group (shard). You should use NodeGroupConfiguration instead.
    preferredMaintenanceWindow String
    Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period.
    primaryClusterId String
    The identifier of the cluster that serves as the primary for this replication group. This cluster must already exist and have a status of available.
    replicasPerNodeGroup Number
    An optional parameter that specifies the number of replica nodes in each node group (shard). Valid values are 0 to 5.
    replicationGroupId String
    The replication group identifier. This parameter is stored as a lowercase string.
    securityGroupIds List<String>
    One or more Amazon VPC security groups associated with this replication group.
    snapshotArns List<String>
    A list of Amazon Resource Names (ARN) that uniquely identify the Redis RDB snapshot files stored in Amazon S3.
    snapshotName String
    The name of a snapshot from which to restore data into the new replication group. The snapshot status changes to restoring while the new replication group is being created.
    snapshotRetentionLimit Number
    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.
    snapshotWindow String
    The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).
    snapshottingClusterId String
    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.
    tags List<Property Map>
    A list of cost allocation 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.
    transitEncryptionEnabled Boolean
    A flag that enables in-transit encryption when set to true.
    transitEncryptionMode String
    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 OSS 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, after that you can set TransitEncryptionMode to required. This process will not trigger the replacement of the replication group.
    userGroupIds List<String>
    The ID of user group to associate with the replication group.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ReplicationGroup resource produces the following output properties:

    ConfigurationEndPoint Pulumi.AwsNative.ElastiCache.Outputs.ReplicationGroupEndpoint
    The configuration details of the replication group.
    Id string
    The provider-assigned unique ID for this managed resource.
    PrimaryEndPoint Pulumi.AwsNative.ElastiCache.Outputs.ReplicationGroupEndpoint
    The primary endpoint configuration
    ReadEndPoint Pulumi.AwsNative.ElastiCache.Outputs.ReadEndPointProperties
    ReaderEndPoint Pulumi.AwsNative.ElastiCache.Outputs.ReplicationGroupEndpoint
    The endpoint of the reader node in the replication group.
    ConfigurationEndPoint ReplicationGroupEndpoint
    The configuration details of the replication group.
    Id string
    The provider-assigned unique ID for this managed resource.
    PrimaryEndPoint ReplicationGroupEndpoint
    The primary endpoint configuration
    ReadEndPoint ReadEndPointProperties
    ReaderEndPoint ReplicationGroupEndpoint
    The endpoint of the reader node in the replication group.
    configurationEndPoint ReplicationGroupEndpoint
    The configuration details of the replication group.
    id String
    The provider-assigned unique ID for this managed resource.
    primaryEndPoint ReplicationGroupEndpoint
    The primary endpoint configuration
    readEndPoint ReadEndPointProperties
    readerEndPoint ReplicationGroupEndpoint
    The endpoint of the reader node in the replication group.
    configurationEndPoint ReplicationGroupEndpoint
    The configuration details of the replication group.
    id string
    The provider-assigned unique ID for this managed resource.
    primaryEndPoint ReplicationGroupEndpoint
    The primary endpoint configuration
    readEndPoint ReadEndPointProperties
    readerEndPoint ReplicationGroupEndpoint
    The endpoint of the reader node in the replication group.
    configuration_end_point ReplicationGroupEndpoint
    The configuration details of the replication group.
    id str
    The provider-assigned unique ID for this managed resource.
    primary_end_point ReplicationGroupEndpoint
    The primary endpoint configuration
    read_end_point ReadEndPointProperties
    reader_end_point ReplicationGroupEndpoint
    The endpoint of the reader node in the replication group.
    configurationEndPoint Property Map
    The configuration details of the replication group.
    id String
    The provider-assigned unique ID for this managed resource.
    primaryEndPoint Property Map
    The primary endpoint configuration
    readEndPoint Property Map
    readerEndPoint Property Map
    The endpoint of the reader node in the replication group.

    Supporting Types

    ReadEndPointProperties, ReadEndPointPropertiesArgs

    Addresses string
    A string containing a comma-separated list of endpoints for the primary and read-only replicas, formatted as [address1, address2, ...]. The order of the addresses maps to the order of the ports from the ReadEndPoint.Ports attribute.
    AddressesList List<string>
    A list of endpoints for the read-only replicas. The order of the addresses maps to the order of the ports from the ReadEndPoint.Ports attribute.
    Ports string
    A string containing a comma-separated list of ports for the read-only replicas, formatted as [port1, port2, ...]. The order of the ports maps to the order of the addresses from the ReadEndPoint.Addresses attribute.
    PortsList List<string>
    A list of ports for the read-only replicas. The order of the ports maps to the order of the addresses from the ReadEndPoint.Addresses attribute.
    Addresses string
    A string containing a comma-separated list of endpoints for the primary and read-only replicas, formatted as [address1, address2, ...]. The order of the addresses maps to the order of the ports from the ReadEndPoint.Ports attribute.
    AddressesList []string
    A list of endpoints for the read-only replicas. The order of the addresses maps to the order of the ports from the ReadEndPoint.Ports attribute.
    Ports string
    A string containing a comma-separated list of ports for the read-only replicas, formatted as [port1, port2, ...]. The order of the ports maps to the order of the addresses from the ReadEndPoint.Addresses attribute.
    PortsList []string
    A list of ports for the read-only replicas. The order of the ports maps to the order of the addresses from the ReadEndPoint.Addresses attribute.
    addresses String
    A string containing a comma-separated list of endpoints for the primary and read-only replicas, formatted as [address1, address2, ...]. The order of the addresses maps to the order of the ports from the ReadEndPoint.Ports attribute.
    addressesList List<String>
    A list of endpoints for the read-only replicas. The order of the addresses maps to the order of the ports from the ReadEndPoint.Ports attribute.
    ports String
    A string containing a comma-separated list of ports for the read-only replicas, formatted as [port1, port2, ...]. The order of the ports maps to the order of the addresses from the ReadEndPoint.Addresses attribute.
    portsList List<String>
    A list of ports for the read-only replicas. The order of the ports maps to the order of the addresses from the ReadEndPoint.Addresses attribute.
    addresses string
    A string containing a comma-separated list of endpoints for the primary and read-only replicas, formatted as [address1, address2, ...]. The order of the addresses maps to the order of the ports from the ReadEndPoint.Ports attribute.
    addressesList string[]
    A list of endpoints for the read-only replicas. The order of the addresses maps to the order of the ports from the ReadEndPoint.Ports attribute.
    ports string
    A string containing a comma-separated list of ports for the read-only replicas, formatted as [port1, port2, ...]. The order of the ports maps to the order of the addresses from the ReadEndPoint.Addresses attribute.
    portsList string[]
    A list of ports for the read-only replicas. The order of the ports maps to the order of the addresses from the ReadEndPoint.Addresses attribute.
    addresses str
    A string containing a comma-separated list of endpoints for the primary and read-only replicas, formatted as [address1, address2, ...]. The order of the addresses maps to the order of the ports from the ReadEndPoint.Ports attribute.
    addresses_list Sequence[str]
    A list of endpoints for the read-only replicas. The order of the addresses maps to the order of the ports from the ReadEndPoint.Ports attribute.
    ports str
    A string containing a comma-separated list of ports for the read-only replicas, formatted as [port1, port2, ...]. The order of the ports maps to the order of the addresses from the ReadEndPoint.Addresses attribute.
    ports_list Sequence[str]
    A list of ports for the read-only replicas. The order of the ports maps to the order of the addresses from the ReadEndPoint.Addresses attribute.
    addresses String
    A string containing a comma-separated list of endpoints for the primary and read-only replicas, formatted as [address1, address2, ...]. The order of the addresses maps to the order of the ports from the ReadEndPoint.Ports attribute.
    addressesList List<String>
    A list of endpoints for the read-only replicas. The order of the addresses maps to the order of the ports from the ReadEndPoint.Ports attribute.
    ports String
    A string containing a comma-separated list of ports for the read-only replicas, formatted as [port1, port2, ...]. The order of the ports maps to the order of the addresses from the ReadEndPoint.Addresses attribute.
    portsList List<String>
    A list of ports for the read-only replicas. The order of the ports maps to the order of the addresses from the ReadEndPoint.Addresses attribute.

    ReplicationGroupCloudWatchLogsDestinationDetails, ReplicationGroupCloudWatchLogsDestinationDetailsArgs

    The configuration details of the CloudWatch Logs destination. Note that this field is marked as required but only if CloudWatch Logs was chosen as the destination.
    LogGroup string
    The name of the CloudWatch Logs log group.
    LogGroup string
    The name of the CloudWatch Logs log group.
    logGroup String
    The name of the CloudWatch Logs log group.
    logGroup string
    The name of the CloudWatch Logs log group.
    log_group str
    The name of the CloudWatch Logs log group.
    logGroup String
    The name of the CloudWatch Logs log group.

    ReplicationGroupDestinationDetails, ReplicationGroupDestinationDetailsArgs

    Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.
    CloudWatchLogsDetails Pulumi.AwsNative.ElastiCache.Inputs.ReplicationGroupCloudWatchLogsDestinationDetails
    The configuration details of the CloudWatch Logs destination. Note that this field is marked as required but only if CloudWatch Logs was chosen as the destination.
    KinesisFirehoseDetails Pulumi.AwsNative.ElastiCache.Inputs.ReplicationGroupKinesisFirehoseDestinationDetails
    The configuration details of the Kinesis Data Firehose destination. Note that this field is marked as required but only if Kinesis Data Firehose was chosen as the destination.
    CloudWatchLogsDetails ReplicationGroupCloudWatchLogsDestinationDetails
    The configuration details of the CloudWatch Logs destination. Note that this field is marked as required but only if CloudWatch Logs was chosen as the destination.
    KinesisFirehoseDetails ReplicationGroupKinesisFirehoseDestinationDetails
    The configuration details of the Kinesis Data Firehose destination. Note that this field is marked as required but only if Kinesis Data Firehose was chosen as the destination.
    cloudWatchLogsDetails ReplicationGroupCloudWatchLogsDestinationDetails
    The configuration details of the CloudWatch Logs destination. Note that this field is marked as required but only if CloudWatch Logs was chosen as the destination.
    kinesisFirehoseDetails ReplicationGroupKinesisFirehoseDestinationDetails
    The configuration details of the Kinesis Data Firehose destination. Note that this field is marked as required but only if Kinesis Data Firehose was chosen as the destination.
    cloudWatchLogsDetails ReplicationGroupCloudWatchLogsDestinationDetails
    The configuration details of the CloudWatch Logs destination. Note that this field is marked as required but only if CloudWatch Logs was chosen as the destination.
    kinesisFirehoseDetails ReplicationGroupKinesisFirehoseDestinationDetails
    The configuration details of the Kinesis Data Firehose destination. Note that this field is marked as required but only if Kinesis Data Firehose was chosen as the destination.
    cloud_watch_logs_details ReplicationGroupCloudWatchLogsDestinationDetails
    The configuration details of the CloudWatch Logs destination. Note that this field is marked as required but only if CloudWatch Logs was chosen as the destination.
    kinesis_firehose_details ReplicationGroupKinesisFirehoseDestinationDetails
    The configuration details of the Kinesis Data Firehose destination. Note that this field is marked as required but only if Kinesis Data Firehose was chosen as the destination.
    cloudWatchLogsDetails Property Map
    The configuration details of the CloudWatch Logs destination. Note that this field is marked as required but only if CloudWatch Logs was chosen as the destination.
    kinesisFirehoseDetails Property Map
    The configuration details of the Kinesis Data Firehose destination. Note that this field is marked as required but only if Kinesis Data Firehose was chosen as the destination.

    ReplicationGroupEndpoint, ReplicationGroupEndpointArgs

    Address string
    The DNS hostname of the cache node.
    Port string
    The port number that the cache engine is listening on.
    Address string
    The DNS hostname of the cache node.
    Port string
    The port number that the cache engine is listening on.
    address String
    The DNS hostname of the cache node.
    port String
    The port number that the cache engine is listening on.
    address string
    The DNS hostname of the cache node.
    port string
    The port number that the cache engine is listening on.
    address str
    The DNS hostname of the cache node.
    port str
    The port number that the cache engine is listening on.
    address String
    The DNS hostname of the cache node.
    port String
    The port number that the cache engine is listening on.

    ReplicationGroupKinesisFirehoseDestinationDetails, ReplicationGroupKinesisFirehoseDestinationDetailsArgs

    The configuration details of the Kinesis Data Firehose destination. Note that this field is marked as required but only if Kinesis Data Firehose was chosen as the destination.
    DeliveryStream string
    The name of the Kinesis Data Firehose delivery stream.
    DeliveryStream string
    The name of the Kinesis Data Firehose delivery stream.
    deliveryStream String
    The name of the Kinesis Data Firehose delivery stream.
    deliveryStream string
    The name of the Kinesis Data Firehose delivery stream.
    delivery_stream str
    The name of the Kinesis Data Firehose delivery stream.
    deliveryStream String
    The name of the Kinesis Data Firehose delivery stream.

    ReplicationGroupLogDeliveryConfigurationRequest, ReplicationGroupLogDeliveryConfigurationRequestArgs

    DestinationDetails Pulumi.AwsNative.ElastiCache.Inputs.ReplicationGroupDestinationDetails
    Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.
    DestinationType string
    Specify either CloudWatch Logs or Kinesis Data Firehose as the destination type. Valid values are either cloudwatch-logs or kinesis-firehose.
    LogFormat string
    Valid values are either json or text.
    LogType string
    Valid value is either slow-log, which refers to slow-log or engine-log.
    DestinationDetails ReplicationGroupDestinationDetails
    Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.
    DestinationType string
    Specify either CloudWatch Logs or Kinesis Data Firehose as the destination type. Valid values are either cloudwatch-logs or kinesis-firehose.
    LogFormat string
    Valid values are either json or text.
    LogType string
    Valid value is either slow-log, which refers to slow-log or engine-log.
    destinationDetails ReplicationGroupDestinationDetails
    Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.
    destinationType String
    Specify either CloudWatch Logs or Kinesis Data Firehose as the destination type. Valid values are either cloudwatch-logs or kinesis-firehose.
    logFormat String
    Valid values are either json or text.
    logType String
    Valid value is either slow-log, which refers to slow-log or engine-log.
    destinationDetails ReplicationGroupDestinationDetails
    Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.
    destinationType string
    Specify either CloudWatch Logs or Kinesis Data Firehose as the destination type. Valid values are either cloudwatch-logs or kinesis-firehose.
    logFormat string
    Valid values are either json or text.
    logType string
    Valid value is either slow-log, which refers to slow-log or engine-log.
    destination_details ReplicationGroupDestinationDetails
    Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.
    destination_type str
    Specify either CloudWatch Logs or Kinesis Data Firehose as the destination type. Valid values are either cloudwatch-logs or kinesis-firehose.
    log_format str
    Valid values are either json or text.
    log_type str
    Valid value is either slow-log, which refers to slow-log or engine-log.
    destinationDetails Property Map
    Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.
    destinationType String
    Specify either CloudWatch Logs or Kinesis Data Firehose as the destination type. Valid values are either cloudwatch-logs or kinesis-firehose.
    logFormat String
    Valid values are either json or text.
    logType String
    Valid value is either slow-log, which refers to slow-log or engine-log.

    ReplicationGroupNodeGroupConfiguration, ReplicationGroupNodeGroupConfigurationArgs

    NodeGroupId string
    Either the ElastiCache for Redis supplied 4-digit id or a user supplied id for the node group these configuration values apply to.
    PrimaryAvailabilityZone string
    The Availability Zone where the primary node of this node group (shard) is launched.
    ReplicaAvailabilityZones List<string>
    A list of Availability Zones to be used for the read replicas. The number of Availability Zones in this list must match the value of ReplicaCount or ReplicasPerNodeGroup if not specified.
    ReplicaCount int
    The number of read replica nodes in this node group (shard).
    Slots string
    A string of comma-separated values where the first set of values are the slot numbers (zero based), and the second set of values are the keyspaces for each slot. The following example specifies three slots (numbered 0, 1, and 2): 0,1,2,0-4999,5000-9999,10000-16,383.
    NodeGroupId string
    Either the ElastiCache for Redis supplied 4-digit id or a user supplied id for the node group these configuration values apply to.
    PrimaryAvailabilityZone string
    The Availability Zone where the primary node of this node group (shard) is launched.
    ReplicaAvailabilityZones []string
    A list of Availability Zones to be used for the read replicas. The number of Availability Zones in this list must match the value of ReplicaCount or ReplicasPerNodeGroup if not specified.
    ReplicaCount int
    The number of read replica nodes in this node group (shard).
    Slots string
    A string of comma-separated values where the first set of values are the slot numbers (zero based), and the second set of values are the keyspaces for each slot. The following example specifies three slots (numbered 0, 1, and 2): 0,1,2,0-4999,5000-9999,10000-16,383.
    nodeGroupId String
    Either the ElastiCache for Redis supplied 4-digit id or a user supplied id for the node group these configuration values apply to.
    primaryAvailabilityZone String
    The Availability Zone where the primary node of this node group (shard) is launched.
    replicaAvailabilityZones List<String>
    A list of Availability Zones to be used for the read replicas. The number of Availability Zones in this list must match the value of ReplicaCount or ReplicasPerNodeGroup if not specified.
    replicaCount Integer
    The number of read replica nodes in this node group (shard).
    slots String
    A string of comma-separated values where the first set of values are the slot numbers (zero based), and the second set of values are the keyspaces for each slot. The following example specifies three slots (numbered 0, 1, and 2): 0,1,2,0-4999,5000-9999,10000-16,383.
    nodeGroupId string
    Either the ElastiCache for Redis supplied 4-digit id or a user supplied id for the node group these configuration values apply to.
    primaryAvailabilityZone string
    The Availability Zone where the primary node of this node group (shard) is launched.
    replicaAvailabilityZones string[]
    A list of Availability Zones to be used for the read replicas. The number of Availability Zones in this list must match the value of ReplicaCount or ReplicasPerNodeGroup if not specified.
    replicaCount number
    The number of read replica nodes in this node group (shard).
    slots string
    A string of comma-separated values where the first set of values are the slot numbers (zero based), and the second set of values are the keyspaces for each slot. The following example specifies three slots (numbered 0, 1, and 2): 0,1,2,0-4999,5000-9999,10000-16,383.
    node_group_id str
    Either the ElastiCache for Redis supplied 4-digit id or a user supplied id for the node group these configuration values apply to.
    primary_availability_zone str
    The Availability Zone where the primary node of this node group (shard) is launched.
    replica_availability_zones Sequence[str]
    A list of Availability Zones to be used for the read replicas. The number of Availability Zones in this list must match the value of ReplicaCount or ReplicasPerNodeGroup if not specified.
    replica_count int
    The number of read replica nodes in this node group (shard).
    slots str
    A string of comma-separated values where the first set of values are the slot numbers (zero based), and the second set of values are the keyspaces for each slot. The following example specifies three slots (numbered 0, 1, and 2): 0,1,2,0-4999,5000-9999,10000-16,383.
    nodeGroupId String
    Either the ElastiCache for Redis supplied 4-digit id or a user supplied id for the node group these configuration values apply to.
    primaryAvailabilityZone String
    The Availability Zone where the primary node of this node group (shard) is launched.
    replicaAvailabilityZones List<String>
    A list of Availability Zones to be used for the read replicas. The number of Availability Zones in this list must match the value of ReplicaCount or ReplicasPerNodeGroup if not specified.
    replicaCount Number
    The number of read replica nodes in this node group (shard).
    slots String
    A string of comma-separated values where the first set of values are the slot numbers (zero based), and the second set of values are the keyspaces for each slot. The following example specifies three slots (numbered 0, 1, and 2): 0,1,2,0-4999,5000-9999,10000-16,383.

    Tag, TagArgs

    A set of tags to apply to the resource.
    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    Viewing docs for AWS Cloud Control v1.59.0
    published on Monday, Mar 30, 2026 by Pulumi
      Try Pulumi Cloud free. Your team will thank you.