Package com.pulumi.aws.elasticache

Class ClusterArgs

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

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  ClusterArgs.Builder  

      • Nested classes/interfaces inherited from class com.pulumi.resources.InputArgs

        com.pulumi.resources.InputArgs.InputArgsInternal

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static ClusterArgs Empty  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> applyImmediately()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> autoMinorVersionUpgrade()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> availabilityZone()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> azMode()  
      static ClusterArgs.Builder builder()  
      static ClusterArgs.Builder builder​(ClusterArgs defaults)  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> clusterId()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> engine()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> engineVersion()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> finalSnapshotIdentifier()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> ipDiscovery()  
      java.util.Optional<com.pulumi.core.Output<java.util.List<ClusterLogDeliveryConfigurationArgs>>> logDeliveryConfigurations()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> maintenanceWindow()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> networkType()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> nodeType()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> notificationTopicArn()  
      java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> numCacheNodes()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> outpostMode()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> parameterGroupName()  
      java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> port()  
      java.util.Optional<com.pulumi.core.Output<java.util.List<java.lang.String>>> preferredAvailabilityZones()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> preferredOutpostArn()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> region()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> replicationGroupId()  
      java.util.Optional<com.pulumi.core.Output<java.util.List<java.lang.String>>> securityGroupIds()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> snapshotArns()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> snapshotName()  
      java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> snapshotRetentionLimit()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> snapshotWindow()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> subnetGroupName()  
      java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>>> tags()  
      java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> transitEncryptionEnabled()  

      • Methods inherited from class com.pulumi.resources.ResourceArgs

        validateMember

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Method Detail

      • applyImmediately

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> applyImmediately()
        Returns:
        Whether any database modifications are applied immediately, or during the next maintenance window. Default is `false`. See [Amazon ElastiCache Documentation for more information](https://docs.aws.amazon.com/AmazonElastiCache/latest/APIReference/API_ModifyCacheCluster.html).

      • autoMinorVersionUpgrade

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> 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 type `"redis"` and if the engine version is 6 or higher. Defaults to `true`.

      • availabilityZone

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> availabilityZone()
        Returns:
        Availability Zone for the cache cluster. If you want to create cache nodes in multi-az, use `preferredAvailabilityZones` instead. Default: System chosen Availability Zone. Changing this value will re-create the resource.

      • azMode

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> azMode()
        Returns:
        Whether the nodes in this Memcached node group are created in a single Availability Zone or created across multiple Availability Zones in the cluster's region. Valid values for this parameter are `single-az` or `cross-az`, default is `single-az`. If you want to choose `cross-az`, `numCacheNodes` must be greater than `1`.

      • clusterId

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> clusterId()
        Returns:
        Group identifier. ElastiCache converts this name to lowercase. Changing this value will re-create the resource.

      • engine

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> engine()
        Returns:
        Name of the cache engine to be used for this cache cluster. Valid values are `memcached`, `redis`.

      • engineVersion

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> engineVersion()
        Returns:
        Version number of the cache engine to be used. If not set, defaults to the latest version. See [Describe Cache Engine Versions](https://docs.aws.amazon.com/cli/latest/reference/elasticache/describe-cache-engine-versions.html) in the AWS Documentation for supported versions. When `engine` is `redis` and the version is 7 or higher, the major and minor version should be set, e.g., `7.2`. When 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. Cannot be provided with `replication_group_id.`

      • finalSnapshotIdentifier

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> finalSnapshotIdentifier()
        Returns:
        Name of your final cluster snapshot. If omitted, no final snapshot will be made.

      • 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`.

      • logDeliveryConfigurations

        public java.util.Optional<com.pulumi.core.Output<java.util.List<ClusterLogDeliveryConfigurationArgs>>> logDeliveryConfigurations()
        Returns:
        Specifies the destination and format of Redis [SLOWLOG](https://redis.io/commands/slowlog) or Redis [Engine Log](https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/Log_Delivery.html#Log_contents-engine-log). See the documentation on [Amazon ElastiCache](https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/Log_Delivery.html). 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`.

      • networkType

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> networkType()
        Returns:
        The IP versions for cache cluster connections. IPv6 is supported with Redis engine `6.2` onword or Memcached version `1.6.6` for all [Nitro system](https://aws.amazon.com/ec2/nitro/) instances. Valid values are `ipv4`, `ipv6` or `dualStack`.

      • nodeType

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> nodeType()
        Returns:
        The instance class used. See AWS documentation for information on [supported node types for Redis OSS](https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/CacheNodes.SupportedTypes.html#CacheNodes.CurrentGen) and [guidance on selecting node types for Redis OSS](https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/CacheNodes.SelectSize.html#CacheNodes.SelectSize.redis). See AWS documentation for information on [supported node types for Memcached](https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/CacheNodes.SupportedTypes.html#CacheNodes.CurrentGen-Memcached) and [guidance on selecting node types for Memcached](https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/CacheNodes.SelectSize.html#CacheNodes.SelectSize.Mem). For Memcached, changing this value will re-create the resource.

      • 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`.

      • numCacheNodes

        public java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> numCacheNodes()
        Returns:
        The initial number of cache nodes that the cache cluster will have. For Redis, this value must be 1. For Memcached, this value must be between 1 and 40. If this number is reduced on subsequent runs, the highest numbered nodes will be removed.

      • outpostMode

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> outpostMode()
        Returns:
        Specify the outpost mode that will apply to the cache cluster creation. Valid values are `"single-outpost"` and `"cross-outpost"`, however AWS currently only supports `"single-outpost"` mode.

      • parameterGroupName

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> parameterGroupName()
        Returns:
        The name of the parameter group to associate with this cache cluster.

      • port

        public java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> port()
        Returns:
        The port number on which each of the cache nodes will accept connections. For Memcached the default is 11211, and for Redis the default port is 6379. Cannot be provided with `replicationGroupId`. Changing this value will re-create the resource.

      • preferredAvailabilityZones

        public java.util.Optional<com.pulumi.core.Output<java.util.List<java.lang.String>>> preferredAvailabilityZones()
        Returns:
        List of the Availability Zones in which cache nodes are created. If you are creating your cluster in an Amazon VPC you can only locate nodes in Availability Zones that are associated with the subnets in the selected subnet group. The number of Availability Zones listed must equal the value of `numCacheNodes`. If you want all the nodes in the same Availability Zone, use `availabilityZone` instead, or repeat the Availability Zone multiple times in the list. Default: System chosen Availability Zones. Detecting drift of existing node availability zone is not currently supported. Updating this argument by itself to migrate existing node availability zones is not currently supported and will show a perpetual difference.

      • preferredOutpostArn

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> preferredOutpostArn()
        Returns:
        The outpost ARN in which the cache cluster will be created.

      • 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.

      • replicationGroupId

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> replicationGroupId()
        Returns:
        ID of the replication group to which this cluster should belong. If this parameter is specified, the cluster is added to the specified replication group as a read replica; otherwise, the cluster is a standalone primary that is not part of any replication group.

      • securityGroupIds

        public java.util.Optional<com.pulumi.core.Output<java.util.List<java.lang.String>>> securityGroupIds()
        Returns:
        One or more VPC security groups associated with the cache cluster. Cannot be provided with `replication_group_id.`

      • snapshotArns

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> snapshotArns()
        Returns:
        Single-element string list containing an ARN of a Redis RDB snapshot file stored in Amazon S3. The object name cannot contain any commas. Changing `snapshotArns` forces a new resource.

      • 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 `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. Example: 05:00-09:00

      • subnetGroupName

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> subnetGroupName()
        Returns:
        Name of the subnet group to be used for the cache cluster. Changing this value will re-create the resource. Cannot be provided with `replication_group_id.`

      • 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. 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:
        Enable encryption in-transit. Supported only with Memcached versions `1.6.12` and later, running in a VPC. For Redis or Valkey transit encryption, use `aws.elasticache.ReplicationGroup` instead. See the [ElastiCache in-transit encryption documentation](https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/in-transit-encryption.html#in-transit-encryption-constraints) for more details.