@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. |
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.
|
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 |
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) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest . |
int |
hashCode() |
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 AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS
services.
|
String |
kmsKeyId()
The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the
cluster.
|
String |
masterUsername()
The user name associated with the master user account for the cluster that is being created.
|
String |
masterUserPassword()
The password associated with the master 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. |
static Class<? extends CreateClusterRequest.Builder> |
serializableBuilderClass() |
List<Tag> |
tags()
A list of tag instances.
|
CreateClusterRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
List<String> |
vpcSecurityGroupIds()
A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.
|
overrideConfiguration
copy
public 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 String clusterIdentifier()
A unique identifier for the cluster. You use this identifier to refer to the cluster for any subsequent cluster operations such as deleting or modifying. The identifier also appears in the Amazon Redshift console.
Constraints:
Must contain from 1 to 63 alphanumeric characters or hyphens.
Alphabetic characters must be lowercase.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Must be unique for all clusters within an AWS account.
Example: myexamplecluster
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
public 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 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: ds1.xlarge
| ds1.8xlarge
| ds2.xlarge
|
ds2.8xlarge
| dc1.large
| dc1.8xlarge
.
Valid Values: ds1.xlarge
| ds1.8xlarge
| ds2.xlarge
|
ds2.8xlarge
| dc1.large
| dc1.8xlarge
.
public String masterUsername()
The user name associated with the master user account for the cluster that is being created.
Constraints:
Must be 1 - 128 alphanumeric characters.
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.
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 String masterUserPassword()
The password associated with the master 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 to 126) except ' (single quote), " (double quote), \, /, @, or space.
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 to 126) except ' (single quote), " (double quote), \, /, @, or space.
public 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.
Default: The default cluster security group for Amazon Redshift.
public 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.
Default: The default VPC security group is associated with the cluster.
public 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 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-1d
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-1d
Constraint: The specified Availability Zone must be in the same region as the current endpoint.
public 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 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 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.
Default: 1
Constraints: Must be a value from 0 to 35.
Default: 1
Constraints: Must be a value from 0 to 35.
public 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 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 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 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 Boolean publiclyAccessible()
If true
, the cluster can be accessed from a public network.
true
, the cluster can be accessed from a public network.public 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 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 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 String elasticIp()
The Elastic IP (EIP) address for the cluster.
Constraints: The cluster must be provisioned in EC2-VPC and publicly-accessible through an Internet gateway. For more information about provisioning clusters in EC2-VPC, go to Supported Platforms to Launch Your Cluster in the Amazon Redshift Cluster Management Guide.
Constraints: The cluster must be provisioned in EC2-VPC and publicly-accessible through an Internet gateway. For more information about provisioning clusters in EC2-VPC, go to Supported Platforms to Launch Your Cluster in the Amazon Redshift Cluster Management Guide.
public List<Tag> tags()
A list of tag instances.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public String kmsKeyId()
The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster.
public 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 String additionalInfo()
Reserved.
public List<String> iamRoles()
A list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services. You must supply the IAM roles in their Amazon Resource Name (ARN) format. You can supply up to 10 IAM roles in a single request.
A cluster can have up to 10 IAM roles associated with it at any time.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
A cluster can have up to 10 IAM roles associated with it at any time.
public CreateClusterRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<CreateClusterRequest.Builder,CreateClusterRequest>
toBuilder
in class RedshiftRequest
public static CreateClusterRequest.Builder builder()
public static Class<? extends CreateClusterRequest.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
SdkRequest
. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.