Package software.amazon.awscdk.services.memorydb

Class CfnParameterGroup

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.memorydb.CfnParameterGroup
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:00.370Z") @Stability(Stable) public class CfnParameterGroup extends CfnResource implements IInspectable
A CloudFormation AWS::MemoryDB::ParameterGroup.

Specifies a new MemoryDB parameter group. A parameter group is a collection of parameters and their values that are applied to all of the nodes in any cluster . For more information, see Configuring engine parameters using parameter groups .

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.memorydb.*;
 Object parameters;
 CfnParameterGroup cfnParameterGroup = CfnParameterGroup.Builder.create(this, "MyCfnParameterGroup")
         .family("family")
         .parameterGroupName("parameterGroupName")
         // the properties below are optional
         .description("description")
         .parameters(parameters)
         .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

    • CfnParameterGroup

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

    • CfnParameterGroup

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

    • CfnParameterGroup

      @Stability(Stable) public CfnParameterGroup(@NotNull Construct scope, @NotNull String id, @NotNull CfnParameterGroupProps props)
      Create a new AWS::MemoryDB::ParameterGroup.

      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.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the ARN of the parameter group, such as arn:aws:memorydb:us-east-1:123456789012:parametergroup/my-parameter-group.

    • getCfnProperties

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

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      An array of key-value pairs to apply to this resource.

      For more information, see Tag .

    • getFamily

      @Stability(Stable) @NotNull public String getFamily()
      The name of the parameter group family that this parameter group is compatible with.

    • setFamily

      @Stability(Stable) public void setFamily(@NotNull String value)
      The name of the parameter group family that this parameter group is compatible with.

    • getParameterGroupName

      @Stability(Stable) @NotNull public String getParameterGroupName()
      The name of the parameter group.

    • setParameterGroupName

      @Stability(Stable) public void setParameterGroupName(@NotNull String value)
      The name of the parameter group.

    • getParameters

      @Stability(Stable) @NotNull public Object getParameters()
      Returns the detailed parameter list for the parameter group.

    • setParameters

      @Stability(Stable) public void setParameters(@NotNull Object value)
      Returns the detailed parameter list for the parameter group.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      A description of the parameter group.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      A description of the parameter group.