Package software.amazon.awscdk.services.dax

Class CfnParameterGroup

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.dax.CfnParameterGroup

All Implemented Interfaces:

IInspectable, IParameterGroupRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)",
           date="2025-10-24T13:34:34.848Z")
@Stability(Stable)
public class CfnParameterGroup
extends CfnResource
implements IInspectable, IParameterGroupRef

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();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dax-parametergroup.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnParameterGroup.Builder	A fluent builder for CfnParameterGroup.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.dax.IParameterGroupRef

IParameterGroupRef.Jsii$Default, IParameterGroupRef.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnParameterGroup(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnParameterGroup(software.amazon.jsii.JsiiObjectRef objRef)
	CfnParameterGroup(software.constructs.Construct scope, String id)
	CfnParameterGroup(software.constructs.Construct scope, String id, CfnParameterGroupProps props)

Method Summary

Modifier and Type	Method	Description
String	getAttrId()
protected Map<String,Object>	getCfnProperties()
String	getDescription()	A description of the parameter group.
String	getParameterGroupName()	The name of the parameter group.
ParameterGroupReference	getParameterGroupRef()	A reference to a ParameterGroup resource.
Object	getParameterNameValues()	An array of name-value pairs for the parameters in the group.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDescription(String value)	A description of the parameter group.
void	setParameterGroupName(String value)	The name of the parameter group.
void	setParameterNameValues(Object value)	An array of name-value pairs for the parameters in the group.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

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
 software.constructs.Construct scope,
 @NotNull
 String id,
 @Nullable
 CfnParameterGroupProps props)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

props - Resource properties.

CfnParameterGroup

@Stability(Stable)
public CfnParameterGroup(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). 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.

getAttrId

@Stability(Stable)
@NotNull
public String getAttrId()

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getParameterGroupRef

@Stability(Stable)
@NotNull
public ParameterGroupReference getParameterGroupRef()

A reference to a ParameterGroup resource.

Specified by:

getParameterGroupRef in interface IParameterGroupRef

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.

getParameterNameValues

@Stability(Stable)
@Nullable
public Object getParameterNameValues()

An array of name-value pairs for the parameters in the group.

setParameterNameValues

@Stability(Stable)
public void setParameterNameValues(@Nullable
 Object value)

An array of name-value pairs for the parameters in the group.