ClusterProps (software.amazon.awscdk:redshift 1.64.1 API)

All Superinterfaces:: software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:: ClusterProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.12.0 (build 5ddc9f2)",
           date="2020-09-25T17:39:22.158Z")
 @Stability(value=Experimental)
public interface ClusterProps
extends software.amazon.jsii.JsiiSerializable

Properties for a new database cluster.

EXPERIMENTAL

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

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`static ClusterProps.Builder`	`builder()`
`default String`	`getClusterName()` An optional identifier for the cluster.
`default ClusterType`	`getClusterType()` Settings for the individual instances that are launched.
`default String`	`getDefaultDatabaseName()` Name of a database which is automatically created inside the cluster.
`default Boolean`	`getEncrypted()` Whether to enable encryption of data at rest in the cluster.
`default IKey`	`getEncryptionKey()` The KMS key to use for encryption of data at rest.
`default IBucket`	`getLoggingBucket()` Bucket to send logs to.
`default String`	`getLoggingKeyPrefix()` Prefix used for logging.
`Login`	`getMasterUser()` Username and password for the administrative user.
`default NodeType`	`getNodeType()` The node type to be provisioned for the cluster.
`default Number`	`getNumberOfNodes()` Number of compute nodes in the cluster.
`default IClusterParameterGroup`	`getParameterGroup()` Additional parameters to pass to the database engine https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html.
`default Number`	`getPort()` What port to listen on.
`default String`	`getPreferredMaintenanceWindow()` A preferred maintenance window day/time range.
`default RemovalPolicy`	`getRemovalPolicy()` 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()` 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()` Security group.
`default IClusterSubnetGroup`	`getSubnetGroup()` A cluster subnet group to use with this cluster.
`IVpc`	`getVpc()` The VPC to place the cluster in.
`default SubnetSelection`	`getVpcSubnets()` 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()
```
    Username and password for the administrative user.
    EXPERIMENTAL
  - getVpc
```
@Stability(value=Experimental)
 @NotNull
IVpc getVpc()
```
    The VPC to place the cluster in.
    EXPERIMENTAL
  - getClusterName
```
@Stability(value=Experimental)
 @Nullable
default String getClusterName()
```
    An optional identifier for the cluster.
    Default: - A name is automatically generated.
    EXPERIMENTAL
  - getClusterType
```
@Stability(value=Experimental)
 @Nullable
default ClusterType getClusterType()
```
    Settings for the individual instances that are launched.
    Default: ClusterType.MULTI_NODE
    EXPERIMENTAL
  - getDefaultDatabaseName
```
@Stability(value=Experimental)
 @Nullable
default String getDefaultDatabaseName()
```
    Name of a database which is automatically created inside the cluster.
    Default: - default_db
    EXPERIMENTAL
  - getEncrypted
```
@Stability(value=Experimental)
 @Nullable
default Boolean getEncrypted()
```
    Whether to enable encryption of data at rest in the cluster.
    Default: true
    EXPERIMENTAL
  - getEncryptionKey
```
@Stability(value=Experimental)
 @Nullable
default IKey getEncryptionKey()
```
    The KMS key to use for encryption of data at rest.
    Default: - AWS-managed key, if encryption at rest is enabled
    EXPERIMENTAL
  - getLoggingBucket
```
@Stability(value=Experimental)
 @Nullable
default IBucket getLoggingBucket()
```
    Bucket to send logs to.
    Logging information includes queries and connection attempts, for the specified Amazon Redshift cluster.
    Default: - No Logs
    EXPERIMENTAL
  - getLoggingKeyPrefix
```
@Stability(value=Experimental)
 @Nullable
default String getLoggingKeyPrefix()
```
    Prefix used for logging.
    Default: - no prefix
    EXPERIMENTAL
  - getNodeType
```
@Stability(value=Experimental)
 @Nullable
default NodeType getNodeType()
```
    The node type to be provisioned for the cluster.
    Default: NodeType.DC2_LARGE
    EXPERIMENTAL
  - getNumberOfNodes
```
@Stability(value=Experimental)
 @Nullable
default Number getNumberOfNodes()
```
    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
    EXPERIMENTAL
  - getParameterGroup
```
@Stability(value=Experimental)
 @Nullable
default IClusterParameterGroup getParameterGroup()
```
    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.
    EXPERIMENTAL
  - getPort
```
@Stability(value=Experimental)
 @Nullable
default Number getPort()
```
    What port to listen on.
    Default: - The default for the engine is used.
    EXPERIMENTAL
  - getPreferredMaintenanceWindow
```
@Stability(value=Experimental)
 @Nullable
default String getPreferredMaintenanceWindow()
```
    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.
    EXPERIMENTAL
    
    See Also:
    
    https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_UpgradeDBInstance.Maintenance.html#Concepts.DBMaintenance
  - getRemovalPolicy
```
@Stability(value=Experimental)
 @Nullable
default RemovalPolicy getRemovalPolicy()
```
    The removal policy to apply when the cluster and its instances are removed from the stack or replaced during an update.
    Default: RemovalPolicy.RETAIN
    EXPERIMENTAL
  - getRoles
```
@Stability(value=Experimental)
 @Nullable
default List<IRole> getRoles()
```
    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.
    EXPERIMENTAL
  - getSecurityGroups
```
@Stability(value=Experimental)
 @Nullable
default List<ISecurityGroup> getSecurityGroups()
```
    Security group.
    Default: - a new security group is created.
    EXPERIMENTAL
  - getSubnetGroup
```
@Stability(value=Experimental)
 @Nullable
default IClusterSubnetGroup getSubnetGroup()
```
    A cluster subnet group to use with this cluster.
    Default: - a new subnet group will be created.
    EXPERIMENTAL
  - getVpcSubnets
```
@Stability(value=Experimental)
 @Nullable
default SubnetSelection getVpcSubnets()
```
    Where to place the instances within the VPC.
    Default: - private subnets
    EXPERIMENTAL
  - builder
```
@Stability(value=Experimental)
static ClusterProps.Builder builder()
```
    Returns:
    
    a ClusterProps.Builder of ClusterProps

Interface ClusterProps

Nested Class Summary

Method Summary

Methods inherited from interface software.amazon.jsii.JsiiSerializable

Method Detail

getMasterUser

getVpc

getClusterName

getClusterType

getDefaultDatabaseName

getEncrypted

getEncryptionKey

getLoggingBucket

getLoggingKeyPrefix

getNodeType

getNumberOfNodes

getParameterGroup

getPort

getPreferredMaintenanceWindow

getRemovalPolicy

getRoles

getSecurityGroups

getSubnetGroup

getVpcSubnets

builder