@Generated(value="software.amazon.awssdk:codegen") public final class CreateClusterRequest extends RedshiftRequest implements ToCopyableBuilder<CreateClusterRequest.Builder,CreateClusterRequest>
| Modifier and Type | Class and Description |
|---|---|
static interface |
CreateClusterRequest.Builder |
| Modifier and Type | Method and Description |
|---|---|
String |
additionalInfo()
Reserved.
|
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. |
AquaConfigurationStatus |
aquaConfigurationStatus()
This parameter is retired.
|
String |
aquaConfigurationStatusAsString()
This parameter is retired.
|
Integer |
automatedSnapshotRetentionPeriod()
The number of days that automated snapshots are retained.
|
String |
availabilityZone()
The EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the cluster.
|
Boolean |
availabilityZoneRelocation()
The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster is
created.
|
static CreateClusterRequest.Builder |
builder() |
String |
clusterIdentifier()
A unique identifier for the cluster.
|
String |
clusterParameterGroupName()
The name of the parameter group to be associated with this cluster.
|
List<String> |
clusterSecurityGroups()
A list of security groups to be associated with this cluster.
|
String |
clusterSubnetGroupName()
The name of a cluster subnet group to be associated with this cluster.
|
String |
clusterType()
The type of the cluster.
|
String |
clusterVersion()
The version of the Amazon Redshift engine software that you want to deploy on the cluster.
|
String |
dbName()
The name of the first database to be created when the cluster is created.
|
String |
defaultIamRoleArn()
The Amazon Resource Name (ARN) for the IAM role that was set as default for the cluster when the cluster was
created.
|
String |
elasticIp()
The Elastic IP (EIP) address for the cluster.
|
Boolean |
encrypted()
If
true, the data in the cluster is encrypted at rest. |
Boolean |
enhancedVpcRouting()
An option that specifies whether to create the cluster with enhanced VPC routing enabled.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
boolean |
hasClusterSecurityGroups()
For responses, this returns true if the service returned a value for the ClusterSecurityGroups property.
|
int |
hashCode() |
boolean |
hasIamRoles()
For responses, this returns true if the service returned a value for the IamRoles property.
|
boolean |
hasTags()
For responses, this returns true if the service returned a value for the Tags property.
|
boolean |
hasVpcSecurityGroupIds()
For responses, this returns true if the service returned a value for the VpcSecurityGroupIds property.
|
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.
|
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.
|
List<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.
|
String |
kmsKeyId()
The Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the
cluster.
|
String |
loadSampleData()
A flag that specifies whether to load sample data once the cluster is created.
|
String |
maintenanceTrackName()
An optional parameter for the name of the maintenance track for the cluster.
|
Integer |
manualSnapshotRetentionPeriod()
The default number of days to retain a manual snapshot.
|
String |
masterUsername()
The user name associated with the admin user account for the cluster that is being created.
|
String |
masterUserPassword()
The password associated with the admin user account for the cluster that is being created.
|
String |
nodeType()
The node type to be provisioned for the cluster.
|
Integer |
numberOfNodes()
The number of compute nodes in the cluster.
|
Integer |
port()
The port number on which the cluster accepts incoming connections.
|
String |
preferredMaintenanceWindow()
The weekly time range (in UTC) during which automated cluster maintenance can occur.
|
Boolean |
publiclyAccessible()
If
true, the cluster can be accessed from a public network. |
List<SdkField<?>> |
sdkFields() |
static Class<? extends CreateClusterRequest.Builder> |
serializableBuilderClass() |
String |
snapshotScheduleIdentifier()
A unique identifier for the snapshot schedule.
|
List<Tag> |
tags()
A list of tag instances.
|
CreateClusterRequest.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
List<String> |
vpcSecurityGroupIds()
A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.
|
overrideConfigurationclone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic final 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.
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.
public final 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 Amazon Web Services account.
Example: myexamplecluster
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
public final 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
single-node, the NumberOfNodes parameter is not required.
multi-node, the NumberOfNodes parameter is required.
Valid Values: multi-node | single-node
Default: multi-node
public final 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
Valid Values: ds2.xlarge | ds2.8xlarge | dc1.large |
dc1.8xlarge | dc2.large | dc2.8xlarge | ra3.xlplus |
ra3.4xlarge | ra3.16xlarge
public final 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.
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.
public final 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 @.
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 @.
public final boolean hasClusterSecurityGroups()
isEmpty() method on the
property). This is useful because the SDK will never return a null collection or map, but you may need to
differentiate between the service returning nothing (or null) and the service returning an empty collection or
map. For requests, this returns true if a value for the property was specified in the request builder, and false
if a value was not specified.public final List<String> clusterSecurityGroups()
A list of security groups to be associated with this cluster.
Default: The default cluster security group for Amazon Redshift.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasClusterSecurityGroups() method.
Default: The default cluster security group for Amazon Redshift.
public final boolean hasVpcSecurityGroupIds()
isEmpty() method on the property).
This is useful because the SDK will never return a null collection or map, but you may need to differentiate
between the service returning nothing (or null) and the service returning an empty collection or map. For
requests, this returns true if a value for the property was specified in the request builder, and false if a
value was not specified.public final List<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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasVpcSecurityGroupIds() method.
Default: The default VPC security group is associated with the cluster.
public final 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).
If this parameter is not provided the resulting cluster will be deployed outside virtual private cloud (VPC).
public final 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.
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.
public final 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.
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.
public final 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.
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.
public final 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.
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.
public final Integer 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.
The value must be either -1 or an integer between 1 and 3,653.
public final Integer 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
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
public final 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
The version selected runs on all the nodes in the cluster.
Constraints: Only version 1.0 is currently available.
Example: 1.0
public final 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
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
public final Integer 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.
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.
public final Boolean publiclyAccessible()
If true, the cluster can be accessed from a public network.
true, the cluster can be accessed from a public network.public final Boolean encrypted()
If true, the data in the cluster is encrypted at rest.
Default: false
true, the data in the cluster is encrypted at rest.
Default: false
public final 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.
public final 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.
public final 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. 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.
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.
public final boolean hasTags()
isEmpty() method on the property). This is useful
because the SDK will never return a null collection or map, but you may need to differentiate between the service
returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true
if a value for the property was specified in the request builder, and false if a value was not specified.public final List<Tag> tags()
A list of tag instances.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasTags() method.
public final String kmsKeyId()
The Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster.
public final 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
If this option is true, enhanced VPC routing is enabled.
Default: false
public final String additionalInfo()
Reserved.
public final boolean hasIamRoles()
isEmpty() method on the property). This is
useful because the SDK will never return a null collection or map, but you may need to differentiate between the
service returning nothing (or null) and the service returning an empty collection or map. For requests, this
returns true if a value for the property was specified in the request builder, and false if a value was not
specified.public final List<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. 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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasIamRoles() method.
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.
public final 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.
current track.public final String snapshotScheduleIdentifier()
A unique identifier for the snapshot schedule.
public final Boolean availabilityZoneRelocation()
The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster is created.
public final 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).
If the service returns an enum value that is not available in the current SDK version,
aquaConfigurationStatus will return AquaConfigurationStatus.UNKNOWN_TO_SDK_VERSION. The raw
value returned by the service is available from aquaConfigurationStatusAsString().
AquaConfigurationStatuspublic final String aquaConfigurationStatusAsString()
This parameter is retired. It does not set the AQUA configuration status. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).
If the service returns an enum value that is not available in the current SDK version,
aquaConfigurationStatus will return AquaConfigurationStatus.UNKNOWN_TO_SDK_VERSION. The raw
value returned by the service is available from aquaConfigurationStatusAsString().
AquaConfigurationStatuspublic final String defaultIamRoleArn()
The Amazon Resource Name (ARN) for the IAM role that was set as default for the cluster when the cluster was created.
public final String loadSampleData()
A flag that specifies whether to load sample data once the cluster is created.
public CreateClusterRequest.Builder toBuilder()
toBuilder in interface ToCopyableBuilder<CreateClusterRequest.Builder,CreateClusterRequest>toBuilder in class RedshiftRequestpublic static CreateClusterRequest.Builder builder()
public static Class<? extends CreateClusterRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsRequestpublic final boolean equals(Object obj)
equals in class AwsRequestpublic final boolean equalsBySdkFields(Object obj)
equalsBySdkFields in interface SdkPojopublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField in class SdkRequestCopyright © 2022. All rights reserved.