Package software.amazon.awscdk.services.neptune

Class CfnDBParameterGroup

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.neptune.CfnDBParameterGroup
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:40.319Z") @Stability(Stable) public class CfnDBParameterGroup extends CfnResource implements IInspectable
A CloudFormation AWS::Neptune::DBParameterGroup.

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.services.neptune.*;
 Object parameters;
 CfnDBParameterGroup cfnDBParameterGroup = CfnDBParameterGroup.Builder.create(this, "MyCfnDBParameterGroup")
         .description("description")
         .family("family")
         .parameters(parameters)
         // the properties below are optional
         .name("name")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnDBParameterGroup

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

    • CfnDBParameterGroup

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

    • CfnDBParameterGroup

      @Stability(Stable) public CfnDBParameterGroup(@NotNull Construct scope, @NotNull String id, @NotNull CfnDBParameterGroupProps props)
      Create a new AWS::Neptune::DBParameterGroup.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.
      This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector -
      • tree inspector to collect and process attributes.
      This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      The tags that you want to attach to this parameter group.

    • getDescription

      @Stability(Stable) @NotNull public String getDescription()
      Provides the customer-specified description for this DB parameter group.

    • setDescription

      @Stability(Stable) public void setDescription(@NotNull String value)
      Provides the customer-specified description for this DB parameter group.

    • getFamily

      @Stability(Stable) @NotNull public String getFamily()
      Must be neptune1 for engine versions prior to 1.2.0.0 , or neptune1.2 for engine version 1.2.0.0 and higher.

    • setFamily

      @Stability(Stable) public void setFamily(@NotNull String value)
      Must be neptune1 for engine versions prior to 1.2.0.0 , or neptune1.2 for engine version 1.2.0.0 and higher.

    • getParameters

      @Stability(Stable) @NotNull public Object getParameters()
      The parameters to set for this DB parameter group.

      The parameters are expressed as a JSON object consisting of key-value pairs.

      Changes to dynamic parameters are applied immediately. During an update, if you have static parameters (whether they were changed or not), it triggers AWS CloudFormation to reboot the associated DB instance without failover.

    • setParameters

      @Stability(Stable) public void setParameters(@NotNull Object value)
      The parameters to set for this DB parameter group.

      The parameters are expressed as a JSON object consisting of key-value pairs.

      Changes to dynamic parameters are applied immediately. During an update, if you have static parameters (whether they were changed or not), it triggers AWS CloudFormation to reboot the associated DB instance without failover.

    • getName

      @Stability(Stable) @Nullable public String getName()
      Provides the name of the DB parameter group.

    • setName

      @Stability(Stable) public void setName(@Nullable String value)
      Provides the name of the DB parameter group.