software.amazon.awscdk.services.redshift

Class CfnClusterParameterGroup

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.redshift.CfnClusterParameterGroup

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:45.824Z")
public class CfnClusterParameterGroup
extends CfnResource
implements IInspectable

A CloudFormation `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 Classes

Modifier and Type	Class and Description
static class	CfnClusterParameterGroup.Builder A fluent builder for CfnClusterParameterGroup.
static interface	CfnClusterParameterGroup.ParameterProperty Describes a parameter in a cluster parameter group.

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
	CfnClusterParameterGroup(Construct scope, java.lang.String id, CfnClusterParameterGroupProps props) Create a new `AWS::Redshift::ClusterParameterGroup`.
protected	CfnClusterParameterGroup(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnClusterParameterGroup(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.String	getDescription() The description of the parameter group.
java.lang.String	getParameterGroupFamily() The name of the cluster parameter group family that this cluster parameter group is compatible with.
java.lang.String	getParameterGroupName() The name of the cluster parameter group.
java.lang.Object	getParameters() An array of parameters to be modified.
TagManager	getTags() The list of tags for the cluster parameter group.
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) The description of the parameter group.
void	setParameterGroupFamily(java.lang.String value) The name of the cluster parameter group family that this cluster parameter group is compatible with.
void	setParameterGroupName(java.lang.String value) The name of the cluster parameter group.
void	setParameters(IResolvable value) An array of parameters to be modified.
void	setParameters(java.util.List<java.lang.Object> 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 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

CfnClusterParameterGroup

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

CfnClusterParameterGroup

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

CfnClusterParameterGroup

public CfnClusterParameterGroup(Construct scope,
                                java.lang.String id,
                                CfnClusterParameterGroupProps props)

Create a new `AWS::Redshift::ClusterParameterGroup`.

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.

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getTags

public TagManager getTags()

The list of tags for the cluster parameter group.

getDescription

public java.lang.String getDescription()

The description of the parameter group.

setDescription

public void setDescription(java.lang.String value)

The description of the parameter group.

getParameterGroupFamily

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

public void setParameterGroupFamily(java.lang.String value)

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

public java.lang.String getParameterGroupName()

The name of the cluster parameter group.

setParameterGroupName

public void setParameterGroupName(java.lang.String value)

The name of the cluster parameter group.

getParameters

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

public void setParameters(IResolvable value)

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

public void setParameters(java.util.List<java.lang.Object> value)

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.