Package com.pulumi.aws.elasticache

Class ReplicationGroupArgs

  • public final class ReplicationGroupArgs
extends com.pulumi.resources.ResourceArgs

    • Method Detail

      • applyImmediately

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> applyImmediately()
        Returns:
        Specifies whether any modifications are applied immediately, or during the next maintenance window. Default is `false`.

      • atRestEncryptionEnabled

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> atRestEncryptionEnabled()
        Returns:
        Whether to enable encryption at rest. When `engine` is `redis`, default is `false`. When `engine` is `valkey`, default is `true`.

      • authToken

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> authToken()
        Returns:
        Password used to access a password protected server. Can be specified only if `transitEncryptionEnabled = true`.

      • authTokenUpdateStrategy

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> authTokenUpdateStrategy()
        Returns:
        Strategy used when modifying `authToken` or `authTokenWo` on an existing replication group. Not used during initial create. Valid values are `SET`, `ROTATE`, and `DELETE`. If omitted during an auth token change, AWS defaults to `ROTATE`. If value is `DELETE` then `authToken` and `authTokenWo` must be omitted.

      • authTokenWo

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> authTokenWo()
        Returns:
        **NOTE:** This field is write-only and its value will not be updated in state as part of read operations. Password used to access a password protected server, whose value will not be stored in state. Can be specified only if `transitEncryptionEnabled = true`. Conflicts with `authToken`. If set, requires `authTokenWoVersion` to be set.

      • authTokenWoVersion

        public java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> authTokenWoVersion()
        Returns:
        Required when `authTokenWo` is set. Changing this value triggers an update to `authTokenWo`.

      • autoMinorVersionUpgrade

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> autoMinorVersionUpgrade()
        Returns:
        Specifies whether minor version engine upgrades will be applied automatically to the underlying Cache Cluster instances during the maintenance window. Only supported for engine types `"redis"` and `"valkey"` and if the engine version is 6 or higher. If this argument is not explicitly set in the configuration, AWS will set a default value of `true` and Terraform will not detect drift on this attribute.

      • automaticFailoverEnabled

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> automaticFailoverEnabled()
        Returns:
        Specifies whether a read-only replica will be automatically promoted to read/write primary if the existing primary fails. If enabled, `numCacheClusters` must be greater than 1. Must be enabled for Redis (cluster mode enabled) replication groups. Defaults to `false`.

      • clusterMode

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> clusterMode()
        Returns:
        Specifies whether cluster mode is enabled or disabled. Valid values are `enabled` or `disabled` or `compatible`

      • dataTieringEnabled

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> dataTieringEnabled()
        Returns:
        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.

      • description

        public com.pulumi.core.Output<java.lang.String> description()
        Returns:
        User-created description for the replication group. Must not be empty.

      • durability

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> durability()
        Returns:
        Specifies the durability mode for the replication group. Valid values are `default`, `async`, `sync`, or `disabled`. Requires cluster mode enabled and Valkey 9.0 or higher.

      • engine

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> engine()
        Returns:
        Name of the cache engine to be used for the clusters in this replication group. Valid values are `redis` or `valkey`. Default is `redis`.

      • engineVersion

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> engineVersion()
        Returns:
        Version number of the cache engine to be used for the cache clusters in this replication group. If the version is 7 or higher, the major and minor version should be set, e.g., `7.2`. If the version is 6, the major and minor version can be set, e.g., `6.2`, or the minor version can be unspecified which will use the latest version at creation time, e.g., `6.x`. Otherwise, specify the full version desired, e.g., `5.0.6`. The actual engine version used is returned in the attribute `engineVersionActual`, see Attribute Reference below.

      • finalSnapshotIdentifier

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> finalSnapshotIdentifier()
        Returns:
        The name of your final node group (shard) snapshot. ElastiCache creates the snapshot from the primary node in the cluster. If omitted, no final snapshot will be made.

      • globalReplicationGroupId

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> globalReplicationGroupId()
        Returns:
        The ID of the global replication group to which this replication group should belong. If this parameter is specified, the replication group is added to the specified global replication group as a secondary replication group; otherwise, the replication group is not part of any global replication group. If `globalReplicationGroupId` is set, the `numNodeGroups` parameter cannot be set.

      • ipDiscovery

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> ipDiscovery()
        Returns:
        The IP version to advertise in the discovery protocol. Valid values are `ipv4` or `ipv6`.

      • kmsKeyId

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> kmsKeyId()
        Returns:
        The ARN of the key that you wish to use if encrypting at rest. If not supplied, uses service managed encryption. Can be specified only if `atRestEncryptionEnabled = true`.

      • logDeliveryConfigurations

        public java.util.Optional<com.pulumi.core.Output<java.util.List<ReplicationGroupLogDeliveryConfigurationArgs>>> logDeliveryConfigurations()
        Returns:
        Specifies the destination and format of Redis OSS/Valkey [SLOWLOG](https://redis.io/commands/slowlog) or Redis OSS/Valkey [Engine Log](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Log_Delivery.html#Log_contents-engine-log). See the documentation on [Amazon ElastiCache](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Log_Delivery.html#Log_contents-engine-log). See Log Delivery Configuration below for more details.

      • maintenanceWindow

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> maintenanceWindow()
        Returns:
        Specifies the weekly time range for when maintenance on the cache cluster is performed. The format is `ddd:hh24:mi-ddd:hh24:mi` (24H Clock UTC). The minimum maintenance window is a 60 minute period. Example: `sun:05:00-sun:09:00`

      • multiAzEnabled

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> multiAzEnabled()
        Returns:
        Specifies whether to enable Multi-AZ Support for the replication group. If `true`, `automaticFailoverEnabled` must also be enabled. Defaults to `false`.

      • networkType

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> networkType()
        Returns:
        The IP versions for cache cluster connections. Valid values are `ipv4`, `ipv6` or `dualStack`.

      • nodeGroupConfigurations

        public java.util.Optional<com.pulumi.core.Output<java.util.List<ReplicationGroupNodeGroupConfigurationArgs>>> nodeGroupConfigurations()
        Returns:
        Configuration block for node groups (shards). Can be specified only if `numNodeGroups` is set. Conflicts with `preferredCacheClusterAzs`. See Node Group Configuration below for more details.

      • nodeType

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> nodeType()
        Returns:
        Instance class to be used. See AWS documentation for information on [supported node types](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html) and [guidance on selecting node types](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/nodes-select-size.html). Required unless `globalReplicationGroupId` is set. Cannot be set if `globalReplicationGroupId` is set.

      • notificationTopicArn

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> notificationTopicArn()
        Returns:
        ARN of an SNS topic to send ElastiCache notifications to. Example: `arn:aws:sns:us-east-1:012345678999:my_sns_topic`

      • numCacheClusters

        public java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> numCacheClusters()
        Returns:
        Number of cache clusters (primary and replicas) this replication group will have. If `automaticFailoverEnabled` or `multiAzEnabled` are `true`, must be at least 2. Updates will occur before other modifications. Conflicts with `numNodeGroups` and `replicasPerNodeGroup`. Defaults to `1`.

      • numNodeGroups

        public java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> numNodeGroups()
        Returns:
        Number of node groups (shards) for this Redis replication group. Changing this number will trigger a resizing operation before other settings modifications. Conflicts with `numCacheClusters`.

      • parameterGroupName

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> parameterGroupName()
        Returns:
        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. To enable "cluster mode", i.e., data sharding, use a parameter group that has the parameter `cluster-enabled` set to true.

      • port

        public java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> port()
        Returns:
        Port number on which each of the cache nodes will accept connections. For Memcache the default is 11211, and for Redis the default port is 6379.

      • preferredCacheClusterAzs

        public java.util.Optional<com.pulumi.core.Output<java.util.List<java.lang.String>>> preferredCacheClusterAzs()
        Returns:
        List of EC2 availability zones in which the replication group's cache clusters will be created. The order of the availability zones in the list is considered. The first item in the list will be the primary node. Ignored when updating.

      • region

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> region()
        Returns:
        Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.

      • replicasPerNodeGroup

        public java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> replicasPerNodeGroup()
        Returns:
        Number of replica nodes in each node group. Changing this number will trigger a resizing operation before other settings modifications. Default AWS limit is 5. Higher values may be available with a quota increase. Conflicts with `numCacheClusters`. Can only be set if `numNodeGroups` is set.

      • replicationGroupId

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> replicationGroupId()
        Returns:
        Replication group identifier. This parameter is stored as a lowercase string. The following arguments are optional:

      • securityGroupIds

        public java.util.Optional<com.pulumi.core.Output<java.util.List<java.lang.String>>> securityGroupIds()
        Returns:
        IDs of one or more Amazon VPC security groups associated with this replication group. Use this parameter only when you are creating a replication group in a VPC.

      • securityGroupNames

        public java.util.Optional<com.pulumi.core.Output<java.util.List<java.lang.String>>> securityGroupNames()
        Returns:
        Names of one or more Amazon VPC security groups associated with this replication group. Use this parameter only when you are creating a replication group in a VPC.

      • snapshotArns

        public java.util.Optional<com.pulumi.core.Output<java.util.List<java.lang.String>>> snapshotArns()
        Returns:
        List of ARNs that identify Redis RDB snapshot files stored in Amazon S3. The names object names cannot contain any commas.

      • snapshotName

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> snapshotName()
        Returns:
        Name of a snapshot from which to restore data into the new node group. Changing the `snapshotName` forces a new resource.

      • snapshotRetentionLimit

        public java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> snapshotRetentionLimit()
        Returns:
        Number of days for which ElastiCache will retain automatic cache cluster snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, then a snapshot that was taken today will be retained for 5 days before being deleted. If the value of `snapshotRetentionLimit` is set to zero (0), backups are turned off. Please note that setting a `snapshotRetentionLimit` is not supported on cache.t1.micro cache nodes

      • snapshotWindow

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> snapshotWindow()
        Returns:
        Daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of your cache cluster. The minimum snapshot window is a 60 minute period. Example: `05:00-09:00`

      • subnetGroupName

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> subnetGroupName()
        Returns:
        Name of the cache subnet group to be used for the replication group.

      • tags

        public java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        Map of tags to assign to the resource. Adding tags to this resource will add or overwrite any existing tags on the clusters in the replication group and not to the group itself. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.

      • transitEncryptionEnabled

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> transitEncryptionEnabled()
        Returns:
        Whether to enable encryption in transit. Changing this argument with an `engineVersion` < `7.0.5` will force a replacement. Engine versions prior to `7.0.5` only allow this transit encryption to be configured during creation of the replication group.

      • transitEncryptionMode

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> transitEncryptionMode()
        Returns:
        A setting that enables clients to migrate to in-transit encryption with no downtime. Valid values are `preferred` and `required`. When enabling encryption on an existing replication group, this must first be set to `preferred` before setting it to `required` in a subsequent apply. See the `TransitEncryptionMode` field in the [`CreateReplicationGroup` API documentation](https://docs.aws.amazon.com/AmazonElastiCache/latest/APIReference/API_CreateReplicationGroup.html) for additional details.

      • userGroupIds

        public java.util.Optional<com.pulumi.core.Output<java.util.List<java.lang.String>>> userGroupIds()
        Returns:
        User Group ID to associate with the replication group. Only a maximum of one (1) user group ID is valid. **NOTE:** This argument _is_ a set because the AWS specification allows for multiple IDs. However, in practice, AWS only allows a maximum size of one.