Package com.pulumi.aws.memorydb

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
      com.pulumi.core.Output<java.lang.String> aclName()  
      java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> autoMinorVersionUpgrade()  
      static ClusterArgs.Builder builder()  
      static ClusterArgs.Builder builder​(ClusterArgs defaults)  
      java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> dataTiering()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> description()  
      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>> finalSnapshotName()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> ipDiscovery()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> kmsKeyArn()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> maintenanceWindow()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> multiRegionClusterName()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> name()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> namePrefix()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> networkType()  
      com.pulumi.core.Output<java.lang.String> nodeType()  
      java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> numReplicasPerShard()  
      java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> numShards()  
      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.lang.String>> region()  
      java.util.Optional<com.pulumi.core.Output<java.util.List<java.lang.String>>> securityGroupIds()  
      java.util.Optional<com.pulumi.core.Output<java.util.List<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>> snsTopicArn()  
      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>> tlsEnabled()  

      • 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

      • aclName

        public com.pulumi.core.Output<java.lang.String> aclName()
        Returns:
        Name of the Access Control List to associate with the cluster.

      • autoMinorVersionUpgrade

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> autoMinorVersionUpgrade()
        Returns:
        When set to `true`, the cluster will automatically receive minor engine version upgrades after launch. Defaults to `true`.

      • dataTiering

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> dataTiering()
        Returns:
        Enables data tiering. This option is not supported by all instance types. For more information, see [Data tiering](https://docs.aws.amazon.com/memorydb/latest/devguide/data-tiering.html).

      • description

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> description()
        Returns:
        Description for the cluster. Defaults to `"Managed by Pulumi"`.

      • engine

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> engine()
        Returns:
        Engine that will run on your nodes. Supported values are `redis` and `valkey`.

      • engineVersion

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> engineVersion()
        Returns:
        Version number of the engine to be used for the cluster. Downgrades are not supported.

      • finalSnapshotName

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> finalSnapshotName()
        Returns:
        Name of the final cluster snapshot to be created when this resource is deleted. If omitted, no final snapshot will be made.

      • ipDiscovery

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> ipDiscovery()
        Returns:
        Mechanism that the cluster uses to discover IP addresses. Valid values are `ipv4` and `ipv6`. Defaults to `ipv4`. To specify `ipv6`, `networkType` must be `ipv6` or `dualStack`.

      • kmsKeyArn

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> kmsKeyArn()
        Returns:
        ARN of the KMS key used to encrypt the cluster at rest.

      • maintenanceWindow

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> maintenanceWindow()
        Returns:
        Weekly time range during which maintenance on the cluster is performed. Specify as a range in the format `ddd:hh24:mi-ddd:hh24:mi` (24H Clock UTC). The minimum maintenance window is a 60 minute period. Example: `sun:23:00-mon:01:30`.

      • multiRegionClusterName

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> multiRegionClusterName()
        Returns:
        Multi region cluster identifier specified on `aws.memorydb.MultiRegionCluster`.

      • name

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> name()
        Returns:
        Name of the cluster. If omitted, the provider will assign a random, unique name. Conflicts with `namePrefix`.

      • namePrefix

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> namePrefix()
        Returns:
        Creates a unique name beginning with the specified prefix. Conflicts with `name`.

      • networkType

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> networkType()
        Returns:
        IP address type for the cluster. Valid values are `ipv4`, `ipv6` and `dualStack`. Defaults to `ipv4`.

      • nodeType

        public com.pulumi.core.Output<java.lang.String> nodeType()
        Returns:
        Compute and memory capacity of the nodes in the cluster. See AWS documentation on [supported node types](https://docs.aws.amazon.com/memorydb/latest/devguide/nodes.supportedtypes.html) as well as [vertical scaling](https://docs.aws.amazon.com/memorydb/latest/devguide/cluster-vertical-scaling.html). The following arguments are optional:

      • numReplicasPerShard

        public java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> numReplicasPerShard()
        Returns:
        Number of replicas to apply to each shard, up to a maximum of 5. Defaults to `1` (i.e. 2 nodes per shard).

      • numShards

        public java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> numShards()
        Returns:
        Number of shards in the cluster. Defaults to `1`.

      • parameterGroupName

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> parameterGroupName()
        Returns:
        Name of the parameter group associated with the cluster.

      • port

        public java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> port()
        Returns:
        Port number on which each of the nodes accepts connections. Defaults to `6379`.

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

      • securityGroupIds

        public java.util.Optional<com.pulumi.core.Output<java.util.List<java.lang.String>>> securityGroupIds()
        Returns:
        Set of VPC Security Group ID-s to associate with this cluster.

      • snapshotArns

        public java.util.Optional<com.pulumi.core.Output<java.util.List<java.lang.String>>> snapshotArns()
        Returns:
        List of ARN-s that uniquely identify RDB snapshot files stored in S3. The snapshot files will be used to populate the new cluster. Object names in the ARN-s 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 cluster.

      • snapshotRetentionLimit

        public java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> snapshotRetentionLimit()
        Returns:
        Number of days for which MemoryDB retains automatic snapshots before deleting them. When set to `0`, automatic backups are disabled. Defaults to `0`.

      • snapshotWindow

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> snapshotWindow()
        Returns:
        Daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your shard. Example: `05:00-09:00`.

      • snsTopicArn

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> snsTopicArn()
        Returns:
        ARN of the SNS topic to which cluster notifications are sent.

      • subnetGroupName

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> subnetGroupName()
        Returns:
        Name of the subnet group to be used for the cluster. Defaults to a subnet group consisting of default VPC subnets.

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

      • tlsEnabled

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> tlsEnabled()
        Returns:
        Whether to enable in-transit encryption on the cluster. When set to `false`, the `aclName` must be `open-access`. Defaults to `true`.