AWS::DocDBElastic::Cluster

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

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::DocDBElastic::Cluster",
  "Properties" : {
      "AdminUserName" : String,
      "AdminUserPassword" : String,
      "AuthType" : String,
      "BackupRetentionPeriod" : Integer,
      "ClusterName" : String,
      "KmsKeyId" : String,
      "PreferredBackupWindow" : String,
      "PreferredMaintenanceWindow" : String,
      "ShardCapacity" : Integer,
      "ShardCount" : Integer,
      "ShardInstanceCount" : Integer,
      "SubnetIds" : [ String, ... ],
      "Tags" : [ Tag, ... ],
      "VpcSecurityGroupIds" : [ String, ... ]
    }
}

YAML

Type: AWS::DocDBElastic::Cluster
Properties:
  AdminUserName: String
  AdminUserPassword: String
  AuthType: String
  BackupRetentionPeriod: Integer
  ClusterName: String
  KmsKeyId: String
  PreferredBackupWindow: String
  PreferredMaintenanceWindow: String
  ShardCapacity: Integer
  ShardCount: Integer
  ShardInstanceCount: Integer
  SubnetIds: 
    - String
  Tags: 
    - Tag
  VpcSecurityGroupIds: 
    - String

Properties

AdminUserName

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.

Required: Yes

Type: String

Update requires: Replacement

AdminUserPassword

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.

Required: Conditional

Type: String

Update requires: No interruption

AuthType

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.

Required: Yes

Type: String

Allowed values: PLAIN_TEXT | SECRET_ARN

Update requires: Replacement

BackupRetentionPeriod

The number of days for which automatic snapshots are retained.

Required: No

Type: Integer

Update requires: No interruption

ClusterName

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

Required: Yes

Type: String

Pattern: [a-zA-z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*

Minimum: 1

Maximum: 50

Update requires: Replacement

KmsKeyId

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.

Required: No

Type: String

Update requires: Replacement

PreferredBackupWindow

The daily time range during which automated backups are created if automated backups are enabled, as determined by backupRetentionPeriod.

Required: No

Type: String

Update requires: No interruption

PreferredMaintenanceWindow

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.

Required: No

Type: String

Update requires: No interruption

ShardCapacity

The number of vCPUs assigned to each elastic cluster shard. Maximum is 64. Allowed values are 2, 4, 8, 16, 32, 64.

Required: Yes

Type: Integer

Update requires: No interruption

ShardCount

The number of shards assigned to the elastic cluster. Maximum is 32.

Required: Yes

Type: Integer

Update requires: No interruption

ShardInstanceCount

The number of replica instances applying to all shards in the cluster. A shardInstanceCount value of 1 means there is one writer instance, and any additional instances are replicas that can be used for reads and to improve availability.

Required: No

Type: Integer

Update requires: No interruption

SubnetIds

The Amazon EC2 subnet IDs for the new elastic cluster.

Required: No

Type: Array of String

Update requires: No interruption

Tags

The tags to be assigned to the new elastic cluster.

Required: No

Type: Array of Tag

Minimum: 0

Maximum: 50

Update requires: No interruption

VpcSecurityGroupIds

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

Required: No

Type: Array of String

Update requires: No interruption

Return values

Ref

Fn::GetAtt

ClusterArn

Property description not available.

ClusterEndpoint

The URL used to connect to the elastic cluster.