class CfnCluster (construct)

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

Implements IConstruct, IConstruct, IDependable, IInspectable

A CloudFormation AWS::DocDBElastic::Cluster.

Creates a new Amazon DocumentDB elastic cluster and returns its cluster structure.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as docdbelastic from '@aws-cdk/aws-docdbelastic';
const cfnCluster = new docdbelastic.CfnCluster(this, 'MyCfnCluster', {
  adminUserName: 'adminUserName',
  authType: 'authType',
  clusterName: 'clusterName',
  shardCapacity: 123,
  shardCount: 123,

  // the properties below are optional
  adminUserPassword: 'adminUserPassword',
  kmsKeyId: 'kmsKeyId',
  preferredMaintenanceWindow: 'preferredMaintenanceWindow',
  subnetIds: ['subnetIds'],
  tags: [{
    key: 'key',
    value: 'value',
  }],
  vpcSecurityGroupIds: ['vpcSecurityGroupIds'],
});

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::DocDBElastic::Cluster.

Construct Props

Name	Type	Description
adminUserName	`string`	The name of the Amazon DocumentDB elastic clusters administrator.
authType	`string`	The authentication type used to determine where to fetch the password used for accessing the elastic cluster.
clusterName	`string`	The name of the new elastic cluster. This parameter is stored as a lowercase string.
shardCapacity	`number`	The number of vCPUs assigned to each elastic cluster shard.
shardCount	`number`	The number of shards assigned to the elastic cluster.
adminUserPassword?	`string`	The password for the Elastic DocumentDB cluster administrator and can contain any printable ASCII characters.
kmsKeyId?	`string`	The KMS key identifier to use to encrypt the new elastic cluster.
preferredMaintenanceWindow?	`string`	The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
subnetIds?	`string[]`	The Amazon EC2 subnet IDs for the new elastic cluster.
tags?	`CfnTag[]`	The tags to be assigned to the new elastic cluster.
vpcSecurityGroupIds?	`string[]`	A list of EC2 VPC security groups to associate with the new elastic cluster.

adminUserName

Type: string

The name of the Amazon DocumentDB elastic clusters administrator.

Constraints :

Must be from 1 to 63 letters or numbers.
The first character must be a letter.
Cannot be a reserved word.

authType

Type: string

The authentication type used to determine where to fetch the password used for accessing the elastic cluster.

Valid types are PLAIN_TEXT or SECRET_ARN .

clusterName

Type: string

The name of the new elastic cluster. This parameter is stored as a lowercase string.

Constraints :

Must contain from 1 to 63 letters, numbers, or hyphens.
The first character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.

Example : my-cluster

shardCapacity

Type: number

The number of vCPUs assigned to each elastic cluster shard.

Maximum is 64. Allowed values are 2, 4, 8, 16, 32, 64.

shardCount

Type: number

The number of shards assigned to the elastic cluster.

Maximum is 32.

adminUserPassword?

Type: string (optional)

The password for the Elastic DocumentDB cluster administrator and can contain any printable ASCII characters.

Constraints :

Must contain from 8 to 100 characters.
Cannot contain a forward slash (/), double quote ("), or the "at" symbol (@).
A valid AdminUserName entry is also required.

kmsKeyId?

Type: string (optional)

The KMS key identifier to use to encrypt the new elastic cluster.

The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a cluster using the same Amazon account that owns this KMS encryption key, you can use the KMS key alias instead of the ARN as the KMS encryption key.

If an encryption key is not specified, Amazon DocumentDB uses the default encryption key that KMS creates for your account. Your account has a different default encryption key for each Amazon Region.

preferredMaintenanceWindow?

Type: string (optional)

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

Format : ddd:hh24:mi-ddd:hh24:mi

Default : a 30-minute window selected at random from an 8-hour block of time for each AWS Region , occurring on a random day of the week.

Valid days : Mon, Tue, Wed, Thu, Fri, Sat, Sun

Constraints : Minimum 30-minute window.

subnetIds?

Type: string[] (optional)

The Amazon EC2 subnet IDs for the new elastic cluster.

tags?

Type: CfnTag[] (optional)

The tags to be assigned to the new elastic cluster.

vpcSecurityGroupIds?

Type: string[] (optional)

A list of EC2 VPC security groups to associate with the new elastic cluster.

Properties

Name	Type	Description
adminUserName	`string`	The name of the Amazon DocumentDB elastic clusters administrator.
attrClusterArn	`string`
attrClusterEndpoint	`string`
authType	`string`	The authentication type used to determine where to fetch the password used for accessing the elastic cluster.
cfnOptions	`ICfnResourceOptions`	Options for this resource, such as condition, update policy etc.
cfnProperties	`{ [string]: any }`
cfnResourceType	`string`	AWS resource type.
clusterName	`string`	The name of the new elastic cluster. This parameter is stored as a lowercase string.
creationStack	`string[]`
logicalId	`string`	The logical ID for this CloudFormation stack element.
node	`ConstructNode`	The construct tree node associated with this construct.
ref	`string`	Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
shardCapacity	`number`	The number of vCPUs assigned to each elastic cluster shard.
shardCount	`number`	The number of shards assigned to the elastic cluster.
stack	`Stack`	The stack in which this element is defined.
tags	`TagManager`	The tags to be assigned to the new elastic cluster.
adminUserPassword?	`string`	The password for the Elastic DocumentDB cluster administrator and can contain any printable ASCII characters.
kmsKeyId?	`string`	The KMS key identifier to use to encrypt the new elastic cluster.
preferredMaintenanceWindow?	`string`	The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
subnetIds?	`string[]`	The Amazon EC2 subnet IDs for the new elastic cluster.
vpcSecurityGroupIds?	`string[]`	A list of EC2 VPC security groups to associate with the new elastic cluster.
static CFN_RESOURCE_TYPE_NAME	`string`	The CloudFormation resource type name for this resource class.

adminUserName

Type: string

The name of the Amazon DocumentDB elastic clusters administrator.

Constraints :

Must be from 1 to 63 letters or numbers.
The first character must be a letter.
Cannot be a reserved word.

attrClusterArn

Type: string

attrClusterEndpoint

Type: string

authType

Type: string

The authentication type used to determine where to fetch the password used for accessing the elastic cluster.

Valid types are PLAIN_TEXT or SECRET_ARN .

cfnOptions

Type: ICfnResourceOptions

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

cfnProperties

Type: { [string]: any }

cfnResourceType

Type: string

AWS resource type.

clusterName

Type: string

The name of the new elastic cluster. This parameter is stored as a lowercase string.

Constraints :

Must contain from 1 to 63 letters, numbers, or hyphens.
The first character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.

Example : my-cluster

creationStack

Type: string[]

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.

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

shardCapacity

Type: number

The number of vCPUs assigned to each elastic cluster shard.

Maximum is 64. Allowed values are 2, 4, 8, 16, 32, 64.

shardCount

Type: number

The number of shards assigned to the elastic cluster.

Maximum is 32.

stack

Type: Stack

The stack in which this element is defined.

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

adminUserPassword?

Type: string (optional)

The password for the Elastic DocumentDB cluster administrator and can contain any printable ASCII characters.

Constraints :

Must contain from 8 to 100 characters.
Cannot contain a forward slash (/), double quote ("), or the "at" symbol (@).
A valid AdminUserName entry is also required.

kmsKeyId?

Type: string (optional)

The KMS key identifier to use to encrypt the new elastic cluster.

If an encryption key is not specified, Amazon DocumentDB uses the default encryption key that KMS creates for your account. Your account has a different default encryption key for each Amazon Region.

preferredMaintenanceWindow?

Type: string (optional)

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

Format : ddd:hh24:mi-ddd:hh24:mi

Default : a 30-minute window selected at random from an 8-hour block of time for each AWS Region , occurring on a random day of the week.

Valid days : Mon, Tue, Wed, Thu, Fri, Sat, Sun

Constraints : Minimum 30-minute window.

subnetIds?

Type: string[] (optional)

The Amazon EC2 subnet IDs for the new elastic cluster.

vpcSecurityGroupIds?

Type: string[] (optional)

A list of EC2 VPC security groups to associate with the new elastic cluster.

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 }