Cluster

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

Create Cluster Resource

new Cluster(name: string, args: ClusterArgs, opts?: CustomResourceOptions);
@overload
def Cluster(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            a_cl_name: Optional[str] = None,
            auto_minor_version_upgrade: Optional[bool] = None,
            cluster_endpoint: Optional[ClusterEndpointArgs] = None,
            cluster_name: Optional[str] = None,
            data_tiering: Optional[ClusterDataTieringStatus] = None,
            description: Optional[str] = None,
            engine_version: Optional[str] = None,
            final_snapshot_name: Optional[str] = None,
            kms_key_id: Optional[str] = None,
            maintenance_window: 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[Sequence[str]] = None,
            snapshot_name: Optional[str] = None,
            snapshot_retention_limit: Optional[int] = None,
            snapshot_window: Optional[str] = None,
            sns_topic_arn: Optional[str] = None,
            sns_topic_status: Optional[str] = None,
            subnet_group_name: Optional[str] = None,
            t_ls_enabled: Optional[bool] = None,
            tags: Optional[Sequence[ClusterTagArgs]] = 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-native: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.

AutoMinorVersionUpgrade bool

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.

ClusterEndpoint Pulumi.AwsNative.MemoryDB.Inputs.ClusterEndpointArgs

The cluster endpoint.

ClusterName string

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

DataTiering Pulumi.AwsNative.MemoryDB.ClusterDataTieringStatus

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

Description string

An optional description of the cluster.

EngineVersion string

The Redis engine version used by the cluster.

FinalSnapshotName string

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.

KmsKeyId string

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

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.

NumReplicasPerShard int

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

NumShards int

The number of shards the cluster will contain.

ParameterGroupName string

The name of the parameter group associated with the cluster.

Port int

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

SecurityGroupIds List<string>

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

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

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

SnapshotRetentionLimit int

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.

SnapshotWindow string

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

SnsTopicArn string

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

SnsTopicStatus string

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

SubnetGroupName string

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

TLSEnabled bool

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.

Tags List<Pulumi.AwsNative.MemoryDB.Inputs.ClusterTagArgs>

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

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.

AutoMinorVersionUpgrade bool

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.

ClusterEndpoint ClusterEndpointArgs

The cluster endpoint.

ClusterName string

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

DataTiering ClusterDataTieringStatus

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

Description string

An optional description of the cluster.

EngineVersion string

The Redis engine version used by the cluster.

FinalSnapshotName string

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.

KmsKeyId string

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

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.

NumReplicasPerShard int

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

NumShards int

The number of shards the cluster will contain.

ParameterGroupName string

The name of the parameter group associated with the cluster.

Port int

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

SecurityGroupIds []string

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

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

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

SnapshotRetentionLimit int

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.

SnapshotWindow string

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

SnsTopicArn string

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

SnsTopicStatus string

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

SubnetGroupName string

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

TLSEnabled bool

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.

Tags []ClusterTagArgs

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

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.

autoMinorVersionUpgrade Boolean

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.

clusterEndpoint ClusterEndpointArgs

The cluster endpoint.

clusterName String

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

dataTiering ClusterDataTieringStatus

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

description String

An optional description of the cluster.

engineVersion String

The Redis engine version used by the cluster.

finalSnapshotName String

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.

kmsKeyId String

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

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.

numReplicasPerShard Integer

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

numShards Integer

The number of shards the cluster will contain.

parameterGroupName String

The name of the parameter group associated with the cluster.

port Integer

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

securityGroupIds List<String>

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

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

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

snapshotRetentionLimit Integer

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.

snapshotWindow String

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

snsTopicArn String

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

snsTopicStatus String

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

subnetGroupName String

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

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

tags List<ClusterTagArgs>

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

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.

autoMinorVersionUpgrade boolean

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.

clusterEndpoint ClusterEndpointArgs

The cluster endpoint.

clusterName string

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

dataTiering ClusterDataTieringStatus

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

description string

An optional description of the cluster.

engineVersion string

The Redis engine version used by the cluster.

finalSnapshotName string

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.

kmsKeyId string

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

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.

numReplicasPerShard number

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

numShards number

The number of shards the cluster will contain.

parameterGroupName string

The name of the parameter group associated with the cluster.

port number

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

securityGroupIds string[]

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

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

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

snapshotRetentionLimit number

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.

snapshotWindow string

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

snsTopicArn string

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

snsTopicStatus string

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

subnetGroupName string

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

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

tags ClusterTagArgs[]

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

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

auto_minor_version_upgrade bool

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.

cluster_endpoint ClusterEndpointArgs

The cluster endpoint.

cluster_name str

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

data_tiering ClusterDataTieringStatus

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

description str

An optional description of the cluster.

engine_version str

The Redis engine version used by the cluster.

final_snapshot_name str

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.

kms_key_id str

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

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.

num_replicas_per_shard int

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

num_shards int

The number of shards the cluster will contain.

parameter_group_name str

The name of the parameter group associated with the cluster.

port int

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

security_group_ids Sequence[str]

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

snapshot_arns Sequence[str]

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.

snapshot_name str

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.

snapshot_retention_limit int

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.

snapshot_window str

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

sns_topic_arn str

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

sns_topic_status str

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

subnet_group_name str

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

t_ls_enabled bool

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.

tags Sequence[ClusterTagArgs]

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

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.

autoMinorVersionUpgrade Boolean

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.

clusterEndpoint Property Map

The cluster endpoint.

clusterName String

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

dataTiering "true" | "false"

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

description String

An optional description of the cluster.

engineVersion String

The Redis engine version used by the cluster.

finalSnapshotName String

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.

kmsKeyId String

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

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.

numReplicasPerShard Number

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

numShards Number

The number of shards the cluster will contain.

parameterGroupName String

The name of the parameter group associated with the cluster.

port Number

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

securityGroupIds List<String>

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

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

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

snapshotRetentionLimit Number

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.

snapshotWindow String

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

snsTopicArn String

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

snsTopicStatus String

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

subnetGroupName String

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

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

tags List<Property Map>

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

Outputs

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

ARN string

The Amazon Resource Name (ARN) of the cluster.

Id string

The provider-assigned unique ID for this managed resource.

ParameterGroupStatus string

The status of the parameter group used by the cluster.

Status string

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

ARN string

The Amazon Resource Name (ARN) of the cluster.

Id string

The provider-assigned unique ID for this managed resource.

ParameterGroupStatus string

The status of the parameter group used by the cluster.

Status string

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

aRN String

The Amazon Resource Name (ARN) of the cluster.

id String

The provider-assigned unique ID for this managed resource.

parameterGroupStatus String

The status of the parameter group used by the cluster.

status String

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

aRN string

The Amazon Resource Name (ARN) of the cluster.

id string

The provider-assigned unique ID for this managed resource.

parameterGroupStatus string

The status of the parameter group used by the cluster.

status string

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

a_rn str

The Amazon Resource Name (ARN) of the cluster.

id str

The provider-assigned unique ID for this managed resource.

parameter_group_status str

The status of the parameter group used by the cluster.

status str

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

aRN String

The Amazon Resource Name (ARN) of the cluster.

id String

The provider-assigned unique ID for this managed resource.

parameterGroupStatus String

The status of the parameter group used by the cluster.

status String

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

Supporting Types

ClusterDataTieringStatus

True
true
False
false
ClusterDataTieringStatusTrue
true
ClusterDataTieringStatusFalse
false
True
true
False
false
True
true
False
false
TRUE
true
FALSE
false
"true"
true
"false"
false

ClusterEndpoint

Address string

The DNS address of the primary read-write node.

Port int

The port number that the engine is listening on.

Address string

The DNS address of the primary read-write node.

Port int

The port number that the engine is listening on.

address String

The DNS address of the primary read-write node.

port Integer

The port number that the engine is listening on.

address string

The DNS address of the primary read-write node.

port number

The port number that the engine is listening on.

address str

The DNS address of the primary read-write node.

port int

The port number that the engine is listening on.

address String

The DNS address of the primary read-write node.

port Number

The port number that the engine is listening on.

ClusterTag

Key string

The key for the tag. May not be null.

Value string

The tag's value. May be null.

Key string

The key for the tag. May not be null.

Value string

The tag's value. May be null.

key String

The key for the tag. May not be null.

value String

The tag's value. May be null.

key string

The key for the tag. May not be null.

value string

The tag's value. May be null.

key str

The key for the tag. May not be null.

value str

The tag's value. May be null.

key String

The key for the tag. May not be null.

value String

The tag's value. May be null.

Package Details

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