Package software.amazon.awscdk.services.redshift

Interface ClusterProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
ClusterProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:42.819Z") @Stability(Experimental) public interface ClusterProps extends software.amazon.jsii.JsiiSerializable
(experimental) Properties for a new database cluster.

Example: 

 import software.amazon.awscdk.services.ec2.*;
 Vpc vpc = new Vpc(this, "Vpc");
 Cluster cluster = Cluster.Builder.create(this, "Redshift")
         .masterUser(Login.builder()
                 .masterUsername("admin")
                 .build())
         .vpc(vpc)
         .build();

  • Method Details

    • getMasterUser

      @Stability(Experimental) @NotNull Login getMasterUser()
      (experimental) Username and password for the administrative user.

    • getVpc

      @Stability(Experimental) @NotNull IVpc getVpc()
      (experimental) The VPC to place the cluster in.

    • getClusterName

      @Stability(Experimental) @Nullable default String getClusterName()
      (experimental) An optional identifier for the cluster.

      Default: - A name is automatically generated.

    • getClusterType

      @Stability(Experimental) @Nullable default ClusterType getClusterType()
      (experimental) Settings for the individual instances that are launched.

      Default:

      invalid @link 
      ClusterType.MULTI_NODE

    • getDefaultDatabaseName

      @Stability(Experimental) @Nullable default String getDefaultDatabaseName()
      (experimental) Name of a database which is automatically created inside the cluster.

      Default: - default_db

    • getEncrypted

      @Stability(Experimental) @Nullable default Boolean getEncrypted()
      (experimental) Whether to enable encryption of data at rest in the cluster.

      Default: true

    • getEncryptionKey

      @Stability(Experimental) @Nullable default IKey getEncryptionKey()
      (experimental) The KMS key to use for encryption of data at rest.

      Default: - AWS-managed key, if encryption at rest is enabled

    • getLoggingBucket

      @Stability(Experimental) @Nullable default IBucket getLoggingBucket()
      (experimental) Bucket to send logs to.

      Logging information includes queries and connection attempts, for the specified Amazon Redshift cluster.

      Default: - No Logs

    • getLoggingKeyPrefix

      @Stability(Experimental) @Nullable default String getLoggingKeyPrefix()
      (experimental) Prefix used for logging.

      Default: - no prefix

    • getNodeType

      @Stability(Experimental) @Nullable default NodeType getNodeType()
      (experimental) The node type to be provisioned for the cluster.

      Default:

      invalid @link 
      NodeType.DC2_LARGE

    • getNumberOfNodes

      @Stability(Experimental) @Nullable default Number getNumberOfNodes()
      (experimental) 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.

      Default: - 2 if `clusterType` is ClusterType.MULTI_NODE, undefined otherwise

    • getParameterGroup

      @Stability(Experimental) @Nullable default IClusterParameterGroup getParameterGroup()
      (experimental) Additional parameters to pass to the database engine https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html.

      Default: - No parameter group.

    • getPort

      @Stability(Experimental) @Nullable default Number getPort()
      (experimental) What port to listen on.

      Default: - The default for the engine is used.

    • getPreferredMaintenanceWindow

      @Stability(Experimental) @Nullable default String getPreferredMaintenanceWindow()
      (experimental) 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'

      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.

      See Also:

    • getPubliclyAccessible

      @Stability(Experimental) @Nullable default Boolean getPubliclyAccessible()
      (experimental) Whether to make cluster publicly accessible.

      Default: false

    • getRemovalPolicy

      @Stability(Experimental) @Nullable default RemovalPolicy getRemovalPolicy()
      (experimental) The removal policy to apply when the cluster and its instances are removed from the stack or replaced during an update.

      Default: RemovalPolicy.RETAIN

    • getRoles

      @Stability(Experimental) @Nullable default List<IRole> getRoles()
      (experimental) A list of AWS Identity and Access Management (IAM) role that can be used by the cluster to access other AWS services.

      Specify a maximum of 10 roles.

      Default: - No role is attached to the cluster.

    • getSecurityGroups

      @Stability(Experimental) @Nullable default List<ISecurityGroup> getSecurityGroups()
      (experimental) Security group.

      Default: - a new security group is created.

    • getSubnetGroup

      @Stability(Experimental) @Nullable default IClusterSubnetGroup getSubnetGroup()
      (experimental) A cluster subnet group to use with this cluster.

      Default: - a new subnet group will be created.

    • getVpcSubnets

      @Stability(Experimental) @Nullable default SubnetSelection getVpcSubnets()
      (experimental) Where to place the instances within the VPC.

      Default: - private subnets

    • builder

      @Stability(Experimental) static ClusterProps.Builder builder()
      Returns:
      a ClusterProps.Builder of ClusterProps