Package software.amazon.awscdk.cfnpropertymixins.services.neptune

Class CfnDBParameterGroupPropsMixin

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.Mixin
software.amazon.awscdk.cfnpropertymixins.services.neptune.CfnDBParameterGroupPropsMixin
All Implemented Interfaces:
software.amazon.jsii.JsiiSerializable, software.constructs.IMixin
@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)", date="2026-03-19T12:55:22.955Z") @Stability(Stable) public class CfnDBParameterGroupPropsMixin extends Mixin implements software.constructs.IMixin
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.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.neptune.*;
 import software.amazon.awscdk.*;
 IMergeStrategy mergeStrategy;
 Object parameters;
 CfnDBParameterGroupPropsMixin cfnDBParameterGroupPropsMixin = CfnDBParameterGroupPropsMixin.Builder.create(CfnDBParameterGroupMixinProps.builder()
         .description("description")
         .family("family")
         .name("name")
         .parameters(parameters)
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build())
 .strategy(mergeStrategy)
 .build();

See Also:

  • Field Details

    • CFN_PROPERTY_KEYS

      @Stability(Stable) protected static final List<String> CFN_PROPERTY_KEYS

  • Constructor Details

    • CfnDBParameterGroupPropsMixin

      protected CfnDBParameterGroupPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnDBParameterGroupPropsMixin

      protected CfnDBParameterGroupPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnDBParameterGroupPropsMixin

      @Stability(Stable) public CfnDBParameterGroupPropsMixin(@NotNull CfnDBParameterGroupMixinProps props, @Nullable CfnPropertyMixinOptions options)
      Create a mixin to apply properties to AWS::Neptune::DBParameterGroup.

      Parameters:
      props - L1 properties to apply. This parameter is required.
      options - Mixin options.

    • CfnDBParameterGroupPropsMixin

      @Stability(Stable) public CfnDBParameterGroupPropsMixin(@NotNull CfnDBParameterGroupMixinProps props)
      Create a mixin to apply properties to AWS::Neptune::DBParameterGroup.

      Parameters:
      props - L1 properties to apply. This parameter is required.

  • Method Details

    • applyTo

      @Stability(Stable) public void applyTo(@NotNull software.constructs.IConstruct construct)
      Apply the mixin properties to the construct.

      Specified by:
      applyTo in interface software.constructs.IMixin
      Specified by:
      applyTo in class Mixin
      Parameters:
      construct - This parameter is required.

    • supports

      @Stability(Stable) @NotNull public Boolean supports(@NotNull software.constructs.IConstruct construct)
      Check if this mixin supports the given construct.

      Specified by:
      supports in interface software.constructs.IMixin
      Overrides:
      supports in class Mixin
      Parameters:
      construct - This parameter is required.

    • getProps

      @Stability(Stable) @NotNull protected CfnDBParameterGroupMixinProps getProps()

    • getStrategy

      @Stability(Stable) @NotNull protected IMergeStrategy getStrategy()