Cluster

class Cluster : KotlinCustomResource

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

Properties

Link copied to clipboard
val aclName: Output<String>

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

Link copied to clipboard
val arn: Output<String>

The Amazon Resource Name (ARN) of the cluster.

Link copied to clipboard

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

The cluster endpoint.

Link copied to clipboard
val clusterName: Output<String>

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

Link copied to clipboard

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>?

An optional description of the cluster.

Link copied to clipboard
val engine: Output<String>?

The engine type used by the cluster.

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

The Redis engine version used by the cluster.

Link copied to clipboard

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 id: Output<String>
Link copied to clipboard

For clusters wth dual stack NetworkType, IpDiscovery controls the Ip protocol (ipv4 or ipv6) returned by the engine commands such as cluster info and cluster nodes which are used by clients to connect to the nodes in the cluster.

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

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

Link copied to clipboard

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

The name of the Global Datastore, it is generated by MemoryDB adding a prefix to MultiRegionClusterNameSuffix.

Link copied to clipboard

Must be either ipv4 | ipv6 | dual_stack.

Link copied to clipboard
val nodeType: Output<String>

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

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

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

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

The number of shards the cluster will contain.

Link copied to clipboard

The name of the parameter group associated with the cluster.

Link copied to clipboard

The status of the parameter group used by the cluster.

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

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

Link copied to clipboard
val pulumiChildResources: Set<KotlinResource>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

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

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

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>?

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

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>?

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>?

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>?

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

Link copied to clipboard
val status: Output<String>

The status of the cluster. For example, Available, Updating, Creating.

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

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

Link copied to clipboard
val tags: Output<List<Tag>>?

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

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

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.

Link copied to clipboard
val urn: Output<String>