Interface CreateClusterRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<CreateClusterRequest.Builder,
,CreateClusterRequest> RedshiftRequest.Builder
,SdkBuilder<CreateClusterRequest.Builder,
,CreateClusterRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
CreateClusterRequest
-
Method Summary
Modifier and TypeMethodDescriptionadditionalInfo
(String additionalInfo) Reserved.allowVersionUpgrade
(Boolean 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.aquaConfigurationStatus
(AquaConfigurationStatus aquaConfigurationStatus) This parameter is retired.automatedSnapshotRetentionPeriod
(Integer 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.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
(String... clusterSecurityGroups) A list of security groups to be associated with this cluster.clusterSecurityGroups
(Collection<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.The name of the first database to be created when the cluster is created.defaultIamRoleArn
(String defaultIamRoleArn) The Amazon Resource Name (ARN) for the IAM role that was set as default for the cluster when the cluster was created.The Elastic IP (EIP) address for the cluster.Iftrue
, the data in the cluster is encrypted at rest.enhancedVpcRouting
(Boolean 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 Identity and Access Management (IAM) roles that can be used by the cluster to access other Amazon Web Services services.iamRoles
(Collection<String> iamRoles) A list of Identity and Access Management (IAM) roles that can be used by the cluster to access other Amazon Web Services services.ipAddressType
(String ipAddressType) The IP address types that the cluster supports.The Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster.loadSampleData
(String loadSampleData) A flag that specifies whether to load sample data once the cluster is created.maintenanceTrackName
(String maintenanceTrackName) An optional parameter for the name of the maintenance track for the cluster.manageMasterPassword
(Boolean manageMasterPassword) Iftrue
, Amazon Redshift uses Secrets Manager to manage this cluster's admin credentials.manualSnapshotRetentionPeriod
(Integer manualSnapshotRetentionPeriod) The default number of days to retain a manual snapshot.masterPasswordSecretKmsKeyId
(String masterPasswordSecretKmsKeyId) The ID of the 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.If true, Amazon Redshift will deploy the cluster in two Availability Zones (AZ).The node type to be provisioned for the cluster.numberOfNodes
(Integer numberOfNodes) The number of compute nodes in the cluster.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.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.redshiftIdcApplicationArn
(String redshiftIdcApplicationArn) The Amazon resource name (ARN) of the Amazon Redshift IAM Identity Center application.snapshotScheduleIdentifier
(String snapshotScheduleIdentifier) A unique identifier for the snapshot schedule.tags
(Collection<Tag> tags) A list of tag instances.tags
(Consumer<Tag.Builder>... tags) A list of tag instances.A list of tag instances.vpcSecurityGroupIds
(String... vpcSecurityGroupIds) A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.vpcSecurityGroupIds
(Collection<String> vpcSecurityGroupIds) A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.redshift.model.RedshiftRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
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.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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
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 Amazon Web Services account.
Example:
myexamplecluster
- Parameters:
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 Amazon Web Services account.
Example:
myexamplecluster
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
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-
single-node
, the NumberOfNodes parameter is not required. -
multi-node
, the NumberOfNodes parameter is required.
Valid Values:
multi-node
|single-node
Default:
multi-node
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
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. 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
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
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.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@
.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
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.Default: The default cluster security group for Amazon Redshift.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.Default: The default cluster security group for Amazon Redshift.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.Default: The default VPC security group is associated with the cluster.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.Default: The default VPC security group is associated with the cluster.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.If this parameter is not provided the resulting cluster will be deployed outside virtual private cloud (VPC).
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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. 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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
automatedSnapshotRetentionPeriod
CreateClusterRequest.Builder automatedSnapshotRetentionPeriod(Integer 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.
You can't disable automated snapshots for RA3 node types. Set the automated retention period from 1-35 days.
Default:
1
Constraints: Must be a value from 0 to 35.
- Parameters:
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.You can't disable automated snapshots for RA3 node types. Set the automated retention period from 1-35 days.
Default:
1
Constraints: Must be a value from 0 to 35.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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. 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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 ds2 or dc2 nodes - Select a port within the range
1150-65535
.
- Parameters:
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 ds2 or dc2 nodes - Select a port within the range
1150-65535
.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
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.The version selected runs on all the nodes in the cluster.
Constraints: Only version 1.0 is currently available.
Example:
1.0
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
- 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
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 when the ClusterType parameter is specified asmulti-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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
publiclyAccessible
If
true
, the cluster can be accessed from a public network.- Parameters:
publiclyAccessible
- Iftrue
, the cluster can be accessed from a public network.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
encrypted
If
true
, the data in the cluster is encrypted at rest.Default: false
- Parameters:
encrypted
- Iftrue
, the data in the cluster is encrypted at rest.Default: false
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
A list of tag instances.
- Parameters:
tags
- A list of tag instances.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
A list of tag instances.
- Parameters:
tags
- A list of tag instances.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
A list of tag instances.
This is a convenience method that creates an instance of theTag.Builder
avoiding the need to create one manually viaTag.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totags(List<Tag>)
.- Parameters:
tags
- a consumer that will call methods onTag.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
kmsKeyId
The Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster.
- Parameters:
kmsKeyId
- The Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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. 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
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
additionalInfo
Reserved.
- Parameters:
additionalInfo
- Reserved.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
iamRoles
A list of Identity and Access Management (IAM) roles that can be used by the cluster to access other Amazon Web Services 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 Identity and Access Management (IAM) roles that can be used by the cluster to access other Amazon Web Services 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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
iamRoles
A list of Identity and Access Management (IAM) roles that can be used by the cluster to access other Amazon Web Services 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 Identity and Access Management (IAM) roles that can be used by the cluster to access other Amazon Web Services 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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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. If you don't provide a maintenance track name, the cluster is assigned to thecurrent
track.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
snapshotScheduleIdentifier
A unique identifier for the snapshot schedule.
- Parameters:
snapshotScheduleIdentifier
- A unique identifier for the snapshot schedule.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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. It does not set the AQUA configuration status. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
aquaConfigurationStatus
CreateClusterRequest.Builder aquaConfigurationStatus(AquaConfigurationStatus 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. It does not set the AQUA configuration status. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
defaultIamRoleArn
The Amazon Resource Name (ARN) for the IAM role that was set as default for the cluster when the cluster was created.
- Parameters:
defaultIamRoleArn
- The Amazon Resource Name (ARN) for the IAM role that was set as default for the cluster when the cluster was created.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
loadSampleData
A flag that specifies whether to load sample data once the cluster is created.
- Parameters:
loadSampleData
- A flag that specifies whether to load sample data once the cluster is created.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
manageMasterPassword
If
true
, Amazon Redshift uses Secrets Manager to manage this cluster's admin credentials. You can't useMasterUserPassword
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 Secrets Manager to manage this cluster's admin credentials. You can't useMasterUserPassword
ifManageMasterPassword
is true. IfManageMasterPassword
is false or not set, Amazon Redshift usesMasterUserPassword
for the admin user account's password.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
masterPasswordSecretKmsKeyId
The ID of the 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 Key Management Service (KMS) key used to encrypt and store the cluster's admin credentials secret. You can only use this parameter ifManageMasterPassword
is true.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
ipAddressType
The IP address types that the cluster supports. Possible values are
ipv4
anddualstack
.- Parameters:
ipAddressType
- The IP address types that the cluster supports. Possible values areipv4
anddualstack
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
multiAZ
If true, Amazon Redshift will deploy the cluster in two Availability Zones (AZ).
- Parameters:
multiAZ
- If true, Amazon Redshift will deploy the cluster in two Availability Zones (AZ).- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
redshiftIdcApplicationArn
The Amazon resource name (ARN) of the Amazon Redshift IAM Identity Center application.
- Parameters:
redshiftIdcApplicationArn
- The Amazon resource name (ARN) of the Amazon Redshift IAM Identity Center application.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
CreateClusterRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
CreateClusterRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-