aws-cdk-lib.aws_docdbelastic.CfnClusterProps

interface CfnClusterProps

LanguageType name
.NETAmazon.CDK.AWS.DocDBElastic.CfnClusterProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsdocdbelastic#CfnClusterProps
Javasoftware.amazon.awscdk.services.docdbelastic.CfnClusterProps
Pythonaws_cdk.aws_docdbelastic.CfnClusterProps
TypeScript aws-cdk-lib » aws_docdbelastic » CfnClusterProps

Properties for defining a CfnCluster.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_docdbelastic as docdbelastic } from 'aws-cdk-lib';
const cfnClusterProps: docdbelastic.CfnClusterProps = {
  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'],
};

Properties

NameTypeDescription
adminUserNamestringThe name of the Amazon DocumentDB elastic clusters administrator.
authTypestringThe authentication type used to determine where to fetch the password used for accessing the elastic cluster.
clusterNamestringThe name of the new elastic cluster. This parameter is stored as a lowercase string.
shardCapacitynumberThe number of vCPUs assigned to each elastic cluster shard.
shardCountnumberThe number of shards assigned to the elastic cluster.
adminUserPassword?stringThe password for the Elastic DocumentDB cluster administrator and can contain any printable ASCII characters.
kmsKeyId?stringThe KMS key identifier to use to encrypt the new elastic cluster.
preferredMaintenanceWindow?stringThe 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.