Package software.amazon.awscdk.services.redshift.alpha

Class ClusterProps.Builder

java.lang.Object

software.amazon.awscdk.services.redshift.alpha.ClusterProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<ClusterProps>

Enclosing interface:

ClusterProps

@Stability(Experimental)
public static final class ClusterProps.Builder
extends Object
implements software.amazon.jsii.Builder<ClusterProps>

A builder for ClusterProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ClusterProps	build()	Builds the configured instance.
ClusterProps.Builder	classicResizing(Boolean classicResizing)	Sets the value of ClusterProps.getClassicResizing()
ClusterProps.Builder	clusterName(String clusterName)	Sets the value of ClusterProps.getClusterName()
ClusterProps.Builder	clusterType(ClusterType clusterType)	Sets the value of ClusterProps.getClusterType()
ClusterProps.Builder	defaultDatabaseName(String defaultDatabaseName)	Sets the value of ClusterProps.getDefaultDatabaseName()
ClusterProps.Builder	defaultRole(IRole defaultRole)	Sets the value of ClusterProps.getDefaultRole()
ClusterProps.Builder	elasticIp(String elasticIp)	Sets the value of ClusterProps.getElasticIp()
ClusterProps.Builder	encrypted(Boolean encrypted)	Sets the value of ClusterProps.getEncrypted()
ClusterProps.Builder	encryptionKey(IKey encryptionKey)	Sets the value of ClusterProps.getEncryptionKey()
ClusterProps.Builder	enhancedVpcRouting(Boolean enhancedVpcRouting)	Sets the value of ClusterProps.getEnhancedVpcRouting()
ClusterProps.Builder	loggingProperties(LoggingProperties loggingProperties)	Sets the value of ClusterProps.getLoggingProperties()
ClusterProps.Builder	masterUser(Login masterUser)	Sets the value of ClusterProps.getMasterUser()
ClusterProps.Builder	multiAz(Boolean multiAz)	Sets the value of ClusterProps.getMultiAz()
ClusterProps.Builder	nodeType(NodeType nodeType)	Sets the value of ClusterProps.getNodeType()
ClusterProps.Builder	numberOfNodes(Number numberOfNodes)	Sets the value of ClusterProps.getNumberOfNodes()
ClusterProps.Builder	parameterGroup(IClusterParameterGroup parameterGroup)	Sets the value of ClusterProps.getParameterGroup()
ClusterProps.Builder	port(Number port)	Sets the value of ClusterProps.getPort()
ClusterProps.Builder	preferredMaintenanceWindow(String preferredMaintenanceWindow)	Sets the value of ClusterProps.getPreferredMaintenanceWindow()
ClusterProps.Builder	publiclyAccessible(Boolean publiclyAccessible)	Sets the value of ClusterProps.getPubliclyAccessible()
ClusterProps.Builder	rebootForParameterChanges(Boolean rebootForParameterChanges)	Sets the value of ClusterProps.getRebootForParameterChanges()
ClusterProps.Builder	removalPolicy(RemovalPolicy removalPolicy)	Sets the value of ClusterProps.getRemovalPolicy()
ClusterProps.Builder	roles(List<? extends IRole> roles)	Sets the value of ClusterProps.getRoles()
ClusterProps.Builder	securityGroups(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 Details

Builder

public Builder()

Method Details

masterUser

@Stability(Experimental)
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

@Stability(Experimental)
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

classicResizing

@Stability(Experimental)
public ClusterProps.Builder classicResizing(Boolean classicResizing)

Sets the value of ClusterProps.getClassicResizing()

Parameters:

classicResizing - If this flag is set, the cluster resizing type will be set to classic. When resizing a cluster, classic resizing will always provision a new cluster and transfer the data there.

Classic resize takes more time to complete, but it can be useful in cases where the change in node count or the node type to migrate to doesn't fall within the bounds for elastic resize.

Returns:

this

clusterName

@Stability(Experimental)
public ClusterProps.Builder clusterName(String clusterName)

Sets the value of ClusterProps.getClusterName()

Parameters:

clusterName - An optional identifier for the cluster.

Returns:

this

clusterType

@Stability(Experimental)
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

@Stability(Experimental)
public ClusterProps.Builder defaultDatabaseName(String defaultDatabaseName)

Sets the value of ClusterProps.getDefaultDatabaseName()

Parameters:

defaultDatabaseName - Name of a database which is automatically created inside the cluster.

Returns:

this

defaultRole

@Stability(Experimental)
public ClusterProps.Builder defaultRole(IRole defaultRole)

Sets the value of ClusterProps.getDefaultRole()

Parameters:

defaultRole - A single AWS Identity and Access Management (IAM) role to be used as the default role for the cluster. The default role must be included in the roles list.

Returns:

this

elasticIp

@Stability(Experimental)
public ClusterProps.Builder elasticIp(String elasticIp)

Sets the value of ClusterProps.getElasticIp()

Parameters:

elasticIp - The Elastic IP (EIP) address for the cluster.

Returns:

this

encrypted

@Stability(Experimental)
public ClusterProps.Builder encrypted(Boolean encrypted)

Sets the value of ClusterProps.getEncrypted()

Parameters:

encrypted - Whether to enable encryption of data at rest in the cluster.

Returns:

this

encryptionKey

@Stability(Experimental)
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

enhancedVpcRouting

@Stability(Experimental)
public ClusterProps.Builder enhancedVpcRouting(Boolean enhancedVpcRouting)

Sets the value of ClusterProps.getEnhancedVpcRouting()

Parameters:

enhancedVpcRouting - If this flag is set, Amazon Redshift forces all COPY and UNLOAD traffic between your cluster and your data repositories through your virtual private cloud (VPC).

Returns:

this

loggingProperties

@Stability(Experimental)
public ClusterProps.Builder loggingProperties(LoggingProperties loggingProperties)

Sets the value of ClusterProps.getLoggingProperties()

Parameters:

loggingProperties - Bucket details for log files to be sent to, including prefix.

Returns:

this

multiAz

@Stability(Experimental)
public ClusterProps.Builder multiAz(Boolean multiAz)

Sets the value of ClusterProps.getMultiAz()

Parameters:

multiAz - Indicating whether Amazon Redshift should deploy the cluster in two Availability Zones.

Returns:

this

nodeType

@Stability(Experimental)
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

@Stability(Experimental)
public ClusterProps.Builder numberOfNodes(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

@Stability(Experimental)
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

@Stability(Experimental)
public ClusterProps.Builder port(Number port)

Sets the value of ClusterProps.getPort()

Parameters:

port - What port to listen on.

Returns:

this

preferredMaintenanceWindow

@Stability(Experimental)
public ClusterProps.Builder preferredMaintenanceWindow(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

@Stability(Experimental)
public ClusterProps.Builder publiclyAccessible(Boolean publiclyAccessible)

Sets the value of ClusterProps.getPubliclyAccessible()

Parameters:

publiclyAccessible - Whether to make cluster publicly accessible.

Returns:

this

rebootForParameterChanges

@Stability(Experimental)
public ClusterProps.Builder rebootForParameterChanges(Boolean rebootForParameterChanges)

Sets the value of ClusterProps.getRebootForParameterChanges()

Parameters:

rebootForParameterChanges - If this flag is set, the cluster will be rebooted when changes to the cluster's parameter group that require a restart to apply.

Returns:

this

removalPolicy

@Stability(Experimental)
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

@Stability(Experimental)
public ClusterProps.Builder roles(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. The maximum number of roles to attach to a cluster is subject to a quota.

Returns:

this

securityGroups

@Stability(Experimental)
public ClusterProps.Builder securityGroups(List<? extends ISecurityGroup> securityGroups)

Sets the value of ClusterProps.getSecurityGroups()

Parameters:

securityGroups - Security group.

Returns:

this

subnetGroup

@Stability(Experimental)
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

@Stability(Experimental)
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

@Stability(Experimental)
public ClusterProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<ClusterProps>

Returns:

a new instance of ClusterProps

Throws:

NullPointerException - if any required attribute was not provided