Class CfnCluster.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnCluster>
- Enclosing class:
CfnCluster
CfnCluster
.-
Method Summary
Modifier and TypeMethodDescriptionallowVersionUpgrade
(Boolean allowVersionUpgrade) Iftrue
, major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster.allowVersionUpgrade
(IResolvable allowVersionUpgrade) Iftrue
, major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster.aquaConfigurationStatus
(String aquaConfigurationStatus) This parameter is retired.automatedSnapshotRetentionPeriod
(Number automatedSnapshotRetentionPeriod) The number of days that automated snapshots are retained.availabilityZone
(String availabilityZone) The EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the cluster.availabilityZoneRelocation
(Boolean availabilityZoneRelocation) The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster is created.availabilityZoneRelocation
(IResolvable availabilityZoneRelocation) The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster is created.availabilityZoneRelocationStatus
(String availabilityZoneRelocationStatus) Describes the status of the Availability Zone relocation operation.build()
A boolean value indicating whether the resize operation is using the classic resize process.classic
(IResolvable classic) A boolean value indicating whether the resize operation is using the classic resize process.clusterIdentifier
(String clusterIdentifier) A unique identifier for the cluster.clusterParameterGroupName
(String clusterParameterGroupName) The name of the parameter group to be associated with this cluster.clusterSecurityGroups
(List<String> clusterSecurityGroups) A list of security groups to be associated with this cluster.clusterSubnetGroupName
(String clusterSubnetGroupName) The name of a cluster subnet group to be associated with this cluster.clusterType
(String clusterType) The type of the cluster.clusterVersion
(String clusterVersion) The version of the Amazon Redshift engine software that you want to deploy on the cluster.static CfnCluster.Builder
The name of the first database to be created when the cluster is created.deferMaintenance
(Boolean deferMaintenance) A Boolean indicating whether to enable the deferred maintenance window.deferMaintenance
(IResolvable deferMaintenance) A Boolean indicating whether to enable the deferred maintenance window.deferMaintenanceDuration
(Number deferMaintenanceDuration) An integer indicating the duration of the maintenance window in days.deferMaintenanceEndTime
(String deferMaintenanceEndTime) A timestamp for the end of the time period when we defer maintenance.deferMaintenanceStartTime
(String deferMaintenanceStartTime) A timestamp indicating the start time for the deferred maintenance window.destinationRegion
(String destinationRegion) The destination region that snapshots are automatically copied to when cross-region snapshot copy is enabled.The Elastic IP (EIP) address for the cluster.Iftrue
, the data in the cluster is encrypted at rest.encrypted
(IResolvable encrypted) Iftrue
, the data in the cluster is encrypted at rest.endpoint
(IResolvable endpoint) The connection endpoint.endpoint
(CfnCluster.EndpointProperty endpoint) The connection endpoint.enhancedVpcRouting
(Boolean enhancedVpcRouting) An option that specifies whether to create the cluster with enhanced VPC routing enabled.enhancedVpcRouting
(IResolvable enhancedVpcRouting) An option that specifies whether to create the cluster with enhanced VPC routing enabled.hsmClientCertificateIdentifier
(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.hsmConfigurationIdentifier
(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.A list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services.The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster.loggingProperties
(IResolvable loggingProperties) Specifies logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.loggingProperties
(CfnCluster.LoggingPropertiesProperty loggingProperties) Specifies logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.maintenanceTrackName
(String maintenanceTrackName) An optional parameter for the name of the maintenance track for the cluster.manageMasterPassword
(Boolean manageMasterPassword) Iftrue
, Amazon Redshift uses AWS Secrets Manager to manage this cluster's admin credentials.manageMasterPassword
(IResolvable manageMasterPassword) Iftrue
, Amazon Redshift uses AWS Secrets Manager to manage this cluster's admin credentials.manualSnapshotRetentionPeriod
(Number manualSnapshotRetentionPeriod) The default number of days to retain a manual snapshot.masterPasswordSecretKmsKeyId
(String masterPasswordSecretKmsKeyId) The ID of the AWS Key Management Service (KMS) key used to encrypt and store the cluster's admin credentials secret.masterUsername
(String masterUsername) The user name associated with the admin user account for the cluster that is being created.masterUserPassword
(String masterUserPassword) The password associated with the admin user account for the cluster that is being created.A boolean indicating whether Amazon Redshift should deploy the cluster in two Availability Zones.multiAz
(IResolvable multiAz) A boolean indicating whether Amazon Redshift should deploy the cluster in two Availability Zones.namespaceResourcePolicy
(Object namespaceResourcePolicy) The policy that is attached to a resource.The node type to be provisioned for the cluster.numberOfNodes
(Number numberOfNodes) The number of compute nodes in the cluster.ownerAccount
(String ownerAccount) The AWS account used to create or copy the snapshot.The port number on which the cluster accepts incoming connections.preferredMaintenanceWindow
(String preferredMaintenanceWindow) The weekly time range (in UTC) during which automated cluster maintenance can occur.publiclyAccessible
(Boolean publiclyAccessible) Iftrue
, the cluster can be accessed from a public network.publiclyAccessible
(IResolvable publiclyAccessible) Iftrue
, the cluster can be accessed from a public network.resourceAction
(String resourceAction) The Amazon Redshift operation to be performed.revisionTarget
(String revisionTarget) Describes aRevisionTarget
object.rotateEncryptionKey
(Boolean rotateEncryptionKey) Rotates the encryption keys for a cluster.rotateEncryptionKey
(IResolvable rotateEncryptionKey) Rotates the encryption keys for a cluster.snapshotClusterIdentifier
(String snapshotClusterIdentifier) The name of the cluster the source snapshot was created from.snapshotCopyGrantName
(String snapshotCopyGrantName) The name of the snapshot copy grant.snapshotCopyManual
(Boolean snapshotCopyManual) Indicates whether to apply the snapshot retention period to newly copied manual snapshots instead of automated snapshots.snapshotCopyManual
(IResolvable snapshotCopyManual) Indicates whether to apply the snapshot retention period to newly copied manual snapshots instead of automated snapshots.snapshotCopyRetentionPeriod
(Number snapshotCopyRetentionPeriod) The number of days to retain automated snapshots in the destination AWS Region after they are copied from the source AWS Region .snapshotIdentifier
(String snapshotIdentifier) The name of the snapshot from which to create the new cluster.A list of tag instances.vpcSecurityGroupIds
(List<String> vpcSecurityGroupIds) A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.
-
Method Details
-
create
@Stability(Stable) public static CfnCluster.Builder create(software.constructs.Construct scope, String id) - Parameters:
scope
- Scope in which this resource is defined. This parameter is required.id
- Construct identifier for this resource (unique in its scope). This parameter is required.- Returns:
- a new instance of
CfnCluster.Builder
.
-
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
- See Also:
-
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
- See Also:
-
masterUsername
The user name associated with the admin user account for the cluster that is being created.Constraints:
- Must be 1 - 128 alphanumeric characters or hyphens. The user name can't be
PUBLIC
. - Must contain only lowercase letters, numbers, underscore, plus sign, period (dot), at symbol (@), or hyphen.
- The first character must be a letter.
- Must not contain a colon (:) or a slash (/).
- 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
- See Also:
- Must be 1 - 128 alphanumeric characters or hyphens. The user name can't be
-
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:
dc2.large
|dc2.8xlarge
|ra3.large
|ra3.xlplus
|ra3.4xlarge
|ra3.16xlarge
- Parameters:
nodeType
- The node type to be provisioned for the cluster. This parameter is required.- Returns:
this
- See Also:
-
allowVersionUpgrade
Iftrue
, 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
- Iftrue
, 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
- See Also:
-
allowVersionUpgrade
Iftrue
, 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
- Iftrue
, 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
- See Also:
-
aquaConfigurationStatus
@Stability(Stable) public CfnCluster.Builder aquaConfigurationStatus(String aquaConfigurationStatus) This parameter is retired.It does not set the AQUA configuration status. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).
- Parameters:
aquaConfigurationStatus
- This parameter is retired. This parameter is required.- Returns:
this
- See Also:
-
automatedSnapshotRetentionPeriod
@Stability(Stable) public CfnCluster.Builder automatedSnapshotRetentionPeriod(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
- See Also:
-
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
- See Also:
-
availabilityZoneRelocation
@Stability(Stable) public CfnCluster.Builder availabilityZoneRelocation(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
- See Also:
-
availabilityZoneRelocation
@Stability(Stable) 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
- See Also:
-
availabilityZoneRelocationStatus
@Stability(Stable) public CfnCluster.Builder availabilityZoneRelocationStatus(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
- See Also:
-
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
- See Also:
-
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
- See Also:
-
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
- See Also:
-
clusterParameterGroupName
@Stability(Stable) public CfnCluster.Builder clusterParameterGroupName(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
- See Also:
-
clusterSecurityGroups
@Stability(Stable) public CfnCluster.Builder clusterSecurityGroups(List<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
- See Also:
-
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
- See Also:
-
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
- See Also:
-
deferMaintenance
A Boolean indicating whether to enable the deferred maintenance window.- Parameters:
deferMaintenance
- A Boolean indicating whether to enable the deferred maintenance window. This parameter is required.- Returns:
this
- See Also:
-
deferMaintenance
A Boolean indicating whether to enable the deferred maintenance window.- Parameters:
deferMaintenance
- A Boolean indicating whether to enable the deferred maintenance window. This parameter is required.- Returns:
this
- See Also:
-
deferMaintenanceDuration
@Stability(Stable) public CfnCluster.Builder deferMaintenanceDuration(Number deferMaintenanceDuration) An integer indicating the duration of the maintenance window in days.If you specify a duration, you can't specify an end time. The duration must be 45 days or less.
- Parameters:
deferMaintenanceDuration
- An integer indicating the duration of the maintenance window in days. This parameter is required.- Returns:
this
- See Also:
-
deferMaintenanceEndTime
@Stability(Stable) public CfnCluster.Builder deferMaintenanceEndTime(String deferMaintenanceEndTime) A timestamp for the end of the time period when we defer maintenance.- Parameters:
deferMaintenanceEndTime
- A timestamp for the end of the time period when we defer maintenance. This parameter is required.- Returns:
this
- See Also:
-
deferMaintenanceStartTime
@Stability(Stable) public CfnCluster.Builder deferMaintenanceStartTime(String deferMaintenanceStartTime) A timestamp indicating the start time for the deferred maintenance window.- Parameters:
deferMaintenanceStartTime
- A timestamp indicating the start time for the deferred maintenance window. This parameter is required.- Returns:
this
- See Also:
-
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
- See Also:
-
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. Don't specify the Elastic IP address for a publicly accessible cluster with availability zone relocation turned on. 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
- See Also:
-
encrypted
Iftrue
, the data in the cluster is encrypted at rest.Default: false
- Parameters:
encrypted
- Iftrue
, the data in the cluster is encrypted at rest. This parameter is required.- Returns:
this
- See Also:
-
encrypted
Iftrue
, the data in the cluster is encrypted at rest.Default: false
- Parameters:
encrypted
- Iftrue
, the data in the cluster is encrypted at rest. This parameter is required.- Returns:
this
- See Also:
-
endpoint
The connection endpoint.- Parameters:
endpoint
- The connection endpoint. This parameter is required.- Returns:
this
- See Also:
-
endpoint
The connection endpoint.- Parameters:
endpoint
- The connection endpoint. This parameter is required.- Returns:
this
- See Also:
-
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
- See Also:
-
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
- See Also:
-
hsmClientCertificateIdentifier
@Stability(Stable) public CfnCluster.Builder hsmClientCertificateIdentifier(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
- See Also:
-
hsmConfigurationIdentifier
@Stability(Stable) public CfnCluster.Builder hsmConfigurationIdentifier(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
- See Also:
-
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
- See Also:
-
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
- See Also:
-
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
- See Also:
-
loggingProperties
@Stability(Stable) 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
- See Also:
-
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
- See Also:
-
manageMasterPassword
Iftrue
, Amazon Redshift uses AWS Secrets Manager to manage this cluster's admin credentials.You can't use
MasterUserPassword
ifManageMasterPassword
is true. IfManageMasterPassword
is false or not set, Amazon Redshift usesMasterUserPassword
for the admin user account's password.- Parameters:
manageMasterPassword
- Iftrue
, Amazon Redshift uses AWS Secrets Manager to manage this cluster's admin credentials. This parameter is required.- Returns:
this
- See Also:
-
manageMasterPassword
Iftrue
, Amazon Redshift uses AWS Secrets Manager to manage this cluster's admin credentials.You can't use
MasterUserPassword
ifManageMasterPassword
is true. IfManageMasterPassword
is false or not set, Amazon Redshift usesMasterUserPassword
for the admin user account's password.- Parameters:
manageMasterPassword
- Iftrue
, Amazon Redshift uses AWS Secrets Manager to manage this cluster's admin credentials. This parameter is required.- Returns:
this
- See Also:
-
manualSnapshotRetentionPeriod
@Stability(Stable) public CfnCluster.Builder manualSnapshotRetentionPeriod(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
- See Also:
-
masterPasswordSecretKmsKeyId
@Stability(Stable) public CfnCluster.Builder masterPasswordSecretKmsKeyId(String masterPasswordSecretKmsKeyId) The ID of the AWS Key Management Service (KMS) key used to encrypt and store the cluster's admin credentials secret.You can only use this parameter if
ManageMasterPassword
is true.- Parameters:
masterPasswordSecretKmsKeyId
- The ID of the AWS Key Management Service (KMS) key used to encrypt and store the cluster's admin credentials secret. This parameter is required.- Returns:
this
- See Also:
-
masterUserPassword
The password associated with the admin user account for the cluster that is being created.You can't use
MasterUserPassword
ifManageMasterPassword
istrue
.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
- See Also:
-
multiAz
A boolean indicating whether Amazon Redshift should deploy the cluster in two Availability Zones.The default is false.
- Parameters:
multiAz
- A boolean indicating whether Amazon Redshift should deploy the cluster in two Availability Zones. This parameter is required.- Returns:
this
- See Also:
-
multiAz
A boolean indicating whether Amazon Redshift should deploy the cluster in two Availability Zones.The default is false.
- Parameters:
multiAz
- A boolean indicating whether Amazon Redshift should deploy the cluster in two Availability Zones. This parameter is required.- Returns:
this
- See Also:
-
namespaceResourcePolicy
@Stability(Stable) public CfnCluster.Builder namespaceResourcePolicy(Object namespaceResourcePolicy) The policy that is attached to a resource.- Parameters:
namespaceResourcePolicy
- The policy that is attached to a resource. This parameter is required.- Returns:
this
- See Also:
-
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
- See Also:
-
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
- See Also:
-
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:
- For clusters with ra3 nodes - Select a port within the ranges
5431-5455
or8191-8215
. (If you have an existing cluster with ra3 nodes, it isn't required that you change the port to these ranges.) - For clusters with dc2 nodes - Select a port within the range
1150-65535
.
- Parameters:
port
- The port number on which the cluster accepts incoming connections. This parameter is required.- Returns:
this
- See Also:
- For clusters with ra3 nodes - Select a port within the ranges
-
preferredMaintenanceWindow
@Stability(Stable) public CfnCluster.Builder preferredMaintenanceWindow(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
- See Also:
-
publiclyAccessible
Iftrue
, the cluster can be accessed from a public network.- Parameters:
publiclyAccessible
- Iftrue
, the cluster can be accessed from a public network. This parameter is required.- Returns:
this
- See Also:
-
publiclyAccessible
Iftrue
, the cluster can be accessed from a public network.- Parameters:
publiclyAccessible
- Iftrue
, the cluster can be accessed from a public network. This parameter is required.- Returns:
this
- See Also:
-
resourceAction
The Amazon Redshift operation to be performed.Supported operations are
pause-cluster
,resume-cluster
, andfailover-primary-compute
.- Parameters:
resourceAction
- The Amazon Redshift operation to be performed. This parameter is required.- Returns:
this
- See Also:
-
revisionTarget
Describes aRevisionTarget
object.- Parameters:
revisionTarget
- Describes aRevisionTarget
object. This parameter is required.- Returns:
this
- See Also:
-
rotateEncryptionKey
Rotates the encryption keys for a cluster.- Parameters:
rotateEncryptionKey
- Rotates the encryption keys for a cluster. This parameter is required.- Returns:
this
- See Also:
-
rotateEncryptionKey
Rotates the encryption keys for a cluster.- Parameters:
rotateEncryptionKey
- Rotates the encryption keys for a cluster. This parameter is required.- Returns:
this
- See Also:
-
snapshotClusterIdentifier
@Stability(Stable) public CfnCluster.Builder snapshotClusterIdentifier(String snapshotClusterIdentifier) The name of the cluster the source snapshot was created from.This parameter is required if your user or role 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
- See Also:
-
snapshotCopyGrantName
The name of the snapshot copy grant.- Parameters:
snapshotCopyGrantName
- The name of the snapshot copy grant. This parameter is required.- Returns:
this
- See Also:
-
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
- See Also:
-
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
- See Also:
-
snapshotCopyRetentionPeriod
@Stability(Stable) public CfnCluster.Builder snapshotCopyRetentionPeriod(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
- See Also:
-
snapshotIdentifier
The name of the snapshot from which to create the new cluster.This parameter isn't case sensitive. You must specify this parameter or
snapshotArn
, but not both.Example:
my-snapshot-id
- Parameters:
snapshotIdentifier
- The name of the snapshot from which to create the new cluster. This parameter is required.- Returns:
this
- See Also:
-
tags
A list of tag instances.- Parameters:
tags
- A list of tag instances. This parameter is required.- Returns:
this
- See Also:
-
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
- See Also:
-
build
- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<CfnCluster>
- Returns:
- a newly built instance of
CfnCluster
.
-