@Stability(value=Experimental)

Package software.amazon.awscdk.services.redshift

Amazon Redshift Construct Library

See: Description

Interface Summary

Interface	Description
CfnCluster.LoggingPropertiesProperty
CfnClusterParameterGroup.ParameterProperty
CfnClusterParameterGroupProps	Properties for defining a `AWS::Redshift::ClusterParameterGroup`.
CfnClusterProps	Properties for defining a `AWS::Redshift::Cluster`.
CfnClusterSecurityGroupIngressProps	Properties for defining a `AWS::Redshift::ClusterSecurityGroupIngress`.
CfnClusterSecurityGroupProps	Properties for defining a `AWS::Redshift::ClusterSecurityGroup`.
CfnClusterSubnetGroupProps	Properties for defining a `AWS::Redshift::ClusterSubnetGroup`.
ClusterAttributes	(experimental) Properties that describe an existing cluster instance.
ClusterParameterGroupProps	(experimental) Properties for a parameter group.
ClusterProps	(experimental) Properties for a new database cluster.
ClusterSubnetGroupProps	(experimental) Properties for creating a ClusterSubnetGroup.
DatabaseSecretProps	(experimental) Construction properties for a DatabaseSecret.
ICluster	(experimental) Create a Redshift Cluster with a given number of nodes.
IClusterParameterGroup	(experimental) A parameter group.
IClusterSubnetGroup	(experimental) Interface for a cluster subnet group.
Login	(experimental) Username and password combination.
RotationMultiUserOptions	(experimental) Options to add the multi user rotation.

Class Summary

Class	Description
CfnCluster	A CloudFormation `AWS::Redshift::Cluster`.
CfnCluster.Builder	A fluent builder for CfnCluster.
CfnCluster.LoggingPropertiesProperty.Builder	A builder for CfnCluster.LoggingPropertiesProperty
CfnCluster.LoggingPropertiesProperty.Jsii$Proxy	An implementation for CfnCluster.LoggingPropertiesProperty
CfnClusterParameterGroup	A CloudFormation `AWS::Redshift::ClusterParameterGroup`.
CfnClusterParameterGroup.Builder	A fluent builder for CfnClusterParameterGroup.
CfnClusterParameterGroup.ParameterProperty.Builder	A builder for CfnClusterParameterGroup.ParameterProperty
CfnClusterParameterGroup.ParameterProperty.Jsii$Proxy	An implementation for CfnClusterParameterGroup.ParameterProperty
CfnClusterParameterGroupProps.Builder	A builder for CfnClusterParameterGroupProps
CfnClusterParameterGroupProps.Jsii$Proxy	An implementation for CfnClusterParameterGroupProps
CfnClusterProps.Builder	A builder for CfnClusterProps
CfnClusterProps.Jsii$Proxy	An implementation for CfnClusterProps
CfnClusterSecurityGroup	A CloudFormation `AWS::Redshift::ClusterSecurityGroup`.
CfnClusterSecurityGroup.Builder	A fluent builder for CfnClusterSecurityGroup.
CfnClusterSecurityGroupIngress	A CloudFormation `AWS::Redshift::ClusterSecurityGroupIngress`.
CfnClusterSecurityGroupIngress.Builder	A fluent builder for CfnClusterSecurityGroupIngress.
CfnClusterSecurityGroupIngressProps.Builder	A builder for CfnClusterSecurityGroupIngressProps
CfnClusterSecurityGroupIngressProps.Jsii$Proxy	An implementation for CfnClusterSecurityGroupIngressProps
CfnClusterSecurityGroupProps.Builder	A builder for CfnClusterSecurityGroupProps
CfnClusterSecurityGroupProps.Jsii$Proxy	An implementation for CfnClusterSecurityGroupProps
CfnClusterSubnetGroup	A CloudFormation `AWS::Redshift::ClusterSubnetGroup`.
CfnClusterSubnetGroup.Builder	A fluent builder for CfnClusterSubnetGroup.
CfnClusterSubnetGroupProps.Builder	A builder for CfnClusterSubnetGroupProps
CfnClusterSubnetGroupProps.Jsii$Proxy	An implementation for CfnClusterSubnetGroupProps
Cluster	(experimental) Create a Redshift cluster a given number of nodes.
Cluster.Builder	(experimental) A fluent builder for Cluster.
ClusterAttributes.Builder	A builder for ClusterAttributes
ClusterAttributes.Jsii$Proxy	An implementation for ClusterAttributes
ClusterParameterGroup	(experimental) A cluster parameter group.
ClusterParameterGroup.Builder	(experimental) A fluent builder for ClusterParameterGroup.
ClusterParameterGroupProps.Builder	A builder for ClusterParameterGroupProps
ClusterParameterGroupProps.Jsii$Proxy	An implementation for ClusterParameterGroupProps
ClusterProps.Builder	A builder for ClusterProps
ClusterProps.Jsii$Proxy	An implementation for ClusterProps
ClusterSubnetGroup	(experimental) Class for creating a Redshift cluster subnet group.
ClusterSubnetGroup.Builder	(experimental) A fluent builder for ClusterSubnetGroup.
ClusterSubnetGroupProps.Builder	A builder for ClusterSubnetGroupProps
ClusterSubnetGroupProps.Jsii$Proxy	An implementation for ClusterSubnetGroupProps
DatabaseSecret	(experimental) A database secret.
DatabaseSecret.Builder	(experimental) A fluent builder for DatabaseSecret.
DatabaseSecretProps.Builder	A builder for DatabaseSecretProps
DatabaseSecretProps.Jsii$Proxy	An implementation for DatabaseSecretProps
Endpoint	(experimental) Connection endpoint of a redshift cluster.
ICluster.Jsii$Proxy	A proxy class which represents a concrete javascript instance of this type.
IClusterParameterGroup.Jsii$Proxy	A proxy class which represents a concrete javascript instance of this type.
IClusterSubnetGroup.Jsii$Proxy	A proxy class which represents a concrete javascript instance of this type.
Login.Builder	A builder for Login
Login.Jsii$Proxy	An implementation for Login
RotationMultiUserOptions.Builder	A builder for RotationMultiUserOptions
RotationMultiUserOptions.Jsii$Proxy	An implementation for RotationMultiUserOptions

Enum Summary

Enum	Description
ClusterType	(experimental) What cluster type to use.
NodeType	(experimental) Possible Node Types to use in the cluster used for defining ClusterProps.nodeType.

Package software.amazon.awscdk.services.redshift Description

Amazon Redshift Construct Library

---

All classes with the Cfn prefix in this module (CFN Resources) are always stable and safe to use.

Starting a Redshift Cluster Database

To set up a Redshift cluster, define a Cluster. It will be launched in a VPC. You can specify a VPC, otherwise one will be created. The nodes are always launched in private subnets and are encrypted by default.

 // Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
 import software.amazon.awscdk.services.redshift.*;
 Cluster cluster = new Cluster(this, "Redshift", new ClusterProps()
         .masterUser(new Login()
                 .masterUsername("admin"))
         .vpc(vpc));
 

By default, the master password will be generated and stored in AWS Secrets Manager.

A default database named default_db will be created in the cluster. To change the name of this database set the defaultDatabaseName attribute in the constructor properties.

Connecting

To control who can access the cluster, use the .connections attribute. Redshift Clusters have a default port, so you don't need to specify the port:

 // Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
 cluster.connections.allowFromAnyIpv4("Open to the world");
 

The endpoint to access your database cluster will be available as the .clusterEndpoint attribute:

 // Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
 cluster.clusterEndpoint.getSocketAddress();
 

Rotating credentials

When the master password is generated and stored in AWS Secrets Manager, it can be rotated automatically:

 // Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
 cluster.addRotationSingleUser();
 

The multi user rotation scheme is also available:

 // Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
 cluster.addRotationMultiUser("MyUser", Map.of(
         "secret", myImportedSecret));
 

This module is part of the AWS Cloud Development Kit project.