class CfnCluster (construct)

Language	Type name
.NET	`Amazon.CDK.AWS.DAX.CfnCluster`
Java	`software.amazon.awscdk.services.dax.CfnCluster`
Python	`aws_cdk.aws_dax.CfnCluster`
TypeScript	`@aws-cdk/aws-dax` » `CfnCluster`

Implements IConstruct, IConstruct, IDependable, IInspectable

A CloudFormation AWS::DAX::Cluster.

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as dax from '@aws-cdk/aws-dax';

declare const tags: any;
const cfnCluster = new dax.CfnCluster(this, 'MyCfnCluster', {
  iamRoleArn: 'iamRoleArn',
  nodeType: 'nodeType',
  replicationFactor: 123,

  // the properties below are optional
  availabilityZones: ['availabilityZones'],
  clusterEndpointEncryptionType: 'clusterEndpointEncryptionType',
  clusterName: 'clusterName',
  description: 'description',
  notificationTopicArn: 'notificationTopicArn',
  parameterGroupName: 'parameterGroupName',
  preferredMaintenanceWindow: 'preferredMaintenanceWindow',
  securityGroupIds: ['securityGroupIds'],
  sseSpecification: {
    sseEnabled: false,
  },
  subnetGroupName: 'subnetGroupName',
  tags: tags,
});

Initializer

new CfnCluster(scope: Construct, id: string, props: CfnClusterProps)

Parameters

scope Construct — - scope in which this resource is defined.
id string — - scoped id of the resource.
props CfnClusterProps — - resource properties.

Create a new AWS::DAX::Cluster.

Construct Props

Name	Type	Description
iamRoleArn	`string`	A valid Amazon Resource Name (ARN) that identifies an IAM role.
nodeType	`string`	The node type for the nodes in the cluster.
replicationFactor	`number`	The number of nodes in the DAX cluster.
availabilityZones?	`string[]`	The Availability Zones (AZs) in which the cluster nodes will reside after the cluster has been created or updated.
clusterEndpointEncryptionType?	`string`	The encryption type of the cluster's endpoint. Available values are:.
clusterName?	`string`	The name of the DAX cluster.
description?	`string`	The description of the cluster.
notificationTopicArn?	`string`	The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications will be sent.
parameterGroupName?	`string`	The parameter group to be associated with the DAX cluster.
preferredMaintenanceWindow?	`string`	A range of time when maintenance of DAX cluster software will be performed.
securityGroupIds?	`string[]`	A list of security group IDs to be assigned to each node in the DAX cluster.
sseSpecification?	`SSESpecificationProperty` `\|` `IResolvable`	Represents the settings used to enable server-side encryption on the cluster.
subnetGroupName?	`string`	The name of the subnet group to be used for the replication group.
tags?	`any`	A set of tags to associate with the DAX cluster.

iamRoleArn

Type: string

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.

nodeType

Type: string

The node type for the nodes in the cluster.

(All nodes in a DAX cluster are of the same type.)

replicationFactor

Type: number

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 .

AWS recommends that you have at least two read replicas per cluster.

availabilityZones?

Type: string[] (optional)

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.

clusterEndpointEncryptionType?

Type: string (optional)

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 .

clusterName?

Type: string (optional)

The name of the DAX cluster.

description?

Type: string (optional)

The description of the cluster.

notificationTopicArn?

Type: string (optional)

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

The Amazon SNS topic owner must be same as the DAX cluster owner.

parameterGroupName?

Type: string (optional)

The parameter group to be associated with the DAX cluster.

preferredMaintenanceWindow?

Type: string (optional)

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.

securityGroupIds?

Type: string[] (optional)

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.

sseSpecification?

Type: SSESpecificationProperty | IResolvable (optional)

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

subnetGroupName?

Type: string (optional)

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

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?

Type: any (optional)

A set of tags to associate with the DAX cluster.

Properties

Name	Type	Description
attrArn	`string`	Returns the ARN of the DAX cluster. For example:.
attrClusterDiscoveryEndpoint	`string`	Returns the endpoint of the DAX cluster. For example:.
attrClusterDiscoveryEndpointUrl	`string`	Returns the endpoint URL of the DAX cluster.
cfnOptions	`ICfnResourceOptions`	Options for this resource, such as condition, update policy etc.
cfnProperties	`{ [string]: any }`
cfnResourceType	`string`	AWS resource type.
creationStack	`string[]`
iamRoleArn	`string`	A valid Amazon Resource Name (ARN) that identifies an IAM role.
logicalId	`string`	The logical ID for this CloudFormation stack element.
node	`ConstructNode`	The construct tree node associated with this construct.
nodeType	`string`	The node type for the nodes in the cluster.
ref	`string`	Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
replicationFactor	`number`	The number of nodes in the DAX cluster.
stack	`Stack`	The stack in which this element is defined.
tags	`TagManager`	A set of tags to associate with the DAX cluster.
availabilityZones?	`string[]`	The Availability Zones (AZs) in which the cluster nodes will reside after the cluster has been created or updated.
clusterEndpointEncryptionType?	`string`	The encryption type of the cluster's endpoint. Available values are:.
clusterName?	`string`	The name of the DAX cluster.
description?	`string`	The description of the cluster.
notificationTopicArn?	`string`	The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications will be sent.
parameterGroupName?	`string`	The parameter group to be associated with the DAX cluster.
preferredMaintenanceWindow?	`string`	A range of time when maintenance of DAX cluster software will be performed.
securityGroupIds?	`string[]`	A list of security group IDs to be assigned to each node in the DAX cluster.
sseSpecification?	`SSESpecificationProperty` `\|` `IResolvable`	Represents the settings used to enable server-side encryption on the cluster.
subnetGroupName?	`string`	The name of the subnet group to be used for the replication group.
static CFN_RESOURCE_TYPE_NAME	`string`	The CloudFormation resource type name for this resource class.

attrArn

Type: string

Returns the ARN of the DAX cluster. For example:.

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

Returns a value similar to the following:

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

attrClusterDiscoveryEndpoint

Type: string

Returns the endpoint of the DAX cluster. For example:.

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

Returns a value similar to the following:

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

attrClusterDiscoveryEndpointUrl

Type: string

Returns the endpoint URL of the DAX cluster.

cfnOptions

Type: ICfnResourceOptions

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

cfnProperties

Type: { [string]: any }

cfnResourceType

Type: string

AWS resource type.

creationStack

Type: string[]

iamRoleArn

Type: string

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.

logicalId

Type: string

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

node

Type: ConstructNode

The construct tree node associated with this construct.

nodeType

Type: string

The node type for the nodes in the cluster.

(All nodes in a DAX cluster are of the same type.)

ref

Type: string

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

replicationFactor

Type: number

The number of nodes in the DAX cluster.

AWS recommends that you have at least two read replicas per cluster.

stack

Type: Stack

The stack in which this element is defined.

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

availabilityZones?

Type: string[] (optional)

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.

clusterEndpointEncryptionType?

Type: string (optional)

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 .

clusterName?

Type: string (optional)

The name of the DAX cluster.

description?

Type: string (optional)

The description of the cluster.

notificationTopicArn?

Type: string (optional)

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

The Amazon SNS topic owner must be same as the DAX cluster owner.

parameterGroupName?

Type: string (optional)

The parameter group to be associated with the DAX cluster.

preferredMaintenanceWindow?

Type: string (optional)

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.

securityGroupIds?

Type: string[] (optional)

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.

sseSpecification?

Type: SSESpecificationProperty | IResolvable (optional)

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

subnetGroupName?

Type: string (optional)

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

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.

static CFN_RESOURCE_TYPE_NAME

Type: string

The CloudFormation resource type name for this resource class.

Methods

Name	Description
addDeletionOverride(path)	Syntactic sugar for `addOverride(path, undefined)`.
addDependsOn(target)	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addMetadata(key, value)	Add a value to the CloudFormation Resource Metadata.
addOverride(path, value)	Adds an override to the synthesized CloudFormation resource.
addPropertyDeletionOverride(propertyPath)	Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride(propertyPath, value)	Adds an override to a resource property.
applyRemovalPolicy(policy?, options?)	Sets the deletion policy of the resource based on the removal policy specified.
getAtt(attributeName)	Returns a token for an runtime attribute of this resource.
getMetadata(key)	Retrieve a value value from the CloudFormation Resource Metadata.
inspect(inspector)	Examines the CloudFormation resource and discloses attributes.
overrideLogicalId(newLogicalId)	Overrides the auto-generated logical ID with a specific ID.
toString()	Returns a string representation of this construct.
protected renderProperties(props)

addDeletionOverride(path)

public addDeletionOverride(path: string): void

Parameters

path string — The path of the value to delete.

Syntactic sugar for addOverride(path, undefined).

addDependsOn(target)

public addDependsOn(target: CfnResource): void

Parameters

target CfnResource

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.

addMetadata(key, value)

public addMetadata(key: string, value: any): void

Parameters

key string
value any

Add a value to the CloudFormation Resource Metadata.

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.](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.)

addOverride(path, value)

public addOverride(path: string, value: any): void

Parameters

path string — - The path of the property, you can use dot notation to override values in complex types.
value any — - The 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,

cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');

would add the overrides

"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.

addPropertyDeletionOverride(propertyPath)

public addPropertyDeletionOverride(propertyPath: string): void

Parameters

propertyPath string — The path to the property.

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

addPropertyOverride(propertyPath, value)

public addPropertyOverride(propertyPath: string, value: any): void

Parameters

propertyPath string — The path of the property.
value any — The value.

Adds an override to a resource property.

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

applyRemovalPolicy(policy?, options?)

public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void

Parameters

policy RemovalPolicy
options RemovalPolicyOptions

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

getAtt(attributeName)

public getAtt(attributeName: string): Reference

Parameters

attributeName string — The name of the attribute.

Returns

Reference

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.

getMetadata(key)

public getMetadata(key: string): any

Parameters

key string

Returns

any

Retrieve a value value from the CloudFormation Resource Metadata.

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)

public inspect(inspector: TreeInspector): void

Parameters

inspector TreeInspector — - tree inspector to collect and process attributes.

Examines the CloudFormation resource and discloses attributes.

overrideLogicalId(newLogicalId)

public overrideLogicalId(newLogicalId: string): void

Parameters

newLogicalId string — The new logical ID to use for this stack element.

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

toString()

public toString(): string

Returns

string

Returns a string representation of this construct.

protected renderProperties(props)

protected renderProperties(props: { [string]: any }): { [string]: any }

Parameters

props { [string]: any }

Returns

{ [string]: any }