software.amazon.awscdk.services.redshift

Class CfnCluster.Builder

java.lang.Object

software.amazon.awscdk.services.redshift.CfnCluster.Builder

Enclosing class:

CfnCluster

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

A fluent builder for CfnCluster.

Method Summary

Modifier and Type	Method and Description
CfnCluster.Builder	allowVersionUpgrade(java.lang.Boolean allowVersionUpgrade) If `true` , major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster.
CfnCluster.Builder	allowVersionUpgrade(IResolvable allowVersionUpgrade) If `true` , major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster.
CfnCluster.Builder	aquaConfigurationStatus(java.lang.String aquaConfigurationStatus) The value represents how the cluster is configured to use AQUA (Advanced Query Accelerator) when it is created.
CfnCluster.Builder	automatedSnapshotRetentionPeriod(java.lang.Number automatedSnapshotRetentionPeriod) The number of days that automated snapshots are retained.
CfnCluster.Builder	availabilityZone(java.lang.String availabilityZone) The EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the cluster.
CfnCluster.Builder	availabilityZoneRelocation(java.lang.Boolean availabilityZoneRelocation) The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster is created.
CfnCluster.Builder	availabilityZoneRelocation(IResolvable availabilityZoneRelocation) The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster is created.
CfnCluster.Builder	availabilityZoneRelocationStatus(java.lang.String availabilityZoneRelocationStatus) Describes the status of the Availability Zone relocation operation.
CfnCluster	build()
CfnCluster.Builder	classic(java.lang.Boolean classic) A boolean value indicating whether the resize operation is using the classic resize process.
CfnCluster.Builder	classic(IResolvable classic) A boolean value indicating whether the resize operation is using the classic resize process.
CfnCluster.Builder	clusterIdentifier(java.lang.String clusterIdentifier) A unique identifier for the cluster.
CfnCluster.Builder	clusterParameterGroupName(java.lang.String clusterParameterGroupName) The name of the parameter group to be associated with this cluster.
CfnCluster.Builder	clusterSecurityGroups(java.util.List<java.lang.String> clusterSecurityGroups) A list of security groups to be associated with this cluster.
CfnCluster.Builder	clusterSubnetGroupName(java.lang.String clusterSubnetGroupName) The name of a cluster subnet group to be associated with this cluster.
CfnCluster.Builder	clusterType(java.lang.String clusterType) The type of the cluster.
CfnCluster.Builder	clusterVersion(java.lang.String clusterVersion) The version of the Amazon Redshift engine software that you want to deploy on the cluster.
static CfnCluster.Builder	create(Construct scope, java.lang.String id)
CfnCluster.Builder	dbName(java.lang.String dbName) The name of the first database to be created when the cluster is created.
CfnCluster.Builder	deferMaintenance(java.lang.Boolean deferMaintenance) `AWS::Redshift::Cluster.DeferMaintenance`.
CfnCluster.Builder	deferMaintenance(IResolvable deferMaintenance) `AWS::Redshift::Cluster.DeferMaintenance`.
CfnCluster.Builder	deferMaintenanceDuration(java.lang.Number deferMaintenanceDuration) `AWS::Redshift::Cluster.DeferMaintenanceDuration`.
CfnCluster.Builder	deferMaintenanceEndTime(java.lang.String deferMaintenanceEndTime) `AWS::Redshift::Cluster.DeferMaintenanceEndTime`.
CfnCluster.Builder	deferMaintenanceStartTime(java.lang.String deferMaintenanceStartTime) `AWS::Redshift::Cluster.DeferMaintenanceStartTime`.
CfnCluster.Builder	destinationRegion(java.lang.String destinationRegion) The destination region that snapshots are automatically copied to when cross-region snapshot copy is enabled.
CfnCluster.Builder	elasticIp(java.lang.String elasticIp) The Elastic IP (EIP) address for the cluster.
CfnCluster.Builder	encrypted(java.lang.Boolean encrypted) If `true` , the data in the cluster is encrypted at rest.
CfnCluster.Builder	encrypted(IResolvable encrypted) If `true` , the data in the cluster is encrypted at rest.
CfnCluster.Builder	enhancedVpcRouting(java.lang.Boolean enhancedVpcRouting) An option that specifies whether to create the cluster with enhanced VPC routing enabled.
CfnCluster.Builder	enhancedVpcRouting(IResolvable enhancedVpcRouting) An option that specifies whether to create the cluster with enhanced VPC routing enabled.
CfnCluster.Builder	hsmClientCertificateIdentifier(java.lang.String hsmClientCertificateIdentifier) Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.
CfnCluster.Builder	hsmConfigurationIdentifier(java.lang.String hsmConfigurationIdentifier) Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM.
CfnCluster.Builder	iamRoles(java.util.List<java.lang.String> iamRoles) A list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services.
CfnCluster.Builder	kmsKeyId(java.lang.String kmsKeyId) The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster.
CfnCluster.Builder	loggingProperties(CfnCluster.LoggingPropertiesProperty loggingProperties) Specifies logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.
CfnCluster.Builder	loggingProperties(IResolvable loggingProperties) Specifies logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.
CfnCluster.Builder	maintenanceTrackName(java.lang.String maintenanceTrackName) An optional parameter for the name of the maintenance track for the cluster.
CfnCluster.Builder	manualSnapshotRetentionPeriod(java.lang.Number manualSnapshotRetentionPeriod) The default number of days to retain a manual snapshot.
CfnCluster.Builder	masterUsername(java.lang.String masterUsername) The user name associated with the admin user account for the cluster that is being created.
CfnCluster.Builder	masterUserPassword(java.lang.String masterUserPassword) The password associated with the admin user account for the cluster that is being created.
CfnCluster.Builder	nodeType(java.lang.String nodeType) The node type to be provisioned for the cluster.
CfnCluster.Builder	numberOfNodes(java.lang.Number numberOfNodes) The number of compute nodes in the cluster.
CfnCluster.Builder	ownerAccount(java.lang.String ownerAccount) The AWS account used to create or copy the snapshot.
CfnCluster.Builder	port(java.lang.Number port) The port number on which the cluster accepts incoming connections.
CfnCluster.Builder	preferredMaintenanceWindow(java.lang.String preferredMaintenanceWindow) The weekly time range (in UTC) during which automated cluster maintenance can occur.
CfnCluster.Builder	publiclyAccessible(java.lang.Boolean publiclyAccessible) If `true` , the cluster can be accessed from a public network.
CfnCluster.Builder	publiclyAccessible(IResolvable publiclyAccessible) If `true` , the cluster can be accessed from a public network.
CfnCluster.Builder	resourceAction(java.lang.String resourceAction) `AWS::Redshift::Cluster.ResourceAction`.
CfnCluster.Builder	revisionTarget(java.lang.String revisionTarget) `AWS::Redshift::Cluster.RevisionTarget`.
CfnCluster.Builder	rotateEncryptionKey(java.lang.Boolean rotateEncryptionKey) `AWS::Redshift::Cluster.RotateEncryptionKey`.
CfnCluster.Builder	rotateEncryptionKey(IResolvable rotateEncryptionKey) `AWS::Redshift::Cluster.RotateEncryptionKey`.
CfnCluster.Builder	snapshotClusterIdentifier(java.lang.String snapshotClusterIdentifier) The name of the cluster the source snapshot was created from.
CfnCluster.Builder	snapshotCopyGrantName(java.lang.String snapshotCopyGrantName) The name of the snapshot copy grant.
CfnCluster.Builder	snapshotCopyManual(java.lang.Boolean snapshotCopyManual) Indicates whether to apply the snapshot retention period to newly copied manual snapshots instead of automated snapshots.
CfnCluster.Builder	snapshotCopyManual(IResolvable snapshotCopyManual) Indicates whether to apply the snapshot retention period to newly copied manual snapshots instead of automated snapshots.
CfnCluster.Builder	snapshotCopyRetentionPeriod(java.lang.Number snapshotCopyRetentionPeriod) The number of days to retain automated snapshots in the destination AWS Region after they are copied from the source AWS Region .
CfnCluster.Builder	snapshotIdentifier(java.lang.String snapshotIdentifier) The name of the snapshot from which to create the new cluster.
CfnCluster.Builder	tags(java.util.List<? extends CfnTag> tags) A list of tag instances.
CfnCluster.Builder	vpcSecurityGroupIds(java.util.List<java.lang.String> vpcSecurityGroupIds) A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

public static CfnCluster.Builder create(Construct scope,
                                        java.lang.String id)

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

Returns:

a new instance of CfnCluster.EndpointProperty.Builder.

clusterType

public CfnCluster.Builder clusterType(java.lang.String clusterType)

The type of the cluster. When cluster type is specified as.

• single-node , the NumberOfNodes parameter is not required.
• multi-node , the NumberOfNodes parameter is required.

Valid Values: multi-node | single-node

Default: multi-node

Parameters:

clusterType - The type of the cluster. When cluster type is specified as. This parameter is required.

Returns:

this

dbName

public CfnCluster.Builder dbName(java.lang.String dbName)

The name of the first database to be created when the cluster is created.

To create additional databases after the cluster is created, connect to the cluster with a SQL client and use SQL commands to create a database. For more information, go to Create a Database in the Amazon Redshift Database Developer Guide.

Default: dev

Constraints:

• Must contain 1 to 64 alphanumeric characters.
• Must contain only lowercase letters.
• Cannot be a word that is reserved by the service. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.

Parameters:

dbName - The name of the first database to be created when the cluster is created. This parameter is required.

Returns:

this

masterUsername

public CfnCluster.Builder masterUsername(java.lang.String masterUsername)

The user name associated with the admin user account for the cluster that is being created.

Constraints:

• Must be 1 - 128 alphanumeric characters. The user name can't be PUBLIC .
• First character must be a letter.
• Cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.

Parameters:

masterUsername - The user name associated with the admin user account for the cluster that is being created. This parameter is required.

Returns:

this

masterUserPassword

public CfnCluster.Builder masterUserPassword(java.lang.String masterUserPassword)

The password associated with the admin user account for the cluster that is being created.

Constraints:

• Must be between 8 and 64 characters in length.
• Must contain at least one uppercase letter.
• Must contain at least one lowercase letter.
• Must contain one number.
• Can be any printable ASCII character (ASCII code 33-126) except ' (single quote), " (double quote), , /, or @.

Parameters:

masterUserPassword - The password associated with the admin user account for the cluster that is being created. This parameter is required.

Returns:

this

nodeType

public CfnCluster.Builder nodeType(java.lang.String nodeType)

The node type to be provisioned for the cluster.

For information about node types, go to Working with Clusters in the Amazon Redshift Cluster Management Guide .

Valid Values: ds2.xlarge | ds2.8xlarge | dc1.large | dc1.8xlarge | dc2.large | dc2.8xlarge | ra3.xlplus | ra3.4xlarge | ra3.16xlarge

Parameters:

nodeType - The node type to be provisioned for the cluster. This parameter is required.

Returns:

this

allowVersionUpgrade

public CfnCluster.Builder allowVersionUpgrade(java.lang.Boolean allowVersionUpgrade)

If `true` , major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster.

When a new major version of the Amazon Redshift engine is released, you can request that the service automatically apply upgrades during the maintenance window to the Amazon Redshift engine that is running on your cluster.

Default: true

Parameters:

allowVersionUpgrade - If `true` , major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster. This parameter is required.

Returns:

this

allowVersionUpgrade

public CfnCluster.Builder allowVersionUpgrade(IResolvable allowVersionUpgrade)

If `true` , major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster.

When a new major version of the Amazon Redshift engine is released, you can request that the service automatically apply upgrades during the maintenance window to the Amazon Redshift engine that is running on your cluster.

Default: true

Parameters:

allowVersionUpgrade - If `true` , major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster. This parameter is required.

Returns:

this

aquaConfigurationStatus

public CfnCluster.Builder aquaConfigurationStatus(java.lang.String aquaConfigurationStatus)

The value represents how the cluster is configured to use AQUA (Advanced Query Accelerator) when it is created.

Possible values include the following.

• enabled - Use AQUA if it is available for the current AWS Region and Amazon Redshift node type.
• disabled - Don't use AQUA.
• auto - Amazon Redshift determines whether to use AQUA.

Parameters:

aquaConfigurationStatus - The value represents how the cluster is configured to use AQUA (Advanced Query Accelerator) when it is created. This parameter is required.

Returns:

this

automatedSnapshotRetentionPeriod

public CfnCluster.Builder automatedSnapshotRetentionPeriod(java.lang.Number automatedSnapshotRetentionPeriod)

The number of days that automated snapshots are retained.

If the value is 0, automated snapshots are disabled. Even if automated snapshots are disabled, you can still create manual snapshots when you want with CreateClusterSnapshot in the Amazon Redshift API Reference .

Default: 1

Constraints: Must be a value from 0 to 35.

Parameters:

automatedSnapshotRetentionPeriod - The number of days that automated snapshots are retained. This parameter is required.

Returns:

this

availabilityZone

public CfnCluster.Builder availabilityZone(java.lang.String availabilityZone)

The EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the cluster.

For example, if you have several EC2 instances running in a specific Availability Zone, then you might want the cluster to be provisioned in the same zone in order to decrease network latency.

Default: A random, system-chosen Availability Zone in the region that is specified by the endpoint.

Example: us-east-2d

Constraint: The specified Availability Zone must be in the same region as the current endpoint.

Parameters:

availabilityZone - The EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the cluster. This parameter is required.

Returns:

this

availabilityZoneRelocation

public CfnCluster.Builder availabilityZoneRelocation(java.lang.Boolean availabilityZoneRelocation)

The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster is created.

Parameters:

availabilityZoneRelocation - The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster is created. This parameter is required.

Returns:

this

availabilityZoneRelocation

public CfnCluster.Builder availabilityZoneRelocation(IResolvable availabilityZoneRelocation)

The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster is created.

Parameters:

availabilityZoneRelocation - The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster is created. This parameter is required.

Returns:

this

availabilityZoneRelocationStatus

public CfnCluster.Builder availabilityZoneRelocationStatus(java.lang.String availabilityZoneRelocationStatus)

Describes the status of the Availability Zone relocation operation.

Parameters:

availabilityZoneRelocationStatus - Describes the status of the Availability Zone relocation operation. This parameter is required.

Returns:

this

classic

public CfnCluster.Builder classic(java.lang.Boolean classic)

A boolean value indicating whether the resize operation is using the classic resize process.

If you don't provide this parameter or set the value to false , the resize type is elastic.

Parameters:

classic - A boolean value indicating whether the resize operation is using the classic resize process. This parameter is required.

Returns:

this

classic

public CfnCluster.Builder classic(IResolvable classic)

A boolean value indicating whether the resize operation is using the classic resize process.

If you don't provide this parameter or set the value to false , the resize type is elastic.

Parameters:

classic - A boolean value indicating whether the resize operation is using the classic resize process. This parameter is required.

Returns:

this

clusterIdentifier

public CfnCluster.Builder clusterIdentifier(java.lang.String clusterIdentifier)

A unique identifier for the cluster.

You use this identifier to refer to the cluster for any subsequent cluster operations such as deleting or modifying. The identifier also appears in the Amazon Redshift console.

Constraints:

• Must contain from 1 to 63 alphanumeric characters or hyphens.
• Alphabetic characters must be lowercase.
• First character must be a letter.
• Cannot end with a hyphen or contain two consecutive hyphens.
• Must be unique for all clusters within an AWS account .

Example: myexamplecluster

Parameters:

clusterIdentifier - A unique identifier for the cluster. This parameter is required.

Returns:

this

clusterParameterGroupName

public CfnCluster.Builder clusterParameterGroupName(java.lang.String clusterParameterGroupName)

The name of the parameter group to be associated with this cluster.

Default: The default Amazon Redshift cluster parameter group. For information about the default parameter group, go to Working with Amazon Redshift Parameter Groups

Constraints:

• Must be 1 to 255 alphanumeric characters or hyphens.
• First character must be a letter.
• Cannot end with a hyphen or contain two consecutive hyphens.

Parameters:

clusterParameterGroupName - The name of the parameter group to be associated with this cluster. This parameter is required.

Returns:

this

clusterSecurityGroups

public CfnCluster.Builder clusterSecurityGroups(java.util.List<java.lang.String> clusterSecurityGroups)

A list of security groups to be associated with this cluster.

Default: The default cluster security group for Amazon Redshift.

Parameters:

clusterSecurityGroups - A list of security groups to be associated with this cluster. This parameter is required.

Returns:

this

clusterSubnetGroupName

public CfnCluster.Builder clusterSubnetGroupName(java.lang.String clusterSubnetGroupName)

The name of a cluster subnet group to be associated with this cluster.

If this parameter is not provided the resulting cluster will be deployed outside virtual private cloud (VPC).

Parameters:

clusterSubnetGroupName - The name of a cluster subnet group to be associated with this cluster. This parameter is required.

Returns:

this

clusterVersion

public CfnCluster.Builder clusterVersion(java.lang.String clusterVersion)

The version of the Amazon Redshift engine software that you want to deploy on the cluster.

The version selected runs on all the nodes in the cluster.

Constraints: Only version 1.0 is currently available.

Example: 1.0

Parameters:

clusterVersion - The version of the Amazon Redshift engine software that you want to deploy on the cluster. This parameter is required.

Returns:

this

deferMaintenance

public CfnCluster.Builder deferMaintenance(java.lang.Boolean deferMaintenance)

`AWS::Redshift::Cluster.DeferMaintenance`.

Parameters:

deferMaintenance - `AWS::Redshift::Cluster.DeferMaintenance`. This parameter is required.

Returns:

this

deferMaintenance

public CfnCluster.Builder deferMaintenance(IResolvable deferMaintenance)

`AWS::Redshift::Cluster.DeferMaintenance`.

Parameters:

deferMaintenance - `AWS::Redshift::Cluster.DeferMaintenance`. This parameter is required.

Returns:

this

deferMaintenanceDuration

public CfnCluster.Builder deferMaintenanceDuration(java.lang.Number deferMaintenanceDuration)

`AWS::Redshift::Cluster.DeferMaintenanceDuration`.

Parameters:

deferMaintenanceDuration - `AWS::Redshift::Cluster.DeferMaintenanceDuration`. This parameter is required.

Returns:

this

deferMaintenanceEndTime

public CfnCluster.Builder deferMaintenanceEndTime(java.lang.String deferMaintenanceEndTime)

`AWS::Redshift::Cluster.DeferMaintenanceEndTime`.

Parameters:

deferMaintenanceEndTime - `AWS::Redshift::Cluster.DeferMaintenanceEndTime`. This parameter is required.

Returns:

this

deferMaintenanceStartTime

public CfnCluster.Builder deferMaintenanceStartTime(java.lang.String deferMaintenanceStartTime)

`AWS::Redshift::Cluster.DeferMaintenanceStartTime`.

Parameters:

deferMaintenanceStartTime - `AWS::Redshift::Cluster.DeferMaintenanceStartTime`. This parameter is required.

Returns:

this

destinationRegion

public CfnCluster.Builder destinationRegion(java.lang.String destinationRegion)

The destination region that snapshots are automatically copied to when cross-region snapshot copy is enabled.

Parameters:

destinationRegion - The destination region that snapshots are automatically copied to when cross-region snapshot copy is enabled. This parameter is required.

Returns:

this

elasticIp

public CfnCluster.Builder elasticIp(java.lang.String elasticIp)

The Elastic IP (EIP) address for the cluster.

Constraints: The cluster must be provisioned in EC2-VPC and publicly-accessible through an Internet gateway. For more information about provisioning clusters in EC2-VPC, go to Supported Platforms to Launch Your Cluster in the Amazon Redshift Cluster Management Guide.

Parameters:

elasticIp - The Elastic IP (EIP) address for the cluster. This parameter is required.

Returns:

this

encrypted

public CfnCluster.Builder encrypted(java.lang.Boolean encrypted)

If `true` , the data in the cluster is encrypted at rest.

Default: false

Parameters:

encrypted - If `true` , the data in the cluster is encrypted at rest. This parameter is required.

Returns:

this

encrypted

public CfnCluster.Builder encrypted(IResolvable encrypted)

If `true` , the data in the cluster is encrypted at rest.

Default: false

Parameters:

encrypted - If `true` , the data in the cluster is encrypted at rest. This parameter is required.

Returns:

this

enhancedVpcRouting

public CfnCluster.Builder enhancedVpcRouting(java.lang.Boolean enhancedVpcRouting)

An option that specifies whether to create the cluster with enhanced VPC routing enabled.

To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.

If this option is true , enhanced VPC routing is enabled.

Default: false

Parameters:

enhancedVpcRouting - An option that specifies whether to create the cluster with enhanced VPC routing enabled. This parameter is required.

Returns:

this

enhancedVpcRouting

public CfnCluster.Builder enhancedVpcRouting(IResolvable enhancedVpcRouting)

An option that specifies whether to create the cluster with enhanced VPC routing enabled.

To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.

If this option is true , enhanced VPC routing is enabled.

Default: false

Parameters:

enhancedVpcRouting - An option that specifies whether to create the cluster with enhanced VPC routing enabled. This parameter is required.

Returns:

this

hsmClientCertificateIdentifier

public CfnCluster.Builder hsmClientCertificateIdentifier(java.lang.String hsmClientCertificateIdentifier)

Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.

Parameters:

hsmClientCertificateIdentifier - Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM. This parameter is required.

Returns:

this

hsmConfigurationIdentifier

public CfnCluster.Builder hsmConfigurationIdentifier(java.lang.String hsmConfigurationIdentifier)

Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM.

Parameters:

hsmConfigurationIdentifier - Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM. This parameter is required.

Returns:

this

iamRoles

public CfnCluster.Builder iamRoles(java.util.List<java.lang.String> iamRoles)

A list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services.

You must supply the IAM roles in their Amazon Resource Name (ARN) format.

The maximum number of IAM roles that you can associate is subject to a quota. For more information, go to Quotas and limits in the Amazon Redshift Cluster Management Guide .

Parameters:

iamRoles - A list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services. This parameter is required.

Returns:

this

kmsKeyId

public CfnCluster.Builder kmsKeyId(java.lang.String kmsKeyId)

The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster.

Parameters:

kmsKeyId - The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster. This parameter is required.

Returns:

this

loggingProperties

public CfnCluster.Builder loggingProperties(IResolvable loggingProperties)

Specifies logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.

Parameters:

loggingProperties - Specifies logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster. This parameter is required.

Returns:

this

loggingProperties

public CfnCluster.Builder loggingProperties(CfnCluster.LoggingPropertiesProperty loggingProperties)

Specifies logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.

Parameters:

loggingProperties - Specifies logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster. This parameter is required.

Returns:

this

maintenanceTrackName

public CfnCluster.Builder maintenanceTrackName(java.lang.String maintenanceTrackName)

An optional parameter for the name of the maintenance track for the cluster.

If you don't provide a maintenance track name, the cluster is assigned to the current track.

Parameters:

maintenanceTrackName - An optional parameter for the name of the maintenance track for the cluster. This parameter is required.

Returns:

this

manualSnapshotRetentionPeriod

public CfnCluster.Builder manualSnapshotRetentionPeriod(java.lang.Number manualSnapshotRetentionPeriod)

The default number of days to retain a manual snapshot.

If the value is -1, the snapshot is retained indefinitely. This setting doesn't change the retention period of existing snapshots.

The value must be either -1 or an integer between 1 and 3,653.

Parameters:

manualSnapshotRetentionPeriod - The default number of days to retain a manual snapshot. This parameter is required.

Returns:

this

numberOfNodes

public CfnCluster.Builder numberOfNodes(java.lang.Number numberOfNodes)

The number of compute nodes in the cluster.

This parameter is required when the ClusterType parameter is specified as multi-node .

For information about determining how many nodes you need, go to Working with Clusters in the Amazon Redshift Cluster Management Guide .

If you don't specify this parameter, you get a single-node cluster. When requesting a multi-node cluster, you must specify the number of nodes that you want in the cluster.

Default: 1

Constraints: Value must be at least 1 and no more than 100.

Parameters:

numberOfNodes - The number of compute nodes in the cluster. This parameter is required.

Returns:

this

ownerAccount

public CfnCluster.Builder ownerAccount(java.lang.String ownerAccount)

The AWS account used to create or copy the snapshot.

Required if you are restoring a snapshot you do not own, optional if you own the snapshot.

Parameters:

ownerAccount - The AWS account used to create or copy the snapshot. This parameter is required.

Returns:

this

port

public CfnCluster.Builder port(java.lang.Number port)

The port number on which the cluster accepts incoming connections.

The cluster is accessible only via the JDBC and ODBC connection strings. Part of the connection string requires the port on which the cluster will listen for incoming connections.

Default: 5439

Valid Values: 1150-65535

Parameters:

port - The port number on which the cluster accepts incoming connections. This parameter is required.

Returns:

this

preferredMaintenanceWindow

public CfnCluster.Builder preferredMaintenanceWindow(java.lang.String preferredMaintenanceWindow)

The weekly time range (in UTC) during which automated cluster maintenance can occur.

Format: ddd:hh24:mi-ddd:hh24:mi

Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. For more information about the time blocks for each region, see Maintenance Windows in Amazon Redshift Cluster Management Guide.

Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun

Constraints: Minimum 30-minute window.

Parameters:

preferredMaintenanceWindow - The weekly time range (in UTC) during which automated cluster maintenance can occur. This parameter is required.

Returns:

this

publiclyAccessible

public CfnCluster.Builder publiclyAccessible(java.lang.Boolean publiclyAccessible)

If `true` , the cluster can be accessed from a public network.

Parameters:

publiclyAccessible - If `true` , the cluster can be accessed from a public network. This parameter is required.

Returns:

this

publiclyAccessible

public CfnCluster.Builder publiclyAccessible(IResolvable publiclyAccessible)

If `true` , the cluster can be accessed from a public network.

Parameters:

publiclyAccessible - If `true` , the cluster can be accessed from a public network. This parameter is required.

Returns:

this

resourceAction

public CfnCluster.Builder resourceAction(java.lang.String resourceAction)

`AWS::Redshift::Cluster.ResourceAction`.

Parameters:

resourceAction - `AWS::Redshift::Cluster.ResourceAction`. This parameter is required.

Returns:

this

revisionTarget

public CfnCluster.Builder revisionTarget(java.lang.String revisionTarget)

`AWS::Redshift::Cluster.RevisionTarget`.

Parameters:

revisionTarget - `AWS::Redshift::Cluster.RevisionTarget`. This parameter is required.

Returns:

this

rotateEncryptionKey

public CfnCluster.Builder rotateEncryptionKey(java.lang.Boolean rotateEncryptionKey)

`AWS::Redshift::Cluster.RotateEncryptionKey`.

Parameters:

rotateEncryptionKey - `AWS::Redshift::Cluster.RotateEncryptionKey`. This parameter is required.

Returns:

this

rotateEncryptionKey

public CfnCluster.Builder rotateEncryptionKey(IResolvable rotateEncryptionKey)

`AWS::Redshift::Cluster.RotateEncryptionKey`.

Parameters:

rotateEncryptionKey - `AWS::Redshift::Cluster.RotateEncryptionKey`. This parameter is required.

Returns:

this

snapshotClusterIdentifier

public CfnCluster.Builder snapshotClusterIdentifier(java.lang.String snapshotClusterIdentifier)

The name of the cluster the source snapshot was created from.

This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name.

Parameters:

snapshotClusterIdentifier - The name of the cluster the source snapshot was created from. This parameter is required.

Returns:

this

snapshotCopyGrantName

public CfnCluster.Builder snapshotCopyGrantName(java.lang.String snapshotCopyGrantName)

The name of the snapshot copy grant.

Parameters:

snapshotCopyGrantName - The name of the snapshot copy grant. This parameter is required.

Returns:

this

snapshotCopyManual

public CfnCluster.Builder snapshotCopyManual(java.lang.Boolean snapshotCopyManual)

Indicates whether to apply the snapshot retention period to newly copied manual snapshots instead of automated snapshots.

Parameters:

snapshotCopyManual - Indicates whether to apply the snapshot retention period to newly copied manual snapshots instead of automated snapshots. This parameter is required.

Returns:

this

snapshotCopyManual

public CfnCluster.Builder snapshotCopyManual(IResolvable snapshotCopyManual)

Indicates whether to apply the snapshot retention period to newly copied manual snapshots instead of automated snapshots.

Parameters:

snapshotCopyManual - Indicates whether to apply the snapshot retention period to newly copied manual snapshots instead of automated snapshots. This parameter is required.

Returns:

this

snapshotCopyRetentionPeriod

public CfnCluster.Builder snapshotCopyRetentionPeriod(java.lang.Number snapshotCopyRetentionPeriod)

The number of days to retain automated snapshots in the destination AWS Region after they are copied from the source AWS Region .

By default, this only changes the retention period of copied automated snapshots.

If you decrease the retention period for automated snapshots that are copied to a destination AWS Region , Amazon Redshift deletes any existing automated snapshots that were copied to the destination AWS Region and that fall outside of the new retention period.

Constraints: Must be at least 1 and no more than 35 for automated snapshots.

If you specify the manual option, only newly copied manual snapshots will have the new retention period.

If you specify the value of -1 newly copied manual snapshots are retained indefinitely.

Constraints: The number of days must be either -1 or an integer between 1 and 3,653 for manual snapshots.

Parameters:

snapshotCopyRetentionPeriod - The number of days to retain automated snapshots in the destination AWS Region after they are copied from the source AWS Region . This parameter is required.

Returns:

this

snapshotIdentifier

public CfnCluster.Builder snapshotIdentifier(java.lang.String snapshotIdentifier)

The name of the snapshot from which to create the new cluster. This parameter isn't case sensitive.

Example: my-snapshot-id

Parameters:

snapshotIdentifier - The name of the snapshot from which to create the new cluster. This parameter isn't case sensitive. This parameter is required.

Returns:

this

tags

public CfnCluster.Builder tags(java.util.List<? extends CfnTag> tags)

A list of tag instances.

Parameters:

tags - A list of tag instances. This parameter is required.

Returns:

this

vpcSecurityGroupIds

public CfnCluster.Builder vpcSecurityGroupIds(java.util.List<java.lang.String> vpcSecurityGroupIds)

A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.

Default: The default VPC security group is associated with the cluster.

Parameters:

vpcSecurityGroupIds - A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster. This parameter is required.

Returns:

this

build

public CfnCluster build()