import * as pulumi from "@pulumi/pulumi"; import * as inputs from "../types/input"; import * as outputs from "../types/output"; /** * Resource type definition for AWS::ElastiCache::ReplicationGroup */ export declare class ReplicationGroup extends pulumi.CustomResource { /** * Get an existing ReplicationGroup resource's state with the given name, ID, and optional extra * properties used to qualify the lookup. * * @param name The _unique_ name of the resulting resource. * @param id The _unique_ provider ID of the resource to lookup. * @param opts Optional settings to control the behavior of the CustomResource. */ static get(name: string, id: pulumi.Input, opts?: pulumi.CustomResourceOptions): ReplicationGroup; /** * Returns true if the given object is an instance of ReplicationGroup. This is designed to work even * when multiple copies of the Pulumi SDK have been loaded into the same process. */ static isInstance(obj: any): obj is ReplicationGroup; /** * 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. */ readonly atRestEncryptionEnabled: pulumi.Output; /** * 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. */ readonly authToken: pulumi.Output; /** * This parameter is currently disabled. */ readonly autoMinorVersionUpgrade: pulumi.Output; /** * 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. */ readonly automaticFailoverEnabled: pulumi.Output; /** * The compute and memory capacity of the nodes in the node group (shard). */ readonly cacheNodeType: pulumi.Output; /** * 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. */ readonly cacheParameterGroupName: pulumi.Output; /** * A list of cache security group names to associate with this replication group. */ readonly cacheSecurityGroupNames: pulumi.Output; /** * The name of the cache subnet group to be used for the replication group. */ readonly cacheSubnetGroupName: pulumi.Output; /** * 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. */ readonly clusterMode: pulumi.Output; /** * The configuration details of the replication group. */ readonly configurationEndPoint: pulumi.Output; /** * 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. */ readonly dataTieringEnabled: pulumi.Output; /** * The name of the cache engine to be used for the clusters in this replication group. */ readonly engine: pulumi.Output; /** * 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. */ readonly engineVersion: pulumi.Output; /** * The name of the Global datastore */ readonly globalReplicationGroupId: pulumi.Output; /** * 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. */ readonly ipDiscovery: pulumi.Output; /** * The ID of the KMS key used to encrypt the disk on the cluster. */ readonly kmsKeyId: pulumi.Output; /** * Specifies the destination, format and type of the logs. */ readonly logDeliveryConfigurations: pulumi.Output; /** * A flag indicating if you have Multi-AZ enabled to enhance fault tolerance. For more information, see Minimizing Downtime: Multi-AZ. */ readonly multiAzEnabled: pulumi.Output; /** * 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 */ readonly networkType: pulumi.Output; /** * NodeGroupConfiguration is a property of the AWS::ElastiCache::ReplicationGroup resource that configures an Amazon ElastiCache (ElastiCache) Redis cluster node group. */ readonly nodeGroupConfiguration: pulumi.Output; /** * The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent. */ readonly notificationTopicArn: pulumi.Output; /** * 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. */ readonly numCacheClusters: pulumi.Output; /** * 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. */ readonly numNodeGroups: pulumi.Output; /** * The port number on which each member of the replication group accepts connections. */ readonly port: pulumi.Output; /** * 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. */ readonly preferredCacheClusterAzs: pulumi.Output; /** * 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. */ readonly preferredMaintenanceWindow: pulumi.Output; /** * 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. */ readonly primaryClusterId: pulumi.Output; /** * The primary endpoint configuration */ readonly primaryEndPoint: pulumi.Output; readonly readEndPoint: pulumi.Output; /** * The endpoint of the reader node in the replication group. */ readonly readerEndPoint: pulumi.Output; /** * An optional parameter that specifies the number of replica nodes in each node group (shard). Valid values are 0 to 5. */ readonly replicasPerNodeGroup: pulumi.Output; /** * A user-created description for the replication group. */ readonly replicationGroupDescription: pulumi.Output; /** * The replication group identifier. This parameter is stored as a lowercase string. */ readonly replicationGroupId: pulumi.Output; /** * One or more Amazon VPC security groups associated with this replication group. */ readonly securityGroupIds: pulumi.Output; /** * A list of Amazon Resource Names (ARN) that uniquely identify the Redis RDB snapshot files stored in Amazon S3. */ readonly snapshotArns: pulumi.Output; /** * 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. */ readonly snapshotName: pulumi.Output; /** * 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. */ readonly snapshotRetentionLimit: pulumi.Output; /** * The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard). */ readonly snapshotWindow: pulumi.Output; /** * 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. */ readonly snapshottingClusterId: pulumi.Output; /** * 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. */ readonly tags: pulumi.Output; /** * A flag that enables in-transit encryption when set to true. */ readonly transitEncryptionEnabled: pulumi.Output; /** * 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. */ readonly transitEncryptionMode: pulumi.Output; /** * The ID of user group to associate with the replication group. */ readonly userGroupIds: pulumi.Output; /** * Create a ReplicationGroup resource with the given unique name, arguments, and options. * * @param name The _unique_ name of the resource. * @param args The arguments to use to populate this resource's properties. * @param opts A bag of options that control this resource's behavior. */ constructor(name: string, args: ReplicationGroupArgs, opts?: pulumi.CustomResourceOptions); } /** * The set of arguments for constructing a ReplicationGroup resource. */ export interface ReplicationGroupArgs { /** * 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. */ atRestEncryptionEnabled?: pulumi.Input; /** * 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. */ authToken?: pulumi.Input; /** * This parameter is currently disabled. */ autoMinorVersionUpgrade?: pulumi.Input; /** * 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. */ automaticFailoverEnabled?: pulumi.Input; /** * The compute and memory capacity of the nodes in the node group (shard). */ cacheNodeType?: pulumi.Input; /** * 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. */ cacheParameterGroupName?: pulumi.Input; /** * A list of cache security group names to associate with this replication group. */ cacheSecurityGroupNames?: pulumi.Input[]>; /** * The name of the cache subnet group to be used for the replication group. */ cacheSubnetGroupName?: pulumi.Input; /** * 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. */ clusterMode?: pulumi.Input; /** * 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. */ dataTieringEnabled?: pulumi.Input; /** * The name of the cache engine to be used for the clusters in this replication group. */ engine?: pulumi.Input; /** * 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. */ engineVersion?: pulumi.Input; /** * The name of the Global datastore */ globalReplicationGroupId?: pulumi.Input; /** * 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. */ ipDiscovery?: pulumi.Input; /** * The ID of the KMS key used to encrypt the disk on the cluster. */ kmsKeyId?: pulumi.Input; /** * Specifies the destination, format and type of the logs. */ logDeliveryConfigurations?: pulumi.Input[]>; /** * A flag indicating if you have Multi-AZ enabled to enhance fault tolerance. For more information, see Minimizing Downtime: Multi-AZ. */ multiAzEnabled?: pulumi.Input; /** * 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 */ networkType?: pulumi.Input; /** * NodeGroupConfiguration is a property of the AWS::ElastiCache::ReplicationGroup resource that configures an Amazon ElastiCache (ElastiCache) Redis cluster node group. */ nodeGroupConfiguration?: pulumi.Input[]>; /** * The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent. */ notificationTopicArn?: pulumi.Input; /** * 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. */ numCacheClusters?: pulumi.Input; /** * 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. */ numNodeGroups?: pulumi.Input; /** * The port number on which each member of the replication group accepts connections. */ port?: pulumi.Input; /** * 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. */ preferredCacheClusterAzs?: pulumi.Input[]>; /** * 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. */ preferredMaintenanceWindow?: pulumi.Input; /** * 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. */ primaryClusterId?: pulumi.Input; /** * An optional parameter that specifies the number of replica nodes in each node group (shard). Valid values are 0 to 5. */ replicasPerNodeGroup?: pulumi.Input; /** * A user-created description for the replication group. */ replicationGroupDescription: pulumi.Input; /** * The replication group identifier. This parameter is stored as a lowercase string. */ replicationGroupId?: pulumi.Input; /** * One or more Amazon VPC security groups associated with this replication group. */ securityGroupIds?: pulumi.Input[]>; /** * A list of Amazon Resource Names (ARN) that uniquely identify the Redis RDB snapshot files stored in Amazon S3. */ snapshotArns?: pulumi.Input[]>; /** * 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. */ snapshotName?: pulumi.Input; /** * 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. */ snapshotRetentionLimit?: pulumi.Input; /** * The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard). */ snapshotWindow?: pulumi.Input; /** * 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. */ snapshottingClusterId?: pulumi.Input; /** * 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. */ tags?: pulumi.Input[]>; /** * A flag that enables in-transit encryption when set to true. */ transitEncryptionEnabled?: pulumi.Input; /** * 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. */ transitEncryptionMode?: pulumi.Input; /** * The ID of user group to associate with the replication group. */ userGroupIds?: pulumi.Input[]>; }