CfnCluster

class aws_cdk.aws_memorydb.CfnCluster(scope, id, *, 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: CfnResource

A CloudFormation AWS::MemoryDB::Cluster.

Specifies a cluster . All nodes in the cluster run the same protocol-compliant engine software.

CloudformationResource:: AWS::MemoryDB::Cluster
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.
import aws_cdk.aws_memorydb as memorydb

cfn_cluster = memorydb.CfnCluster(self, "MyCfnCluster",
    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
)

Create a new AWS::MemoryDB::Cluster.

Parameters:

scope (Construct) –
- scope in which this resource is defined.
id (str) –
- scoped id of the resource.
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[IResolvable, EndpointProperty, Dict[str, Any], 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.

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters:: path (str) – The path of the value to delete.
Return type:: None

add_depends_on(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:

target (CfnResource) –

Return type:

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters:

key (str) –
value (Any) –

See:

Return type:

None

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

path (str) –
- The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
value (Any) –
- The value. Could be primitive or complex.

Return type:

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters:: property_path (str) – The path to the property.
Return type:: None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

property_path (str) – The path of the property.
value (Any) – The value.

Return type:

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Parameters:

policy (Optional[RemovalPolicy]) –
apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true
default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resoure, please consult that specific resource’s documentation.

Return type:

None

get_att(attribute_name)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:: attribute_name (str) – The name of the attribute.
Return type:: Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

key (str) –

See:

Return type:

Any

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters:

inspector (TreeInspector) –

tree inspector to collect and process attributes.

Return type:

None

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters:: new_logical_id (str) – The new logical ID to use for this stack element.
Return type:: None

to_string()

Returns a string representation of this construct.

Return type:: str
Returns:: a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::MemoryDB::Cluster'

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

attr_arn

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

CloudformationAttribute:: ARN

attr_cluster_endpoint_address

The address of the cluster ‘s configuration endpoint.

CloudformationAttribute:: ClusterEndpoint.Address

attr_cluster_endpoint_port

The port used by the cluster configuration endpoint.

CloudformationAttribute:: ClusterEndpoint.Port

attr_parameter_group_status

The status of the parameter group used by the cluster , for example active or applying .

CloudformationAttribute:: ParameterGroupStatus

attr_status

The status of the cluster.

For example, ‘available’, ‘updating’ or ‘creating’.

CloudformationAttribute:: Status

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

cfn_options: Options for this resource, such as condition, update policy etc.

cfn_resource_type: AWS resource type.

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

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

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

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Returns:

the logical ID as a stringified token. This value will only get resolved during synthesis.

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: The construct tree node associated with this construct.

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

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

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

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

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

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters:

x (Any) –

Return type:

bool

Returns:

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(construct)

Check whether the given construct is a CfnResource.

Parameters:

construct (IConstruct) –

Return type:

bool

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters:

x (Any) –

Return type:

bool

EndpointProperty

class CfnCluster.EndpointProperty(*, address=None, port=None)

Bases: object

Represents the information required for client programs to connect to the cluster and its nodes.

Parameters:

address (Optional[str]) – The DNS hostname of the node.
port (Union[int, float, None]) – The port number that the engine is listening on.

Link:

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

ExampleMetadata:

fixture=_generated

Example:

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

endpoint_property = memorydb.CfnCluster.EndpointProperty(
    address="address",
    port=123
)

Attributes

address

The DNS hostname of the node.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-memorydb-cluster-endpoint.html#cfn-memorydb-cluster-endpoint-address

port

The port number that the engine is listening on.

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