@Generated(value="jsii-pacmak/1.50.0 (build d1830a4)", date="2022-01-09T19:25:26.009Z") @Stability(value=Stable) public class CfnCluster extends CfnResource implements IInspectable
Specifies a cluster. A cluster is a fully managed data warehouse that consists of a set of compute nodes.
To create a cluster in Virtual Private Cloud (VPC), you must provide a cluster subnet group name. The cluster subnet group identifies the subnets of your VPC that Amazon Redshift uses when creating the cluster. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide .
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.*;
CfnCluster cfnCluster = CfnCluster.Builder.create(this, "MyCfnCluster")
.clusterType("clusterType")
.dbName("dbName")
.masterUsername("masterUsername")
.masterUserPassword("masterUserPassword")
.nodeType("nodeType")
// the properties below are optional
.allowVersionUpgrade(false)
.aquaConfigurationStatus("aquaConfigurationStatus")
.automatedSnapshotRetentionPeriod(123)
.availabilityZone("availabilityZone")
.availabilityZoneRelocation(false)
.availabilityZoneRelocationStatus("availabilityZoneRelocationStatus")
.classic(false)
.clusterIdentifier("clusterIdentifier")
.clusterParameterGroupName("clusterParameterGroupName")
.clusterSecurityGroups(List.of("clusterSecurityGroups"))
.clusterSubnetGroupName("clusterSubnetGroupName")
.clusterVersion("clusterVersion")
.deferMaintenance(false)
.deferMaintenanceDuration(123)
.deferMaintenanceEndTime("deferMaintenanceEndTime")
.deferMaintenanceStartTime("deferMaintenanceStartTime")
.destinationRegion("destinationRegion")
.elasticIp("elasticIp")
.encrypted(false)
.enhancedVpcRouting(false)
.hsmClientCertificateIdentifier("hsmClientCertificateIdentifier")
.hsmConfigurationIdentifier("hsmConfigurationIdentifier")
.iamRoles(List.of("iamRoles"))
.kmsKeyId("kmsKeyId")
.loggingProperties(LoggingPropertiesProperty.builder()
.bucketName("bucketName")
// the properties below are optional
.s3KeyPrefix("s3KeyPrefix")
.build())
.maintenanceTrackName("maintenanceTrackName")
.manualSnapshotRetentionPeriod(123)
.numberOfNodes(123)
.ownerAccount("ownerAccount")
.port(123)
.preferredMaintenanceWindow("preferredMaintenanceWindow")
.publiclyAccessible(false)
.resourceAction("resourceAction")
.revisionTarget("revisionTarget")
.rotateEncryptionKey(false)
.snapshotClusterIdentifier("snapshotClusterIdentifier")
.snapshotCopyGrantName("snapshotCopyGrantName")
.snapshotCopyManual(false)
.snapshotCopyRetentionPeriod(123)
.snapshotIdentifier("snapshotIdentifier")
.tags(List.of(CfnTag.builder()
.key("key")
.value("value")
.build()))
.vpcSecurityGroupIds(List.of("vpcSecurityGroupIds"))
.build();
| Modifier and Type | Class and Description |
|---|---|
static class |
CfnCluster.Builder
A fluent builder for
CfnCluster. |
static interface |
CfnCluster.EndpointProperty
Describes a connection endpoint.
|
static interface |
CfnCluster.LoggingPropertiesProperty
Specifies logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.
|
software.amazon.jsii.JsiiObject.InitializationModeIInspectable.Jsii$Default, IInspectable.Jsii$ProxyIConstruct.Jsii$Default| Modifier and Type | Field and Description |
|---|---|
static String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
| 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) |
| Modifier and Type | Method and Description |
|---|---|
Object |
getAllowVersionUpgrade()
If `true` , major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster.
|
String |
getAquaConfigurationStatus()
The value represents how the cluster is configured to use AQUA (Advanced Query Accelerator) when it is created.
|
String |
getAttrDeferMaintenanceIdentifier() |
String |
getAttrEndpointAddress()
The connection endpoint for the Amazon Redshift cluster.
|
String |
getAttrEndpointPort()
The port number on which the Amazon Redshift cluster accepts connections.
|
String |
getAttrId()
A unique identifier for the cluster.
|
Number |
getAutomatedSnapshotRetentionPeriod()
The number of days that automated snapshots are retained.
|
String |
getAvailabilityZone()
The EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the cluster.
|
Object |
getAvailabilityZoneRelocation()
The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster is created.
|
String |
getAvailabilityZoneRelocationStatus()
Describes the status of the Availability Zone relocation operation.
|
protected Map<String,Object> |
getCfnProperties() |
Object |
getClassic()
A boolean value indicating whether the resize operation is using the classic resize process.
|
String |
getClusterIdentifier()
A unique identifier for the cluster.
|
String |
getClusterParameterGroupName()
The name of the parameter group to be associated with this cluster.
|
List<String> |
getClusterSecurityGroups()
A list of security groups to be associated with this cluster.
|
String |
getClusterSubnetGroupName()
The name of a cluster subnet group to be associated with this cluster.
|
String |
getClusterType()
The type of the cluster.
|
String |
getClusterVersion()
The version of the Amazon Redshift engine software that you want to deploy on the cluster.
|
String |
getDbName()
The name of the first database to be created when the cluster is created.
|
Object |
getDeferMaintenance()
`AWS::Redshift::Cluster.DeferMaintenance`.
|
Number |
getDeferMaintenanceDuration()
`AWS::Redshift::Cluster.DeferMaintenanceDuration`.
|
String |
getDeferMaintenanceEndTime()
`AWS::Redshift::Cluster.DeferMaintenanceEndTime`.
|
String |
getDeferMaintenanceStartTime()
`AWS::Redshift::Cluster.DeferMaintenanceStartTime`.
|
String |
getDestinationRegion()
The destination region that snapshots are automatically copied to when cross-region snapshot copy is enabled.
|
String |
getElasticIp()
The Elastic IP (EIP) address for the cluster.
|
Object |
getEncrypted()
If `true` , the data in the cluster is encrypted at rest.
|
Object |
getEnhancedVpcRouting()
An option that specifies whether to create the cluster with enhanced VPC routing enabled.
|
String |
getHsmClientCertificateIdentifier()
Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.
|
String |
getHsmConfigurationIdentifier()
Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM.
|
List<String> |
getIamRoles()
A list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services.
|
String |
getKmsKeyId()
The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster.
|
Object |
getLoggingProperties()
Specifies logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.
|
String |
getMaintenanceTrackName()
An optional parameter for the name of the maintenance track for the cluster.
|
Number |
getManualSnapshotRetentionPeriod()
The default number of days to retain a manual snapshot.
|
String |
getMasterUsername()
The user name associated with the admin user account for the cluster that is being created.
|
String |
getMasterUserPassword()
The password associated with the admin user account for the cluster that is being created.
|
String |
getNodeType()
The node type to be provisioned for the cluster.
|
Number |
getNumberOfNodes()
The number of compute nodes in the cluster.
|
String |
getOwnerAccount()
The AWS account used to create or copy the snapshot.
|
Number |
getPort()
The port number on which the cluster accepts incoming connections.
|
String |
getPreferredMaintenanceWindow()
The weekly time range (in UTC) during which automated cluster maintenance can occur.
|
Object |
getPubliclyAccessible()
If `true` , the cluster can be accessed from a public network.
|
String |
getResourceAction()
`AWS::Redshift::Cluster.ResourceAction`.
|
String |
getRevisionTarget()
`AWS::Redshift::Cluster.RevisionTarget`.
|
Object |
getRotateEncryptionKey()
`AWS::Redshift::Cluster.RotateEncryptionKey`.
|
String |
getSnapshotClusterIdentifier()
The name of the cluster the source snapshot was created from.
|
String |
getSnapshotCopyGrantName()
The name of the snapshot copy grant.
|
Object |
getSnapshotCopyManual()
`AWS::Redshift::Cluster.SnapshotCopyManual`.
|
Number |
getSnapshotCopyRetentionPeriod()
`AWS::Redshift::Cluster.SnapshotCopyRetentionPeriod`.
|
String |
getSnapshotIdentifier()
The name of the snapshot from which to create the new cluster.
|
TagManager |
getTags()
A list of tag instances.
|
List<String> |
getVpcSecurityGroupIds()
A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.
|
void |
inspect(TreeInspector inspector)
Examines the CloudFormation resource and discloses attributes.
|
protected Map<String,Object> |
renderProperties(Map<String,Object> props) |
void |
setAllowVersionUpgrade(Boolean value)
If `true` , major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster.
|
void |
setAllowVersionUpgrade(IResolvable value)
If `true` , major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster.
|
void |
setAquaConfigurationStatus(String value)
The value represents how the cluster is configured to use AQUA (Advanced Query Accelerator) when it is created.
|
void |
setAutomatedSnapshotRetentionPeriod(Number value)
The number of days that automated snapshots are retained.
|
void |
setAvailabilityZone(String value)
The EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the cluster.
|
void |
setAvailabilityZoneRelocation(Boolean value)
The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster is created.
|
void |
setAvailabilityZoneRelocation(IResolvable value)
The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster is created.
|
void |
setAvailabilityZoneRelocationStatus(String value)
Describes the status of the Availability Zone relocation operation.
|
void |
setClassic(Boolean value)
A boolean value indicating whether the resize operation is using the classic resize process.
|
void |
setClassic(IResolvable value)
A boolean value indicating whether the resize operation is using the classic resize process.
|
void |
setClusterIdentifier(String value)
A unique identifier for the cluster.
|
void |
setClusterParameterGroupName(String value)
The name of the parameter group to be associated with this cluster.
|
void |
setClusterSecurityGroups(List<String> value)
A list of security groups to be associated with this cluster.
|
void |
setClusterSubnetGroupName(String value)
The name of a cluster subnet group to be associated with this cluster.
|
void |
setClusterType(String value)
The type of the cluster.
|
void |
setClusterVersion(String value)
The version of the Amazon Redshift engine software that you want to deploy on the cluster.
|
void |
setDbName(String value)
The name of the first database to be created when the cluster is created.
|
void |
setDeferMaintenance(Boolean value)
`AWS::Redshift::Cluster.DeferMaintenance`.
|
void |
setDeferMaintenance(IResolvable value)
`AWS::Redshift::Cluster.DeferMaintenance`.
|
void |
setDeferMaintenanceDuration(Number value)
`AWS::Redshift::Cluster.DeferMaintenanceDuration`.
|
void |
setDeferMaintenanceEndTime(String value)
`AWS::Redshift::Cluster.DeferMaintenanceEndTime`.
|
void |
setDeferMaintenanceStartTime(String value)
`AWS::Redshift::Cluster.DeferMaintenanceStartTime`.
|
void |
setDestinationRegion(String value)
The destination region that snapshots are automatically copied to when cross-region snapshot copy is enabled.
|
void |
setElasticIp(String value)
The Elastic IP (EIP) address for the cluster.
|
void |
setEncrypted(Boolean value)
If `true` , the data in the cluster is encrypted at rest.
|
void |
setEncrypted(IResolvable value)
If `true` , the data in the cluster is encrypted at rest.
|
void |
setEnhancedVpcRouting(Boolean value)
An option that specifies whether to create the cluster with enhanced VPC routing enabled.
|
void |
setEnhancedVpcRouting(IResolvable value)
An option that specifies whether to create the cluster with enhanced VPC routing enabled.
|
void |
setHsmClientCertificateIdentifier(String value)
Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.
|
void |
setHsmConfigurationIdentifier(String value)
Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM.
|
void |
setIamRoles(List<String> value)
A list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services.
|
void |
setKmsKeyId(String value)
The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster.
|
void |
setLoggingProperties(CfnCluster.LoggingPropertiesProperty value)
Specifies logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.
|
void |
setLoggingProperties(IResolvable value)
Specifies logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.
|
void |
setMaintenanceTrackName(String value)
An optional parameter for the name of the maintenance track for the cluster.
|
void |
setManualSnapshotRetentionPeriod(Number value)
The default number of days to retain a manual snapshot.
|
void |
setMasterUsername(String value)
The user name associated with the admin user account for the cluster that is being created.
|
void |
setMasterUserPassword(String value)
The password associated with the admin user account for the cluster that is being created.
|
void |
setNodeType(String value)
The node type to be provisioned for the cluster.
|
void |
setNumberOfNodes(Number value)
The number of compute nodes in the cluster.
|
void |
setOwnerAccount(String value)
The AWS account used to create or copy the snapshot.
|
void |
setPort(Number value)
The port number on which the cluster accepts incoming connections.
|
void |
setPreferredMaintenanceWindow(String value)
The weekly time range (in UTC) during which automated cluster maintenance can occur.
|
void |
setPubliclyAccessible(Boolean value)
If `true` , the cluster can be accessed from a public network.
|
void |
setPubliclyAccessible(IResolvable value)
If `true` , the cluster can be accessed from a public network.
|
void |
setResourceAction(String value)
`AWS::Redshift::Cluster.ResourceAction`.
|
void |
setRevisionTarget(String value)
`AWS::Redshift::Cluster.RevisionTarget`.
|
void |
setRotateEncryptionKey(Boolean value)
`AWS::Redshift::Cluster.RotateEncryptionKey`.
|
void |
setRotateEncryptionKey(IResolvable value)
`AWS::Redshift::Cluster.RotateEncryptionKey`.
|
void |
setSnapshotClusterIdentifier(String value)
The name of the cluster the source snapshot was created from.
|
void |
setSnapshotCopyGrantName(String value)
The name of the snapshot copy grant.
|
void |
setSnapshotCopyManual(Boolean value)
`AWS::Redshift::Cluster.SnapshotCopyManual`.
|
void |
setSnapshotCopyManual(IResolvable value)
`AWS::Redshift::Cluster.SnapshotCopyManual`.
|
void |
setSnapshotCopyRetentionPeriod(Number value)
`AWS::Redshift::Cluster.SnapshotCopyRetentionPeriod`.
|
void |
setSnapshotIdentifier(String value)
The name of the snapshot from which to create the new cluster.
|
void |
setVpcSecurityGroupIds(List<String> value)
A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validatePropertiesgetRefgetCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalIdgetNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validatejsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet@Stability(value=Stable) public static final String CFN_RESOURCE_TYPE_NAME
protected CfnCluster(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnCluster(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
@Stability(value=Stable)
public CfnCluster(@NotNull
Construct scope,
@NotNull
String id,
@NotNull
CfnClusterProps props)
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.@Stability(value=Stable)
public void inspect(@NotNull
TreeInspector inspector)
inspect in interface IInspectableinspector - - tree inspector to collect and process attributes. This parameter is required.@Stability(value=Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
renderProperties in class CfnResourceprops - This parameter is required.@Stability(value=Stable) @NotNull public String getAttrDeferMaintenanceIdentifier()
@Stability(value=Stable) @NotNull public String getAttrEndpointAddress()
For example: examplecluster.cg034hpkmmjt.us-east-1.redshift.amazonaws.com .
@Stability(value=Stable) @NotNull public String getAttrEndpointPort()
For example: 5439 .
@Stability(value=Stable) @NotNull public String getAttrId()
You use this identifier to refer to the cluster for any subsequent cluster operations such as deleting or modifying. The identifier also appears in the Amazon Redshift console.
Example: myexamplecluster
@Stability(value=Stable) @NotNull protected Map<String,Object> getCfnProperties()
getCfnProperties in class CfnResource@Stability(value=Stable) @NotNull public TagManager getTags()
@Stability(value=Stable) @NotNull public String getClusterType()
single-node , the NumberOfNodes parameter is not required.multi-node , the NumberOfNodes parameter is required.
Valid Values: multi-node | single-node
Default: multi-node
@Stability(value=Stable)
public void setClusterType(@NotNull
String value)
single-node , the NumberOfNodes parameter is not required.multi-node , the NumberOfNodes parameter is required.
Valid Values: multi-node | single-node
Default: multi-node
@Stability(value=Stable) @NotNull public String getDbName()
To create additional databases after the cluster is created, connect to the cluster with a SQL client and use SQL commands to create a database. For more information, go to Create a Database in the Amazon Redshift Database Developer Guide.
Default: dev
Constraints:
@Stability(value=Stable)
public void setDbName(@NotNull
String value)
To create additional databases after the cluster is created, connect to the cluster with a SQL client and use SQL commands to create a database. For more information, go to Create a Database in the Amazon Redshift Database Developer Guide.
Default: dev
Constraints:
@Stability(value=Stable) @NotNull public String getMasterUsername()
Constraints:
PUBLIC .@Stability(value=Stable)
public void setMasterUsername(@NotNull
String value)
Constraints:
PUBLIC .@Stability(value=Stable) @NotNull public String getMasterUserPassword()
Constraints:
@Stability(value=Stable)
public void setMasterUserPassword(@NotNull
String value)
Constraints:
@Stability(value=Stable) @NotNull public String getNodeType()
For information about node types, go to Working with Clusters in the Amazon Redshift Cluster Management Guide .
Valid Values: ds2.xlarge | ds2.8xlarge | dc1.large | dc1.8xlarge | dc2.large | dc2.8xlarge | ra3.xlplus | ra3.4xlarge | ra3.16xlarge
@Stability(value=Stable)
public void setNodeType(@NotNull
String value)
For information about node types, go to Working with Clusters in the Amazon Redshift Cluster Management Guide .
Valid Values: ds2.xlarge | ds2.8xlarge | dc1.large | dc1.8xlarge | dc2.large | dc2.8xlarge | ra3.xlplus | ra3.4xlarge | ra3.16xlarge
@Stability(value=Stable) @Nullable public Object getAllowVersionUpgrade()
When a new major version of the Amazon Redshift engine is released, you can request that the service automatically apply upgrades during the maintenance window to the Amazon Redshift engine that is running on your cluster.
Default: true
@Stability(value=Stable)
public void setAllowVersionUpgrade(@Nullable
Boolean value)
When a new major version of the Amazon Redshift engine is released, you can request that the service automatically apply upgrades during the maintenance window to the Amazon Redshift engine that is running on your cluster.
Default: true
@Stability(value=Stable)
public void setAllowVersionUpgrade(@Nullable
IResolvable value)
When a new major version of the Amazon Redshift engine is released, you can request that the service automatically apply upgrades during the maintenance window to the Amazon Redshift engine that is running on your cluster.
Default: true
@Stability(value=Stable) @Nullable public String getAquaConfigurationStatus()
Possible values include the following.
@Stability(value=Stable)
public void setAquaConfigurationStatus(@Nullable
String value)
Possible values include the following.
@Stability(value=Stable) @Nullable public Number getAutomatedSnapshotRetentionPeriod()
If the value is 0, automated snapshots are disabled. Even if automated snapshots are disabled, you can still create manual snapshots when you want with CreateClusterSnapshot in the Amazon Redshift API Reference .
Default: 1
Constraints: Must be a value from 0 to 35.
@Stability(value=Stable)
public void setAutomatedSnapshotRetentionPeriod(@Nullable
Number value)
If the value is 0, automated snapshots are disabled. Even if automated snapshots are disabled, you can still create manual snapshots when you want with CreateClusterSnapshot in the Amazon Redshift API Reference .
Default: 1
Constraints: Must be a value from 0 to 35.
@Stability(value=Stable) @Nullable public String getAvailabilityZone()
For example, if you have several EC2 instances running in a specific Availability Zone, then you might want the cluster to be provisioned in the same zone in order to decrease network latency.
Default: A random, system-chosen Availability Zone in the region that is specified by the endpoint.
Example: us-east-2d
Constraint: The specified Availability Zone must be in the same region as the current endpoint.
@Stability(value=Stable)
public void setAvailabilityZone(@Nullable
String value)
For example, if you have several EC2 instances running in a specific Availability Zone, then you might want the cluster to be provisioned in the same zone in order to decrease network latency.
Default: A random, system-chosen Availability Zone in the region that is specified by the endpoint.
Example: us-east-2d
Constraint: The specified Availability Zone must be in the same region as the current endpoint.
@Stability(value=Stable) @Nullable public Object getAvailabilityZoneRelocation()
@Stability(value=Stable)
public void setAvailabilityZoneRelocation(@Nullable
Boolean value)
@Stability(value=Stable)
public void setAvailabilityZoneRelocation(@Nullable
IResolvable value)
@Stability(value=Stable) @Nullable public String getAvailabilityZoneRelocationStatus()
@Stability(value=Stable)
public void setAvailabilityZoneRelocationStatus(@Nullable
String value)
@Stability(value=Stable) @Nullable public Object getClassic()
If you don't provide this parameter or set the value to false , the resize type is elastic.
@Stability(value=Stable)
public void setClassic(@Nullable
Boolean value)
If you don't provide this parameter or set the value to false , the resize type is elastic.
@Stability(value=Stable)
public void setClassic(@Nullable
IResolvable value)
If you don't provide this parameter or set the value to false , the resize type is elastic.
@Stability(value=Stable) @Nullable public String getClusterIdentifier()
You use this identifier to refer to the cluster for any subsequent cluster operations such as deleting or modifying. The identifier also appears in the Amazon Redshift console.
Constraints:
Example: myexamplecluster
@Stability(value=Stable)
public void setClusterIdentifier(@Nullable
String value)
You use this identifier to refer to the cluster for any subsequent cluster operations such as deleting or modifying. The identifier also appears in the Amazon Redshift console.
Constraints:
Example: myexamplecluster
@Stability(value=Stable) @Nullable public String getClusterParameterGroupName()
Default: The default Amazon Redshift cluster parameter group. For information about the default parameter group, go to Working with Amazon Redshift Parameter Groups
Constraints:
@Stability(value=Stable)
public void setClusterParameterGroupName(@Nullable
String value)
Default: The default Amazon Redshift cluster parameter group. For information about the default parameter group, go to Working with Amazon Redshift Parameter Groups
Constraints:
@Stability(value=Stable) @Nullable public List<String> getClusterSecurityGroups()
Default: The default cluster security group for Amazon Redshift.
@Stability(value=Stable)
public void setClusterSecurityGroups(@Nullable
List<String> value)
Default: The default cluster security group for Amazon Redshift.
@Stability(value=Stable) @Nullable public String getClusterSubnetGroupName()
If this parameter is not provided the resulting cluster will be deployed outside virtual private cloud (VPC).
@Stability(value=Stable)
public void setClusterSubnetGroupName(@Nullable
String value)
If this parameter is not provided the resulting cluster will be deployed outside virtual private cloud (VPC).
@Stability(value=Stable) @Nullable public String getClusterVersion()
The version selected runs on all the nodes in the cluster.
Constraints: Only version 1.0 is currently available.
Example: 1.0
@Stability(value=Stable)
public void setClusterVersion(@Nullable
String value)
The version selected runs on all the nodes in the cluster.
Constraints: Only version 1.0 is currently available.
Example: 1.0
@Stability(value=Stable) @Nullable public Object getDeferMaintenance()
@Stability(value=Stable)
public void setDeferMaintenance(@Nullable
Boolean value)
@Stability(value=Stable)
public void setDeferMaintenance(@Nullable
IResolvable value)
@Stability(value=Stable) @Nullable public Number getDeferMaintenanceDuration()
@Stability(value=Stable)
public void setDeferMaintenanceDuration(@Nullable
Number value)
@Stability(value=Stable) @Nullable public String getDeferMaintenanceEndTime()
@Stability(value=Stable)
public void setDeferMaintenanceEndTime(@Nullable
String value)
@Stability(value=Stable) @Nullable public String getDeferMaintenanceStartTime()
@Stability(value=Stable)
public void setDeferMaintenanceStartTime(@Nullable
String value)
@Stability(value=Stable) @Nullable public String getDestinationRegion()
@Stability(value=Stable)
public void setDestinationRegion(@Nullable
String value)
@Stability(value=Stable) @Nullable public String getElasticIp()
Constraints: The cluster must be provisioned in EC2-VPC and publicly-accessible through an Internet gateway. For more information about provisioning clusters in EC2-VPC, go to Supported Platforms to Launch Your Cluster in the Amazon Redshift Cluster Management Guide.
@Stability(value=Stable)
public void setElasticIp(@Nullable
String value)
Constraints: The cluster must be provisioned in EC2-VPC and publicly-accessible through an Internet gateway. For more information about provisioning clusters in EC2-VPC, go to Supported Platforms to Launch Your Cluster in the Amazon Redshift Cluster Management Guide.
@Stability(value=Stable) @Nullable public Object getEncrypted()
Default: false
@Stability(value=Stable)
public void setEncrypted(@Nullable
Boolean value)
Default: false
@Stability(value=Stable)
public void setEncrypted(@Nullable
IResolvable value)
Default: false
@Stability(value=Stable) @Nullable public Object getEnhancedVpcRouting()
To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.
If this option is true , enhanced VPC routing is enabled.
Default: false
@Stability(value=Stable)
public void setEnhancedVpcRouting(@Nullable
Boolean value)
To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.
If this option is true , enhanced VPC routing is enabled.
Default: false
@Stability(value=Stable)
public void setEnhancedVpcRouting(@Nullable
IResolvable value)
To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.
If this option is true , enhanced VPC routing is enabled.
Default: false
@Stability(value=Stable) @Nullable public String getHsmClientCertificateIdentifier()
@Stability(value=Stable)
public void setHsmClientCertificateIdentifier(@Nullable
String value)
@Stability(value=Stable) @Nullable public String getHsmConfigurationIdentifier()
@Stability(value=Stable)
public void setHsmConfigurationIdentifier(@Nullable
String value)
@Stability(value=Stable) @Nullable public List<String> getIamRoles()
You must supply the IAM roles in their Amazon Resource Name (ARN) format. You can supply up to 10 IAM roles in a single request.
A cluster can have up to 10 IAM roles associated with it at any time.
@Stability(value=Stable)
public void setIamRoles(@Nullable
List<String> value)
You must supply the IAM roles in their Amazon Resource Name (ARN) format. You can supply up to 10 IAM roles in a single request.
A cluster can have up to 10 IAM roles associated with it at any time.
@Stability(value=Stable) @Nullable public String getKmsKeyId()
@Stability(value=Stable)
public void setKmsKeyId(@Nullable
String value)
@Stability(value=Stable) @Nullable public Object getLoggingProperties()
@Stability(value=Stable)
public void setLoggingProperties(@Nullable
IResolvable value)
@Stability(value=Stable)
public void setLoggingProperties(@Nullable
CfnCluster.LoggingPropertiesProperty value)
@Stability(value=Stable) @Nullable public String getMaintenanceTrackName()
If you don't provide a maintenance track name, the cluster is assigned to the current track.
@Stability(value=Stable)
public void setMaintenanceTrackName(@Nullable
String value)
If you don't provide a maintenance track name, the cluster is assigned to the current track.
@Stability(value=Stable) @Nullable public Number getManualSnapshotRetentionPeriod()
If the value is -1, the snapshot is retained indefinitely. This setting doesn't change the retention period of existing snapshots.
The value must be either -1 or an integer between 1 and 3,653.
@Stability(value=Stable)
public void setManualSnapshotRetentionPeriod(@Nullable
Number value)
If the value is -1, the snapshot is retained indefinitely. This setting doesn't change the retention period of existing snapshots.
The value must be either -1 or an integer between 1 and 3,653.
@Stability(value=Stable) @Nullable public Number getNumberOfNodes()
This parameter is required when the ClusterType parameter is specified as multi-node .
For information about determining how many nodes you need, go to Working with Clusters in the Amazon Redshift Cluster Management Guide .
If you don't specify this parameter, you get a single-node cluster. When requesting a multi-node cluster, you must specify the number of nodes that you want in the cluster.
Default: 1
Constraints: Value must be at least 1 and no more than 100.
@Stability(value=Stable)
public void setNumberOfNodes(@Nullable
Number value)
This parameter is required when the ClusterType parameter is specified as multi-node .
For information about determining how many nodes you need, go to Working with Clusters in the Amazon Redshift Cluster Management Guide .
If you don't specify this parameter, you get a single-node cluster. When requesting a multi-node cluster, you must specify the number of nodes that you want in the cluster.
Default: 1
Constraints: Value must be at least 1 and no more than 100.
@Stability(value=Stable) @Nullable public String getOwnerAccount()
Required if you are restoring a snapshot you do not own, optional if you own the snapshot.
@Stability(value=Stable)
public void setOwnerAccount(@Nullable
String value)
Required if you are restoring a snapshot you do not own, optional if you own the snapshot.
@Stability(value=Stable) @Nullable public Number getPort()
The cluster is accessible only via the JDBC and ODBC connection strings. Part of the connection string requires the port on which the cluster will listen for incoming connections.
Default: 5439
Valid Values: 1150-65535
@Stability(value=Stable)
public void setPort(@Nullable
Number value)
The cluster is accessible only via the JDBC and ODBC connection strings. Part of the connection string requires the port on which the cluster will listen for incoming connections.
Default: 5439
Valid Values: 1150-65535
@Stability(value=Stable) @Nullable public String getPreferredMaintenanceWindow()
Format: ddd:hh24:mi-ddd:hh24:mi
Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. For more information about the time blocks for each region, see Maintenance Windows in Amazon Redshift Cluster Management Guide.
Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun
Constraints: Minimum 30-minute window.
@Stability(value=Stable)
public void setPreferredMaintenanceWindow(@Nullable
String value)
Format: ddd:hh24:mi-ddd:hh24:mi
Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. For more information about the time blocks for each region, see Maintenance Windows in Amazon Redshift Cluster Management Guide.
Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun
Constraints: Minimum 30-minute window.
@Stability(value=Stable) @Nullable public Object getPubliclyAccessible()
@Stability(value=Stable)
public void setPubliclyAccessible(@Nullable
Boolean value)
@Stability(value=Stable)
public void setPubliclyAccessible(@Nullable
IResolvable value)
@Stability(value=Stable) @Nullable public String getResourceAction()
@Stability(value=Stable)
public void setResourceAction(@Nullable
String value)
@Stability(value=Stable) @Nullable public String getRevisionTarget()
@Stability(value=Stable)
public void setRevisionTarget(@Nullable
String value)
@Stability(value=Stable) @Nullable public Object getRotateEncryptionKey()
@Stability(value=Stable)
public void setRotateEncryptionKey(@Nullable
Boolean value)
@Stability(value=Stable)
public void setRotateEncryptionKey(@Nullable
IResolvable value)
@Stability(value=Stable) @Nullable public String getSnapshotClusterIdentifier()
This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name.
@Stability(value=Stable)
public void setSnapshotClusterIdentifier(@Nullable
String value)
This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name.
@Stability(value=Stable) @Nullable public String getSnapshotCopyGrantName()
@Stability(value=Stable)
public void setSnapshotCopyGrantName(@Nullable
String value)
@Stability(value=Stable) @Nullable public Object getSnapshotCopyManual()
@Stability(value=Stable)
public void setSnapshotCopyManual(@Nullable
Boolean value)
@Stability(value=Stable)
public void setSnapshotCopyManual(@Nullable
IResolvable value)
@Stability(value=Stable) @Nullable public Number getSnapshotCopyRetentionPeriod()
@Stability(value=Stable)
public void setSnapshotCopyRetentionPeriod(@Nullable
Number value)
@Stability(value=Stable) @Nullable public String getSnapshotIdentifier()
Example: my-snapshot-id
@Stability(value=Stable)
public void setSnapshotIdentifier(@Nullable
String value)
Example: my-snapshot-id
@Stability(value=Stable) @Nullable public List<String> getVpcSecurityGroupIds()
Default: The default VPC security group is associated with the cluster.
Copyright © 2022. All rights reserved.