software.amazon.awscdk.services.redshift.package-info Maven / Gradle / Ivy
Show all versions of redshift Show documentation
/**
* Amazon Redshift Construct Library
*
* ---
*
* 
*
*
*
* All classes with the Cfn prefix in this module (CFN Resources) are always stable and safe to use.
*
*
*
* 
*
*
*
* The APIs of higher level constructs in this module are experimental and under active development.
* They are subject to non-backward compatible changes or removal in any future version. These are
* not subject to the Semantic Versioning model and breaking changes will be
* announced in the release notes. This means that while you may use them, you may need to update
* your source code when upgrading to a newer version of this package.
*
*
*
*
*
*
*
*
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.
*
* By default, the cluster will not be publicly accessible.
* Depending on your use case, you can make the cluster publicly accessible with the publiclyAccessible property.
*
*
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.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
package software.amazon.awscdk.services.redshift;