Package 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:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:42.747Z") @Stability(Stable) public class CfnCluster extends CfnResource implements IInspectable
A CloudFormation AWS::Redshift::Cluster.

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();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnCluster

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

    • CfnCluster

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

    • CfnCluster

      @Stability(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 Details

    • inspect

      @Stability(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(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrDeferMaintenanceIdentifier

      @Stability(Stable) @NotNull public String getAttrDeferMaintenanceIdentifier()
      A unique identifier for the maintenance window.

    • getAttrEndpointAddress

      @Stability(Stable) @NotNull public String getAttrEndpointAddress()
      The connection endpoint for the Amazon Redshift cluster.

      For example: examplecluster.cg034hpkmmjt.us-east-1.redshift.amazonaws.com .

    • getAttrEndpointPort

      @Stability(Stable) @NotNull public String getAttrEndpointPort()
      The port number on which the Amazon Redshift cluster accepts connections.

      For example: 5439 .

    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()
      A unique identifier for the cluster.

      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

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      A list of tag instances.

    • getClusterType

      @Stability(Stable) @NotNull public String getClusterType()
      The type of the cluster. When cluster type is specified as.

      • single-node , the NumberOfNodes parameter is not required.
      • multi-node , the NumberOfNodes parameter is required.

      Valid Values: multi-node | single-node

      Default: multi-node

    • setClusterType

      @Stability(Stable) public void setClusterType(@NotNull String value)
      The type of the cluster. When cluster type is specified as.

      • single-node , the NumberOfNodes parameter is not required.
      • multi-node , the NumberOfNodes parameter is required.

      Valid Values: multi-node | single-node

      Default: multi-node

    • getDbName

      @Stability(Stable) @NotNull public String getDbName()
      The name of the first database to be created when the cluster is created.

      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:

      • Must contain 1 to 64 alphanumeric characters.
      • Must contain only lowercase letters.
      • Cannot be a word that is reserved by the service. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.

    • setDbName

      @Stability(Stable) public void setDbName(@NotNull String value)
      The name of the first database to be created when the cluster is created.

      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:

      • Must contain 1 to 64 alphanumeric characters.
      • Must contain only lowercase letters.
      • Cannot be a word that is reserved by the service. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.

    • getMasterUsername

      @Stability(Stable) @NotNull public String getMasterUsername()
      The user name associated with the admin user for the cluster that is being created.

      Constraints:

      • Must be 1 - 128 alphanumeric characters or hyphens. The user name can't be PUBLIC .
      • Must contain only lowercase letters, numbers, underscore, plus sign, period (dot), at symbol (@), or hyphen.
      • The first character must be a letter.
      • Must not contain a colon (:) or a slash (/).
      • Cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.

    • setMasterUsername

      @Stability(Stable) public void setMasterUsername(@NotNull String value)
      The user name associated with the admin user for the cluster that is being created.

      Constraints:

      • Must be 1 - 128 alphanumeric characters or hyphens. The user name can't be PUBLIC .
      • Must contain only lowercase letters, numbers, underscore, plus sign, period (dot), at symbol (@), or hyphen.
      • The first character must be a letter.
      • Must not contain a colon (:) or a slash (/).
      • Cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.

    • getMasterUserPassword

      @Stability(Stable) @NotNull public String getMasterUserPassword()
      The password associated with the admin user for the cluster that is being created.

      Constraints:

      • Must be between 8 and 64 characters in length.
      • Must contain at least one uppercase letter.
      • Must contain at least one lowercase letter.
      • Must contain one number.
      • Can be any printable ASCII character (ASCII code 33-126) except ' (single quote), " (double quote), \ , / , or @ .

    • setMasterUserPassword

      @Stability(Stable) public void setMasterUserPassword(@NotNull String value)
      The password associated with the admin user for the cluster that is being created.

      Constraints:

      • Must be between 8 and 64 characters in length.
      • Must contain at least one uppercase letter.
      • Must contain at least one lowercase letter.
      • Must contain one number.
      • Can be any printable ASCII character (ASCII code 33-126) except ' (single quote), " (double quote), \ , / , or @ .

    • getNodeType

      @Stability(Stable) @NotNull public String getNodeType()
      The node type to be provisioned for the cluster.

      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

    • setNodeType

      @Stability(Stable) public void setNodeType(@NotNull String value)
      The node type to be provisioned for the cluster.

      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

    • getAllowVersionUpgrade

      @Stability(Stable) @Nullable public 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.

      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

    • setAllowVersionUpgrade

      @Stability(Stable) public void setAllowVersionUpgrade(@Nullable 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.

      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

    • setAllowVersionUpgrade

      @Stability(Stable) public void setAllowVersionUpgrade(@Nullable 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.

      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

    • getAquaConfigurationStatus

      @Stability(Stable) @Nullable public String getAquaConfigurationStatus()
      This parameter is retired.

      It does not set the AQUA configuration status. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).

    • setAquaConfigurationStatus

      @Stability(Stable) public void setAquaConfigurationStatus(@Nullable String value)
      This parameter is retired.

      It does not set the AQUA configuration status. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).

    • getAutomatedSnapshotRetentionPeriod

      @Stability(Stable) @Nullable public Number getAutomatedSnapshotRetentionPeriod()
      The number of days that automated snapshots are retained.

      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.

    • setAutomatedSnapshotRetentionPeriod

      @Stability(Stable) public void setAutomatedSnapshotRetentionPeriod(@Nullable Number value)
      The number of days that automated snapshots are retained.

      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.

    • getAvailabilityZone

      @Stability(Stable) @Nullable public String getAvailabilityZone()
      The EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the cluster.

      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.

    • setAvailabilityZone

      @Stability(Stable) public void setAvailabilityZone(@Nullable String value)
      The EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the cluster.

      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.

    • getAvailabilityZoneRelocation

      @Stability(Stable) @Nullable public Object getAvailabilityZoneRelocation()
      The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster is created.

    • setAvailabilityZoneRelocation

      @Stability(Stable) public void setAvailabilityZoneRelocation(@Nullable Boolean value)
      The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster is created.

    • setAvailabilityZoneRelocation

      @Stability(Stable) public void setAvailabilityZoneRelocation(@Nullable IResolvable value)
      The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster is created.

    • getAvailabilityZoneRelocationStatus

      @Stability(Stable) @Nullable public String getAvailabilityZoneRelocationStatus()
      Describes the status of the Availability Zone relocation operation.

    • setAvailabilityZoneRelocationStatus

      @Stability(Stable) public void setAvailabilityZoneRelocationStatus(@Nullable String value)
      Describes the status of the Availability Zone relocation operation.

    • getClassic

      @Stability(Stable) @Nullable public Object getClassic()
      A boolean value indicating whether the resize operation is using the classic resize process.

      If you don't provide this parameter or set the value to false , the resize type is elastic.

    • setClassic

      @Stability(Stable) public void setClassic(@Nullable Boolean value)
      A boolean value indicating whether the resize operation is using the classic resize process.

      If you don't provide this parameter or set the value to false , the resize type is elastic.

    • setClassic

      @Stability(Stable) public void setClassic(@Nullable IResolvable value)
      A boolean value indicating whether the resize operation is using the classic resize process.

      If you don't provide this parameter or set the value to false , the resize type is elastic.

    • getClusterIdentifier

      @Stability(Stable) @Nullable public String getClusterIdentifier()
      A unique identifier for the cluster.

      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:

      • Must contain from 1 to 63 alphanumeric characters or hyphens.
      • Alphabetic characters must be lowercase.
      • First character must be a letter.
      • Cannot end with a hyphen or contain two consecutive hyphens.
      • Must be unique for all clusters within an AWS account .

      Example: myexamplecluster

    • setClusterIdentifier

      @Stability(Stable) public void setClusterIdentifier(@Nullable String value)
      A unique identifier for the cluster.

      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:

      • Must contain from 1 to 63 alphanumeric characters or hyphens.
      • Alphabetic characters must be lowercase.
      • First character must be a letter.
      • Cannot end with a hyphen or contain two consecutive hyphens.
      • Must be unique for all clusters within an AWS account .

      Example: myexamplecluster

    • getClusterParameterGroupName

      @Stability(Stable) @Nullable public String getClusterParameterGroupName()
      The name of the parameter group to be associated with this cluster.

      Default: The default Amazon Redshift cluster parameter group. For information about the default parameter group, go to Working with Amazon Redshift Parameter Groups

      Constraints:

      • Must be 1 to 255 alphanumeric characters or hyphens.
      • First character must be a letter.
      • Cannot end with a hyphen or contain two consecutive hyphens.

    • setClusterParameterGroupName

      @Stability(Stable) public void setClusterParameterGroupName(@Nullable String value)
      The name of the parameter group to be associated with this cluster.

      Default: The default Amazon Redshift cluster parameter group. For information about the default parameter group, go to Working with Amazon Redshift Parameter Groups

      Constraints:

      • Must be 1 to 255 alphanumeric characters or hyphens.
      • First character must be a letter.
      • Cannot end with a hyphen or contain two consecutive hyphens.

    • getClusterSecurityGroups

      @Stability(Stable) @Nullable public List<String> getClusterSecurityGroups()
      A list of security groups to be associated with this cluster.

      Default: The default cluster security group for Amazon Redshift.

    • setClusterSecurityGroups

      @Stability(Stable) public void setClusterSecurityGroups(@Nullable List<String> value)
      A list of security groups to be associated with this cluster.

      Default: The default cluster security group for Amazon Redshift.

    • getClusterSubnetGroupName

      @Stability(Stable) @Nullable public String getClusterSubnetGroupName()
      The name of a cluster subnet group to be associated with this cluster.

      If this parameter is not provided the resulting cluster will be deployed outside virtual private cloud (VPC).

    • setClusterSubnetGroupName

      @Stability(Stable) public void setClusterSubnetGroupName(@Nullable String value)
      The name of a cluster subnet group to be associated with this cluster.

      If this parameter is not provided the resulting cluster will be deployed outside virtual private cloud (VPC).

    • getClusterVersion

      @Stability(Stable) @Nullable public String getClusterVersion()
      The version of the Amazon Redshift engine software that you want to deploy on the cluster.

      The version selected runs on all the nodes in the cluster.

      Constraints: Only version 1.0 is currently available.

      Example: 1.0

    • setClusterVersion

      @Stability(Stable) public void setClusterVersion(@Nullable String value)
      The version of the Amazon Redshift engine software that you want to deploy on the cluster.

      The version selected runs on all the nodes in the cluster.

      Constraints: Only version 1.0 is currently available.

      Example: 1.0

    • getDeferMaintenance

      @Stability(Stable) @Nullable public Object getDeferMaintenance()
      A Boolean indicating whether to enable the deferred maintenance window.

    • setDeferMaintenance

      @Stability(Stable) public void setDeferMaintenance(@Nullable Boolean value)
      A Boolean indicating whether to enable the deferred maintenance window.

    • setDeferMaintenance

      @Stability(Stable) public void setDeferMaintenance(@Nullable IResolvable value)
      A Boolean indicating whether to enable the deferred maintenance window.

    • getDeferMaintenanceDuration

      @Stability(Stable) @Nullable public Number getDeferMaintenanceDuration()
      An integer indicating the duration of the maintenance window in days.

      If you specify a duration, you can't specify an end time. The duration must be 45 days or less.

    • setDeferMaintenanceDuration

      @Stability(Stable) public void setDeferMaintenanceDuration(@Nullable Number value)
      An integer indicating the duration of the maintenance window in days.

      If you specify a duration, you can't specify an end time. The duration must be 45 days or less.

    • getDeferMaintenanceEndTime

      @Stability(Stable) @Nullable public String getDeferMaintenanceEndTime()
      A timestamp for the end of the time period when we defer maintenance.

    • setDeferMaintenanceEndTime

      @Stability(Stable) public void setDeferMaintenanceEndTime(@Nullable String value)
      A timestamp for the end of the time period when we defer maintenance.

    • getDeferMaintenanceStartTime

      @Stability(Stable) @Nullable public String getDeferMaintenanceStartTime()
      A timestamp indicating the start time for the deferred maintenance window.

    • setDeferMaintenanceStartTime

      @Stability(Stable) public void setDeferMaintenanceStartTime(@Nullable String value)
      A timestamp indicating the start time for the deferred maintenance window.

    • getDestinationRegion

      @Stability(Stable) @Nullable public String getDestinationRegion()
      The destination region that snapshots are automatically copied to when cross-region snapshot copy is enabled.

    • setDestinationRegion

      @Stability(Stable) public void setDestinationRegion(@Nullable String value)
      The destination region that snapshots are automatically copied to when cross-region snapshot copy is enabled.

    • getElasticIp

      @Stability(Stable) @Nullable public String getElasticIp()
      The Elastic IP (EIP) address for the cluster.

      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.

    • setElasticIp

      @Stability(Stable) public void setElasticIp(@Nullable String value)
      The Elastic IP (EIP) address for the cluster.

      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.

    • getEncrypted

      @Stability(Stable) @Nullable public Object getEncrypted()
      If true , the data in the cluster is encrypted at rest.

      Default: false

    • setEncrypted

      @Stability(Stable) public void setEncrypted(@Nullable Boolean value)
      If true , the data in the cluster is encrypted at rest.

      Default: false

    • setEncrypted

      @Stability(Stable) public void setEncrypted(@Nullable IResolvable value)
      If true , the data in the cluster is encrypted at rest.

      Default: false

    • getEndpoint

      @Stability(Stable) @Nullable public Object getEndpoint()
      The connection endpoint.

    • setEndpoint

      @Stability(Stable) public void setEndpoint(@Nullable IResolvable value)
      The connection endpoint.

    • setEndpoint

      @Stability(Stable) public void setEndpoint(@Nullable CfnCluster.EndpointProperty value)
      The connection endpoint.

    • getEnhancedVpcRouting

      @Stability(Stable) @Nullable public Object getEnhancedVpcRouting()
      An option that specifies whether to create the cluster with enhanced VPC routing enabled.

      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

    • setEnhancedVpcRouting

      @Stability(Stable) public void setEnhancedVpcRouting(@Nullable Boolean value)
      An option that specifies whether to create the cluster with enhanced VPC routing enabled.

      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

    • setEnhancedVpcRouting

      @Stability(Stable) public void setEnhancedVpcRouting(@Nullable IResolvable value)
      An option that specifies whether to create the cluster with enhanced VPC routing enabled.

      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

    • getHsmClientCertificateIdentifier

      @Stability(Stable) @Nullable public 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.

    • setHsmClientCertificateIdentifier

      @Stability(Stable) public void setHsmClientCertificateIdentifier(@Nullable 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.

    • getHsmConfigurationIdentifier

      @Stability(Stable) @Nullable public 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.

    • setHsmConfigurationIdentifier

      @Stability(Stable) public void setHsmConfigurationIdentifier(@Nullable 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.

    • getIamRoles

      @Stability(Stable) @Nullable public 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.

      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 .

    • setIamRoles

      @Stability(Stable) public void setIamRoles(@Nullable 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.

      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 .

    • getKmsKeyId

      @Stability(Stable) @Nullable public 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.

    • setKmsKeyId

      @Stability(Stable) public void setKmsKeyId(@Nullable 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.

    • getLoggingProperties

      @Stability(Stable) @Nullable public Object getLoggingProperties()
      Specifies logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.

    • setLoggingProperties

      @Stability(Stable) public void setLoggingProperties(@Nullable IResolvable value)
      Specifies logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.

    • setLoggingProperties

      @Stability(Stable) public void setLoggingProperties(@Nullable CfnCluster.LoggingPropertiesProperty value)
      Specifies logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.

    • getMaintenanceTrackName

      @Stability(Stable) @Nullable public String getMaintenanceTrackName()
      An optional parameter for the name of the maintenance track for the cluster.

      If you don't provide a maintenance track name, the cluster is assigned to the current track.

    • setMaintenanceTrackName

      @Stability(Stable) public void setMaintenanceTrackName(@Nullable String value)
      An optional parameter for the name of the maintenance track for the cluster.

      If you don't provide a maintenance track name, the cluster is assigned to the current track.

    • getManualSnapshotRetentionPeriod

      @Stability(Stable) @Nullable public Number getManualSnapshotRetentionPeriod()
      The default number of days to retain a manual snapshot.

      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.

    • setManualSnapshotRetentionPeriod

      @Stability(Stable) public void setManualSnapshotRetentionPeriod(@Nullable Number value)
      The default number of days to retain a manual snapshot.

      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.

    • getNumberOfNodes

      @Stability(Stable) @Nullable public Number getNumberOfNodes()
      The number of compute nodes in the cluster.

      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.

    • setNumberOfNodes

      @Stability(Stable) public void setNumberOfNodes(@Nullable Number value)
      The number of compute nodes in the cluster.

      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.

    • getOwnerAccount

      @Stability(Stable) @Nullable public String getOwnerAccount()
      The AWS account used to create or copy the snapshot.

      Required if you are restoring a snapshot you do not own, optional if you own the snapshot.

    • setOwnerAccount

      @Stability(Stable) public void setOwnerAccount(@Nullable String value)
      The AWS account used to create or copy the snapshot.

      Required if you are restoring a snapshot you do not own, optional if you own the snapshot.

    • getPort

      @Stability(Stable) @Nullable public Number getPort()
      The port number on which the cluster accepts incoming connections.

      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

    • setPort

      @Stability(Stable) public void setPort(@Nullable Number value)
      The port number on which the cluster accepts incoming connections.

      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

    • getPreferredMaintenanceWindow

      @Stability(Stable) @Nullable public String getPreferredMaintenanceWindow()
      The weekly time range (in UTC) during which automated cluster maintenance can occur.

      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.

    • setPreferredMaintenanceWindow

      @Stability(Stable) public void setPreferredMaintenanceWindow(@Nullable String value)
      The weekly time range (in UTC) during which automated cluster maintenance can occur.

      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.

    • getPubliclyAccessible

      @Stability(Stable) @Nullable public Object getPubliclyAccessible()
      If true , the cluster can be accessed from a public network.

    • setPubliclyAccessible

      @Stability(Stable) public void setPubliclyAccessible(@Nullable Boolean value)
      If true , the cluster can be accessed from a public network.

    • setPubliclyAccessible

      @Stability(Stable) public void setPubliclyAccessible(@Nullable IResolvable value)
      If true , the cluster can be accessed from a public network.

    • getResourceAction

      @Stability(Stable) @Nullable public String getResourceAction()
      The Amazon Redshift operation to be performed.

      Supported operations are pause-cluster and resume-cluster .

    • setResourceAction

      @Stability(Stable) public void setResourceAction(@Nullable String value)
      The Amazon Redshift operation to be performed.

      Supported operations are pause-cluster and resume-cluster .

    • getRevisionTarget

      @Stability(Stable) @Nullable public String getRevisionTarget()
      Describes a RevisionTarget object.

    • setRevisionTarget

      @Stability(Stable) public void setRevisionTarget(@Nullable String value)
      Describes a RevisionTarget object.

    • getRotateEncryptionKey

      @Stability(Stable) @Nullable public Object getRotateEncryptionKey()
      Rotates the encryption keys for a cluster.

    • setRotateEncryptionKey

      @Stability(Stable) public void setRotateEncryptionKey(@Nullable Boolean value)
      Rotates the encryption keys for a cluster.

    • setRotateEncryptionKey

      @Stability(Stable) public void setRotateEncryptionKey(@Nullable IResolvable value)
      Rotates the encryption keys for a cluster.

    • getSnapshotClusterIdentifier

      @Stability(Stable) @Nullable public String getSnapshotClusterIdentifier()
      The name of the cluster the source snapshot was created from.

      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.

    • setSnapshotClusterIdentifier

      @Stability(Stable) public void setSnapshotClusterIdentifier(@Nullable String value)
      The name of the cluster the source snapshot was created from.

      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.

    • getSnapshotCopyGrantName

      @Stability(Stable) @Nullable public String getSnapshotCopyGrantName()
      The name of the snapshot copy grant.

    • setSnapshotCopyGrantName

      @Stability(Stable) public void setSnapshotCopyGrantName(@Nullable String value)
      The name of the snapshot copy grant.

    • getSnapshotCopyManual

      @Stability(Stable) @Nullable public Object getSnapshotCopyManual()
      Indicates whether to apply the snapshot retention period to newly copied manual snapshots instead of automated snapshots.

    • setSnapshotCopyManual

      @Stability(Stable) public void setSnapshotCopyManual(@Nullable Boolean value)
      Indicates whether to apply the snapshot retention period to newly copied manual snapshots instead of automated snapshots.

    • setSnapshotCopyManual

      @Stability(Stable) public void setSnapshotCopyManual(@Nullable IResolvable value)
      Indicates whether to apply the snapshot retention period to newly copied manual snapshots instead of automated snapshots.

    • getSnapshotCopyRetentionPeriod

      @Stability(Stable) @Nullable public Number getSnapshotCopyRetentionPeriod()
      The number of days to retain automated snapshots in the destination AWS Region after they are copied from the source AWS Region .

      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.

    • setSnapshotCopyRetentionPeriod

      @Stability(Stable) public void setSnapshotCopyRetentionPeriod(@Nullable Number value)
      The number of days to retain automated snapshots in the destination AWS Region after they are copied from the source AWS Region .

      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.

    • getSnapshotIdentifier

      @Stability(Stable) @Nullable public String getSnapshotIdentifier()
      The name of the snapshot from which to create the new cluster.

      This parameter isn't case sensitive. You must specify this parameter or snapshotArn , but not both.

      Example: my-snapshot-id

    • setSnapshotIdentifier

      @Stability(Stable) public void setSnapshotIdentifier(@Nullable String value)
      The name of the snapshot from which to create the new cluster.

      This parameter isn't case sensitive. You must specify this parameter or snapshotArn , but not both.

      Example: my-snapshot-id

    • getVpcSecurityGroupIds

      @Stability(Stable) @Nullable public List<String> getVpcSecurityGroupIds()
      A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.

      Default: The default VPC security group is associated with the cluster.

    • setVpcSecurityGroupIds

      @Stability(Stable) public void setVpcSecurityGroupIds(@Nullable List<String> value)
      A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.

      Default: The default VPC security group is associated with the cluster.