Cluster

class Cluster : KotlinCustomResource

Provides a MemoryDB Cluster. More information about MemoryDB can be found in the Developer Guide.

Example Usage

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.memorydb.Cluster;
import com.pulumi.aws.memorydb.ClusterArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var example = new Cluster("example", ClusterArgs.builder()
.aclName("open-access")
.nodeType("db.t4g.small")
.numShards(2)
.securityGroupIds(aws_security_group.example().id())
.snapshotRetentionLimit(7)
.subnetGroupName(aws_memorydb_subnet_group.example().id())
.build());
}
}

Import

Use the name to import a cluster. For example

$ pulumi import aws:memorydb/cluster:Cluster example my-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 ARN of the cluster.

Link copied to clipboard

When set to true, the cluster will automatically receive minor engine version upgrades after launch. Defaults to true.

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

Enables data tiering. This option is not supported by all instance types. For more information, see Data tiering.

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

Description for the cluster.

Link copied to clipboard

Patch version number of the Redis engine used by the cluster.

Link copied to clipboard
val engineVersion: Output<String>

Version number of the Redis engine to be used for the cluster. Downgrades are not supported.

Link copied to clipboard

Name of the final cluster snapshot to be created when this resource is deleted. If omitted, no final snapshot will be made.

Link copied to clipboard
val id: Output<String>
Link copied to clipboard
val kmsKeyArn: Output<String>?

ARN of the KMS key used to encrypt the cluster at rest.

Link copied to clipboard

Specifies the 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.

Link copied to clipboard
val name: Output<String>

Name of the cluster. If omitted, the provider will assign a random, unique name. Conflicts with name_prefix.

Link copied to clipboard
val namePrefix: Output<String>

Creates a unique name beginning with the specified prefix. Conflicts with name.

Link copied to clipboard
val nodeType: Output<String>

The compute and memory capacity of the nodes in the cluster. See AWS documentation on supported node types as well as vertical scaling. The following arguments are optional:

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

The number of replicas to apply to each shard, up to a maximum of 5. Defaults to 1 (i.e. 2 nodes per shard).

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

The number of shards in the cluster. Defaults to 1.

Link copied to clipboard

The name of the parameter group associated with the cluster.

Link copied to clipboard
val port: Output<Int>

The port number on which each of the nodes accepts connections. Defaults to 6379.

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

Set of VPC Security Group ID-s to associate with this cluster.

Link copied to clipboard
val shards: Output<List<ClusterShard>>

Set of shards in this cluster.

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

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.

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

The name of a snapshot from which to restore data into the new cluster.

Link copied to clipboard

The number of days for which MemoryDB retains automatic snapshots before deleting them. When set to 0, automatic backups are disabled. Defaults to 0.

Link copied to clipboard
val snapshotWindow: Output<String>

The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your shard. Example: 05:00-09:00.

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

ARN of the SNS topic to which cluster notifications are sent.

Link copied to clipboard
val subnetGroupName: Output<String>

The name of the subnet group to be used for the cluster. Defaults to a subnet group consisting of default VPC subnets.

Link copied to clipboard
val tags: Output<Map<String, String>>?

A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

Link copied to clipboard
val tagsAll: Output<Map<String, String>>

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

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

A flag to enable in-transit encryption on the cluster. When set to false, the acl_name must be open-access. Defaults to true.

Link copied to clipboard
val urn: Output<String>