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.memorydb.CfnParameterGroup
- All Implemented Interfaces:
IInspectable
,ITaggable
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
,software.constructs.IDependable
@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
date="2024-10-11T15:56:01.963Z")
@Stability(Stable)
public class CfnParameterGroup
extends CfnResource
implements IInspectable, ITaggable
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();
- See Also:
-
Nested Class Summary
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.ITaggable
ITaggable.Jsii$Default, ITaggable.Jsii$Proxy
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ModifierConstructorDescriptionprotected
CfnParameterGroup
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnParameterGroup
(software.amazon.jsii.JsiiObjectRef objRef) CfnParameterGroup
(software.constructs.Construct scope, String id, CfnParameterGroupProps props) -
Method Summary
Modifier and TypeMethodDescriptionWhen you pass the logical ID of this resource to the intrinsicRef
function, Ref returns the ARN of the parameter group, such asarn:aws:memorydb:us-east-1:123456789012:parametergroup/my-parameter-group
.A description of the parameter group.The name of the parameter group family that this parameter group is compatible with.The name of the parameter group.Returns the detailed parameter list for the parameter group.getTags()
Tag Manager which manages the tags for this resource.An array of key-value pairs to apply to this resource.void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties
(Map<String, Object> props) void
setDescription
(String value) A description of the parameter group.void
The name of the parameter group family that this parameter group is compatible with.void
setParameterGroupName
(String value) The name of the parameter group.void
setParameters
(Object value) Returns the detailed parameter list for the parameter group.void
setTagsRaw
(List<CfnTag> value) An array of key-value pairs to apply to this resource.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.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Field Details
-
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, @NotNull 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. This parameter is required.
-
-
Method Details
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- 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 classCfnResource
- Parameters:
props
- This parameter is required.
-
getAttrArn
When you pass the logical ID of this resource to the intrinsicRef
function, Ref returns the ARN of the parameter group, such asarn:aws:memorydb:us-east-1:123456789012:parametergroup/my-parameter-group
. -
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getTags
Tag Manager which manages the tags for this resource. -
getFamily
The name of the parameter group family that this parameter group is compatible with. -
setFamily
The name of the parameter group family that this parameter group is compatible with. -
getParameterGroupName
The name of the parameter group. -
setParameterGroupName
The name of the parameter group. -
getDescription
A description of the parameter group. -
setDescription
A description of the parameter group. -
getParameters
Returns the detailed parameter list for the parameter group. -
setParameters
Returns the detailed parameter list for the parameter group. -
getTagsRaw
An array of key-value pairs to apply to this resource. -
setTagsRaw
An array of key-value pairs to apply to this resource.
-