CfnClusterProps

All Known Implementing Classes:: CfnClusterProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.63.2 (build a8a8833)",
           date="2022-08-17T17:31:17.358Z")
public interface CfnClusterProps

Properties for defining a `CfnCluster`.

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.*;
 CfnClusterProps cfnClusterProps = CfnClusterProps.builder()
         .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();

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static class`	`CfnClusterProps.Builder` A builder for `CfnClusterProps`
`static class`	`CfnClusterProps.Jsii$Proxy` An implementation for `CfnClusterProps`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`static CfnClusterProps.Builder`	`builder()`
`default 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.
`default java.lang.String`	`getAquaConfigurationStatus()` The value represents how the cluster is configured to use AQUA (Advanced Query Accelerator) when it is created.
`default java.lang.Number`	`getAutomatedSnapshotRetentionPeriod()` The number of days that automated snapshots are retained.
`default java.lang.String`	`getAvailabilityZone()` The EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the cluster.
`default java.lang.Object`	`getAvailabilityZoneRelocation()` The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster is created.
`default java.lang.String`	`getAvailabilityZoneRelocationStatus()` Describes the status of the Availability Zone relocation operation.
`default java.lang.Object`	`getClassic()` A boolean value indicating whether the resize operation is using the classic resize process.
`default java.lang.String`	`getClusterIdentifier()` A unique identifier for the cluster.
`default java.lang.String`	`getClusterParameterGroupName()` The name of the parameter group to be associated with this cluster.
`default java.util.List<java.lang.String>`	`getClusterSecurityGroups()` A list of security groups to be associated with this cluster.
`default 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.
`default 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.
`default java.lang.Object`	`getDeferMaintenance()` `AWS::Redshift::Cluster.DeferMaintenance`.
`default java.lang.Number`	`getDeferMaintenanceDuration()` `AWS::Redshift::Cluster.DeferMaintenanceDuration`.
`default java.lang.String`	`getDeferMaintenanceEndTime()` `AWS::Redshift::Cluster.DeferMaintenanceEndTime`.
`default java.lang.String`	`getDeferMaintenanceStartTime()` `AWS::Redshift::Cluster.DeferMaintenanceStartTime`.
`default java.lang.String`	`getDestinationRegion()` The destination region that snapshots are automatically copied to when cross-region snapshot copy is enabled.
`default java.lang.String`	`getElasticIp()` The Elastic IP (EIP) address for the cluster.
`default java.lang.Object`	`getEncrypted()` If `true` , the data in the cluster is encrypted at rest.
`default java.lang.Object`	`getEnhancedVpcRouting()` An option that specifies whether to create the cluster with enhanced VPC routing enabled.
`default 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.
`default 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.
`default 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.
`default 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.
`default java.lang.Object`	`getLoggingProperties()` Specifies logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.
`default java.lang.String`	`getMaintenanceTrackName()` An optional parameter for the name of the maintenance track for the cluster.
`default 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 account for the cluster that is being created.
`java.lang.String`	`getMasterUserPassword()` The password associated with the admin user account for the cluster that is being created.
`java.lang.String`	`getNodeType()` The node type to be provisioned for the cluster.
`default java.lang.Number`	`getNumberOfNodes()` The number of compute nodes in the cluster.
`default java.lang.String`	`getOwnerAccount()` The AWS account used to create or copy the snapshot.
`default java.lang.Number`	`getPort()` The port number on which the cluster accepts incoming connections.
`default java.lang.String`	`getPreferredMaintenanceWindow()` The weekly time range (in UTC) during which automated cluster maintenance can occur.
`default java.lang.Object`	`getPubliclyAccessible()` If `true` , the cluster can be accessed from a public network.
`default java.lang.String`	`getResourceAction()` `AWS::Redshift::Cluster.ResourceAction`.
`default java.lang.String`	`getRevisionTarget()` `AWS::Redshift::Cluster.RevisionTarget`.
`default java.lang.Object`	`getRotateEncryptionKey()` `AWS::Redshift::Cluster.RotateEncryptionKey`.
`default java.lang.String`	`getSnapshotClusterIdentifier()` The name of the cluster the source snapshot was created from.
`default java.lang.String`	`getSnapshotCopyGrantName()` The name of the snapshot copy grant.
`default java.lang.Object`	`getSnapshotCopyManual()` Indicates whether to apply the snapshot retention period to newly copied manual snapshots instead of automated snapshots.
`default 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 .
`default java.lang.String`	`getSnapshotIdentifier()` The name of the snapshot from which to create the new cluster.
`default java.util.List<CfnTag>`	`getTags()` A list of tag instances.
`default java.util.List<java.lang.String>`	`getVpcSecurityGroupIds()` A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.

- Method Detail
  - getClusterType
```
java.lang.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
  - getDbName
```
java.lang.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.
  - getMasterUsername
```
java.lang.String getMasterUsername()
```
    The user name associated with the admin user account for the cluster that is being created.
    Constraints:
    - Must be 1 - 128 alphanumeric characters. The user name can't be PUBLIC .
    - First character must be a letter.
    - Cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.
  - getMasterUserPassword
```
java.lang.String getMasterUserPassword()
```
    The password associated with the admin user account 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
```
java.lang.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
  - getAllowVersionUpgrade
```
default 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.
    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
```
default java.lang.String getAquaConfigurationStatus()
```
    The value represents how the cluster is configured to use AQUA (Advanced Query Accelerator) when it is created.
    Possible values include the following.
    - enabled - Use AQUA if it is available for the current AWS Region and Amazon Redshift node type.
    - disabled - Don't use AQUA.
    - auto - Amazon Redshift determines whether to use AQUA.
  - getAutomatedSnapshotRetentionPeriod
```
default java.lang.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.
  - getAvailabilityZone
```
default java.lang.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.
  - getAvailabilityZoneRelocation
```
default java.lang.Object getAvailabilityZoneRelocation()
```
    The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster is created.
  - getAvailabilityZoneRelocationStatus
```
default java.lang.String getAvailabilityZoneRelocationStatus()
```
    Describes the status of the Availability Zone relocation operation.
  - getClassic
```
default java.lang.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.
  - getClusterIdentifier
```
default java.lang.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
  - getClusterParameterGroupName
```
default java.lang.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.
  - getClusterSecurityGroups
```
default java.util.List<java.lang.String> getClusterSecurityGroups()
```
    A list of security groups to be associated with this cluster.
    Default: The default cluster security group for Amazon Redshift.
  - getClusterSubnetGroupName
```
default java.lang.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).
  - getClusterVersion
```
default java.lang.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
  - getDeferMaintenance
```
default java.lang.Object getDeferMaintenance()
```
    `AWS::Redshift::Cluster.DeferMaintenance`.
  - getDeferMaintenanceDuration
```
default java.lang.Number getDeferMaintenanceDuration()
```
    `AWS::Redshift::Cluster.DeferMaintenanceDuration`.
  - getDeferMaintenanceEndTime
```
default java.lang.String getDeferMaintenanceEndTime()
```
    `AWS::Redshift::Cluster.DeferMaintenanceEndTime`.
  - getDeferMaintenanceStartTime
```
default java.lang.String getDeferMaintenanceStartTime()
```
    `AWS::Redshift::Cluster.DeferMaintenanceStartTime`.
  - getDestinationRegion
```
default java.lang.String getDestinationRegion()
```
    The destination region that snapshots are automatically copied to when cross-region snapshot copy is enabled.
  - getElasticIp
```
default java.lang.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. 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
```
default java.lang.Object getEncrypted()
```
    If `true` , the data in the cluster is encrypted at rest.
    Default: false
  - getEnhancedVpcRouting
```
default java.lang.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
  - getHsmClientCertificateIdentifier
```
default 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.
  - getHsmConfigurationIdentifier
```
default 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.
  - getIamRoles
```
default 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.
    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
```
default 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.
  - getLoggingProperties
```
default java.lang.Object getLoggingProperties()
```
    Specifies logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.
  - getMaintenanceTrackName
```
default java.lang.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.
  - getManualSnapshotRetentionPeriod
```
default java.lang.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.
  - getNumberOfNodes
```
default java.lang.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.
  - getOwnerAccount
```
default java.lang.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.
  - getPort
```
default java.lang.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
  - getPreferredMaintenanceWindow
```
default java.lang.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.
  - getPubliclyAccessible
```
default java.lang.Object getPubliclyAccessible()
```
    If `true` , the cluster can be accessed from a public network.
  - getResourceAction
```
default java.lang.String getResourceAction()
```
    `AWS::Redshift::Cluster.ResourceAction`.
  - getRevisionTarget
```
default java.lang.String getRevisionTarget()
```
    `AWS::Redshift::Cluster.RevisionTarget`.
  - getRotateEncryptionKey
```
default java.lang.Object getRotateEncryptionKey()
```
    `AWS::Redshift::Cluster.RotateEncryptionKey`.
  - getSnapshotClusterIdentifier
```
default java.lang.String getSnapshotClusterIdentifier()
```
    The name of the cluster the source snapshot was created from.
    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.
  - getSnapshotCopyGrantName
```
default java.lang.String getSnapshotCopyGrantName()
```
    The name of the snapshot copy grant.
  - getSnapshotCopyManual
```
default java.lang.Object getSnapshotCopyManual()
```
    Indicates whether to apply the snapshot retention period to newly copied manual snapshots instead of automated snapshots.
  - getSnapshotCopyRetentionPeriod
```
default 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 .
    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
```
default java.lang.String getSnapshotIdentifier()
```
    The name of the snapshot from which to create the new cluster. This parameter isn't case sensitive.
    Example: my-snapshot-id
  - getTags
```
default java.util.List<CfnTag> getTags()
```
    A list of tag instances.
  - getVpcSecurityGroupIds
```
default java.util.List<java.lang.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.
  - builder
```
static CfnClusterProps.Builder builder()
```
    Returns:
    
    a CfnClusterProps.Builder of CfnClusterProps

Interface CfnClusterProps

Nested Class Summary

Method Summary

Method Detail

getClusterType

getDbName

getMasterUsername

getMasterUserPassword

getNodeType

getAllowVersionUpgrade

getAquaConfigurationStatus

getAutomatedSnapshotRetentionPeriod

getAvailabilityZone

getAvailabilityZoneRelocation

getAvailabilityZoneRelocationStatus

getClassic

getClusterIdentifier

getClusterParameterGroupName

getClusterSecurityGroups

getClusterSubnetGroupName

getClusterVersion

getDeferMaintenance

getDeferMaintenanceDuration

getDeferMaintenanceEndTime

getDeferMaintenanceStartTime

getDestinationRegion

getElasticIp

getEncrypted

getEnhancedVpcRouting

getHsmClientCertificateIdentifier

getHsmConfigurationIdentifier

getIamRoles

getKmsKeyId

getLoggingProperties

getMaintenanceTrackName

getManualSnapshotRetentionPeriod

getNumberOfNodes

getOwnerAccount

getPort

getPreferredMaintenanceWindow

getPubliclyAccessible

getResourceAction

getRevisionTarget

getRotateEncryptionKey

getSnapshotClusterIdentifier

getSnapshotCopyGrantName

getSnapshotCopyManual

getSnapshotCopyRetentionPeriod

getSnapshotIdentifier

getTags

getVpcSecurityGroupIds

builder