Type object
Schema URL https://catalog.lintel.tools/schemas/schemastore/serverless-framework-configuration/_shared/latest--aws-memorydb-cluster.json
Parent schema serverless-framework-configuration
Type: object

The AWS::MemoryDB::Cluster resource creates an Amazon MemoryDB Cluster.. Source:- https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-memorydb

Properties

ClusterName string | Aws_CF_FunctionString required

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

NodeType string | Aws_CF_FunctionString required

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

ACLName string | Aws_CF_FunctionString required

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

Description string | Aws_CF_FunctionString

An optional description of the cluster.

NumShards integer

The number of shards the cluster will contain.

NumReplicasPerShard integer

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

SubnetGroupName string | Aws_CF_FunctionString

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

SecurityGroupIds string[]

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

MaintenanceWindow string | Aws_CF_FunctionString

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.

ParameterGroupName string | Aws_CF_FunctionString

The name of the parameter group associated with the cluster.

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

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

SnsTopicArn string | Aws_CF_FunctionString

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

SnsTopicStatus string | Aws_CF_FunctionString

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

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.

DataTiering string | Aws_CF_FunctionString
KmsKeyId string | Aws_CF_FunctionString

The ID of the KMS key used to encrypt the 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 | Aws_CF_FunctionString

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.

FinalSnapshotName string | Aws_CF_FunctionString

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.

EngineVersion string | Aws_CF_FunctionString

The Redis engine version used by the cluster.

ClusterEndpoint object
2 nested properties
Address string | Aws_CF_FunctionString

The DNS address of the primary read-write node.

Port integer

The port number that the engine is listening on.

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.

Tags Tag[]

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

maxItems=50uniqueItems=true

Definitions

Endpoint object
Address string | Aws_CF_FunctionString

The DNS address of the primary read-write node.

Port integer

The port number that the engine is listening on.

Tag object

A key-value pair to associate with a resource.

Key string | Aws_CF_FunctionString required

The key for the tag. May not be null.

Value string | Aws_CF_FunctionString required

The tag's value. May be null.

DataTieringStatus string | Aws_CF_FunctionString