class CfnDBClusterPropsMixin

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.DocDB.Mixins.CfnDBClusterPropsMixin
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsdocdb/mixins#CfnDBClusterPropsMixin
Java	software.amazon.awscdk.mixins.preview.services.docdb.mixins.CfnDBClusterPropsMixin
Python	aws_cdk.mixins_preview.aws_docdb.mixins.CfnDBClusterPropsMixin
TypeScript	@aws-cdk/mixins-preview » aws_docdb » mixins » CfnDBClusterPropsMixin

Implements IMixin

Extends Mixin

The AWS::DocDB::DBCluster Amazon DocumentDB (with MongoDB compatibility) resource describes a DBCluster.

Amazon DocumentDB is a fully managed, MongoDB-compatible document database engine. For more information, see DBCluster in the Amazon DocumentDB Developer Guide .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.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 docdb_mixins } from '@aws-cdk/mixins-preview/aws-docdb';
const cfnDBClusterPropsMixin = new docdb_mixins.CfnDBClusterPropsMixin({
  availabilityZones: ['availabilityZones'],
  backupRetentionPeriod: 123,
  copyTagsToSnapshot: false,
  dbClusterIdentifier: 'dbClusterIdentifier',
  dbClusterParameterGroupName: 'dbClusterParameterGroupName',
  dbSubnetGroupName: 'dbSubnetGroupName',
  deletionProtection: false,
  enableCloudwatchLogsExports: ['enableCloudwatchLogsExports'],
  engineVersion: 'engineVersion',
  globalClusterIdentifier: 'globalClusterIdentifier',
  kmsKeyId: 'kmsKeyId',
  manageMasterUserPassword: false,
  masterUsername: 'masterUsername',
  masterUserPassword: 'masterUserPassword',
  masterUserSecretKmsKeyId: 'masterUserSecretKmsKeyId',
  networkType: 'networkType',
  port: 123,
  preferredBackupWindow: 'preferredBackupWindow',
  preferredMaintenanceWindow: 'preferredMaintenanceWindow',
  restoreToTime: 'restoreToTime',
  restoreType: 'restoreType',
  rotateMasterUserPassword: false,
  serverlessV2ScalingConfiguration: {
    maxCapacity: 123,
    minCapacity: 123,
  },
  snapshotIdentifier: 'snapshotIdentifier',
  sourceDbClusterIdentifier: 'sourceDbClusterIdentifier',
  storageEncrypted: false,
  storageType: 'storageType',
  tags: [{
    key: 'key',
    value: 'value',
  }],
  useLatestRestorableTime: false,
  vpcSecurityGroupIds: ['vpcSecurityGroupIds'],
}, /* all optional props */ {
  strategy: mixins.PropertyMergeStrategy.OVERRIDE,
});

Initializer

new CfnDBClusterPropsMixin(props: CfnDBClusterMixinProps, options?: CfnPropertyMixinOptions)

Parameters

• props CfnDBClusterMixinProps — L1 properties to apply.
• options CfnPropertyMixinOptions — Mixin options.

Create a mixin to apply properties to AWS::DocDB::DBCluster.

Properties

Name	Type	Description
props	CfnDBClusterMixinProps
strategy	PropertyMergeStrategy
static CFN_PROPERTY_KEYS	string[]

---

props

Type: CfnDBClusterMixinProps

---

strategy

Type: PropertyMergeStrategy

---

static CFN_PROPERTY_KEYS

Type: string[]

Methods

Name	Description
applyTo(construct)	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

• IConstruct

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.