@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)", date="2023-03-14T16:25:31.474Z") 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) .endpoint(EndpointProperty.builder() .address("address") .port("port") .build()) .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.
|
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
Modifier | Constructor and Description |
---|---|
|
CfnCluster(Construct scope,
java.lang.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 |
---|---|
java.lang.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.
|
java.lang.String |
getAquaConfigurationStatus()
This parameter is retired.
|
java.lang.String |
getAttrDeferMaintenanceIdentifier()
A unique identifier for the maintenance window.
|
java.lang.String |
getAttrEndpointAddress()
The connection endpoint for the Amazon Redshift cluster.
|
java.lang.String |
getAttrEndpointPort()
The port number on which the Amazon Redshift cluster accepts connections.
|
java.lang.String |
getAttrId()
A unique identifier for the cluster.
|
java.lang.Number |
getAutomatedSnapshotRetentionPeriod()
The number of days that automated snapshots are retained.
|
java.lang.String |
getAvailabilityZone()
The EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the cluster.
|
java.lang.Object |
getAvailabilityZoneRelocation()
The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster is created.
|
java.lang.String |
getAvailabilityZoneRelocationStatus()
Describes the status of the Availability Zone relocation operation.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
getCfnProperties() |
java.lang.Object |
getClassic()
A boolean value indicating whether the resize operation is using the classic resize process.
|
java.lang.String |
getClusterIdentifier()
A unique identifier for the cluster.
|
java.lang.String |
getClusterParameterGroupName()
The name of the parameter group to be associated with this cluster.
|
java.util.List<java.lang.String> |
getClusterSecurityGroups()
A list of security groups to be associated with this cluster.
|
java.lang.String |
getClusterSubnetGroupName()
The name of a cluster subnet group to be associated with this cluster.
|
java.lang.String |
getClusterType()
The type of the cluster.
|
java.lang.String |
getClusterVersion()
The version of the Amazon Redshift engine software that you want to deploy on the cluster.
|
java.lang.String |
getDbName()
The name of the first database to be created when the cluster is created.
|
java.lang.Object |
getDeferMaintenance()
A Boolean indicating whether to enable the deferred maintenance window.
|
java.lang.Number |
getDeferMaintenanceDuration()
An integer indicating the duration of the maintenance window in days.
|
java.lang.String |
getDeferMaintenanceEndTime()
A timestamp for the end of the time period when we defer maintenance.
|
java.lang.String |
getDeferMaintenanceStartTime()
A timestamp indicating the start time for the deferred maintenance window.
|
java.lang.String |
getDestinationRegion()
The destination region that snapshots are automatically copied to when cross-region snapshot copy is enabled.
|
java.lang.String |
getElasticIp()
The Elastic IP (EIP) address for the cluster.
|
java.lang.Object |
getEncrypted()
If `true` , the data in the cluster is encrypted at rest.
|
java.lang.Object |
getEndpoint()
The connection endpoint.
|
java.lang.Object |
getEnhancedVpcRouting()
An option that specifies whether to create the cluster with enhanced VPC routing enabled.
|
java.lang.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.
|
java.lang.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.
|
java.util.List<java.lang.String> |
getIamRoles()
A list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services.
|
java.lang.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.
|
java.lang.Object |
getLoggingProperties()
Specifies logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.
|
java.lang.String |
getMaintenanceTrackName()
An optional parameter for the name of the maintenance track for the cluster.
|
java.lang.Number |
getManualSnapshotRetentionPeriod()
The default number of days to retain a manual snapshot.
|
java.lang.String |
getMasterUsername()
The user name associated with the admin user for the cluster that is being created.
|
java.lang.String |
getMasterUserPassword()
The password associated with the admin user for the cluster that is being created.
|
java.lang.String |
getNodeType()
The node type to be provisioned for the cluster.
|
java.lang.Number |
getNumberOfNodes()
The number of compute nodes in the cluster.
|
java.lang.String |
getOwnerAccount()
The AWS account used to create or copy the snapshot.
|
java.lang.Number |
getPort()
The port number on which the cluster accepts incoming connections.
|
java.lang.String |
getPreferredMaintenanceWindow()
The weekly time range (in UTC) during which automated cluster maintenance can occur.
|
java.lang.Object |
getPubliclyAccessible()
If `true` , the cluster can be accessed from a public network.
|
java.lang.String |
getResourceAction()
The Amazon Redshift operation to be performed.
|
java.lang.String |
getRevisionTarget()
Describes a `RevisionTarget` object.
|
java.lang.Object |
getRotateEncryptionKey()
Rotates the encryption keys for a cluster.
|
java.lang.String |
getSnapshotClusterIdentifier()
The name of the cluster the source snapshot was created from.
|
java.lang.String |
getSnapshotCopyGrantName()
The name of the snapshot copy grant.
|
java.lang.Object |
getSnapshotCopyManual()
Indicates whether to apply the snapshot retention period to newly copied manual snapshots instead of automated snapshots.
|
java.lang.Number |
getSnapshotCopyRetentionPeriod()
The number of days to retain automated snapshots in the destination AWS Region after they are copied from the source AWS Region .
|
java.lang.String |
getSnapshotIdentifier()
The name of the snapshot from which to create the new cluster.
|
TagManager |
getTags()
A list of tag instances.
|
java.util.List<java.lang.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 java.util.Map<java.lang.String,java.lang.Object> |
renderProperties(java.util.Map<java.lang.String,java.lang.Object> props) |
void |
setAllowVersionUpgrade(java.lang.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(java.lang.String value)
This parameter is retired.
|
void |
setAutomatedSnapshotRetentionPeriod(java.lang.Number value)
The number of days that automated snapshots are retained.
|
void |
setAvailabilityZone(java.lang.String value)
The EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the cluster.
|
void |
setAvailabilityZoneRelocation(java.lang.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(java.lang.String value)
Describes the status of the Availability Zone relocation operation.
|
void |
setClassic(java.lang.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(java.lang.String value)
A unique identifier for the cluster.
|
void |
setClusterParameterGroupName(java.lang.String value)
The name of the parameter group to be associated with this cluster.
|
void |
setClusterSecurityGroups(java.util.List<java.lang.String> value)
A list of security groups to be associated with this cluster.
|
void |
setClusterSubnetGroupName(java.lang.String value)
The name of a cluster subnet group to be associated with this cluster.
|
void |
setClusterType(java.lang.String value)
The type of the cluster.
|
void |
setClusterVersion(java.lang.String value)
The version of the Amazon Redshift engine software that you want to deploy on the cluster.
|
void |
setDbName(java.lang.String value)
The name of the first database to be created when the cluster is created.
|
void |
setDeferMaintenance(java.lang.Boolean value)
A Boolean indicating whether to enable the deferred maintenance window.
|
void |
setDeferMaintenance(IResolvable value)
A Boolean indicating whether to enable the deferred maintenance window.
|
void |
setDeferMaintenanceDuration(java.lang.Number value)
An integer indicating the duration of the maintenance window in days.
|
void |
setDeferMaintenanceEndTime(java.lang.String value)
A timestamp for the end of the time period when we defer maintenance.
|
void |
setDeferMaintenanceStartTime(java.lang.String value)
A timestamp indicating the start time for the deferred maintenance window.
|
void |
setDestinationRegion(java.lang.String value)
The destination region that snapshots are automatically copied to when cross-region snapshot copy is enabled.
|
void |
setElasticIp(java.lang.String value)
The Elastic IP (EIP) address for the cluster.
|
void |
setEncrypted(java.lang.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 |
setEndpoint(CfnCluster.EndpointProperty value)
The connection endpoint.
|
void |
setEndpoint(IResolvable value)
The connection endpoint.
|
void |
setEnhancedVpcRouting(java.lang.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(java.lang.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(java.lang.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(java.util.List<java.lang.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(java.lang.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(java.lang.String value)
An optional parameter for the name of the maintenance track for the cluster.
|
void |
setManualSnapshotRetentionPeriod(java.lang.Number value)
The default number of days to retain a manual snapshot.
|
void |
setMasterUsername(java.lang.String value)
The user name associated with the admin user for the cluster that is being created.
|
void |
setMasterUserPassword(java.lang.String value)
The password associated with the admin user for the cluster that is being created.
|
void |
setNodeType(java.lang.String value)
The node type to be provisioned for the cluster.
|
void |
setNumberOfNodes(java.lang.Number value)
The number of compute nodes in the cluster.
|
void |
setOwnerAccount(java.lang.String value)
The AWS account used to create or copy the snapshot.
|
void |
setPort(java.lang.Number value)
The port number on which the cluster accepts incoming connections.
|
void |
setPreferredMaintenanceWindow(java.lang.String value)
The weekly time range (in UTC) during which automated cluster maintenance can occur.
|
void |
setPubliclyAccessible(java.lang.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(java.lang.String value)
The Amazon Redshift operation to be performed.
|
void |
setRevisionTarget(java.lang.String value)
Describes a `RevisionTarget` object.
|
void |
setRotateEncryptionKey(java.lang.Boolean value)
Rotates the encryption keys for a cluster.
|
void |
setRotateEncryptionKey(IResolvable value)
Rotates the encryption keys for a cluster.
|
void |
setSnapshotClusterIdentifier(java.lang.String value)
The name of the cluster the source snapshot was created from.
|
void |
setSnapshotCopyGrantName(java.lang.String value)
The name of the snapshot copy grant.
|
void |
setSnapshotCopyManual(java.lang.Boolean value)
Indicates whether to apply the snapshot retention period to newly copied manual snapshots instead of automated snapshots.
|
void |
setSnapshotCopyManual(IResolvable value)
Indicates whether to apply the snapshot retention period to newly copied manual snapshots instead of automated snapshots.
|
void |
setSnapshotCopyRetentionPeriod(java.lang.Number value)
The number of days to retain automated snapshots in the destination AWS Region after they are copied from the source AWS Region .
|
void |
setSnapshotIdentifier(java.lang.String value)
The name of the snapshot from which to create the new cluster.
|
void |
setVpcSecurityGroupIds(java.util.List<java.lang.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, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnCluster(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnCluster(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnCluster(Construct scope, java.lang.String id, 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.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.public java.lang.String getAttrDeferMaintenanceIdentifier()
public java.lang.String getAttrEndpointAddress()
For example: examplecluster.cg034hpkmmjt.us-east-1.redshift.amazonaws.com
.
public java.lang.String getAttrEndpointPort()
For example: 5439
.
public java.lang.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
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public TagManager getTags()
public java.lang.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
public void setClusterType(java.lang.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
public java.lang.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:
public void setDbName(java.lang.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:
public java.lang.String getMasterUsername()
Constraints:
PUBLIC
.public void setMasterUsername(java.lang.String value)
Constraints:
PUBLIC
.public java.lang.String getMasterUserPassword()
Constraints:
'
(single quote), "
(double quote), \
, /
, or @
.public void setMasterUserPassword(java.lang.String value)
Constraints:
'
(single quote), "
(double quote), \
, /
, or @
.public java.lang.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
public void setNodeType(java.lang.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
public java.lang.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
public void setAllowVersionUpgrade(java.lang.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
public void setAllowVersionUpgrade(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
public java.lang.String getAquaConfigurationStatus()
It does not set the AQUA configuration status. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).
public void setAquaConfigurationStatus(java.lang.String value)
It does not set the AQUA configuration status. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).
public java.lang.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.
public void setAutomatedSnapshotRetentionPeriod(java.lang.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.
public java.lang.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.
public void setAvailabilityZone(java.lang.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.
public java.lang.Object getAvailabilityZoneRelocation()
public void setAvailabilityZoneRelocation(java.lang.Boolean value)
public void setAvailabilityZoneRelocation(IResolvable value)
public java.lang.String getAvailabilityZoneRelocationStatus()
public void setAvailabilityZoneRelocationStatus(java.lang.String value)
public java.lang.Object getClassic()
If you don't provide this parameter or set the value to false
, the resize type is elastic.
public void setClassic(java.lang.Boolean value)
If you don't provide this parameter or set the value to false
, the resize type is elastic.
public void setClassic(IResolvable value)
If you don't provide this parameter or set the value to false
, the resize type is elastic.
public java.lang.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
public void setClusterIdentifier(java.lang.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
public java.lang.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:
public void setClusterParameterGroupName(java.lang.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:
public java.util.List<java.lang.String> getClusterSecurityGroups()
Default: The default cluster security group for Amazon Redshift.
public void setClusterSecurityGroups(java.util.List<java.lang.String> value)
Default: The default cluster security group for Amazon Redshift.
public java.lang.String getClusterSubnetGroupName()
If this parameter is not provided the resulting cluster will be deployed outside virtual private cloud (VPC).
public void setClusterSubnetGroupName(java.lang.String value)
If this parameter is not provided the resulting cluster will be deployed outside virtual private cloud (VPC).
public java.lang.String getClusterVersion()
The version selected runs on all the nodes in the cluster.
Constraints: Only version 1.0 is currently available.
Example: 1.0
public void setClusterVersion(java.lang.String value)
The version selected runs on all the nodes in the cluster.
Constraints: Only version 1.0 is currently available.
Example: 1.0
public java.lang.Object getDeferMaintenance()
public void setDeferMaintenance(java.lang.Boolean value)
public void setDeferMaintenance(IResolvable value)
public java.lang.Number getDeferMaintenanceDuration()
If you specify a duration, you can't specify an end time. The duration must be 45 days or less.
public void setDeferMaintenanceDuration(java.lang.Number value)
If you specify a duration, you can't specify an end time. The duration must be 45 days or less.
public java.lang.String getDeferMaintenanceEndTime()
public void setDeferMaintenanceEndTime(java.lang.String value)
public java.lang.String getDeferMaintenanceStartTime()
public void setDeferMaintenanceStartTime(java.lang.String value)
public java.lang.String getDestinationRegion()
public void setDestinationRegion(java.lang.String value)
public java.lang.String getElasticIp()
Constraints: The cluster must be provisioned in EC2-VPC and publicly-accessible through an Internet gateway. Don't specify the Elastic IP address for a publicly accessible cluster with availability zone relocation turned on. For more information about provisioning clusters in EC2-VPC, go to Supported Platforms to Launch Your Cluster in the Amazon Redshift Cluster Management Guide.
public void setElasticIp(java.lang.String value)
Constraints: The cluster must be provisioned in EC2-VPC and publicly-accessible through an Internet gateway. Don't specify the Elastic IP address for a publicly accessible cluster with availability zone relocation turned on. For more information about provisioning clusters in EC2-VPC, go to Supported Platforms to Launch Your Cluster in the Amazon Redshift Cluster Management Guide.
public java.lang.Object getEncrypted()
Default: false
public void setEncrypted(java.lang.Boolean value)
Default: false
public void setEncrypted(IResolvable value)
Default: false
public java.lang.Object getEndpoint()
public void setEndpoint(IResolvable value)
public void setEndpoint(CfnCluster.EndpointProperty value)
public java.lang.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
public void setEnhancedVpcRouting(java.lang.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
public void setEnhancedVpcRouting(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
public java.lang.String getHsmClientCertificateIdentifier()
public void setHsmClientCertificateIdentifier(java.lang.String value)
public java.lang.String getHsmConfigurationIdentifier()
public void setHsmConfigurationIdentifier(java.lang.String value)
public java.util.List<java.lang.String> getIamRoles()
You must supply the IAM roles in their Amazon Resource Name (ARN) format.
The maximum number of IAM roles that you can associate is subject to a quota. For more information, go to Quotas and limits in the Amazon Redshift Cluster Management Guide .
public void setIamRoles(java.util.List<java.lang.String> value)
You must supply the IAM roles in their Amazon Resource Name (ARN) format.
The maximum number of IAM roles that you can associate is subject to a quota. For more information, go to Quotas and limits in the Amazon Redshift Cluster Management Guide .
public java.lang.String getKmsKeyId()
public void setKmsKeyId(java.lang.String value)
public java.lang.Object getLoggingProperties()
public void setLoggingProperties(IResolvable value)
public void setLoggingProperties(CfnCluster.LoggingPropertiesProperty value)
public java.lang.String getMaintenanceTrackName()
If you don't provide a maintenance track name, the cluster is assigned to the current
track.
public void setMaintenanceTrackName(java.lang.String value)
If you don't provide a maintenance track name, the cluster is assigned to the current
track.
public java.lang.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.
public void setManualSnapshotRetentionPeriod(java.lang.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.
public java.lang.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.
public void setNumberOfNodes(java.lang.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.
public java.lang.String getOwnerAccount()
Required if you are restoring a snapshot you do not own, optional if you own the snapshot.
public void setOwnerAccount(java.lang.String value)
Required if you are restoring a snapshot you do not own, optional if you own the snapshot.
public java.lang.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
public void setPort(java.lang.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
public java.lang.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.
public void setPreferredMaintenanceWindow(java.lang.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.
public java.lang.Object getPubliclyAccessible()
public void setPubliclyAccessible(java.lang.Boolean value)
public void setPubliclyAccessible(IResolvable value)
public java.lang.String getResourceAction()
Supported operations are pause-cluster
and resume-cluster
.
public void setResourceAction(java.lang.String value)
Supported operations are pause-cluster
and resume-cluster
.
public java.lang.String getRevisionTarget()
public void setRevisionTarget(java.lang.String value)
public java.lang.Object getRotateEncryptionKey()
public void setRotateEncryptionKey(java.lang.Boolean value)
public void setRotateEncryptionKey(IResolvable value)
public java.lang.String getSnapshotClusterIdentifier()
This parameter is required if your user or role has a policy containing a snapshot resource element that specifies anything other than * for the cluster name.
public void setSnapshotClusterIdentifier(java.lang.String value)
This parameter is required if your user or role has a policy containing a snapshot resource element that specifies anything other than * for the cluster name.
public java.lang.String getSnapshotCopyGrantName()
public void setSnapshotCopyGrantName(java.lang.String value)
public java.lang.Object getSnapshotCopyManual()
public void setSnapshotCopyManual(java.lang.Boolean value)
public void setSnapshotCopyManual(IResolvable value)
public java.lang.Number getSnapshotCopyRetentionPeriod()
By default, this only changes the retention period of copied automated snapshots.
If you decrease the retention period for automated snapshots that are copied to a destination AWS Region , Amazon Redshift deletes any existing automated snapshots that were copied to the destination AWS Region and that fall outside of the new retention period.
Constraints: Must be at least 1 and no more than 35 for automated snapshots.
If you specify the manual
option, only newly copied manual snapshots will have the new retention period.
If you specify the value of -1 newly copied manual snapshots are retained indefinitely.
Constraints: The number of days must be either -1 or an integer between 1 and 3,653 for manual snapshots.
public void setSnapshotCopyRetentionPeriod(java.lang.Number value)
By default, this only changes the retention period of copied automated snapshots.
If you decrease the retention period for automated snapshots that are copied to a destination AWS Region , Amazon Redshift deletes any existing automated snapshots that were copied to the destination AWS Region and that fall outside of the new retention period.
Constraints: Must be at least 1 and no more than 35 for automated snapshots.
If you specify the manual
option, only newly copied manual snapshots will have the new retention period.
If you specify the value of -1 newly copied manual snapshots are retained indefinitely.
Constraints: The number of days must be either -1 or an integer between 1 and 3,653 for manual snapshots.
public java.lang.String getSnapshotIdentifier()
This parameter isn't case sensitive. You must specify this parameter or snapshotArn
, but not both.
Example: my-snapshot-id
public void setSnapshotIdentifier(java.lang.String value)
This parameter isn't case sensitive. You must specify this parameter or snapshotArn
, but not both.
Example: my-snapshot-id
public java.util.List<java.lang.String> getVpcSecurityGroupIds()
Default: The default VPC security group is associated with the cluster.
public void setVpcSecurityGroupIds(java.util.List<java.lang.String> value)
Default: The default VPC security group is associated with the cluster.