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.15.0 (build 585166b)",
           date="2020-12-30T23:06:02.452Z")
 @Stability(value=Experimental)
public interface ClusterProps
extends software.amazon.jsii.JsiiSerializable

(experimental) Properties for a new database cluster.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ClusterProps.Builder A builder for ClusterProps
static class	ClusterProps.Jsii$Proxy An implementation for ClusterProps

Method Summary

Modifier and Type	Method and Description
static ClusterProps.Builder	builder()
default String	getClusterName() (experimental) An optional identifier for the cluster.
default ClusterType	getClusterType() (experimental) Settings for the individual instances that are launched.
default String	getDefaultDatabaseName() (experimental) Name of a database which is automatically created inside the cluster.
default Boolean	getEncrypted() (experimental) Whether to enable encryption of data at rest in the cluster.
default IKey	getEncryptionKey() (experimental) The KMS key to use for encryption of data at rest.
default IBucket	getLoggingBucket() (experimental) Bucket to send logs to.
default String	getLoggingKeyPrefix() (experimental) Prefix used for logging.
Login	getMasterUser() (experimental) Username and password for the administrative user.
default NodeType	getNodeType() (experimental) The node type to be provisioned for the cluster.
default Number	getNumberOfNodes() (experimental) Number of compute nodes in the cluster.
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 Number	getPort() (experimental) What port to listen on.
default String	getPreferredMaintenanceWindow() (experimental) A preferred maintenance window day/time range.
default Boolean	getPubliclyAccessible() (experimental) Whether to make cluster publicly accessible.
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 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.
default List<ISecurityGroup>	getSecurityGroups() (experimental) Security group.
default IClusterSubnetGroup	getSubnetGroup() (experimental) A cluster subnet group to use with this cluster.
IVpc	getVpc() (experimental) The VPC to place the cluster in.
default SubnetSelection	getVpcSubnets() (experimental) Where to place the instances within the VPC.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getMasterUser

@Stability(value=Experimental)
 @NotNull
Login getMasterUser()

(experimental) Username and password for the administrative user.

getVpc

@Stability(value=Experimental)
 @NotNull
IVpc getVpc()

(experimental) The VPC to place the cluster in.

getClusterName

@Stability(value=Experimental)
 @Nullable
default String getClusterName()

(experimental) An optional identifier for the cluster.

Default: - A name is automatically generated.

getClusterType

@Stability(value=Experimental)
 @Nullable
default ClusterType getClusterType()

(experimental) Settings for the individual instances that are launched.

Default: ClusterType.MULTI_NODE

getDefaultDatabaseName

@Stability(value=Experimental)
 @Nullable
default String getDefaultDatabaseName()

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

Default: - default_db

getEncrypted

@Stability(value=Experimental)
 @Nullable
default Boolean getEncrypted()

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

Default: true

getEncryptionKey

@Stability(value=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(value=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(value=Experimental)
 @Nullable
default String getLoggingKeyPrefix()

(experimental) Prefix used for logging.

Default: - no prefix

getNodeType

@Stability(value=Experimental)
 @Nullable
default NodeType getNodeType()

(experimental) The node type to be provisioned for the cluster.

Default: NodeType.DC2_LARGE

getNumberOfNodes

@Stability(value=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(value=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(value=Experimental)
 @Nullable
default Number getPort()

(experimental) What port to listen on.

Default: - The default for the engine is used.

getPreferredMaintenanceWindow

@Stability(value=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:

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

getPubliclyAccessible

@Stability(value=Experimental)
 @Nullable
default Boolean getPubliclyAccessible()

(experimental) Whether to make cluster publicly accessible.

Default: false

getRemovalPolicy

@Stability(value=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(value=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(value=Experimental)
 @Nullable
default List<ISecurityGroup> getSecurityGroups()

(experimental) Security group.

Default: - a new security group is created.

getSubnetGroup

@Stability(value=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(value=Experimental)
 @Nullable
default SubnetSelection getVpcSubnets()

(experimental) Where to place the instances within the VPC.

Default: - private subnets

builder

@Stability(value=Experimental)
static ClusterProps.Builder builder()

Returns:

a ClusterProps.Builder of ClusterProps