AWS Classic

Pulumi Official
Package maintained by Pulumi
v5.10.0 published on Monday, Jul 11, 2022 by Pulumi

Cluster

Provides a MemoryDB Cluster.

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

Example Usage

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
    public MyStack()
    {
        var example = new Aws.MemoryDb.Cluster("example", new Aws.MemoryDb.ClusterArgs
        {
            AclName = "open-access",
            NodeType = "db.t4g.small",
            NumShards = 2,
            SecurityGroupIds = 
            {
                aws_security_group.Example.Id,
            },
            SnapshotRetentionLimit = 7,
            SubnetGroupName = aws_memorydb_subnet_group.Example.Id,
        });
    }

}
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/memorydb"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := memorydb.NewCluster(ctx, "example", &memorydb.ClusterArgs{
			AclName:   pulumi.String("open-access"),
			NodeType:  pulumi.String("db.t4g.small"),
			NumShards: pulumi.Int(2),
			SecurityGroupIds: pulumi.StringArray{
				pulumi.Any(aws_security_group.Example.Id),
			},
			SnapshotRetentionLimit: pulumi.Int(7),
			SubnetGroupName:        pulumi.Any(aws_memorydb_subnet_group.Example.Id),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;

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 pulumi
import pulumi_aws as aws

example = aws.memorydb.Cluster("example",
    acl_name="open-access",
    node_type="db.t4g.small",
    num_shards=2,
    security_group_ids=[aws_security_group["example"]["id"]],
    snapshot_retention_limit=7,
    subnet_group_name=aws_memorydb_subnet_group["example"]["id"])
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.memorydb.Cluster("example", {
    aclName: "open-access",
    nodeType: "db.t4g.small",
    numShards: 2,
    securityGroupIds: [aws_security_group.example.id],
    snapshotRetentionLimit: 7,
    subnetGroupName: aws_memorydb_subnet_group.example.id,
});
resources:
  example:
    type: aws:memorydb:Cluster
    properties:
      aclName: open-access
      nodeType: db.t4g.small
      numShards: 2
      securityGroupIds:
        - ${aws_security_group.example.id}
      snapshotRetentionLimit: 7
      subnetGroupName: ${aws_memorydb_subnet_group.example.id}

Create a Cluster Resource

new Cluster(name: string, args: ClusterArgs, opts?: CustomResourceOptions);
@overload
def Cluster(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            acl_name: Optional[str] = None,
            auto_minor_version_upgrade: Optional[bool] = None,
            description: Optional[str] = None,
            engine_version: Optional[str] = None,
            final_snapshot_name: Optional[str] = None,
            kms_key_arn: Optional[str] = None,
            maintenance_window: Optional[str] = None,
            name: Optional[str] = None,
            name_prefix: Optional[str] = None,
            node_type: Optional[str] = None,
            num_replicas_per_shard: Optional[int] = None,
            num_shards: Optional[int] = None,
            parameter_group_name: Optional[str] = None,
            port: Optional[int] = None,
            security_group_ids: Optional[Sequence[str]] = None,
            snapshot_arns: Optional[str] = None,
            snapshot_name: Optional[str] = None,
            snapshot_retention_limit: Optional[int] = None,
            snapshot_window: Optional[str] = None,
            sns_topic_arn: Optional[str] = None,
            subnet_group_name: Optional[str] = None,
            tags: Optional[Mapping[str, str]] = None,
            tls_enabled: Optional[bool] = None)
@overload
def Cluster(resource_name: str,
            args: ClusterArgs,
            opts: Optional[ResourceOptions] = None)
func NewCluster(ctx *Context, name string, args ClusterArgs, opts ...ResourceOption) (*Cluster, error)
public Cluster(string name, ClusterArgs args, CustomResourceOptions? opts = null)
public Cluster(String name, ClusterArgs args)
public Cluster(String name, ClusterArgs args, CustomResourceOptions options)
type: aws:memorydb:Cluster
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args ClusterArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args ClusterArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args ClusterArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args ClusterArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args ClusterArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Cluster Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The Cluster resource accepts the following input properties:

AclName string

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

NodeType string

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

AutoMinorVersionUpgrade bool

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

Description string
EngineVersion string

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

FinalSnapshotName string

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

KmsKeyArn string

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

MaintenanceWindow string

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. Example: sun:23:00-mon:01:30.

Name string

Name of this node.

  • endpoint
NamePrefix string

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

NumReplicasPerShard 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).

NumShards int

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

ParameterGroupName string

The name of the parameter group associated with the cluster.

Port int

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

SecurityGroupIds List<string>

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

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

SnapshotName string

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

SnapshotRetentionLimit int

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

SnapshotWindow string

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

SnsTopicArn string

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

SubnetGroupName string

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

Tags Dictionary<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.

TlsEnabled bool

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

AclName string

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

NodeType string

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

AutoMinorVersionUpgrade bool

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

Description string
EngineVersion string

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

FinalSnapshotName string

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

KmsKeyArn string

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

MaintenanceWindow string

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. Example: sun:23:00-mon:01:30.

Name string

Name of this node.

  • endpoint
NamePrefix string

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

NumReplicasPerShard 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).

NumShards int

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

ParameterGroupName string

The name of the parameter group associated with the cluster.

Port int

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

SecurityGroupIds []string

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

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

SnapshotName string

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

SnapshotRetentionLimit int

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

SnapshotWindow string

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

SnsTopicArn string

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

SubnetGroupName string

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

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

TlsEnabled bool

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

aclName String

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

nodeType String

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

autoMinorVersionUpgrade Boolean

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

description String
engineVersion String

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

finalSnapshotName String

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

kmsKeyArn String

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

maintenanceWindow String

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. Example: sun:23:00-mon:01:30.

name String

Name of this node.

  • endpoint
namePrefix String

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

numReplicasPerShard Integer

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

numShards Integer

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

parameterGroupName String

The name of the parameter group associated with the cluster.

port Integer

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

securityGroupIds List<String>

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

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

snapshotName String

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

snapshotRetentionLimit Integer

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

snapshotWindow String

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

snsTopicArn String

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

subnetGroupName String

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

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

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

aclName string

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

nodeType string

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

autoMinorVersionUpgrade boolean

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

description string
engineVersion string

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

finalSnapshotName string

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

kmsKeyArn string

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

maintenanceWindow string

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. Example: sun:23:00-mon:01:30.

name string

Name of this node.

  • endpoint
namePrefix string

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

numReplicasPerShard number

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

numShards number

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

parameterGroupName string

The name of the parameter group associated with the cluster.

port number

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

securityGroupIds string[]

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

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

snapshotName string

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

snapshotRetentionLimit number

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

snapshotWindow string

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

snsTopicArn string

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

subnetGroupName string

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

tags {[key: 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.

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

acl_name str

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

node_type str

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

auto_minor_version_upgrade bool

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

description str
engine_version str

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

final_snapshot_name str

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

kms_key_arn str

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

maintenance_window str

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. Example: sun:23:00-mon:01:30.

name str

Name of this node.

  • endpoint
name_prefix str

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

num_replicas_per_shard 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).

num_shards int

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

parameter_group_name str

The name of the parameter group associated with the cluster.

port int

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

security_group_ids Sequence[str]

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

snapshot_arns str

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.

snapshot_name str

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

snapshot_retention_limit int

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

snapshot_window str

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

sns_topic_arn str

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

subnet_group_name str

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

tags Mapping[str, str]

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.

tls_enabled bool

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

aclName String

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

nodeType String

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

autoMinorVersionUpgrade Boolean

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

description String
engineVersion String

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

finalSnapshotName String

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

kmsKeyArn String

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

maintenanceWindow String

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. Example: sun:23:00-mon:01:30.

name String

Name of this node.

  • endpoint
namePrefix String

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

numReplicasPerShard Number

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

numShards Number

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

parameterGroupName String

The name of the parameter group associated with the cluster.

port Number

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

securityGroupIds List<String>

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

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

snapshotName String

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

snapshotRetentionLimit Number

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

snapshotWindow String

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

snsTopicArn String

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

subnetGroupName String

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

tags Map<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.

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

Outputs

All input properties are implicitly available as output properties. Additionally, the Cluster resource produces the following output properties:

Arn string

The ARN of the cluster.

  • cluster_endpoint
ClusterEndpoints List<Pulumi.Aws.MemoryDb.Outputs.ClusterClusterEndpoint>
EnginePatchVersion string

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

Id string

The provider-assigned unique ID for this managed resource.

Shards List<Pulumi.Aws.MemoryDb.Outputs.ClusterShard>

Set of shards in this cluster.

TagsAll Dictionary<string, string>

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

Arn string

The ARN of the cluster.

  • cluster_endpoint
ClusterEndpoints []ClusterClusterEndpoint
EnginePatchVersion string

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

Id string

The provider-assigned unique ID for this managed resource.

Shards []ClusterShard

Set of shards in this cluster.

TagsAll map[string]string

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

arn String

The ARN of the cluster.

  • cluster_endpoint
clusterEndpoints List<ClusterClusterEndpoint>
enginePatchVersion String

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

id String

The provider-assigned unique ID for this managed resource.

shards List<ClusterShard>

Set of shards in this cluster.

tagsAll Map<String,String>

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

arn string

The ARN of the cluster.

  • cluster_endpoint
clusterEndpoints ClusterClusterEndpoint[]
enginePatchVersion string

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

id string

The provider-assigned unique ID for this managed resource.

shards ClusterShard[]

Set of shards in this cluster.

tagsAll {[key: string]: string}

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

arn str

The ARN of the cluster.

  • cluster_endpoint
cluster_endpoints Sequence[ClusterClusterEndpoint]
engine_patch_version str

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

id str

The provider-assigned unique ID for this managed resource.

shards Sequence[ClusterShard]

Set of shards in this cluster.

tags_all Mapping[str, str]

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

arn String

The ARN of the cluster.

  • cluster_endpoint
clusterEndpoints List<Property Map>
enginePatchVersion String

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

id String

The provider-assigned unique ID for this managed resource.

shards List<Property Map>

Set of shards in this cluster.

tagsAll Map<String>

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

Look up an Existing Cluster Resource

Get an existing Cluster resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: ClusterState, opts?: CustomResourceOptions): Cluster
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        acl_name: Optional[str] = None,
        arn: Optional[str] = None,
        auto_minor_version_upgrade: Optional[bool] = None,
        cluster_endpoints: Optional[Sequence[ClusterClusterEndpointArgs]] = None,
        description: Optional[str] = None,
        engine_patch_version: Optional[str] = None,
        engine_version: Optional[str] = None,
        final_snapshot_name: Optional[str] = None,
        kms_key_arn: Optional[str] = None,
        maintenance_window: Optional[str] = None,
        name: Optional[str] = None,
        name_prefix: Optional[str] = None,
        node_type: Optional[str] = None,
        num_replicas_per_shard: Optional[int] = None,
        num_shards: Optional[int] = None,
        parameter_group_name: Optional[str] = None,
        port: Optional[int] = None,
        security_group_ids: Optional[Sequence[str]] = None,
        shards: Optional[Sequence[ClusterShardArgs]] = None,
        snapshot_arns: Optional[str] = None,
        snapshot_name: Optional[str] = None,
        snapshot_retention_limit: Optional[int] = None,
        snapshot_window: Optional[str] = None,
        sns_topic_arn: Optional[str] = None,
        subnet_group_name: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None,
        tls_enabled: Optional[bool] = None) -> Cluster
func GetCluster(ctx *Context, name string, id IDInput, state *ClusterState, opts ...ResourceOption) (*Cluster, error)
public static Cluster Get(string name, Input<string> id, ClusterState? state, CustomResourceOptions? opts = null)
public static Cluster get(String name, Output<String> id, ClusterState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
AclName string

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

Arn string

The ARN of the cluster.

  • cluster_endpoint
AutoMinorVersionUpgrade bool

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

ClusterEndpoints List<Pulumi.Aws.MemoryDb.Inputs.ClusterClusterEndpointArgs>
Description string
EnginePatchVersion string

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

EngineVersion string

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

FinalSnapshotName string

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

KmsKeyArn string

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

MaintenanceWindow string

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. Example: sun:23:00-mon:01:30.

Name string

Name of this node.

  • endpoint
NamePrefix string

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

NodeType string

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

NumReplicasPerShard 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).

NumShards int

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

ParameterGroupName string

The name of the parameter group associated with the cluster.

Port int

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

SecurityGroupIds List<string>

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

Shards List<Pulumi.Aws.MemoryDb.Inputs.ClusterShardArgs>

Set of shards in this cluster.

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

SnapshotName string

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

SnapshotRetentionLimit int

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

SnapshotWindow string

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

SnsTopicArn string

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

SubnetGroupName string

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

Tags Dictionary<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.

TagsAll Dictionary<string, string>

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

TlsEnabled bool

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

AclName string

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

Arn string

The ARN of the cluster.

  • cluster_endpoint
AutoMinorVersionUpgrade bool

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

ClusterEndpoints []ClusterClusterEndpointArgs
Description string
EnginePatchVersion string

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

EngineVersion string

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

FinalSnapshotName string

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

KmsKeyArn string

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

MaintenanceWindow string

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. Example: sun:23:00-mon:01:30.

Name string

Name of this node.

  • endpoint
NamePrefix string

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

NodeType string

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

NumReplicasPerShard 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).

NumShards int

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

ParameterGroupName string

The name of the parameter group associated with the cluster.

Port int

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

SecurityGroupIds []string

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

Shards []ClusterShardArgs

Set of shards in this cluster.

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

SnapshotName string

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

SnapshotRetentionLimit int

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

SnapshotWindow string

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

SnsTopicArn string

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

SubnetGroupName string

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

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

TagsAll map[string]string

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

TlsEnabled bool

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

aclName String

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

arn String

The ARN of the cluster.

  • cluster_endpoint
autoMinorVersionUpgrade Boolean

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

clusterEndpoints List<ClusterClusterEndpointArgs>
description String
enginePatchVersion String

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

engineVersion String

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

finalSnapshotName String

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

kmsKeyArn String

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

maintenanceWindow String

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. Example: sun:23:00-mon:01:30.

name String

Name of this node.

  • endpoint
namePrefix String

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

nodeType String

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

numReplicasPerShard Integer

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

numShards Integer

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

parameterGroupName String

The name of the parameter group associated with the cluster.

port Integer

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

securityGroupIds List<String>

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

shards List<ClusterShardArgs>

Set of shards in this cluster.

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

snapshotName String

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

snapshotRetentionLimit Integer

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

snapshotWindow String

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

snsTopicArn String

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

subnetGroupName String

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

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

tagsAll Map<String,String>

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

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

aclName string

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

arn string

The ARN of the cluster.

  • cluster_endpoint
autoMinorVersionUpgrade boolean

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

clusterEndpoints ClusterClusterEndpointArgs[]
description string
enginePatchVersion string

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

engineVersion string

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

finalSnapshotName string

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

kmsKeyArn string

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

maintenanceWindow string

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. Example: sun:23:00-mon:01:30.

name string

Name of this node.

  • endpoint
namePrefix string

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

nodeType string

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

numReplicasPerShard number

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

numShards number

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

parameterGroupName string

The name of the parameter group associated with the cluster.

port number

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

securityGroupIds string[]

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

shards ClusterShardArgs[]

Set of shards in this cluster.

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

snapshotName string

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

snapshotRetentionLimit number

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

snapshotWindow string

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

snsTopicArn string

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

subnetGroupName string

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

tags {[key: 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.

tagsAll {[key: string]: string}

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

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

acl_name str

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

arn str

The ARN of the cluster.

  • cluster_endpoint
auto_minor_version_upgrade bool

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

cluster_endpoints Sequence[ClusterClusterEndpointArgs]
description str
engine_patch_version str

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

engine_version str

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

final_snapshot_name str

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

kms_key_arn str

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

maintenance_window str

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. Example: sun:23:00-mon:01:30.

name str

Name of this node.

  • endpoint
name_prefix str

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

node_type str

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

num_replicas_per_shard 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).

num_shards int

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

parameter_group_name str

The name of the parameter group associated with the cluster.

port int

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

security_group_ids Sequence[str]

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

shards Sequence[ClusterShardArgs]

Set of shards in this cluster.

snapshot_arns str

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.

snapshot_name str

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

snapshot_retention_limit int

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

snapshot_window str

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

sns_topic_arn str

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

subnet_group_name str

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

tags Mapping[str, str]

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.

tags_all Mapping[str, str]

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

tls_enabled bool

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

aclName String

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

arn String

The ARN of the cluster.

  • cluster_endpoint
autoMinorVersionUpgrade Boolean

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

clusterEndpoints List<Property Map>
description String
enginePatchVersion String

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

engineVersion String

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

finalSnapshotName String

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

kmsKeyArn String

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

maintenanceWindow String

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. Example: sun:23:00-mon:01:30.

name String

Name of this node.

  • endpoint
namePrefix String

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

nodeType String

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

numReplicasPerShard Number

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

numShards Number

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

parameterGroupName String

The name of the parameter group associated with the cluster.

port Number

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

securityGroupIds List<String>

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

shards List<Property Map>

Set of shards in this cluster.

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

snapshotName String

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

snapshotRetentionLimit Number

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

snapshotWindow String

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

snsTopicArn String

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

subnetGroupName String

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

tags Map<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.

tagsAll Map<String>

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

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

Supporting Types

ClusterClusterEndpoint

Address string

DNS hostname of the node.

Port int

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

Address string

DNS hostname of the node.

Port int

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

address String

DNS hostname of the node.

port Integer

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

address string

DNS hostname of the node.

port number

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

address str

DNS hostname of the node.

port int

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

address String

DNS hostname of the node.

port Number

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

ClusterShard

Name string

Name of this node.

  • endpoint
Nodes List<Pulumi.Aws.MemoryDb.Inputs.ClusterShardNode>

Set of nodes in this shard.

NumNodes int

Number of individual nodes in this shard.

Slots string

Keyspace for this shard. Example: 0-16383.

Name string

Name of this node.

  • endpoint
Nodes []ClusterShardNode

Set of nodes in this shard.

NumNodes int

Number of individual nodes in this shard.

Slots string

Keyspace for this shard. Example: 0-16383.

name String

Name of this node.

  • endpoint
nodes List<ClusterShardNode>

Set of nodes in this shard.

numNodes Integer

Number of individual nodes in this shard.

slots String

Keyspace for this shard. Example: 0-16383.

name string

Name of this node.

  • endpoint
nodes ClusterShardNode[]

Set of nodes in this shard.

numNodes number

Number of individual nodes in this shard.

slots string

Keyspace for this shard. Example: 0-16383.

name str

Name of this node.

  • endpoint
nodes Sequence[ClusterShardNode]

Set of nodes in this shard.

num_nodes int

Number of individual nodes in this shard.

slots str

Keyspace for this shard. Example: 0-16383.

name String

Name of this node.

  • endpoint
nodes List<Property Map>

Set of nodes in this shard.

numNodes Number

Number of individual nodes in this shard.

slots String

Keyspace for this shard. Example: 0-16383.

ClusterShardNode

AvailabilityZone string

The Availability Zone in which the node resides.

CreateTime string

The date and time when the node was created. Example: 2022-01-01T21:00:00Z.

Endpoints List<Pulumi.Aws.MemoryDb.Inputs.ClusterShardNodeEndpoint>
Name string

Name of this node.

  • endpoint
AvailabilityZone string

The Availability Zone in which the node resides.

CreateTime string

The date and time when the node was created. Example: 2022-01-01T21:00:00Z.

Endpoints []ClusterShardNodeEndpoint
Name string

Name of this node.

  • endpoint
availabilityZone String

The Availability Zone in which the node resides.

createTime String

The date and time when the node was created. Example: 2022-01-01T21:00:00Z.

endpoints List<ClusterShardNodeEndpoint>
name String

Name of this node.

  • endpoint
availabilityZone string

The Availability Zone in which the node resides.

createTime string

The date and time when the node was created. Example: 2022-01-01T21:00:00Z.

endpoints ClusterShardNodeEndpoint[]
name string

Name of this node.

  • endpoint
availability_zone str

The Availability Zone in which the node resides.

create_time str

The date and time when the node was created. Example: 2022-01-01T21:00:00Z.

endpoints Sequence[ClusterShardNodeEndpoint]
name str

Name of this node.

  • endpoint
availabilityZone String

The Availability Zone in which the node resides.

createTime String

The date and time when the node was created. Example: 2022-01-01T21:00:00Z.

endpoints List<Property Map>
name String

Name of this node.

  • endpoint

ClusterShardNodeEndpoint

Address string

DNS hostname of the node.

Port int

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

Address string

DNS hostname of the node.

Port int

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

address String

DNS hostname of the node.

port Integer

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

address string

DNS hostname of the node.

port number

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

address str

DNS hostname of the node.

port int

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

address String

DNS hostname of the node.

port Number

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

Import

Use the name to import a cluster. For example

 $ pulumi import aws:memorydb/cluster:Cluster example my-cluster

Package Details

Repository
https://github.com/pulumi/pulumi-aws
License
Apache-2.0
Notes

This Pulumi package is based on the aws Terraform Provider.