ClusterProps

All Known Implementing Classes:: ClusterProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:45.875Z")
public interface ClusterProps

(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();

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 java.lang.String`	`getClusterName()` (experimental) An optional identifier for the cluster.
`default ClusterType`	`getClusterType()` (experimental) Settings for the individual instances that are launched.
`default java.lang.String`	`getDefaultDatabaseName()` (experimental) Name of a database which is automatically created inside the cluster.
`default java.lang.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 java.lang.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 java.lang.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 java.lang.Number`	`getPort()` (experimental) What port to listen on.
`default java.lang.String`	`getPreferredMaintenanceWindow()` (experimental) A preferred maintenance window day/time range.
`default java.lang.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 java.util.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 java.util.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.

- Method Detail
  - getMasterUser
```
Login getMasterUser()
```
    (experimental) Username and password for the administrative user.
  - getVpc
```
IVpc getVpc()
```
    (experimental) The VPC to place the cluster in.
  - getClusterName
```
default java.lang.String getClusterName()
```
    (experimental) An optional identifier for the cluster.
    Default: - A name is automatically generated.
  - getClusterType
```
default ClusterType getClusterType()
```
    (experimental) Settings for the individual instances that are launched.
    Default: ClusterType.MULTI_NODE
  - getDefaultDatabaseName
```
default java.lang.String getDefaultDatabaseName()
```
    (experimental) Name of a database which is automatically created inside the cluster.
    Default: - default_db
  - getEncrypted
```
default java.lang.Boolean getEncrypted()
```
    (experimental) Whether to enable encryption of data at rest in the cluster.
    Default: true
  - getEncryptionKey
```
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
```
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
```
default java.lang.String getLoggingKeyPrefix()
```
    (experimental) Prefix used for logging.
    Default: - no prefix
  - getNodeType
```
default NodeType getNodeType()
```
    (experimental) The node type to be provisioned for the cluster.
    Default: NodeType.DC2_LARGE
  - getNumberOfNodes
```
default java.lang.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
```
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
```
default java.lang.Number getPort()
```
    (experimental) What port to listen on.
    Default: - The default for the engine is used.
  - getPreferredMaintenanceWindow
```
default java.lang.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
```
default java.lang.Boolean getPubliclyAccessible()
```
    (experimental) Whether to make cluster publicly accessible.
    Default: false
  - getRemovalPolicy
```
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
```
default java.util.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
```
default java.util.List<ISecurityGroup> getSecurityGroups()
```
    (experimental) Security group.
    Default: - a new security group is created.
  - getSubnetGroup
```
default IClusterSubnetGroup getSubnetGroup()
```
    (experimental) A cluster subnet group to use with this cluster.
    Default: - a new subnet group will be created.
  - getVpcSubnets
```
default SubnetSelection getVpcSubnets()
```
    (experimental) Where to place the instances within the VPC.
    Default: - private subnets
  - builder
```
static ClusterProps.Builder builder()
```
    Returns:
    
    a ClusterProps.Builder of ClusterProps

Interface ClusterProps

Nested Class Summary

Method Summary

Method Detail

getMasterUser

getVpc

getClusterName

getClusterType

getDefaultDatabaseName

getEncrypted

getEncryptionKey

getLoggingBucket

getLoggingKeyPrefix

getNodeType

getNumberOfNodes

getParameterGroup

getPort

getPreferredMaintenanceWindow

getPubliclyAccessible

getRemovalPolicy

getRoles

getSecurityGroups

getSubnetGroup

getVpcSubnets

builder