Package software.amazon.awscdk.services.dax

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

A named set of parameters that are applied to all of the nodes in a DAX cluster.

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.dax.*;
 Object parameterNameValues;
 CfnParameterGroup cfnParameterGroup = CfnParameterGroup.Builder.create(this, "MyCfnParameterGroup")
         .description("description")
         .parameterGroupName("parameterGroupName")
         .parameterNameValues(parameterNameValues)
         .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, @Nullable CfnParameterGroupProps props)
      Create a new AWS::DAX::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.

    • CfnParameterGroup

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

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      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

    • getParameterNameValues

      @Stability(Stable) @NotNull public Object getParameterNameValues()
      An array of name-value pairs for the parameters in the group.

      Each element in the array represents a single parameter.

      record-ttl-millis and query-ttl-millis are the only supported parameter names. For more details, see Configuring TTL Settings .

    • setParameterNameValues

      @Stability(Stable) public void setParameterNameValues(@NotNull Object value)
      An array of name-value pairs for the parameters in the group.

      Each element in the array represents a single parameter.

      record-ttl-millis and query-ttl-millis are the only supported parameter names. For more details, see Configuring TTL Settings .

    • 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.

    • getParameterGroupName

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

    • setParameterGroupName

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