interface CfnClusterProps

Language	Type name
.NET	`Amazon.CDK.AWS.Redshift.CfnClusterProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsredshift#CfnClusterProps`
Java	`software.amazon.awscdk.services.redshift.CfnClusterProps`
Python	`aws_cdk.aws_redshift.CfnClusterProps`
TypeScript	`aws-cdk-lib` » `aws_redshift` » `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 { aws_redshift as redshift } from 'aws-cdk-lib';

declare const namespaceResourcePolicy: any;
const cfnClusterProps: redshift.CfnClusterProps = {
  clusterType: 'clusterType',
  dbName: 'dbName',
  masterUsername: 'masterUsername',
  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: ['clusterSecurityGroups'],
  clusterSubnetGroupName: 'clusterSubnetGroupName',
  clusterVersion: 'clusterVersion',
  deferMaintenance: false,
  deferMaintenanceDuration: 123,
  deferMaintenanceEndTime: 'deferMaintenanceEndTime',
  deferMaintenanceStartTime: 'deferMaintenanceStartTime',
  destinationRegion: 'destinationRegion',
  elasticIp: 'elasticIp',
  encrypted: false,
  endpoint: {
    address: 'address',
    port: 'port',
  },
  enhancedVpcRouting: false,
  hsmClientCertificateIdentifier: 'hsmClientCertificateIdentifier',
  hsmConfigurationIdentifier: 'hsmConfigurationIdentifier',
  iamRoles: ['iamRoles'],
  kmsKeyId: 'kmsKeyId',
  loggingProperties: {
    bucketName: 'bucketName',
    logDestinationType: 'logDestinationType',
    logExports: ['logExports'],
    s3KeyPrefix: 's3KeyPrefix',
  },
  maintenanceTrackName: 'maintenanceTrackName',
  manageMasterPassword: false,
  manualSnapshotRetentionPeriod: 123,
  masterPasswordSecretKmsKeyId: 'masterPasswordSecretKmsKeyId',
  masterUserPassword: 'masterUserPassword',
  multiAz: false,
  namespaceResourcePolicy: namespaceResourcePolicy,
  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: [{
    key: 'key',
    value: 'value',
  }],
  vpcSecurityGroupIds: ['vpcSecurityGroupIds'],
};

Properties

Name	Type	Description
clusterType	`string`	The type of the cluster. When cluster type is specified as.
dbName	`string`	The name of the first database to be created when the cluster is created.
masterUsername	`string`	The user name associated with the admin user account for the cluster that is being created.
nodeType	`string`	The node type to be provisioned for the cluster.
allowVersionUpgrade?	`boolean \|` `IResolvable`	If `true` , major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster.
aquaConfigurationStatus?	`string`	This parameter is retired.
automatedSnapshotRetentionPeriod?	`number`	The number of days that automated snapshots are retained.
availabilityZone?	`string`	The EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the cluster.
availabilityZoneRelocation?	`boolean \|` `IResolvable`	The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster is created.
availabilityZoneRelocationStatus?	`string`	Describes the status of the Availability Zone relocation operation.
classic?	`boolean \|` `IResolvable`	A boolean value indicating whether the resize operation is using the classic resize process.
clusterIdentifier?	`string`	A unique identifier for the cluster.
clusterParameterGroupName?	`string`	The name of the parameter group to be associated with this cluster.
clusterSecurityGroups?	`string[]`	A list of security groups to be associated with this cluster.
clusterSubnetGroupName?	`string`	The name of a cluster subnet group to be associated with this cluster.
clusterVersion?	`string`	The version of the Amazon Redshift engine software that you want to deploy on the cluster.
deferMaintenance?	`boolean \|` `IResolvable`	A Boolean indicating whether to enable the deferred maintenance window.
deferMaintenanceDuration?	`number`	An integer indicating the duration of the maintenance window in days.
deferMaintenanceEndTime?	`string`	A timestamp for the end of the time period when we defer maintenance.
deferMaintenanceStartTime?	`string`	A timestamp indicating the start time for the deferred maintenance window.
destinationRegion?	`string`	The destination region that snapshots are automatically copied to when cross-region snapshot copy is enabled.
elasticIp?	`string`	The Elastic IP (EIP) address for the cluster.
encrypted?	`boolean \|` `IResolvable`	If `true` , the data in the cluster is encrypted at rest.
endpoint?	`IResolvable` `\|` `EndpointProperty`	The connection endpoint.
enhancedVpcRouting?	`boolean \|` `IResolvable`	An option that specifies whether to create the cluster with enhanced VPC routing enabled.
hsmClientCertificateIdentifier?	`string`	Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.
hsmConfigurationIdentifier?	`string`	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.
iamRoles?	`string[]`	A list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services.
kmsKeyId?	`string`	The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster.
loggingProperties?	`IResolvable` `\|` `LoggingPropertiesProperty`	Specifies logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.
maintenanceTrackName?	`string`	An optional parameter for the name of the maintenance track for the cluster.
manageMasterPassword?	`boolean \|` `IResolvable`	If `true` , Amazon Redshift uses AWS Secrets Manager to manage this cluster's admin credentials.
manualSnapshotRetentionPeriod?	`number`	The default number of days to retain a manual snapshot.
masterPasswordSecretKmsKeyId?	`string`	The ID of the AWS Key Management Service (KMS) key used to encrypt and store the cluster's admin credentials secret.
masterUserPassword?	`string`	The password associated with the admin user account for the cluster that is being created.
multiAz?	`boolean \|` `IResolvable`	A boolean indicating whether Amazon Redshift should deploy the cluster in two Availability Zones.
namespaceResourcePolicy?	`any`	The policy that is attached to a resource.
numberOfNodes?	`number`	The number of compute nodes in the cluster.
ownerAccount?	`string`	The AWS account used to create or copy the snapshot.
port?	`number`	The port number on which the cluster accepts incoming connections.
preferredMaintenanceWindow?	`string`	The weekly time range (in UTC) during which automated cluster maintenance can occur.
publiclyAccessible?	`boolean \|` `IResolvable`	If `true` , the cluster can be accessed from a public network.
resourceAction?	`string`	The Amazon Redshift operation to be performed.
revisionTarget?	`string`	Describes a `RevisionTarget` object.
rotateEncryptionKey?	`boolean \|` `IResolvable`	Rotates the encryption keys for a cluster.
snapshotClusterIdentifier?	`string`	The name of the cluster the source snapshot was created from.
snapshotCopyGrantName?	`string`	The name of the snapshot copy grant.
snapshotCopyManual?	`boolean \|` `IResolvable`	Indicates whether to apply the snapshot retention period to newly copied manual snapshots instead of automated snapshots.
snapshotCopyRetentionPeriod?	`number`	The number of days to retain automated snapshots in the destination AWS Region after they are copied from the source AWS Region .
snapshotIdentifier?	`string`	The name of the snapshot from which to create the new cluster.
tags?	`CfnTag[]`	A list of tag instances.
vpcSecurityGroupIds?	`string[]`	A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.

clusterType

Type: string

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

dbName

Type: string

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.

masterUsername

Type: string

The user name associated with the admin user account 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.

nodeType

Type: string

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 .

allowVersionUpgrade?

Type: boolean | IResolvable (optional)

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

aquaConfigurationStatus?

Type: string (optional)

This parameter is retired.

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

automatedSnapshotRetentionPeriod?

Type: number (optional)

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.

availabilityZone?

Type: string (optional)

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.

availabilityZoneRelocation?

Type: boolean | IResolvable (optional)

The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster is created.

availabilityZoneRelocationStatus?

Type: string (optional)

Describes the status of the Availability Zone relocation operation.

classic?

Type: boolean | IResolvable (optional)

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.

clusterIdentifier?

Type: string (optional)

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

clusterParameterGroupName?

Type: string (optional)

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.

clusterSecurityGroups?

Type: string[] (optional)

A list of security groups to be associated with this cluster.

Default: The default cluster security group for Amazon Redshift.

clusterSubnetGroupName?

Type: string (optional)

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

clusterVersion?

Type: string (optional)

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

deferMaintenance?

Type: boolean | IResolvable (optional)

A Boolean indicating whether to enable the deferred maintenance window.

deferMaintenanceDuration?

Type: number (optional)

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.

deferMaintenanceEndTime?

Type: string (optional)

A timestamp for the end of the time period when we defer maintenance.

deferMaintenanceStartTime?

Type: string (optional)

A timestamp indicating the start time for the deferred maintenance window.

destinationRegion?

Type: string (optional)

The destination region that snapshots are automatically copied to when cross-region snapshot copy is enabled.

elasticIp?

Type: string (optional)

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.

encrypted?

Type: boolean | IResolvable (optional)

If true , the data in the cluster is encrypted at rest.

Default: false

endpoint?

Type: IResolvable | EndpointProperty (optional)

The connection endpoint.

enhancedVpcRouting?

Type: boolean | IResolvable (optional)

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

hsmClientCertificateIdentifier?

Type: string (optional)

Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.

hsmConfigurationIdentifier?

Type: string (optional)

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.

iamRoles?

Type: string[] (optional)

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 .

kmsKeyId?

Type: string (optional)

The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster.

loggingProperties?

Type: IResolvable | LoggingPropertiesProperty (optional)

Specifies logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.

maintenanceTrackName?

Type: string (optional)

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.

manageMasterPassword?

Type: boolean | IResolvable (optional)

If true , Amazon Redshift uses AWS Secrets Manager to manage this cluster's admin credentials.

You can't use MasterUserPassword if ManageMasterPassword is true. If ManageMasterPassword is false or not set, Amazon Redshift uses MasterUserPassword for the admin user account's password.

manualSnapshotRetentionPeriod?

Type: number (optional)

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.

masterPasswordSecretKmsKeyId?

Type: string (optional)

The ID of the AWS Key Management Service (KMS) key used to encrypt and store the cluster's admin credentials secret.

You can only use this parameter if ManageMasterPassword is true.

masterUserPassword?

Type: string (optional)

The password associated with the admin user account for the cluster that is being created.

You can't use MasterUserPassword if ManageMasterPassword is true .

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

multiAz?

Type: boolean | IResolvable (optional)

A boolean indicating whether Amazon Redshift should deploy the cluster in two Availability Zones.

The default is false.

namespaceResourcePolicy?

Type: any (optional)

The policy that is attached to a resource.

numberOfNodes?

Type: number (optional)

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.

ownerAccount?

Type: string (optional)

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.

port?

Type: number (optional)

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:

For clusters with ra3 nodes - Select a port within the ranges 5431-5455 or 8191-8215 . (If you have an existing cluster with ra3 nodes, it isn't required that you change the port to these ranges.)
For clusters with dc2 nodes - Select a port within the range 1150-65535 .

preferredMaintenanceWindow?

Type: string (optional)

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.

publiclyAccessible?

Type: boolean | IResolvable (optional)

If true , the cluster can be accessed from a public network.

resourceAction?

Type: string (optional)

The Amazon Redshift operation to be performed.

Supported operations are pause-cluster , resume-cluster , and failover-primary-compute .

revisionTarget?

Type: string (optional)

Describes a RevisionTarget object.

rotateEncryptionKey?

Type: boolean | IResolvable (optional)

Rotates the encryption keys for a cluster.

snapshotClusterIdentifier?

Type: string (optional)

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.

snapshotCopyGrantName?

Type: string (optional)

The name of the snapshot copy grant.

snapshotCopyManual?

Type: boolean | IResolvable (optional)

Indicates whether to apply the snapshot retention period to newly copied manual snapshots instead of automated snapshots.

snapshotCopyRetentionPeriod?

Type: number (optional)

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.

snapshotIdentifier?

Type: string (optional)

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

tags?

Type: CfnTag[] (optional)

A list of tag instances.

vpcSecurityGroupIds?

Type: string[] (optional)

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.