class CfnDBClusterParameterGroupPropsMixin

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

Implements IMixin

Extends Mixin

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

For more information, see DBClusterParameterGroup in the Amazon DocumentDB Developer Guide .

Parameters in a cluster parameter group apply to all of the instances in a cluster.

A cluster parameter group is initially created with the default parameters for the database engine used by instances in the cluster. To provide custom values for any of the parameters, you must modify the group after you create it. After you create a DB cluster parameter group, you must associate it with your cluster. For the new cluster parameter group and associated settings to take effect, you must then reboot the DB instances in the cluster without failover.

After you create a cluster parameter group, you should wait at least 5 minutes before creating your first cluster that uses that cluster parameter group as the default parameter group. This allows Amazon DocumentDB to fully complete the create action before the cluster parameter group is used as the default for a new cluster. This step is especially important for parameters that are critical when creating the default database for a cluster, such as the character set for the default database defined by the character_set_database parameter.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbclusterparametergroup.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';

declare const parameters: any;
const cfnDBClusterParameterGroupPropsMixin = new docdb_mixins.CfnDBClusterParameterGroupPropsMixin({
  description: 'description',
  family: 'family',
  name: 'name',
  parameters: parameters,
  tags: [{
    key: 'key',
    value: 'value',
  }],
}, /* all optional props */ {
  strategy: mixins.PropertyMergeStrategy.OVERRIDE,
});

Initializer

new CfnDBClusterParameterGroupPropsMixin(props: CfnDBClusterParameterGroupMixinProps, options?: CfnPropertyMixinOptions)

Parameters

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

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

Properties

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

---

props

Type: CfnDBClusterParameterGroupMixinProps

---

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.