CfnClusterProps

class aws_cdk.aws_memorydb.CfnClusterProps(*, acl_name, cluster_name, node_type, auto_minor_version_upgrade=None, cluster_endpoint=None, data_tiering=None, description=None, engine_version=None, final_snapshot_name=None, kms_key_id=None, maintenance_window=None, num_replicas_per_shard=None, num_shards=None, parameter_group_name=None, port=None, security_group_ids=None, snapshot_arns=None, snapshot_name=None, snapshot_retention_limit=None, snapshot_window=None, sns_topic_arn=None, sns_topic_status=None, subnet_group_name=None, tags=None, tls_enabled=None)

Bases: object

Properties for defining a CfnCluster.

Parameters
  • acl_name (str) – The name of the Access Control List to associate with the cluster .

  • cluster_name (str) – The name of the cluster .

  • node_type (str) – The cluster ‘s node type.

  • auto_minor_version_upgrade (Union[bool, IResolvable, None]) – When set to true, the cluster will automatically receive minor engine version upgrades after launch.

  • cluster_endpoint (Union[EndpointProperty, Dict[str, Any], IResolvable, None]) – The cluster ‘s configuration endpoint.

  • data_tiering (Optional[str]) – Enables data tiering. Data tiering is only supported for replication groups using the r6gd node type. This parameter must be set to true when using r6gd nodes. For more information, see Data tiering .

  • description (Optional[str]) – A description of the cluster .

  • engine_version (Optional[str]) – The Redis engine version used by the cluster .

  • final_snapshot_name (Optional[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 (Optional[str]) – The ID of the KMS key used to encrypt the cluster .

  • maintenance_window (Optional[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. Pattern : ddd:hh24:mi-ddd:hh24:mi

  • num_replicas_per_shard (Union[int, float, None]) – The number of replicas to apply to each shard. Default value : 1 Maximum value : 5

  • num_shards (Union[int, float, None]) – The number of shards in the cluster .

  • parameter_group_name (Optional[str]) – The name of the parameter group used by the cluster .

  • port (Union[int, float, None]) – The port used by the cluster .

  • security_group_ids (Optional[Sequence[str]]) – A list of security group names to associate with this cluster .

  • snapshot_arns (Optional[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 (Optional[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 (Union[int, float, None]) – 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 (Optional[str]) – The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your shard. Example: 05:00-09:00 If you do not specify this parameter, MemoryDB automatically chooses an appropriate time range.

  • sns_topic_arn (Optional[str]) – When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the ARN of the SNS topic, such as arn:aws:memorydb:us-east-1:123456789012:mySNSTopic.

  • sns_topic_status (Optional[str]) – The SNS topic must be in Active status to receive notifications.

  • subnet_group_name (Optional[str]) – The name of the subnet group used by the cluster .

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – An array of key-value pairs to apply to this resource. For more information, see Tag .

  • tls_enabled (Union[bool, IResolvable, None]) – A flag to indicate if In-transit encryption is enabled.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_memorydb as memorydb

cfn_cluster_props = memorydb.CfnClusterProps(
    acl_name="aclName",
    cluster_name="clusterName",
    node_type="nodeType",

    # the properties below are optional
    auto_minor_version_upgrade=False,
    cluster_endpoint=memorydb.CfnCluster.EndpointProperty(
        address="address",
        port=123
    ),
    data_tiering="dataTiering",
    description="description",
    engine_version="engineVersion",
    final_snapshot_name="finalSnapshotName",
    kms_key_id="kmsKeyId",
    maintenance_window="maintenanceWindow",
    num_replicas_per_shard=123,
    num_shards=123,
    parameter_group_name="parameterGroupName",
    port=123,
    security_group_ids=["securityGroupIds"],
    snapshot_arns=["snapshotArns"],
    snapshot_name="snapshotName",
    snapshot_retention_limit=123,
    snapshot_window="snapshotWindow",
    sns_topic_arn="snsTopicArn",
    sns_topic_status="snsTopicStatus",
    subnet_group_name="subnetGroupName",
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    tls_enabled=False
)

Attributes

acl_name

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

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#cfn-memorydb-cluster-aclname

auto_minor_version_upgrade

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

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#cfn-memorydb-cluster-autominorversionupgrade

cluster_endpoint

The cluster ‘s configuration endpoint.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#cfn-memorydb-cluster-clusterendpoint

cluster_name

The name of the cluster .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#cfn-memorydb-cluster-clustername

data_tiering

Enables data tiering.

Data tiering is only supported for replication groups using the r6gd node type. This parameter must be set to true when using r6gd nodes. For more information, see Data tiering .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#cfn-memorydb-cluster-datatiering

description

A description of the cluster .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#cfn-memorydb-cluster-description

engine_version

The Redis engine version used by the cluster .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#cfn-memorydb-cluster-engineversion

final_snapshot_name

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.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#cfn-memorydb-cluster-finalsnapshotname

kms_key_id

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

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#cfn-memorydb-cluster-kmskeyid

maintenance_window

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.

Pattern : ddd:hh24:mi-ddd:hh24:mi

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#cfn-memorydb-cluster-maintenancewindow

node_type

The cluster ‘s node type.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#cfn-memorydb-cluster-nodetype

num_replicas_per_shard

The number of replicas to apply to each shard.

Default value : 1

Maximum value : 5

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#cfn-memorydb-cluster-numreplicaspershard

num_shards

The number of shards in the cluster .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#cfn-memorydb-cluster-numshards

parameter_group_name

The name of the parameter group used by the cluster .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#cfn-memorydb-cluster-parametergroupname

port

The port used by the cluster .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#cfn-memorydb-cluster-port

security_group_ids

A list of security group names to associate with this cluster .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#cfn-memorydb-cluster-securitygroupids

snapshot_arns

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.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#cfn-memorydb-cluster-snapshotarns

snapshot_name

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.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#cfn-memorydb-cluster-snapshotname

snapshot_retention_limit

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.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#cfn-memorydb-cluster-snapshotretentionlimit

snapshot_window

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

Example: 05:00-09:00 If you do not specify this parameter, MemoryDB automatically chooses an appropriate time range.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#cfn-memorydb-cluster-snapshotwindow

sns_topic_arn

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the ARN of the SNS topic, such as arn:aws:memorydb:us-east-1:123456789012:mySNSTopic.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#cfn-memorydb-cluster-snstopicarn

sns_topic_status

The SNS topic must be in Active status to receive notifications.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#cfn-memorydb-cluster-snstopicstatus

subnet_group_name

The name of the subnet group used by the cluster .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#cfn-memorydb-cluster-subnetgroupname

tags

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

For more information, see Tag .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#cfn-memorydb-cluster-tags

tls_enabled

A flag to indicate if In-transit encryption is enabled.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#cfn-memorydb-cluster-tlsenabled