software.amazon.awscdk.services.memorydb

Class CfnParameterGroup

java.lang.Object

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

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:38.868Z")
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();
 

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 interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
java.lang.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`.
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.String	getDescription() A description of the parameter group.
java.lang.String	getFamily() The name of the parameter group family that this parameter group is compatible with.
java.lang.String	getParameterGroupName() The name of the parameter group.
java.lang.Object	getParameters() Returns the detailed parameter list for the parameter group.
TagManager	getTags() An array of key-value pairs to apply to this resource.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setDescription(java.lang.String value) A description of the parameter group.
void	setFamily(java.lang.String value) The name of the parameter group family that this parameter group is compatible with.
void	setParameterGroupName(java.lang.String value) The name of the parameter group.
void	setParameters(java.lang.Object value) Returns the detailed parameter list for the parameter group.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

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

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.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

public CfnParameterGroup(Construct scope,
                         java.lang.String id,
                         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 Detail

inspect

public void inspect(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

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

public java.lang.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

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

public TagManager getTags()

An array of key-value pairs to apply to this resource.

For more information, see Tag .

getFamily

public java.lang.String getFamily()

The name of the parameter group family that this parameter group is compatible with.

setFamily

public void setFamily(java.lang.String value)

The name of the parameter group family that this parameter group is compatible with.

getParameterGroupName

public java.lang.String getParameterGroupName()

The name of the parameter group.

setParameterGroupName

public void setParameterGroupName(java.lang.String value)

The name of the parameter group.

getParameters

public java.lang.Object getParameters()

Returns the detailed parameter list for the parameter group.

setParameters

public void setParameters(java.lang.Object value)

Returns the detailed parameter list for the parameter group.

getDescription

public java.lang.String getDescription()

A description of the parameter group.

setDescription

public void setDescription(java.lang.String value)

A description of the parameter group.