class CfnClusterPropsMixin
| Language | Type name |
|---|---|
.NET | Amazon.CDK.Mixins.Preview.AWS.DocDBElastic.Mixins.CfnClusterPropsMixin |
Go | github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsdocdbelastic/mixins#CfnClusterPropsMixin |
Java | software.amazon.awscdk.mixins.preview.services.docdbelastic.mixins.CfnClusterPropsMixin |
Python | aws_cdk.mixins_preview.aws_docdbelastic.mixins.CfnClusterPropsMixin |
TypeScript | @aws-cdk/mixins-preview » aws_docdbelastic » mixins » CfnClusterPropsMixin |
Implements
IMixin
Extends
Mixin
Creates a new Amazon DocumentDB elastic cluster and returns its cluster structure.
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 } from '@aws-cdk/mixins-preview';
import { mixins as docdbelastic_mixins } from '@aws-cdk/mixins-preview/aws-docdbelastic';
const cfnClusterPropsMixin = new docdbelastic_mixins.CfnClusterPropsMixin({
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'],
}, /* all optional props */ {
strategy: mixins.PropertyMergeStrategy.OVERRIDE,
});
Initializer
new CfnClusterPropsMixin(props: CfnClusterMixinProps, options?: CfnPropertyMixinOptions)
Parameters
- props
Cfn— L1 properties to apply.Cluster Mixin Props - options
Cfn— Mixin options.Property Mixin Options
Create a mixin to apply properties to AWS::DocDBElastic::Cluster.
Properties
| Name | Type | Description |
|---|---|---|
| props | Cfn | |
| strategy | Property | |
| static CFN_PROPERTY_KEYS | string[] |
props
Type:
Cfn
strategy
Type:
Property
static CFN_PROPERTY_KEYS
Type:
string[]
Methods
| Name | Description |
|---|---|
| apply | Apply the mixin properties to the construct. |
| supports(construct) | Check if this mixin supports the given construct. |
applyTo(construct)
public applyTo(construct: IConstruct): IConstruct
Parameters
- construct
IConstruct
Returns
Apply the mixin properties to the construct.
supports(construct)
public supports(construct: IConstruct): boolean
Parameters
- construct
IConstruct
Returns
boolean
Check if this mixin supports the given construct.

.NET
Go
Java
Python
TypeScript