class CfnDBParameterGroupPropsMixin

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.Neptune.Mixins.CfnDBParameterGroupPropsMixin
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsneptune/mixins#CfnDBParameterGroupPropsMixin
Java	software.amazon.awscdk.mixins.preview.services.neptune.mixins.CfnDBParameterGroupPropsMixin
Python	aws_cdk.mixins_preview.aws_neptune.mixins.CfnDBParameterGroupPropsMixin
TypeScript	@aws-cdk/mixins-preview » aws_neptune » mixins » CfnDBParameterGroupPropsMixin

Implements IMixin

Extends Mixin

AWS::Neptune::DBParameterGroup creates a new DB parameter group.

This type can be declared in a template and referenced in the DBParameterGroupName parameter of AWS::Neptune::DBInstance .

Applying a parameter group to a DB instance might require the instance to reboot, resulting in a database outage for the duration of the reboot. > If you provide a custom DBParameterGroup that you associate with DBInstance , it is best to specify an EngineVersion property in DBCluster . That EngineVersion needs to be compatible with the value of the Family property in the DBParameterGroup .

A DB parameter group is initially created with the default parameters for the database engine used by the DB instance. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBParameterGroup . Once you've created a DB parameter group, you need to associate it with your DB instance using ModifyDBInstance . When you associate a new DB parameter group with a running DB instance, you need to reboot the DB instance without failover for the new DB parameter group and associated settings to take effect.

After you create a DB parameter group, you should wait at least 5 minutes before creating your first DB instance that uses that DB parameter group as the default parameter group. This allows Amazon Neptune to fully complete the create action before the parameter group is used as the default for a new DB instance. This is especially important for parameters that are critical when creating the default database for a DB instance, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon Neptune console or the DescribeDBParameters command to verify that your DB parameter group has been created or modified.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbparametergroup.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 neptune_mixins } from '@aws-cdk/mixins-preview/aws-neptune';

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

Initializer

new CfnDBParameterGroupPropsMixin(props: CfnDBParameterGroupMixinProps, options?: CfnPropertyMixinOptions)

Parameters

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

Create a mixin to apply properties to AWS::Neptune::DBParameterGroup.

Properties

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

---

props

Type: CfnDBParameterGroupMixinProps

---

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.