CfnCluster

class aws_cdk.aws_dax.CfnCluster(scope, id, *, iam_role_arn, node_type, replication_factor, availability_zones=None, cluster_endpoint_encryption_type=None, cluster_name=None, description=None, notification_topic_arn=None, parameter_group_name=None, preferred_maintenance_window=None, security_group_ids=None, sse_specification=None, subnet_group_name=None, tags=None)

Bases: CfnResource

Creates a DAX cluster.

All nodes in the cluster run the same DAX caching software.

See:

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

CloudformationResource:

AWS::DAX::Cluster

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_dax as dax

# tags: Any

cfn_cluster = dax.CfnCluster(self, "MyCfnCluster",
    iam_role_arn="iamRoleArn",
    node_type="nodeType",
    replication_factor=123,

    # the properties below are optional
    availability_zones=["availabilityZones"],
    cluster_endpoint_encryption_type="clusterEndpointEncryptionType",
    cluster_name="clusterName",
    description="description",
    notification_topic_arn="notificationTopicArn",
    parameter_group_name="parameterGroupName",
    preferred_maintenance_window="preferredMaintenanceWindow",
    security_group_ids=["securityGroupIds"],
    sse_specification=dax.CfnCluster.SSESpecificationProperty(
        sse_enabled=False
    ),
    subnet_group_name="subnetGroupName",
    tags=tags
)
Parameters:
  • scope (Construct) – Scope in which this resource is defined.

  • id (str) – Construct identifier for this resource (unique in its scope).

  • iam_role_arn (str) – A valid Amazon Resource Name (ARN) that identifies an IAM role. At runtime, DAX will assume this role and use the role’s permissions to access DynamoDB on your behalf.

  • node_type (str) – The node type for the nodes in the cluster. (All nodes in a DAX cluster are of the same type.)

  • replication_factor (Union[int, float]) – The number of nodes in the DAX cluster. A replication factor of 1 will create a single-node cluster, without any read replicas. For additional fault tolerance, you can create a multiple node cluster with one or more read replicas. To do this, set ReplicationFactor to a number between 3 (one primary and two read replicas) and 10 (one primary and nine read replicas). If the AvailabilityZones parameter is provided, its length must equal the ReplicationFactor . .. epigraph:: AWS recommends that you have at least two read replicas per cluster.

  • availability_zones (Optional[Sequence[str]]) – The Availability Zones (AZs) in which the cluster nodes will reside after the cluster has been created or updated. If provided, the length of this list must equal the ReplicationFactor parameter. If you omit this parameter, DAX will spread the nodes across Availability Zones for the highest availability.

  • cluster_endpoint_encryption_type (Optional[str]) – The encryption type of the cluster’s endpoint. Available values are:. - NONE - The cluster’s endpoint will be unencrypted. - TLS - The cluster’s endpoint will be encrypted with Transport Layer Security, and will provide an x509 certificate for authentication. The default value is NONE .

  • cluster_name (Optional[str]) – The name of the DAX cluster.

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

  • notification_topic_arn (Optional[str]) – The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications will be sent. .. epigraph:: The Amazon SNS topic owner must be same as the DAX cluster owner.

  • parameter_group_name (Optional[str]) – The parameter group to be associated with the DAX cluster.

  • preferred_maintenance_window (Optional[str]) – A range of time when maintenance of DAX cluster software will be performed. For example: sun:01:00-sun:09:00 . Cluster maintenance normally takes less than 30 minutes, and is performed automatically within the maintenance window.

  • security_group_ids (Optional[Sequence[str]]) – A list of security group IDs to be assigned to each node in the DAX cluster. (Each of the security group ID is system-generated.) If this parameter is not specified, DAX assigns the default VPC security group to each node.

  • sse_specification (Union[IResolvable, SSESpecificationProperty, Dict[str, Any], None]) – Represents the settings used to enable server-side encryption on the cluster.

  • subnet_group_name (Optional[str]) – The name of the subnet group to be used for the replication group. .. epigraph:: DAX clusters can only run in an Amazon VPC environment. All of the subnets that you specify in a subnet group must exist in the same VPC.

  • tags (Any) – A set of tags to associate with the DAX cluster.

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_dependency(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_depends_on(target)

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

Parameters:

target (CfnResource) –

Deprecated:

use addDependency

Stability:

deprecated

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 intermediate 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). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

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 resource, please consult that specific resource’s documentation.

See:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

Return type:

None

get_att(attribute_name, type_hint=None)

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.

  • type_hint (Optional[ResolutionTypeHint]) –

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

obtain_dependencies()

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Return type:

List[Union[Stack, CfnResource]]

obtain_resource_dependencies()

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Return type:

List[CfnResource]

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

remove_dependency(target)

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:

target (CfnResource) –

Return type:

None

replace_dependency(target, new_target)

Replaces one dependency with another.

Parameters:
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::DAX::Cluster'
attr_arn

.

{ "Fn::GetAtt": [" MyDAXCluster ", "Arn"] }

Returns a value similar to the following:

arn:aws:dax:us-east-1:111122223333:cache/MyDAXCluster

CloudformationAttribute:

Arn

Type:

Returns the ARN of the DAX cluster. For example

attr_cluster_discovery_endpoint

.

{ "Fn::GetAtt": [" MyDAXCluster ", "ClusterDiscoveryEndpoint"] }

Returns a value similar to the following:

mydaxcluster.0h3d6x.clustercfg.dax.use1.cache.amazonaws.com:8111

CloudformationAttribute:

ClusterDiscoveryEndpoint

Type:

Returns the endpoint of the DAX cluster. For example

attr_cluster_discovery_endpoint_url

Returns the endpoint URL of the DAX cluster.

CloudformationAttribute:

ClusterDiscoveryEndpointURL

attr_id

Id

Type:

cloudformationAttribute

availability_zones

The Availability Zones (AZs) in which the cluster nodes will reside after the cluster has been created or updated.

cfn_options

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

cfn_resource_type

AWS resource type.

cluster_endpoint_encryption_type

The encryption type of the cluster’s endpoint.

Available values are:.

cluster_name

The name of the DAX cluster.

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.

description

The description of the cluster.

iam_role_arn

A valid Amazon Resource Name (ARN) that identifies an IAM role.

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.

node

The tree node.

node_type

The node type for the nodes in the cluster.

notification_topic_arn

The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications will be sent.

parameter_group_name

The parameter group to be associated with the DAX cluster.

preferred_maintenance_window

A range of time when maintenance of DAX cluster software will be performed.

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 }).

replication_factor

The number of nodes in the DAX cluster.

security_group_ids

A list of security group IDs to be assigned to each node in the DAX cluster.

sse_specification

Represents the settings used to enable server-side encryption on the cluster.

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 to be used for the replication group.

tags

Tag Manager which manages the tags for this resource.

tags_raw

A set of tags to associate with the DAX cluster.

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(x)

Check whether the given object is a CfnResource.

Parameters:

x (Any) –

Return type:

bool

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters:

x (Any) – Any object.

Return type:

bool

Returns:

true if x is an object created from a class which extends Construct.

SSESpecificationProperty

class CfnCluster.SSESpecificationProperty(*, sse_enabled=None)

Bases: object

Represents the settings used to enable server-side encryption.

Parameters:

sse_enabled (Union[bool, IResolvable, None]) – Indicates whether server-side encryption is enabled (true) or disabled (false) on the cluster.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dax-cluster-ssespecification.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_dax as dax

s_sESpecification_property = dax.CfnCluster.SSESpecificationProperty(
    sse_enabled=False
)

Attributes

sse_enabled

Indicates whether server-side encryption is enabled (true) or disabled (false) on the cluster.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dax-cluster-ssespecification.html#cfn-dax-cluster-ssespecification-sseenabled