software.amazon.awscdk.services.redshift

Class CfnCluster

java.lang.Object

software.amazon.jsii.JsiiObject

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.CfnCluster

All Implemented Interfaces:

IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct

@Generated(value="jsii-pacmak/1.30.0 (build adae23f)",
           date="2021-06-17T00:23:31.770Z")
 @Stability(value=Stable)
public class CfnCluster
extends CfnResource
implements IInspectable

A CloudFormation `AWS::Redshift::Cluster`.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnCluster.Builder A fluent builder for CfnCluster.
static interface	CfnCluster.LoggingPropertiesProperty

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.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 String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnCluster(Construct scope, String id, CfnClusterProps props) Create a new `AWS::Redshift::Cluster`.
protected	CfnCluster(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnCluster(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
Object	getAllowVersionUpgrade() `AWS::Redshift::Cluster.AllowVersionUpgrade`.
String	getAttrEndpointAddress()
String	getAttrEndpointPort()
Number	getAutomatedSnapshotRetentionPeriod() `AWS::Redshift::Cluster.AutomatedSnapshotRetentionPeriod`.
String	getAvailabilityZone() `AWS::Redshift::Cluster.AvailabilityZone`.
protected Map<String,Object>	getCfnProperties()
String	getClusterIdentifier() `AWS::Redshift::Cluster.ClusterIdentifier`.
String	getClusterParameterGroupName() `AWS::Redshift::Cluster.ClusterParameterGroupName`.
List<String>	getClusterSecurityGroups() `AWS::Redshift::Cluster.ClusterSecurityGroups`.
String	getClusterSubnetGroupName() `AWS::Redshift::Cluster.ClusterSubnetGroupName`.
String	getClusterType() `AWS::Redshift::Cluster.ClusterType`.
String	getClusterVersion() `AWS::Redshift::Cluster.ClusterVersion`.
String	getDbName() `AWS::Redshift::Cluster.DBName`.
String	getElasticIp() `AWS::Redshift::Cluster.ElasticIp`.
Object	getEncrypted() `AWS::Redshift::Cluster.Encrypted`.
String	getHsmClientCertificateIdentifier() `AWS::Redshift::Cluster.HsmClientCertificateIdentifier`.
String	getHsmConfigurationIdentifier() `AWS::Redshift::Cluster.HsmConfigurationIdentifier`.
List<String>	getIamRoles() `AWS::Redshift::Cluster.IamRoles`.
String	getKmsKeyId() `AWS::Redshift::Cluster.KmsKeyId`.
Object	getLoggingProperties() `AWS::Redshift::Cluster.LoggingProperties`.
String	getMasterUsername() `AWS::Redshift::Cluster.MasterUsername`.
String	getMasterUserPassword() `AWS::Redshift::Cluster.MasterUserPassword`.
String	getNodeType() `AWS::Redshift::Cluster.NodeType`.
Number	getNumberOfNodes() `AWS::Redshift::Cluster.NumberOfNodes`.
String	getOwnerAccount() `AWS::Redshift::Cluster.OwnerAccount`.
Number	getPort() `AWS::Redshift::Cluster.Port`.
String	getPreferredMaintenanceWindow() `AWS::Redshift::Cluster.PreferredMaintenanceWindow`.
Object	getPubliclyAccessible() `AWS::Redshift::Cluster.PubliclyAccessible`.
String	getSnapshotClusterIdentifier() `AWS::Redshift::Cluster.SnapshotClusterIdentifier`.
String	getSnapshotIdentifier() `AWS::Redshift::Cluster.SnapshotIdentifier`.
TagManager	getTags() `AWS::Redshift::Cluster.Tags`.
List<String>	getVpcSecurityGroupIds() `AWS::Redshift::Cluster.VpcSecurityGroupIds`.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAllowVersionUpgrade(Boolean value) `AWS::Redshift::Cluster.AllowVersionUpgrade`.
void	setAllowVersionUpgrade(IResolvable value) `AWS::Redshift::Cluster.AllowVersionUpgrade`.
void	setAutomatedSnapshotRetentionPeriod(Number value) `AWS::Redshift::Cluster.AutomatedSnapshotRetentionPeriod`.
void	setAvailabilityZone(String value) `AWS::Redshift::Cluster.AvailabilityZone`.
void	setClusterIdentifier(String value) `AWS::Redshift::Cluster.ClusterIdentifier`.
void	setClusterParameterGroupName(String value) `AWS::Redshift::Cluster.ClusterParameterGroupName`.
void	setClusterSecurityGroups(List<String> value) `AWS::Redshift::Cluster.ClusterSecurityGroups`.
void	setClusterSubnetGroupName(String value) `AWS::Redshift::Cluster.ClusterSubnetGroupName`.
void	setClusterType(String value) `AWS::Redshift::Cluster.ClusterType`.
void	setClusterVersion(String value) `AWS::Redshift::Cluster.ClusterVersion`.
void	setDbName(String value) `AWS::Redshift::Cluster.DBName`.
void	setElasticIp(String value) `AWS::Redshift::Cluster.ElasticIp`.
void	setEncrypted(Boolean value) `AWS::Redshift::Cluster.Encrypted`.
void	setEncrypted(IResolvable value) `AWS::Redshift::Cluster.Encrypted`.
void	setHsmClientCertificateIdentifier(String value) `AWS::Redshift::Cluster.HsmClientCertificateIdentifier`.
void	setHsmConfigurationIdentifier(String value) `AWS::Redshift::Cluster.HsmConfigurationIdentifier`.
void	setIamRoles(List<String> value) `AWS::Redshift::Cluster.IamRoles`.
void	setKmsKeyId(String value) `AWS::Redshift::Cluster.KmsKeyId`.
void	setLoggingProperties(CfnCluster.LoggingPropertiesProperty value) `AWS::Redshift::Cluster.LoggingProperties`.
void	setLoggingProperties(IResolvable value) `AWS::Redshift::Cluster.LoggingProperties`.
void	setMasterUsername(String value) `AWS::Redshift::Cluster.MasterUsername`.
void	setMasterUserPassword(String value) `AWS::Redshift::Cluster.MasterUserPassword`.
void	setNodeType(String value) `AWS::Redshift::Cluster.NodeType`.
void	setNumberOfNodes(Number value) `AWS::Redshift::Cluster.NumberOfNodes`.
void	setOwnerAccount(String value) `AWS::Redshift::Cluster.OwnerAccount`.
void	setPort(Number value) `AWS::Redshift::Cluster.Port`.
void	setPreferredMaintenanceWindow(String value) `AWS::Redshift::Cluster.PreferredMaintenanceWindow`.
void	setPubliclyAccessible(Boolean value) `AWS::Redshift::Cluster.PubliclyAccessible`.
void	setPubliclyAccessible(IResolvable value) `AWS::Redshift::Cluster.PubliclyAccessible`.
void	setSnapshotClusterIdentifier(String value) `AWS::Redshift::Cluster.SnapshotClusterIdentifier`.
void	setSnapshotIdentifier(String value) `AWS::Redshift::Cluster.SnapshotIdentifier`.
void	setVpcSecurityGroupIds(List<String> value) `AWS::Redshift::Cluster.VpcSecurityGroupIds`.

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 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

CfnCluster

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

CfnCluster

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

CfnCluster

@Stability(value=Stable)
public CfnCluster(@NotNull
                                           Construct scope,
                                           @NotNull
                                           String id,
                                           @NotNull
                                           CfnClusterProps props)

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

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

@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.

getAttrEndpointAddress

@Stability(value=Stable)
 @NotNull
public String getAttrEndpointAddress()

getAttrEndpointPort

@Stability(value=Stable)
 @NotNull
public String getAttrEndpointPort()

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

`AWS::Redshift::Cluster.Tags`.

getClusterType

@Stability(value=Stable)
 @NotNull
public String getClusterType()

`AWS::Redshift::Cluster.ClusterType`.

setClusterType

@Stability(value=Stable)
public void setClusterType(@NotNull
                                                    String value)

`AWS::Redshift::Cluster.ClusterType`.

getDbName

@Stability(value=Stable)
 @NotNull
public String getDbName()

`AWS::Redshift::Cluster.DBName`.

setDbName

@Stability(value=Stable)
public void setDbName(@NotNull
                                               String value)

`AWS::Redshift::Cluster.DBName`.

getMasterUsername

@Stability(value=Stable)
 @NotNull
public String getMasterUsername()

`AWS::Redshift::Cluster.MasterUsername`.

setMasterUsername

@Stability(value=Stable)
public void setMasterUsername(@NotNull
                                                       String value)

`AWS::Redshift::Cluster.MasterUsername`.

getMasterUserPassword

@Stability(value=Stable)
 @NotNull
public String getMasterUserPassword()

`AWS::Redshift::Cluster.MasterUserPassword`.

setMasterUserPassword

@Stability(value=Stable)
public void setMasterUserPassword(@NotNull
                                                           String value)

`AWS::Redshift::Cluster.MasterUserPassword`.

getNodeType

@Stability(value=Stable)
 @NotNull
public String getNodeType()

`AWS::Redshift::Cluster.NodeType`.

setNodeType

@Stability(value=Stable)
public void setNodeType(@NotNull
                                                 String value)

`AWS::Redshift::Cluster.NodeType`.

getAllowVersionUpgrade

@Stability(value=Stable)
 @Nullable
public Object getAllowVersionUpgrade()

`AWS::Redshift::Cluster.AllowVersionUpgrade`.

setAllowVersionUpgrade

@Stability(value=Stable)
public void setAllowVersionUpgrade(@Nullable
                                                            Boolean value)

`AWS::Redshift::Cluster.AllowVersionUpgrade`.

setAllowVersionUpgrade

@Stability(value=Stable)
public void setAllowVersionUpgrade(@Nullable
                                                            IResolvable value)

`AWS::Redshift::Cluster.AllowVersionUpgrade`.

getAutomatedSnapshotRetentionPeriod

@Stability(value=Stable)
 @Nullable
public Number getAutomatedSnapshotRetentionPeriod()

`AWS::Redshift::Cluster.AutomatedSnapshotRetentionPeriod`.

setAutomatedSnapshotRetentionPeriod

@Stability(value=Stable)
public void setAutomatedSnapshotRetentionPeriod(@Nullable
                                                                         Number value)

`AWS::Redshift::Cluster.AutomatedSnapshotRetentionPeriod`.

getAvailabilityZone

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

`AWS::Redshift::Cluster.AvailabilityZone`.

setAvailabilityZone

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

`AWS::Redshift::Cluster.AvailabilityZone`.

getClusterIdentifier

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

`AWS::Redshift::Cluster.ClusterIdentifier`.

setClusterIdentifier

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

`AWS::Redshift::Cluster.ClusterIdentifier`.

getClusterParameterGroupName

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

`AWS::Redshift::Cluster.ClusterParameterGroupName`.

setClusterParameterGroupName

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

`AWS::Redshift::Cluster.ClusterParameterGroupName`.

getClusterSecurityGroups

@Stability(value=Stable)
 @Nullable
public List<String> getClusterSecurityGroups()

`AWS::Redshift::Cluster.ClusterSecurityGroups`.

setClusterSecurityGroups

@Stability(value=Stable)
public void setClusterSecurityGroups(@Nullable
                                                              List<String> value)

`AWS::Redshift::Cluster.ClusterSecurityGroups`.

getClusterSubnetGroupName

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

`AWS::Redshift::Cluster.ClusterSubnetGroupName`.

setClusterSubnetGroupName

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

`AWS::Redshift::Cluster.ClusterSubnetGroupName`.

getClusterVersion

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

`AWS::Redshift::Cluster.ClusterVersion`.

setClusterVersion

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

`AWS::Redshift::Cluster.ClusterVersion`.

getElasticIp

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

`AWS::Redshift::Cluster.ElasticIp`.

setElasticIp

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

`AWS::Redshift::Cluster.ElasticIp`.

getEncrypted

@Stability(value=Stable)
 @Nullable
public Object getEncrypted()

`AWS::Redshift::Cluster.Encrypted`.

setEncrypted

@Stability(value=Stable)
public void setEncrypted(@Nullable
                                                  Boolean value)

`AWS::Redshift::Cluster.Encrypted`.

setEncrypted

@Stability(value=Stable)
public void setEncrypted(@Nullable
                                                  IResolvable value)

`AWS::Redshift::Cluster.Encrypted`.

getHsmClientCertificateIdentifier

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

`AWS::Redshift::Cluster.HsmClientCertificateIdentifier`.

setHsmClientCertificateIdentifier

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

`AWS::Redshift::Cluster.HsmClientCertificateIdentifier`.

getHsmConfigurationIdentifier

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

`AWS::Redshift::Cluster.HsmConfigurationIdentifier`.

setHsmConfigurationIdentifier

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

`AWS::Redshift::Cluster.HsmConfigurationIdentifier`.

getIamRoles

@Stability(value=Stable)
 @Nullable
public List<String> getIamRoles()

`AWS::Redshift::Cluster.IamRoles`.

setIamRoles

@Stability(value=Stable)
public void setIamRoles(@Nullable
                                                 List<String> value)

`AWS::Redshift::Cluster.IamRoles`.

getKmsKeyId

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

`AWS::Redshift::Cluster.KmsKeyId`.

setKmsKeyId

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

`AWS::Redshift::Cluster.KmsKeyId`.

getLoggingProperties

@Stability(value=Stable)
 @Nullable
public Object getLoggingProperties()

`AWS::Redshift::Cluster.LoggingProperties`.

setLoggingProperties

@Stability(value=Stable)
public void setLoggingProperties(@Nullable
                                                          IResolvable value)

`AWS::Redshift::Cluster.LoggingProperties`.

setLoggingProperties

@Stability(value=Stable)
public void setLoggingProperties(@Nullable
                                                          CfnCluster.LoggingPropertiesProperty value)

`AWS::Redshift::Cluster.LoggingProperties`.

getNumberOfNodes

@Stability(value=Stable)
 @Nullable
public Number getNumberOfNodes()

`AWS::Redshift::Cluster.NumberOfNodes`.

setNumberOfNodes

@Stability(value=Stable)
public void setNumberOfNodes(@Nullable
                                                      Number value)

`AWS::Redshift::Cluster.NumberOfNodes`.

getOwnerAccount

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

`AWS::Redshift::Cluster.OwnerAccount`.

setOwnerAccount

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

`AWS::Redshift::Cluster.OwnerAccount`.

getPort

@Stability(value=Stable)
 @Nullable
public Number getPort()

`AWS::Redshift::Cluster.Port`.

setPort

@Stability(value=Stable)
public void setPort(@Nullable
                                             Number value)

`AWS::Redshift::Cluster.Port`.

getPreferredMaintenanceWindow

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

`AWS::Redshift::Cluster.PreferredMaintenanceWindow`.

setPreferredMaintenanceWindow

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

`AWS::Redshift::Cluster.PreferredMaintenanceWindow`.

getPubliclyAccessible

@Stability(value=Stable)
 @Nullable
public Object getPubliclyAccessible()

`AWS::Redshift::Cluster.PubliclyAccessible`.

setPubliclyAccessible

@Stability(value=Stable)
public void setPubliclyAccessible(@Nullable
                                                           Boolean value)

`AWS::Redshift::Cluster.PubliclyAccessible`.

setPubliclyAccessible

@Stability(value=Stable)
public void setPubliclyAccessible(@Nullable
                                                           IResolvable value)

`AWS::Redshift::Cluster.PubliclyAccessible`.

getSnapshotClusterIdentifier

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

`AWS::Redshift::Cluster.SnapshotClusterIdentifier`.

setSnapshotClusterIdentifier

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

`AWS::Redshift::Cluster.SnapshotClusterIdentifier`.

getSnapshotIdentifier

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

`AWS::Redshift::Cluster.SnapshotIdentifier`.

setSnapshotIdentifier

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

`AWS::Redshift::Cluster.SnapshotIdentifier`.

getVpcSecurityGroupIds

@Stability(value=Stable)
 @Nullable
public List<String> getVpcSecurityGroupIds()

`AWS::Redshift::Cluster.VpcSecurityGroupIds`.

setVpcSecurityGroupIds

@Stability(value=Stable)
public void setVpcSecurityGroupIds(@Nullable
                                                            List<String> value)

`AWS::Redshift::Cluster.VpcSecurityGroupIds`.