ClusterProps.Builder

java.lang.Object
- software.amazon.awscdk.services.redshift.ClusterProps.Builder

Enclosing interface:: ClusterProps

public static final class ClusterProps.Builder
extends java.lang.Object

A builder for ClusterProps

Constructor Summary

Constructors
Constructor and Description

Builder()

Constructors
Constructor and Description
`Builder()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ClusterProps`	`build()` Builds the configured instance.
`ClusterProps.Builder`	`clusterName(java.lang.String clusterName)` Sets the value of `ClusterProps.getClusterName()`
`ClusterProps.Builder`	`clusterType(ClusterType clusterType)` Sets the value of `ClusterProps.getClusterType()`
`ClusterProps.Builder`	`defaultDatabaseName(java.lang.String defaultDatabaseName)` Sets the value of `ClusterProps.getDefaultDatabaseName()`
`ClusterProps.Builder`	`encrypted(java.lang.Boolean encrypted)` Sets the value of `ClusterProps.getEncrypted()`
`ClusterProps.Builder`	`encryptionKey(IKey encryptionKey)` Sets the value of `ClusterProps.getEncryptionKey()`
`ClusterProps.Builder`	`loggingBucket(IBucket loggingBucket)` Sets the value of `ClusterProps.getLoggingBucket()`
`ClusterProps.Builder`	`loggingKeyPrefix(java.lang.String loggingKeyPrefix)` Sets the value of `ClusterProps.getLoggingKeyPrefix()`
`ClusterProps.Builder`	`masterUser(Login masterUser)` Sets the value of `ClusterProps.getMasterUser()`
`ClusterProps.Builder`	`nodeType(NodeType nodeType)` Sets the value of `ClusterProps.getNodeType()`
`ClusterProps.Builder`	`numberOfNodes(java.lang.Number numberOfNodes)` Sets the value of `ClusterProps.getNumberOfNodes()`
`ClusterProps.Builder`	`parameterGroup(IClusterParameterGroup parameterGroup)` Sets the value of `ClusterProps.getParameterGroup()`
`ClusterProps.Builder`	`port(java.lang.Number port)` Sets the value of `ClusterProps.getPort()`
`ClusterProps.Builder`	`preferredMaintenanceWindow(java.lang.String preferredMaintenanceWindow)` Sets the value of `ClusterProps.getPreferredMaintenanceWindow()`
`ClusterProps.Builder`	`publiclyAccessible(java.lang.Boolean publiclyAccessible)` Sets the value of `ClusterProps.getPubliclyAccessible()`
`ClusterProps.Builder`	`removalPolicy(RemovalPolicy removalPolicy)` Sets the value of `ClusterProps.getRemovalPolicy()`
`ClusterProps.Builder`	`roles(java.util.List<? extends IRole> roles)` Sets the value of `ClusterProps.getRoles()`
`ClusterProps.Builder`	`securityGroups(java.util.List<? extends ISecurityGroup> securityGroups)` Sets the value of `ClusterProps.getSecurityGroups()`
`ClusterProps.Builder`	`subnetGroup(IClusterSubnetGroup subnetGroup)` Sets the value of `ClusterProps.getSubnetGroup()`
`ClusterProps.Builder`	`vpc(IVpc vpc)` Sets the value of `ClusterProps.getVpc()`
`ClusterProps.Builder`	`vpcSubnets(SubnetSelection vpcSubnets)` Sets the value of `ClusterProps.getVpcSubnets()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Builder
```
public Builder()
```
- Method Detail
  - masterUser
```
public ClusterProps.Builder masterUser(Login masterUser)
```
    Sets the value of ClusterProps.getMasterUser()
    
    Parameters:
    
    masterUser - Username and password for the administrative user. This parameter is required.
    
    Returns:
    
    this
  - vpc
```
public ClusterProps.Builder vpc(IVpc vpc)
```
    Sets the value of ClusterProps.getVpc()
    
    Parameters:
    
    vpc - The VPC to place the cluster in. This parameter is required.
    
    Returns:
    
    this
  - clusterName
```
public ClusterProps.Builder clusterName(java.lang.String clusterName)
```
    Sets the value of ClusterProps.getClusterName()
    
    Parameters:
    
    clusterName - An optional identifier for the cluster.
    
    Returns:
    
    this
  - clusterType
```
public ClusterProps.Builder clusterType(ClusterType clusterType)
```
    Sets the value of ClusterProps.getClusterType()
    
    Parameters:
    
    clusterType - Settings for the individual instances that are launched.
    
    Returns:
    
    this
  - defaultDatabaseName
```
public ClusterProps.Builder defaultDatabaseName(java.lang.String defaultDatabaseName)
```
    Sets the value of ClusterProps.getDefaultDatabaseName()
    
    Parameters:
    
    defaultDatabaseName - Name of a database which is automatically created inside the cluster.
    
    Returns:
    
    this
  - encrypted
```
public ClusterProps.Builder encrypted(java.lang.Boolean encrypted)
```
    Sets the value of ClusterProps.getEncrypted()
    
    Parameters:
    
    encrypted - Whether to enable encryption of data at rest in the cluster.
    
    Returns:
    
    this
  - encryptionKey
```
public ClusterProps.Builder encryptionKey(IKey encryptionKey)
```
    Sets the value of ClusterProps.getEncryptionKey()
    
    Parameters:
    
    encryptionKey - The KMS key to use for encryption of data at rest.
    
    Returns:
    
    this
  - loggingBucket
```
public ClusterProps.Builder loggingBucket(IBucket loggingBucket)
```
    Sets the value of ClusterProps.getLoggingBucket()
    
    Parameters:
    
    loggingBucket - Bucket to send logs to. Logging information includes queries and connection attempts, for the specified Amazon Redshift cluster.
    
    Returns:
    
    this
  - loggingKeyPrefix
```
public ClusterProps.Builder loggingKeyPrefix(java.lang.String loggingKeyPrefix)
```
    Sets the value of ClusterProps.getLoggingKeyPrefix()
    
    Parameters:
    
    loggingKeyPrefix - Prefix used for logging.
    
    Returns:
    
    this
  - nodeType
```
public ClusterProps.Builder nodeType(NodeType nodeType)
```
    Sets the value of ClusterProps.getNodeType()
    
    Parameters:
    
    nodeType - The node type to be provisioned for the cluster.
    
    Returns:
    
    this
  - numberOfNodes
```
public ClusterProps.Builder numberOfNodes(java.lang.Number numberOfNodes)
```
    Sets the value of ClusterProps.getNumberOfNodes()
    
    Parameters:
    
    numberOfNodes - 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.
    
    Returns:
    
    this
  - parameterGroup
```
public ClusterProps.Builder parameterGroup(IClusterParameterGroup parameterGroup)
```
    Sets the value of ClusterProps.getParameterGroup()
    
    Parameters:
    
    parameterGroup - Additional parameters to pass to the database engine https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html.
    
    Returns:
    
    this
  - port
```
public ClusterProps.Builder port(java.lang.Number port)
```
    Sets the value of ClusterProps.getPort()
    
    Parameters:
    
    port - What port to listen on.
    
    Returns:
    
    this
  - preferredMaintenanceWindow
```
public ClusterProps.Builder preferredMaintenanceWindow(java.lang.String preferredMaintenanceWindow)
```
    Sets the value of ClusterProps.getPreferredMaintenanceWindow()
    
    Parameters:
    
    preferredMaintenanceWindow - 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'
    
    Returns:
    
    this
  - publiclyAccessible
```
public ClusterProps.Builder publiclyAccessible(java.lang.Boolean publiclyAccessible)
```
    Sets the value of ClusterProps.getPubliclyAccessible()
    
    Parameters:
    
    publiclyAccessible - Whether to make cluster publicly accessible.
    
    Returns:
    
    this
  - removalPolicy
```
public ClusterProps.Builder removalPolicy(RemovalPolicy removalPolicy)
```
    Sets the value of ClusterProps.getRemovalPolicy()
    
    Parameters:
    
    removalPolicy - The removal policy to apply when the cluster and its instances are removed from the stack or replaced during an update.
    
    Returns:
    
    this
  - roles
```
public ClusterProps.Builder roles(java.util.List<? extends IRole> roles)
```
    Sets the value of ClusterProps.getRoles()
    
    Parameters:
    
    roles - 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.
    
    Returns:
    
    this
  - securityGroups
```
public ClusterProps.Builder securityGroups(java.util.List<? extends ISecurityGroup> securityGroups)
```
    Sets the value of ClusterProps.getSecurityGroups()
    
    Parameters:
    
    securityGroups - Security group.
    
    Returns:
    
    this
  - subnetGroup
```
public ClusterProps.Builder subnetGroup(IClusterSubnetGroup subnetGroup)
```
    Sets the value of ClusterProps.getSubnetGroup()
    
    Parameters:
    
    subnetGroup - A cluster subnet group to use with this cluster.
    
    Returns:
    
    this
  - vpcSubnets
```
public ClusterProps.Builder vpcSubnets(SubnetSelection vpcSubnets)
```
    Sets the value of ClusterProps.getVpcSubnets()
    
    Parameters:
    
    vpcSubnets - Where to place the instances within the VPC.
    
    Returns:
    
    this
  - build
```
public ClusterProps build()
```
    Builds the configured instance.
    
    Returns:
    
    a new instance of ClusterProps
    
    Throws:
    
    java.lang.NullPointerException - if any required attribute was not provided

Class ClusterProps.Builder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Builder

Method Detail

masterUser

vpc

clusterName

clusterType

defaultDatabaseName

encrypted

encryptionKey

loggingBucket

loggingKeyPrefix

nodeType

numberOfNodes

parameterGroup

port

preferredMaintenanceWindow

publiclyAccessible

removalPolicy

roles

securityGroups

subnetGroup

vpcSubnets

build