interface CfnClusterMixinProps
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.Mixins.Preview.AWS.DocDBElastic.Mixins.CfnClusterMixinProps |
 Go | github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsdocdbelastic/mixins#CfnClusterMixinProps |
 Java | software.amazon.awscdk.mixins.preview.services.docdbelastic.mixins.CfnClusterMixinProps |
 Python | aws_cdk.mixins_preview.aws_docdbelastic.mixins.CfnClusterMixinProps |
 TypeScript | @aws-cdk/mixins-preview » aws_docdbelastic » mixins » CfnClusterMixinProps |
Properties for CfnClusterPropsMixin.
See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdbelastic-cluster.html
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins as docdbelastic_mixins } from '@aws-cdk/mixins-preview/aws-docdbelastic';
const cfnClusterMixinProps: docdbelastic_mixins.CfnClusterMixinProps = {
adminUserName: 'adminUserName',
adminUserPassword: 'adminUserPassword',
authType: 'authType',
backupRetentionPeriod: 123,
clusterName: 'clusterName',
kmsKeyId: 'kmsKeyId',
preferredBackupWindow: 'preferredBackupWindow',
preferredMaintenanceWindow: 'preferredMaintenanceWindow',
shardCapacity: 123,
shardCount: 123,
shardInstanceCount: 123,
subnetIds: ['subnetIds'],
tags: [{
key: 'key',
value: 'value',
}],
vpcSecurityGroupIds: ['vpcSecurityGroupIds'],
};
Properties
| Name | Type | Description |
|---|---|---|
| admin | string | The name of the Amazon DocumentDB elastic clusters administrator. |
| admin | string | The password for the Elastic DocumentDB cluster administrator and can contain any printable ASCII characters. |
| auth | string | The authentication type used to determine where to fetch the password used for accessing the elastic cluster. |
| backup | number | The number of days for which automatic snapshots are retained. |
| cluster | string | The name of the new elastic cluster. This parameter is stored as a lowercase string. |
| kms | string | The KMS key identifier to use to encrypt the new elastic cluster. |
| preferred | string | The daily time range during which automated backups are created if automated backups are enabled, as determined by backupRetentionPeriod . |
| preferred | string | The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). |
| shard | number | The number of vCPUs assigned to each elastic cluster shard. |
| shard | number | The number of shards assigned to the elastic cluster. |
| shard | number | The number of replica instances applying to all shards in the cluster. |
| subnet | string[] | The Amazon EC2 subnet IDs for the new elastic cluster. |
| tags? | Cfn[] | The tags to be assigned to the new elastic cluster. |
| vpc | string[] | A list of EC2 VPC security groups to associate with the new elastic cluster. |
adminUserName?
Type:
string
(optional)
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.
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
AdminUserNameentry is also required.
authType?
Type:
string
(optional)
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 .
backupRetentionPeriod?
Type:
number
(optional)
The number of days for which automatic snapshots are retained.
clusterName?
Type:
string
(optional)
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
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.
preferredBackupWindow?
Type:
string
(optional)
The daily time range during which automated backups are created if automated backups are enabled, as determined by backupRetentionPeriod .
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.
shardCapacity?
Type:
number
(optional)
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
(optional)
The number of shards assigned to the elastic cluster.
Maximum is 32.
shardInstanceCount?
Type:
number
(optional)
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.
subnetIds?
Type:
string[]
(optional)
The Amazon EC2 subnet IDs for the new elastic cluster.
tags?
Type:
Cfn[]
(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.