@aws-cdk_aws-redshift-alpha.ClusterProps

interface ClusterProps ๐Ÿ”น

LanguageType name
.NETAmazon.CDK.AWS.Redshift.Alpha.ClusterProps
Gogithub.com/aws/aws-cdk-go/awscdkredshiftalpha/v2#ClusterProps
Javasoftware.amazon.awscdk.services.redshift.alpha.ClusterProps
Pythonaws_cdk.aws_redshift_alpha.ClusterProps
TypeScript (source)@aws-cdk/aws-redshift-alpha ยป ClusterProps

Properties for a new database cluster.

Example

import * as ec2 from 'aws-cdk-lib/aws-ec2';
import * as cdk from 'aws-cdk-lib';
declare const vpc: ec2.Vpc;

const cluster = new Cluster(this, 'Cluster', {
  masterUser: {
    masterUsername: 'admin',
    masterPassword: cdk.SecretValue.unsafePlainText('tooshort'),
  },
  vpc,
});

cluster.addToParameterGroup('enable_user_activity_logging', 'true');

Properties

NameTypeDescription
masterUser๐Ÿ”นLoginUsername and password for the administrative user.
vpc๐Ÿ”นIVpcThe VPC to place the cluster in.
classicResizing?๐Ÿ”นbooleanIf this flag is set, the cluster resizing type will be set to classic.
clusterName?๐Ÿ”นstringAn optional identifier for the cluster.
clusterType?๐Ÿ”นClusterTypeSettings for the individual instances that are launched.
defaultDatabaseName?๐Ÿ”นstringName of a database which is automatically created inside the cluster.
defaultRole?๐Ÿ”นIRoleA single AWS Identity and Access Management (IAM) role to be used as the default role for the cluster.
elasticIp?๐Ÿ”นstringThe Elastic IP (EIP) address for the cluster.
encrypted?๐Ÿ”นbooleanWhether to enable encryption of data at rest in the cluster.
encryptionKey?๐Ÿ”นIKeyThe KMS key to use for encryption of data at rest.
enhancedVpcRouting?๐Ÿ”นbooleanIf this flag is set, Amazon Redshift forces all COPY and UNLOAD traffic between your cluster and your data repositories through your virtual private cloud (VPC).
loggingProperties?๐Ÿ”นLoggingPropertiesBucket details for log files to be sent to, including prefix.
nodeType?๐Ÿ”นNodeTypeThe node type to be provisioned for the cluster.
numberOfNodes?๐Ÿ”นnumberNumber of compute nodes in the cluster. Only specify this property for multi-node clusters.
parameterGroup?๐Ÿ”นIClusterParameterGroupAdditional parameters to pass to the database engine https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html.
port?๐Ÿ”นnumberWhat port to listen on.
preferredMaintenanceWindow?๐Ÿ”นstringA preferred maintenance window day/time range. Should be specified as a range ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC).
publiclyAccessible?๐Ÿ”นbooleanWhether to make cluster publicly accessible.
rebootForParameterChanges?๐Ÿ”นbooleanIf this flag is set, the cluster will be rebooted when changes to the cluster's parameter group that require a restart to apply.
removalPolicy?๐Ÿ”นRemovalPolicyThe removal policy to apply when the cluster and its instances are removed from the stack or replaced during an update.
roles?๐Ÿ”นIRole[]A list of AWS Identity and Access Management (IAM) role that can be used by the cluster to access other AWS services.
securityGroups?๐Ÿ”นISecurityGroup[]Security group.
subnetGroup?๐Ÿ”นIClusterSubnetGroupA cluster subnet group to use with this cluster.
vpcSubnets?๐Ÿ”นSubnetSelectionWhere to place the instances within the VPC.

masterUser๐Ÿ”น

Type: Login

Username and password for the administrative user.


vpc๐Ÿ”น

Type: IVpc

The VPC to place the cluster in.


classicResizing?๐Ÿ”น

Type: boolean (optional, default: Elastic resize type)

If this flag is set, the cluster resizing type will be set to classic.

When resizing a cluster, classic resizing will always provision a new cluster and transfer the data there.

Classic resize takes more time to complete, but it can be useful in cases where the change in node count or the node type to migrate to doesn't fall within the bounds for elastic resize.

See also: https://docs.aws.amazon.com/redshift/latest/mgmt/managing-cluster-operations.html#elastic-resize


clusterName?๐Ÿ”น

Type: string (optional, default: A name is automatically generated.)

An optional identifier for the cluster.


clusterType?๐Ÿ”น

Type: ClusterType (optional, default: ClusterType.MULTI_NODE)

Settings for the individual instances that are launched.


defaultDatabaseName?๐Ÿ”น

Type: string (optional, default: default_db)

Name of a database which is automatically created inside the cluster.


defaultRole?๐Ÿ”น

Type: IRole (optional, default: No default role is specified for the cluster.)

A single AWS Identity and Access Management (IAM) role to be used as the default role for the cluster.

The default role must be included in the roles list.


elasticIp?๐Ÿ”น

Type: string (optional, default: No Elastic IP)

The Elastic IP (EIP) address for the cluster.

See also: https://docs.aws.amazon.com/redshift/latest/mgmt/managing-clusters-vpc.html


encrypted?๐Ÿ”น

Type: boolean (optional, default: true)

Whether to enable encryption of data at rest in the cluster.


encryptionKey?๐Ÿ”น

Type: IKey (optional, default: AWS-managed key, if encryption at rest is enabled)

The KMS key to use for encryption of data at rest.


enhancedVpcRouting?๐Ÿ”น

Type: boolean (optional, default: false)

If this flag is set, Amazon Redshift forces all COPY and UNLOAD traffic between your cluster and your data repositories through your virtual private cloud (VPC).

See also: https://docs.aws.amazon.com/redshift/latest/mgmt/enhanced-vpc-routing.html


loggingProperties?๐Ÿ”น

Type: LoggingProperties (optional, default: No logging bucket is used)

Bucket details for log files to be sent to, including prefix.


nodeType?๐Ÿ”น

Type: NodeType (optional, default: NodeType.DC2_LARGE)

The node type to be provisioned for the cluster.


numberOfNodes?๐Ÿ”น

Type: number (optional, default: 2 if clusterType is ClusterType.MULTI_NODE, undefined otherwise)

Number of compute nodes in the cluster. Only specify this property for multi-node clusters.

Value must be at least 2 and no more than 100.


parameterGroup?๐Ÿ”น

Type: IClusterParameterGroup (optional, default: No parameter group.)

Additional parameters to pass to the database engine https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html.


port?๐Ÿ”น

Type: number (optional, default: The default for the engine is used.)

What port to listen on.


preferredMaintenanceWindow?๐Ÿ”น

Type: string (optional, default: 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week.)

A preferred maintenance window day/time range. Should be specified as a range ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC).

Example: 'Sun:23:45-Mon:00:15'

See also: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_UpgradeDBInstance.Maintenance.html#Concepts.DBMaintenance


publiclyAccessible?๐Ÿ”น

Type: boolean (optional, default: false)

Whether to make cluster publicly accessible.


rebootForParameterChanges?๐Ÿ”น

Type: boolean (optional, default: false)

If this flag is set, the cluster will be rebooted when changes to the cluster's parameter group that require a restart to apply.


removalPolicy?๐Ÿ”น

Type: RemovalPolicy (optional, default: RemovalPolicy.RETAIN)

The removal policy to apply when the cluster and its instances are removed from the stack or replaced during an update.


roles?๐Ÿ”น

Type: IRole[] (optional, default: No role is attached to the cluster.)

A list of AWS Identity and Access Management (IAM) role that can be used by the cluster to access other AWS services.

The maximum number of roles to attach to a cluster is subject to a quota.


securityGroups?๐Ÿ”น

Type: ISecurityGroup[] (optional, default: a new security group is created.)

Security group.


subnetGroup?๐Ÿ”น

Type: IClusterSubnetGroup (optional, default: a new subnet group will be created.)

A cluster subnet group to use with this cluster.


vpcSubnets?๐Ÿ”น

Type: SubnetSelection (optional, default: private subnets)

Where to place the instances within the VPC.