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, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:37.905Z")
 @Stability(value=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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static 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.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

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

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnParameterGroup(software.constructs.Construct scope, String id) Create a new `AWS::DAX::ParameterGroup`.
	CfnParameterGroup(software.constructs.Construct scope, String id, CfnParameterGroupProps props) Create a new `AWS::DAX::ParameterGroup`.
protected	CfnParameterGroup(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnParameterGroup(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
protected Map<String,Object>	getCfnProperties()
String	getDescription() A description of the parameter group.
String	getParameterGroupName() The name of the parameter group.
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, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, 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.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnParameterGroup

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

CfnParameterGroup

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

CfnParameterGroup

@Stability(value=Stable)
public CfnParameterGroup(@NotNull
                                                  software.constructs.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(value=Stable)
public CfnParameterGroup(@NotNull
                                                  software.constructs.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 Detail

inspect

@Stability(value=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(value=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(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getParameterNameValues

@Stability(value=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(value=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(value=Stable)
 @Nullable
public String getDescription()

A description of the parameter group.

setDescription

@Stability(value=Stable)
public void setDescription(@Nullable
                                                    String value)

A description of the parameter group.

getParameterGroupName

@Stability(value=Stable)
 @Nullable
public String getParameterGroupName()

The name of the parameter group.

setParameterGroupName

@Stability(value=Stable)
public void setParameterGroupName(@Nullable
                                                           String value)

The name of the parameter group.