pulumi-aws-native-kotlin/com.pulumi.awsnative.memorydb.kotlin/ClusterArgs

ClusterArgs

data class ClusterArgs(val aclName: Output<String>? = null, val autoMinorVersionUpgrade: Output<Boolean>? = null, val clusterEndpoint: Output<ClusterEndpointArgs>? = null, val clusterName: Output<String>? = null, val dataTiering: Output<ClusterDataTieringStatus>? = null, val description: Output<String>? = null, val engineVersion: Output<String>? = null, val finalSnapshotName: Output<String>? = null, val kmsKeyId: Output<String>? = null, val maintenanceWindow: Output<String>? = null, val nodeType: Output<String>? = null, val numReplicasPerShard: Output<Int>? = null, val numShards: Output<Int>? = null, val parameterGroupName: Output<String>? = null, val port: Output<Int>? = null, val securityGroupIds: Output<List<String>>? = null, val snapshotArns: Output<List<String>>? = null, val snapshotName: Output<String>? = null, val snapshotRetentionLimit: Output<Int>? = null, val snapshotWindow: Output<String>? = null, val snsTopicArn: Output<String>? = null, val snsTopicStatus: Output<String>? = null, val subnetGroupName: Output<String>? = null, val tags: Output<List<ClusterTagArgs>>? = null, val tlsEnabled: Output<Boolean>? = null) : ConvertibleToJava<ClusterArgs>

The AWS::MemoryDB::Cluster resource creates an Amazon MemoryDB Cluster.

Constructors

Link copied to clipboard
fun ClusterArgs(aclName: Output<String>? = null, autoMinorVersionUpgrade: Output<Boolean>? = null, clusterEndpoint: Output<ClusterEndpointArgs>? = null, clusterName: Output<String>? = null, dataTiering: Output<ClusterDataTieringStatus>? = null, description: Output<String>? = null, engineVersion: Output<String>? = null, finalSnapshotName: Output<String>? = null, kmsKeyId: Output<String>? = null, maintenanceWindow: Output<String>? = null, nodeType: Output<String>? = null, numReplicasPerShard: Output<Int>? = null, numShards: Output<Int>? = null, parameterGroupName: Output<String>? = null, port: Output<Int>? = null, securityGroupIds: Output<List<String>>? = null, snapshotArns: Output<List<String>>? = null, snapshotName: Output<String>? = null, snapshotRetentionLimit: Output<Int>? = null, snapshotWindow: Output<String>? = null, snsTopicArn: Output<String>? = null, snsTopicStatus: Output<String>? = null, subnetGroupName: Output<String>? = null, tags: Output<List<ClusterTagArgs>>? = null, tlsEnabled: Output<Boolean>? = null)

Functions

Link copied to clipboard
open override fun toJava(): ClusterArgs

Properties

Link copied to clipboard
val aclName: Output<String>? = null

The name of the Access Control List to associate with the cluster.

Link copied to clipboard
val autoMinorVersionUpgrade: Output<Boolean>? = null

A flag that enables automatic minor version upgrade when set to true. You cannot modify the value of AutoMinorVersionUpgrade after the cluster is created. To enable AutoMinorVersionUpgrade on a cluster you must set AutoMinorVersionUpgrade to true when you create a cluster.

Link copied to clipboard
val clusterEndpoint: Output<ClusterEndpointArgs>? = null

The cluster endpoint.

Link copied to clipboard
val clusterName: Output<String>? = null

The name of the cluster. This value must be unique as it also serves as the cluster identifier.

Link copied to clipboard
val dataTiering: Output<ClusterDataTieringStatus>? = null

Enables data tiering. Data tiering is only supported for clusters using the r6gd node type. This parameter must be set when using r6gd nodes.

Link copied to clipboard
val description: Output<String>? = null

An optional description of the cluster.

Link copied to clipboard
val engineVersion: Output<String>? = null

The Redis engine version used by the cluster.

Link copied to clipboard
val finalSnapshotName: Output<String>? = null

The user-supplied name of a final cluster snapshot. This is the unique name that identifies the snapshot. MemoryDB creates the snapshot, and then deletes the cluster immediately afterward.

Link copied to clipboard
val kmsKeyId: Output<String>? = null

The ID of the KMS key used to encrypt the cluster.

Link copied to clipboard
val maintenanceWindow: Output<String>? = null

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.

Link copied to clipboard
val nodeType: Output<String>? = null

The compute and memory capacity of the nodes in the cluster.

Link copied to clipboard
val numReplicasPerShard: Output<Int>? = null

The number of replicas to apply to each shard. The limit is 5.

Link copied to clipboard
val numShards: Output<Int>? = null

The number of shards the cluster will contain.

Link copied to clipboard
val parameterGroupName: Output<String>? = null

The name of the parameter group associated with the cluster.

Link copied to clipboard
val port: Output<Int>? = null

The port number on which each member of the cluster accepts connections.

Link copied to clipboard
val securityGroupIds: Output<List<String>>? = null

One or more Amazon VPC security groups associated with this cluster.

Link copied to clipboard
val snapshotArns: Output<List<String>>? = null

A list of Amazon Resource Names (ARN) that uniquely identify the RDB snapshot files stored in Amazon S3. The snapshot files are used to populate the new cluster. The Amazon S3 object name in the ARN cannot contain any commas.

Link copied to clipboard
val snapshotName: Output<String>? = null

The name of a snapshot from which to restore data into the new cluster. The snapshot status changes to restoring while the new cluster is being created.

Link copied to clipboard
val snapshotRetentionLimit: Output<Int>? = null

The number of days for which MemoryDB 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.

Link copied to clipboard
val snapshotWindow: Output<String>? = null

The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your cluster.

Link copied to clipboard
val snsTopicArn: Output<String>? = null

The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.

Link copied to clipboard
val snsTopicStatus: Output<String>? = null

The status of the Amazon SNS notification topic. Notifications are sent only if the status is enabled.

Link copied to clipboard
val subnetGroupName: Output<String>? = null

The name of the subnet group to be used for the cluster.

Link copied to clipboard
val tags: Output<List<ClusterTagArgs>>? = null

An array of key-value pairs to apply to this cluster.

Link copied to clipboard
val tlsEnabled: Output<Boolean>? = null

A flag that enables in-transit encryption when set to true. You cannot modify the value of TransitEncryptionEnabled after the cluster is created. To enable in-transit encryption on a cluster you must set TransitEncryptionEnabled to true when you create a cluster.