We recommend new projects start with resources from the AWS provider.
aws-native.memorydb.Cluster
Explore with Pulumi AI
We recommend new projects start with resources from the AWS provider.
The AWS::MemoryDB::Cluster resource creates an Amazon MemoryDB Cluster.
Create Cluster Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Cluster(name: string, args: ClusterArgs, opts?: CustomResourceOptions);
@overload
def Cluster(resource_name: str,
args: ClusterArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Cluster(resource_name: str,
opts: Optional[ResourceOptions] = None,
node_type: Optional[str] = None,
acl_name: Optional[str] = None,
num_shards: Optional[int] = None,
tls_enabled: Optional[bool] = 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_id: Optional[str] = None,
maintenance_window: Optional[str] = None,
cluster_endpoint: Optional[ClusterEndpointArgs] = None,
port: Optional[int] = None,
data_tiering: Optional[ClusterDataTieringStatus] = None,
cluster_name: Optional[str] = None,
num_replicas_per_shard: 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,
tags: Optional[Sequence[_root_inputs.TagArgs]] = None,
parameter_group_name: Optional[str] = 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.
Parameters
- 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:
- Acl
Name string - The name of the Access Control List to associate with the cluster.
- Node
Type string - The compute and memory capacity of the nodes in the cluster.
- Auto
Minor boolVersion Upgrade 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 Pulumi.Aws Native. Memory Db. Inputs. Cluster Endpoint - The cluster endpoint.
- Cluster
Name string - The name of the cluster. This value must be unique as it also serves as the cluster identifier.
- Data
Tiering Pulumi.Aws Native. Memory Db. Cluster Data Tiering Status - 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.
- Engine
Version string - The Redis engine version used by the cluster.
- Final
Snapshot stringName - 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 stringId - The ID of the KMS key used to encrypt the cluster.
- Maintenance
Window 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.
- Num
Replicas intPer Shard - 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 stringName - 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 List<string>Ids - One or more Amazon VPC security groups associated with this cluster.
- Snapshot
Arns 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.
- Snapshot
Name 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.
- Snapshot
Retention intLimit - 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 string - The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your cluster.
- Sns
Topic stringArn - The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.
- Sns
Topic stringStatus - The status of the Amazon SNS notification topic. Notifications are sent only if the status is enabled.
- Subnet
Group stringName - The name of the subnet group to be used for the cluster.
- List<Pulumi.
Aws Native. Inputs. Tag> - An array of key-value pairs to apply to this cluster.
- Tls
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.
- Acl
Name string - The name of the Access Control List to associate with the cluster.
- Node
Type string - The compute and memory capacity of the nodes in the cluster.
- Auto
Minor boolVersion Upgrade 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 ClusterEndpoint Args - The cluster endpoint.
- Cluster
Name string - The name of the cluster. This value must be unique as it also serves as the cluster identifier.
- Data
Tiering ClusterData Tiering Status - 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.
- Engine
Version string - The Redis engine version used by the cluster.
- Final
Snapshot stringName - 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 stringId - The ID of the KMS key used to encrypt the cluster.
- Maintenance
Window 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.
- Num
Replicas intPer Shard - 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 stringName - 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 []stringIds - One or more Amazon VPC security groups associated with this cluster.
- Snapshot
Arns []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.
- Snapshot
Name 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.
- Snapshot
Retention intLimit - 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 string - The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your cluster.
- Sns
Topic stringArn - The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.
- Sns
Topic stringStatus - The status of the Amazon SNS notification topic. Notifications are sent only if the status is enabled.
- Subnet
Group stringName - The name of the subnet group to be used for the cluster.
- Tag
Args - An array of key-value pairs to apply to this cluster.
- Tls
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.
- acl
Name String - The name of the Access Control List to associate with the cluster.
- node
Type String - The compute and memory capacity of the nodes in the cluster.
- auto
Minor BooleanVersion Upgrade 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 ClusterEndpoint - The cluster endpoint.
- cluster
Name String - The name of the cluster. This value must be unique as it also serves as the cluster identifier.
- data
Tiering ClusterData Tiering Status - 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.
- engine
Version String - The Redis engine version used by the cluster.
- final
Snapshot StringName - 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 StringId - The ID of the KMS key used to encrypt the cluster.
- maintenance
Window 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.
- num
Replicas IntegerPer Shard - The number of replicas to apply to each shard. The limit is 5.
- num
Shards Integer - The number of shards the cluster will contain.
- parameter
Group StringName - The name of the parameter group associated with the cluster.
- port Integer
- The port number on which each member of the cluster accepts connections.
- security
Group List<String>Ids - One or more Amazon VPC security groups associated with this cluster.
- snapshot
Arns 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.
- snapshot
Name 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.
- snapshot
Retention IntegerLimit - 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 String - The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your cluster.
- sns
Topic StringArn - The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.
- sns
Topic StringStatus - The status of the Amazon SNS notification topic. Notifications are sent only if the status is enabled.
- subnet
Group StringName - The name of the subnet group to be used for the cluster.
- List<Tag>
- An array of key-value pairs to apply to this cluster.
- tls
Enabled 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.
- acl
Name string - The name of the Access Control List to associate with the cluster.
- node
Type string - The compute and memory capacity of the nodes in the cluster.
- auto
Minor booleanVersion Upgrade 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 ClusterEndpoint - The cluster endpoint.
- cluster
Name string - The name of the cluster. This value must be unique as it also serves as the cluster identifier.
- data
Tiering ClusterData Tiering Status - 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.
- engine
Version string - The Redis engine version used by the cluster.
- final
Snapshot stringName - 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 stringId - The ID of the KMS key used to encrypt the cluster.
- maintenance
Window 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.
- num
Replicas numberPer Shard - The number of replicas to apply to each shard. The limit is 5.
- num
Shards number - The number of shards the cluster will contain.
- parameter
Group stringName - The name of the parameter group associated with the cluster.
- port number
- The port number on which each member of the cluster accepts connections.
- security
Group string[]Ids - One or more Amazon VPC security groups associated with this cluster.
- snapshot
Arns 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.
- snapshot
Name 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.
- snapshot
Retention numberLimit - 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 string - The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your cluster.
- sns
Topic stringArn - The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.
- sns
Topic stringStatus - The status of the Amazon SNS notification topic. Notifications are sent only if the status is enabled.
- subnet
Group stringName - The name of the subnet group to be used for the cluster.
- Tag[]
- An array of key-value pairs to apply to this cluster.
- tls
Enabled 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.
- 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.
- auto_
minor_ boolversion_ upgrade 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 ClusterEndpoint Args - 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 ClusterData Tiering Status - 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_ strname - 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_ strid - 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_ intper_ shard - 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_ strname - 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_ Sequence[str]ids - 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_ intlimit - 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_ strarn - The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.
- sns_
topic_ strstatus - The status of the Amazon SNS notification topic. Notifications are sent only if the status is enabled.
- subnet_
group_ strname - The name of the subnet group to be used for the cluster.
- Sequence[Tag
Args] - An array of key-value pairs to apply to this cluster.
- tls_
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.
- acl
Name String - The name of the Access Control List to associate with the cluster.
- node
Type String - The compute and memory capacity of the nodes in the cluster.
- auto
Minor BooleanVersion Upgrade 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 Property Map - The cluster endpoint.
- cluster
Name String - The name of the cluster. This value must be unique as it also serves as the cluster identifier.
- data
Tiering "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.
- engine
Version String - The Redis engine version used by the cluster.
- final
Snapshot StringName - 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 StringId - The ID of the KMS key used to encrypt the cluster.
- maintenance
Window 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.
- num
Replicas NumberPer Shard - The number of replicas to apply to each shard. The limit is 5.
- num
Shards Number - The number of shards the cluster will contain.
- parameter
Group StringName - The name of the parameter group associated with the cluster.
- port Number
- The port number on which each member of the cluster accepts connections.
- security
Group List<String>Ids - One or more Amazon VPC security groups associated with this cluster.
- snapshot
Arns 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.
- snapshot
Name 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.
- snapshot
Retention NumberLimit - 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 String - The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your cluster.
- sns
Topic StringArn - The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.
- sns
Topic StringStatus - The status of the Amazon SNS notification topic. Notifications are sent only if the status is enabled.
- subnet
Group StringName - The name of the subnet group to be used for the cluster.
- List<Property Map>
- An array of key-value pairs to apply to this cluster.
- tls
Enabled 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.
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.
- Parameter
Group stringStatus - 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.
- Parameter
Group stringStatus - 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.
- parameter
Group StringStatus - 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.
- parameter
Group stringStatus - The status of the parameter group used by the cluster.
- status string
- The status of the cluster. For example, Available, Updating, Creating.
- arn str
- The Amazon Resource Name (ARN) of the cluster.
- id str
- The provider-assigned unique ID for this managed resource.
- parameter_
group_ strstatus - 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.
- parameter
Group StringStatus - 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, ClusterDataTieringStatusArgs
- True
- true
- False
- false
- Cluster
Data Tiering Status True - true
- Cluster
Data Tiering Status False - false
- True
- true
- False
- false
- True
- true
- False
- false
- TRUE
- true
- FALSE
- false
- "true"
- true
- "false"
- false
ClusterEndpoint, ClusterEndpointArgs
Tag, TagArgs
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.