We recommend new projects start with resources from the AWS provider.
published on Monday, Mar 23, 2026 by Pulumi
We recommend new projects start with resources from the AWS provider.
published on Monday, Mar 23, 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:
- Replication
Group stringDescription - A user-created description for the replication group.
- At
Rest boolEncryption Enabled - 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 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.
- Auto
Minor boolVersion Upgrade - This parameter is currently disabled.
- Automatic
Failover boolEnabled - 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 stringType - The compute and memory capacity of the nodes in the node group (shard).
- Cache
Parameter stringGroup Name - 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 List<string>Group Names - A list of cache security group names to associate with this replication group.
- Cache
Subnet stringGroup Name - The name of the cache subnet group to be used for the replication group.
- Cluster
Mode 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.
- Data
Tiering boolEnabled - 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.
- Engine
Version 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.
- Global
Replication stringGroup Id - The name of the Global datastore
- Ip
Discovery 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.
- Kms
Key stringId - The ID of the KMS key used to encrypt the disk on the cluster.
- Log
Delivery List<Pulumi.Configurations Aws Native. Elasti Cache. Inputs. Replication Group Log Delivery Configuration Request> - Specifies the destination, format and type of the logs.
- Multi
Az boolEnabled - A flag indicating if you have Multi-AZ enabled to enhance fault tolerance. For more information, see Minimizing Downtime: Multi-AZ.
- Network
Type 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
- Node
Group List<Pulumi.Configuration Aws Native. Elasti Cache. Inputs. Replication Group Node Group Configuration> - NodeGroupConfiguration is a property of the AWS::ElastiCache::ReplicationGroup resource that configures an Amazon ElastiCache (ElastiCache) Redis cluster node group.
- Notification
Topic stringArn - The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.
- Num
Cache intClusters - 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 intGroups - 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 List<string>Cluster Azs - 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 stringWindow - 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 stringId - 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 intNode Group - An optional parameter that specifies the number of replica nodes in each node group (shard). Valid values are 0 to 5.
- Replication
Group stringId - The replication group identifier. This parameter is stored as a lowercase string.
- Security
Group List<string>Ids - One or more Amazon VPC security groups associated with this replication group.
- Snapshot
Arns List<string> - A list of Amazon Resource Names (ARN) that uniquely identify the Redis RDB snapshot files stored in Amazon S3.
- Snapshot
Name 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.
- Snapshot
Retention intLimit - 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 string - The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).
- Snapshotting
Cluster stringId - 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.
-
List<Pulumi.
Aws Native. 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.
- Transit
Encryption boolEnabled - A flag that enables in-transit encryption when set to true.
- Transit
Encryption stringMode - 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 List<string>Ids - The ID of user group to associate with the replication group.
- Replication
Group stringDescription - A user-created description for the replication group.
- At
Rest boolEncryption Enabled - 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 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.
- Auto
Minor boolVersion Upgrade - This parameter is currently disabled.
- Automatic
Failover boolEnabled - 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 stringType - The compute and memory capacity of the nodes in the node group (shard).
- Cache
Parameter stringGroup Name - 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 []stringGroup Names - A list of cache security group names to associate with this replication group.
- Cache
Subnet stringGroup Name - The name of the cache subnet group to be used for the replication group.
- Cluster
Mode 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.
- Data
Tiering boolEnabled - 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.
- Engine
Version 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.
- Global
Replication stringGroup Id - The name of the Global datastore
- Ip
Discovery 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.
- Kms
Key stringId - The ID of the KMS key used to encrypt the disk on the cluster.
- Log
Delivery []ReplicationConfigurations Group Log Delivery Configuration Request Args - Specifies the destination, format and type of the logs.
- Multi
Az boolEnabled - A flag indicating if you have Multi-AZ enabled to enhance fault tolerance. For more information, see Minimizing Downtime: Multi-AZ.
- Network
Type 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
- Node
Group []ReplicationConfiguration Group Node Group Configuration Args - NodeGroupConfiguration is a property of the AWS::ElastiCache::ReplicationGroup resource that configures an Amazon ElastiCache (ElastiCache) Redis cluster node group.
- Notification
Topic stringArn - The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.
- Num
Cache intClusters - 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 intGroups - 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 []stringCluster Azs - 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 stringWindow - 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 stringId - 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 intNode Group - An optional parameter that specifies the number of replica nodes in each node group (shard). Valid values are 0 to 5.
- Replication
Group stringId - The replication group identifier. This parameter is stored as a lowercase string.
- Security
Group []stringIds - One or more Amazon VPC security groups associated with this replication group.
- Snapshot
Arns []string - A list of Amazon Resource Names (ARN) that uniquely identify the Redis RDB snapshot files stored in Amazon S3.
- Snapshot
Name 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.
- Snapshot
Retention intLimit - 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 string - The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).
- Snapshotting
Cluster stringId - 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.
-
Tag
Args - 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 boolEnabled - A flag that enables in-transit encryption when set to true.
- Transit
Encryption stringMode - 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 []stringIds - The ID of user group to associate with the replication group.
- replication
Group StringDescription - A user-created description for the replication group.
- at
Rest BooleanEncryption Enabled - 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 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.
- auto
Minor BooleanVersion Upgrade - This parameter is currently disabled.
- automatic
Failover BooleanEnabled - 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 StringType - The compute and memory capacity of the nodes in the node group (shard).
- cache
Parameter StringGroup Name - 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 List<String>Group Names - A list of cache security group names to associate with this replication group.
- cache
Subnet StringGroup Name - The name of the cache subnet group to be used for the replication group.
- cluster
Mode 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.
- data
Tiering BooleanEnabled - 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.
- engine
Version 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.
- global
Replication StringGroup Id - The name of the Global datastore
- ip
Discovery 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.
- kms
Key StringId - The ID of the KMS key used to encrypt the disk on the cluster.
- log
Delivery List<ReplicationConfigurations Group Log Delivery Configuration Request> - Specifies the destination, format and type of the logs.
- multi
Az BooleanEnabled - A flag indicating if you have Multi-AZ enabled to enhance fault tolerance. For more information, see Minimizing Downtime: Multi-AZ.
- network
Type 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
- node
Group List<ReplicationConfiguration Group Node Group Configuration> - NodeGroupConfiguration is a property of the AWS::ElastiCache::ReplicationGroup resource that configures an Amazon ElastiCache (ElastiCache) Redis cluster node group.
- notification
Topic StringArn - The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.
- num
Cache IntegerClusters - 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 IntegerGroups - 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.
- preferred
Cache List<String>Cluster Azs - 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 StringWindow - 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 StringId - 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 IntegerNode Group - An optional parameter that specifies the number of replica nodes in each node group (shard). Valid values are 0 to 5.
- replication
Group StringId - The replication group identifier. This parameter is stored as a lowercase string.
- security
Group List<String>Ids - One or more Amazon VPC security groups associated with this replication group.
- snapshot
Arns List<String> - A list of Amazon Resource Names (ARN) that uniquely identify the Redis RDB snapshot files stored in Amazon S3.
- snapshot
Name 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.
- snapshot
Retention IntegerLimit - 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 String - The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).
- snapshotting
Cluster StringId - 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.
- 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.
- transit
Encryption BooleanEnabled - A flag that enables in-transit encryption when set to true.
- transit
Encryption StringMode - 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 List<String>Ids - The ID of user group to associate with the replication group.
- replication
Group stringDescription - A user-created description for the replication group.
- at
Rest booleanEncryption Enabled - 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 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.
- auto
Minor booleanVersion Upgrade - This parameter is currently disabled.
- automatic
Failover booleanEnabled - 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 stringType - The compute and memory capacity of the nodes in the node group (shard).
- cache
Parameter stringGroup Name - 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 string[]Group Names - A list of cache security group names to associate with this replication group.
- cache
Subnet stringGroup Name - The name of the cache subnet group to be used for the replication group.
- cluster
Mode 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.
- data
Tiering booleanEnabled - 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.
- engine
Version 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.
- global
Replication stringGroup Id - The name of the Global datastore
- ip
Discovery 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.
- kms
Key stringId - The ID of the KMS key used to encrypt the disk on the cluster.
- log
Delivery ReplicationConfigurations Group Log Delivery Configuration Request[] - Specifies the destination, format and type of the logs.
- multi
Az booleanEnabled - A flag indicating if you have Multi-AZ enabled to enhance fault tolerance. For more information, see Minimizing Downtime: Multi-AZ.
- network
Type 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
- node
Group ReplicationConfiguration Group Node Group Configuration[] - NodeGroupConfiguration is a property of the AWS::ElastiCache::ReplicationGroup resource that configures an Amazon ElastiCache (ElastiCache) Redis cluster node group.
- notification
Topic stringArn - The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.
- num
Cache numberClusters - 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 numberGroups - 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.
- preferred
Cache string[]Cluster Azs - 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 stringWindow - 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 stringId - 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 numberNode Group - An optional parameter that specifies the number of replica nodes in each node group (shard). Valid values are 0 to 5.
- replication
Group stringId - The replication group identifier. This parameter is stored as a lowercase string.
- security
Group string[]Ids - One or more Amazon VPC security groups associated with this replication group.
- snapshot
Arns string[] - A list of Amazon Resource Names (ARN) that uniquely identify the Redis RDB snapshot files stored in Amazon S3.
- snapshot
Name 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.
- snapshot
Retention numberLimit - 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 string - The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).
- snapshotting
Cluster stringId - 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.
- 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.
- transit
Encryption booleanEnabled - A flag that enables in-transit encryption when set to true.
- transit
Encryption stringMode - 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 string[]Ids - The ID of user group to associate with the replication group.
- replication_
group_ strdescription - A user-created description for the replication group.
- at_
rest_ boolencryption_ enabled - 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_ boolversion_ upgrade - This parameter is currently disabled.
- automatic_
failover_ boolenabled - 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_ strtype - The compute and memory capacity of the nodes in the node group (shard).
- cache_
parameter_ strgroup_ name - 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_ Sequence[str]group_ names - A list of cache security group names to associate with this replication group.
- cache_
subnet_ strgroup_ name - 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_ boolenabled - 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_ strgroup_ id - 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_ strid - The ID of the KMS key used to encrypt the disk on the cluster.
- log_
delivery_ Sequence[Replicationconfigurations Group Log Delivery Configuration Request Args] - Specifies the destination, format and type of the logs.
- multi_
az_ boolenabled - 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_ Sequence[Replicationconfiguration Group Node Group Configuration Args] - NodeGroupConfiguration is a property of the AWS::ElastiCache::ReplicationGroup resource that configures an Amazon ElastiCache (ElastiCache) Redis cluster node group.
- notification_
topic_ strarn - The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.
- num_
cache_ intclusters - 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_ intgroups - 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_ Sequence[str]cluster_ azs - 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_ strwindow - 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_ strid - 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_ intnode_ group - An optional parameter that specifies the number of replica nodes in each node group (shard). Valid values are 0 to 5.
- replication_
group_ strid - The replication group identifier. This parameter is stored as a lowercase string.
- security_
group_ Sequence[str]ids - 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_ intlimit - 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_ strid - 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.
-
Sequence[Tag
Args] - 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_ boolenabled - A flag that enables in-transit encryption when set to true.
- transit_
encryption_ strmode - 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_ Sequence[str]ids - The ID of user group to associate with the replication group.
- replication
Group StringDescription - A user-created description for the replication group.
- at
Rest BooleanEncryption Enabled - 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 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.
- auto
Minor BooleanVersion Upgrade - This parameter is currently disabled.
- automatic
Failover BooleanEnabled - 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 StringType - The compute and memory capacity of the nodes in the node group (shard).
- cache
Parameter StringGroup Name - 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 List<String>Group Names - A list of cache security group names to associate with this replication group.
- cache
Subnet StringGroup Name - The name of the cache subnet group to be used for the replication group.
- cluster
Mode 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.
- data
Tiering BooleanEnabled - 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.
- engine
Version 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.
- global
Replication StringGroup Id - The name of the Global datastore
- ip
Discovery 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.
- kms
Key StringId - The ID of the KMS key used to encrypt the disk on the cluster.
- log
Delivery List<Property Map>Configurations - Specifies the destination, format and type of the logs.
- multi
Az BooleanEnabled - A flag indicating if you have Multi-AZ enabled to enhance fault tolerance. For more information, see Minimizing Downtime: Multi-AZ.
- network
Type 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
- node
Group List<Property Map>Configuration - NodeGroupConfiguration is a property of the AWS::ElastiCache::ReplicationGroup resource that configures an Amazon ElastiCache (ElastiCache) Redis cluster node group.
- notification
Topic StringArn - The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.
- num
Cache NumberClusters - 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 NumberGroups - 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.
- preferred
Cache List<String>Cluster Azs - 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 StringWindow - 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 StringId - 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 NumberNode Group - An optional parameter that specifies the number of replica nodes in each node group (shard). Valid values are 0 to 5.
- replication
Group StringId - The replication group identifier. This parameter is stored as a lowercase string.
- security
Group List<String>Ids - One or more Amazon VPC security groups associated with this replication group.
- snapshot
Arns List<String> - A list of Amazon Resource Names (ARN) that uniquely identify the Redis RDB snapshot files stored in Amazon S3.
- snapshot
Name 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.
- snapshot
Retention NumberLimit - 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 String - The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).
- snapshotting
Cluster StringId - 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.
- 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.
- transit
Encryption BooleanEnabled - A flag that enables in-transit encryption when set to true.
- transit
Encryption StringMode - 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 List<String>Ids - 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:
- Configuration
End Pulumi.Point Aws Native. Elasti Cache. Outputs. Replication Group Endpoint - The configuration details of the replication group.
- Id string
- The provider-assigned unique ID for this managed resource.
- Primary
End Pulumi.Point Aws Native. Elasti Cache. Outputs. Replication Group Endpoint - The primary endpoint configuration
- Read
End Pulumi.Point Aws Native. Elasti Cache. Outputs. Read End Point Properties - Reader
End Pulumi.Point Aws Native. Elasti Cache. Outputs. Replication Group Endpoint - The endpoint of the reader node in the replication group.
- Configuration
End ReplicationPoint Group Endpoint - The configuration details of the replication group.
- Id string
- The provider-assigned unique ID for this managed resource.
- Primary
End ReplicationPoint Group Endpoint - The primary endpoint configuration
- Read
End ReadPoint End Point Properties - Reader
End ReplicationPoint Group Endpoint - The endpoint of the reader node in the replication group.
- configuration
End ReplicationPoint Group Endpoint - The configuration details of the replication group.
- id String
- The provider-assigned unique ID for this managed resource.
- primary
End ReplicationPoint Group Endpoint - The primary endpoint configuration
- read
End ReadPoint End Point Properties - reader
End ReplicationPoint Group Endpoint - The endpoint of the reader node in the replication group.
- configuration
End ReplicationPoint Group Endpoint - The configuration details of the replication group.
- id string
- The provider-assigned unique ID for this managed resource.
- primary
End ReplicationPoint Group Endpoint - The primary endpoint configuration
- read
End ReadPoint End Point Properties - reader
End ReplicationPoint Group Endpoint - The endpoint of the reader node in the replication group.
- configuration_
end_ Replicationpoint Group Endpoint - The configuration details of the replication group.
- id str
- The provider-assigned unique ID for this managed resource.
- primary_
end_ Replicationpoint Group Endpoint - The primary endpoint configuration
- read_
end_ Readpoint End Point Properties - reader_
end_ Replicationpoint Group Endpoint - The endpoint of the reader node in the replication group.
- configuration
End Property MapPoint - The configuration details of the replication group.
- id String
- The provider-assigned unique ID for this managed resource.
- primary
End Property MapPoint - The primary endpoint configuration
- read
End Property MapPoint - reader
End Property MapPoint - 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.
- Addresses
List 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.
- Ports
List 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.
- Addresses
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.
- Ports
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.
- addresses
List 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.
- ports
List 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.
- addresses
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.
- ports
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 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.
- addresses
List 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.
- ports
List 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.- Log
Group string - The name of the CloudWatch Logs log group.
- Log
Group string - The name of the CloudWatch Logs log group.
- log
Group String - The name of the CloudWatch Logs log group.
- log
Group string - The name of the CloudWatch Logs log group.
- log_
group str - The name of the CloudWatch Logs log group.
- log
Group String - The name of the CloudWatch Logs log group.
ReplicationGroupDestinationDetails, ReplicationGroupDestinationDetailsArgs
Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.- Cloud
Watch Pulumi.Logs Details Aws Native. Elasti Cache. Inputs. Replication Group Cloud Watch Logs Destination Details - 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 Pulumi.Details Aws Native. Elasti Cache. Inputs. Replication Group Kinesis Firehose Destination Details - 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 ReplicationLogs Details Group Cloud Watch Logs Destination Details - 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 ReplicationDetails Group Kinesis Firehose Destination Details - 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 ReplicationLogs Details Group Cloud Watch Logs Destination Details - 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 ReplicationDetails Group Kinesis Firehose Destination Details - 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 ReplicationLogs Details Group Cloud Watch Logs Destination Details - 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 ReplicationDetails Group Kinesis Firehose Destination Details - 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_ Replicationlogs_ details Group Cloud Watch Logs Destination Details - 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_ Replicationdetails Group Kinesis Firehose Destination Details - 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 Property MapLogs Details - 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 Property MapDetails - 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
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.- Delivery
Stream string - The name of the Kinesis Data Firehose delivery stream.
- Delivery
Stream string - The name of the Kinesis Data Firehose delivery stream.
- delivery
Stream String - The name of the Kinesis Data Firehose delivery stream.
- delivery
Stream string - The name of the Kinesis Data Firehose delivery stream.
- delivery_
stream str - The name of the Kinesis Data Firehose delivery stream.
- delivery
Stream String - The name of the Kinesis Data Firehose delivery stream.
ReplicationGroupLogDeliveryConfigurationRequest, ReplicationGroupLogDeliveryConfigurationRequestArgs
- Destination
Details Pulumi.Aws Native. Elasti Cache. Inputs. Replication Group Destination Details - Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.
- Destination
Type string - Specify either CloudWatch Logs or Kinesis Data Firehose as the destination type. Valid values are either cloudwatch-logs or kinesis-firehose.
- Log
Format string - Valid values are either json or text.
- Log
Type string - Valid value is either slow-log, which refers to slow-log or engine-log.
- Destination
Details ReplicationGroup Destination Details - Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.
- Destination
Type string - Specify either CloudWatch Logs or Kinesis Data Firehose as the destination type. Valid values are either cloudwatch-logs or kinesis-firehose.
- Log
Format string - Valid values are either json or text.
- Log
Type string - Valid value is either slow-log, which refers to slow-log or engine-log.
- destination
Details ReplicationGroup Destination Details - Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.
- destination
Type String - Specify either CloudWatch Logs or Kinesis Data Firehose as the destination type. Valid values are either cloudwatch-logs or kinesis-firehose.
- log
Format String - Valid values are either json or text.
- log
Type String - Valid value is either slow-log, which refers to slow-log or engine-log.
- destination
Details ReplicationGroup Destination Details - Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.
- destination
Type string - Specify either CloudWatch Logs or Kinesis Data Firehose as the destination type. Valid values are either cloudwatch-logs or kinesis-firehose.
- log
Format string - Valid values are either json or text.
- log
Type string - Valid value is either slow-log, which refers to slow-log or engine-log.
- destination_
details ReplicationGroup Destination Details - 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.
- destination
Details Property Map - Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.
- destination
Type String - Specify either CloudWatch Logs or Kinesis Data Firehose as the destination type. Valid values are either cloudwatch-logs or kinesis-firehose.
- log
Format String - Valid values are either json or text.
- log
Type String - Valid value is either slow-log, which refers to slow-log or engine-log.
ReplicationGroupNodeGroupConfiguration, ReplicationGroupNodeGroupConfigurationArgs
- Node
Group stringId - 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 stringZone - The Availability Zone where the primary node of this node group (shard) is launched.
- Replica
Availability List<string>Zones - 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 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 stringId - 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 stringZone - The Availability Zone where the primary node of this node group (shard) is launched.
- Replica
Availability []stringZones - 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 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 StringId - 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 StringZone - The Availability Zone where the primary node of this node group (shard) is launched.
- replica
Availability List<String>Zones - 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 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.
- node
Group stringId - 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 stringZone - The Availability Zone where the primary node of this node group (shard) is launched.
- replica
Availability string[]Zones - 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 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_ strid - 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_ strzone - The Availability Zone where the primary node of this node group (shard) is launched.
- replica_
availability_ Sequence[str]zones - 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.
- node
Group StringId - 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 StringZone - The Availability Zone where the primary node of this node group (shard) is launched.
- replica
Availability List<String>Zones - 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 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.Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.
published on Monday, Mar 23, 2026 by Pulumi
