Class CfnClusterParameterGroup
- All Implemented Interfaces:
IConstruct
,IDependable
,IInspectable
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
AWS::Redshift::ClusterParameterGroup
.
Describes a parameter group.
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.redshift.*; CfnClusterParameterGroup cfnClusterParameterGroup = CfnClusterParameterGroup.Builder.create(this, "MyCfnClusterParameterGroup") .description("description") .parameterGroupFamily("parameterGroupFamily") // the properties below are optional .parameterGroupName("parameterGroupName") .parameters(List.of(ParameterProperty.builder() .parameterName("parameterName") .parameterValue("parameterValue") .build())) .tags(List.of(CfnTag.builder() .key("key") .value("value") .build())) .build();
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final class
A fluent builder forCfnClusterParameterGroup
.static interface
Describes a parameter in a cluster parameter group.Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct
IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ConstructorsModifierConstructorDescriptionCfnClusterParameterGroup
(Construct scope, String id, CfnClusterParameterGroupProps props) Create a newAWS::Redshift::ClusterParameterGroup
.protected
CfnClusterParameterGroup
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnClusterParameterGroup
(software.amazon.jsii.JsiiObjectRef objRef) -
Method Summary
Modifier and TypeMethodDescriptionThe description of the parameter group.The name of the cluster parameter group family that this cluster parameter group is compatible with.The name of the cluster parameter group.An array of parameters to be modified.getTags()
The list of tags for the cluster parameter group.void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties
(Map<String, Object> props) void
setDescription
(String value) The description of the parameter group.void
setParameterGroupFamily
(String value) The name of the cluster parameter group family that this cluster parameter group is compatible with.void
setParameterGroupName
(String value) The name of the cluster parameter group.void
setParameters
(List<Object> value) An array of parameters to be modified.void
setParameters
(IResolvable value) An array of parameters to be modified.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 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
-
CfnClusterParameterGroup
protected CfnClusterParameterGroup(software.amazon.jsii.JsiiObjectRef objRef) -
CfnClusterParameterGroup
protected CfnClusterParameterGroup(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
CfnClusterParameterGroup
@Stability(Stable) public CfnClusterParameterGroup(@NotNull Construct scope, @NotNull String id, @NotNull CfnClusterParameterGroupProps props) Create a newAWS::Redshift::ClusterParameterGroup
.- Parameters:
scope
-- scope in which this resource is defined.
id
-- scoped id of the resource.
props
-- resource properties.
-
-
Method Details
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- Parameters:
inspector
-- tree inspector to collect and process attributes.
-
renderProperties
@Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String, Object> props) - Overrides:
renderProperties
in classCfnResource
- Parameters:
props
- This parameter is required.
-
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getTags
The list of tags for the cluster parameter group. -
getDescription
The description of the parameter group. -
setDescription
The description of the parameter group. -
getParameterGroupFamily
The name of the cluster parameter group family that this cluster parameter group is compatible with.You can create a custom parameter group and then associate your cluster with it. For more information, see Amazon Redshift parameter groups .
-
setParameterGroupFamily
The name of the cluster parameter group family that this cluster parameter group is compatible with.You can create a custom parameter group and then associate your cluster with it. For more information, see Amazon Redshift parameter groups .
-
getParameterGroupName
The name of the cluster parameter group. -
setParameterGroupName
The name of the cluster parameter group. -
getParameters
An array of parameters to be modified. A maximum of 20 parameters can be modified in a single request.For each parameter to be modified, you must supply at least the parameter name and parameter value; other name-value pairs of the parameter are optional.
For the workload management (WLM) configuration, you must supply all the name-value pairs in the wlm_json_configuration parameter.
-
setParameters
An array of parameters to be modified. A maximum of 20 parameters can be modified in a single request.For each parameter to be modified, you must supply at least the parameter name and parameter value; other name-value pairs of the parameter are optional.
For the workload management (WLM) configuration, you must supply all the name-value pairs in the wlm_json_configuration parameter.
-
setParameters
An array of parameters to be modified. A maximum of 20 parameters can be modified in a single request.For each parameter to be modified, you must supply at least the parameter name and parameter value; other name-value pairs of the parameter are optional.
For the workload management (WLM) configuration, you must supply all the name-value pairs in the wlm_json_configuration parameter.
-