public class CreateClusterRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP
Constructor and Description |
---|
CreateClusterRequest() |
Modifier and Type | Method and Description |
---|---|
CreateClusterRequest |
clone() |
boolean |
equals(Object obj) |
String |
getAdditionalInfo()
Reserved.
|
Boolean |
getAllowVersionUpgrade()
If
true , major version upgrades can be applied during the
maintenance window to the Amazon Redshift engine that is running on the
cluster. |
Integer |
getAutomatedSnapshotRetentionPeriod()
The number of days that automated snapshots are retained.
|
String |
getAvailabilityZone()
The EC2 Availability Zone (AZ) in which you want Amazon Redshift to
provision the cluster.
|
String |
getClusterIdentifier()
A unique identifier for the cluster.
|
String |
getClusterParameterGroupName()
The name of the parameter group to be associated with this cluster.
|
List<String> |
getClusterSecurityGroups()
A list of security groups to be associated with this cluster.
|
String |
getClusterSubnetGroupName()
The name of a cluster subnet group to be associated with this cluster.
|
String |
getClusterType()
The type of the cluster.
|
String |
getClusterVersion()
The version of the Amazon Redshift engine software that you want to
deploy on the cluster.
|
String |
getDBName()
The name of the first database to be created when the cluster is created.
|
String |
getElasticIp()
The Elastic IP (EIP) address for the cluster.
|
Boolean |
getEncrypted()
If
true , the data in the cluster is encrypted at rest. |
String |
getHsmClientCertificateIdentifier()
Specifies the name of the HSM client certificate the Amazon Redshift
cluster uses to retrieve the data encryption keys stored in an HSM.
|
String |
getHsmConfigurationIdentifier()
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> |
getIamRoles()
A list of AWS Identity and Access Management (IAM) roles that can be used
by the cluster to access other AWS services.
|
String |
getKmsKeyId()
The AWS Key Management Service (KMS) key ID of the encryption key that
you want to use to encrypt data in the cluster.
|
String |
getMasterUsername()
The user name associated with the master user account for the cluster
that is being created.
|
String |
getMasterUserPassword()
The password associated with the master user account for the cluster that
is being created.
|
String |
getNodeType()
The node type to be provisioned for the cluster.
|
Integer |
getNumberOfNodes()
The number of compute nodes in the cluster.
|
Integer |
getPort()
The port number on which the cluster accepts incoming connections.
|
String |
getPreferredMaintenanceWindow()
The weekly time range (in UTC) during which automated cluster maintenance
can occur.
|
Boolean |
getPubliclyAccessible()
If
true , the cluster can be accessed from a public network. |
List<Tag> |
getTags()
A list of tag instances.
|
List<String> |
getVpcSecurityGroupIds()
A list of Virtual Private Cloud (VPC) security groups to be associated
with the cluster.
|
int |
hashCode() |
Boolean |
isAllowVersionUpgrade()
If
true , major version upgrades can be applied during the
maintenance window to the Amazon Redshift engine that is running on the
cluster. |
Boolean |
isEncrypted()
If
true , the data in the cluster is encrypted at rest. |
Boolean |
isPubliclyAccessible()
If
true , the cluster can be accessed from a public network. |
void |
setAdditionalInfo(String additionalInfo)
Reserved.
|
void |
setAllowVersionUpgrade(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. |
void |
setAutomatedSnapshotRetentionPeriod(Integer automatedSnapshotRetentionPeriod)
The number of days that automated snapshots are retained.
|
void |
setAvailabilityZone(String availabilityZone)
The EC2 Availability Zone (AZ) in which you want Amazon Redshift to
provision the cluster.
|
void |
setClusterIdentifier(String clusterIdentifier)
A unique identifier for the cluster.
|
void |
setClusterParameterGroupName(String clusterParameterGroupName)
The name of the parameter group to be associated with this cluster.
|
void |
setClusterSecurityGroups(Collection<String> clusterSecurityGroups)
A list of security groups to be associated with this cluster.
|
void |
setClusterSubnetGroupName(String clusterSubnetGroupName)
The name of a cluster subnet group to be associated with this cluster.
|
void |
setClusterType(String clusterType)
The type of the cluster.
|
void |
setClusterVersion(String clusterVersion)
The version of the Amazon Redshift engine software that you want to
deploy on the cluster.
|
void |
setDBName(String dBName)
The name of the first database to be created when the cluster is created.
|
void |
setElasticIp(String elasticIp)
The Elastic IP (EIP) address for the cluster.
|
void |
setEncrypted(Boolean encrypted)
If
true , the data in the cluster is encrypted at rest. |
void |
setHsmClientCertificateIdentifier(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.
|
void |
setHsmConfigurationIdentifier(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.
|
void |
setIamRoles(Collection<String> iamRoles)
A list of AWS Identity and Access Management (IAM) roles that can be used
by the cluster to access other AWS services.
|
void |
setKmsKeyId(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.
|
void |
setMasterUsername(String masterUsername)
The user name associated with the master user account for the cluster
that is being created.
|
void |
setMasterUserPassword(String masterUserPassword)
The password associated with the master user account for the cluster that
is being created.
|
void |
setNodeType(String nodeType)
The node type to be provisioned for the cluster.
|
void |
setNumberOfNodes(Integer numberOfNodes)
The number of compute nodes in the cluster.
|
void |
setPort(Integer port)
The port number on which the cluster accepts incoming connections.
|
void |
setPreferredMaintenanceWindow(String preferredMaintenanceWindow)
The weekly time range (in UTC) during which automated cluster maintenance
can occur.
|
void |
setPubliclyAccessible(Boolean publiclyAccessible)
If
true , the cluster can be accessed from a public network. |
void |
setTags(Collection<Tag> tags)
A list of tag instances.
|
void |
setVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)
A list of Virtual Private Cloud (VPC) security groups to be associated
with the cluster.
|
String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
CreateClusterRequest |
withAdditionalInfo(String additionalInfo)
Reserved.
|
CreateClusterRequest |
withAllowVersionUpgrade(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. |
CreateClusterRequest |
withAutomatedSnapshotRetentionPeriod(Integer automatedSnapshotRetentionPeriod)
The number of days that automated snapshots are retained.
|
CreateClusterRequest |
withAvailabilityZone(String availabilityZone)
The EC2 Availability Zone (AZ) in which you want Amazon Redshift to
provision the cluster.
|
CreateClusterRequest |
withClusterIdentifier(String clusterIdentifier)
A unique identifier for the cluster.
|
CreateClusterRequest |
withClusterParameterGroupName(String clusterParameterGroupName)
The name of the parameter group to be associated with this cluster.
|
CreateClusterRequest |
withClusterSecurityGroups(Collection<String> clusterSecurityGroups)
A list of security groups to be associated with this cluster.
|
CreateClusterRequest |
withClusterSecurityGroups(String... clusterSecurityGroups)
A list of security groups to be associated with this cluster.
|
CreateClusterRequest |
withClusterSubnetGroupName(String clusterSubnetGroupName)
The name of a cluster subnet group to be associated with this cluster.
|
CreateClusterRequest |
withClusterType(String clusterType)
The type of the cluster.
|
CreateClusterRequest |
withClusterVersion(String clusterVersion)
The version of the Amazon Redshift engine software that you want to
deploy on the cluster.
|
CreateClusterRequest |
withDBName(String dBName)
The name of the first database to be created when the cluster is created.
|
CreateClusterRequest |
withElasticIp(String elasticIp)
The Elastic IP (EIP) address for the cluster.
|
CreateClusterRequest |
withEncrypted(Boolean encrypted)
If
true , the data in the cluster is encrypted at rest. |
CreateClusterRequest |
withHsmClientCertificateIdentifier(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.
|
CreateClusterRequest |
withHsmConfigurationIdentifier(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.
|
CreateClusterRequest |
withIamRoles(Collection<String> iamRoles)
A list of AWS Identity and Access Management (IAM) roles that can be used
by the cluster to access other AWS services.
|
CreateClusterRequest |
withIamRoles(String... iamRoles)
A list of AWS Identity and Access Management (IAM) roles that can be used
by the cluster to access other AWS services.
|
CreateClusterRequest |
withKmsKeyId(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.
|
CreateClusterRequest |
withMasterUsername(String masterUsername)
The user name associated with the master user account for the cluster
that is being created.
|
CreateClusterRequest |
withMasterUserPassword(String masterUserPassword)
The password associated with the master user account for the cluster that
is being created.
|
CreateClusterRequest |
withNodeType(String nodeType)
The node type to be provisioned for the cluster.
|
CreateClusterRequest |
withNumberOfNodes(Integer numberOfNodes)
The number of compute nodes in the cluster.
|
CreateClusterRequest |
withPort(Integer port)
The port number on which the cluster accepts incoming connections.
|
CreateClusterRequest |
withPreferredMaintenanceWindow(String preferredMaintenanceWindow)
The weekly time range (in UTC) during which automated cluster maintenance
can occur.
|
CreateClusterRequest |
withPubliclyAccessible(Boolean publiclyAccessible)
If
true , the cluster can be accessed from a public network. |
CreateClusterRequest |
withTags(Collection<Tag> tags)
A list of tag instances.
|
CreateClusterRequest |
withTags(Tag... tags)
A list of tag instances.
|
CreateClusterRequest |
withVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)
A list of Virtual Private Cloud (VPC) security groups to be associated
with the cluster.
|
CreateClusterRequest |
withVpcSecurityGroupIds(String... vpcSecurityGroupIds)
A list of Virtual Private Cloud (VPC) security groups to be associated
with the cluster.
|
copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
public void setDBName(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:
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:
public String getDBName()
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:
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:
public CreateClusterRequest withDBName(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:
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:
public void setClusterIdentifier(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:
Example: myexamplecluster
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:
Example: myexamplecluster
public String getClusterIdentifier()
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:
Example: myexamplecluster
Constraints:
Example: myexamplecluster
public CreateClusterRequest withClusterIdentifier(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:
Example: myexamplecluster
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:
Example: myexamplecluster
public void setClusterType(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
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
public String getClusterType()
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 CreateClusterRequest withClusterType(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
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
public void setNodeType(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
.
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
.
public String getNodeType()
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 CreateClusterRequest withNodeType(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
.
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
.
public void setMasterUsername(String masterUsername)
The user name associated with the master user account for the cluster that is being created.
Constraints:
masterUsername
- The user name associated with the master user account for the
cluster that is being created.
Constraints:
public String getMasterUsername()
The user name associated with the master user account for the cluster that is being created.
Constraints:
Constraints:
public CreateClusterRequest withMasterUsername(String masterUsername)
The user name associated with the master user account for the cluster that is being created.
Constraints:
masterUsername
- The user name associated with the master user account for the
cluster that is being created.
Constraints:
public void setMasterUserPassword(String masterUserPassword)
The password associated with the master user account for the cluster that is being created.
Constraints:
masterUserPassword
- The password associated with the master user account for the
cluster that is being created.
Constraints:
public String getMasterUserPassword()
The password associated with the master user account for the cluster that is being created.
Constraints:
Constraints:
public CreateClusterRequest withMasterUserPassword(String masterUserPassword)
The password associated with the master user account for the cluster that is being created.
Constraints:
masterUserPassword
- The password associated with the master user account for the
cluster that is being created.
Constraints:
public List<String> getClusterSecurityGroups()
A list of security groups to be associated with this cluster.
Default: The default cluster security group for Amazon Redshift.
Default: The default cluster security group for Amazon Redshift.
public void setClusterSecurityGroups(Collection<String> clusterSecurityGroups)
A list of security groups to be associated with this cluster.
Default: The default cluster security group for Amazon Redshift.
clusterSecurityGroups
- A list of security groups to be associated with this cluster.
Default: The default cluster security group for Amazon Redshift.
public CreateClusterRequest withClusterSecurityGroups(String... clusterSecurityGroups)
A list of security groups to be associated with this cluster.
Default: The default cluster security group for Amazon Redshift.
NOTE: This method appends the values to the existing list (if
any). Use setClusterSecurityGroups(java.util.Collection)
or
withClusterSecurityGroups(java.util.Collection)
if you want to
override the existing values.
clusterSecurityGroups
- A list of security groups to be associated with this cluster.
Default: The default cluster security group for Amazon Redshift.
public CreateClusterRequest withClusterSecurityGroups(Collection<String> clusterSecurityGroups)
A list of security groups to be associated with this cluster.
Default: The default cluster security group for Amazon Redshift.
clusterSecurityGroups
- A list of security groups to be associated with this cluster.
Default: The default cluster security group for Amazon Redshift.
public List<String> getVpcSecurityGroupIds()
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.
Default: The default VPC security group is associated with the cluster.
public void setVpcSecurityGroupIds(Collection<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.
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.
public CreateClusterRequest withVpcSecurityGroupIds(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.
NOTE: This method appends the values to the existing list (if
any). Use setVpcSecurityGroupIds(java.util.Collection)
or
withVpcSecurityGroupIds(java.util.Collection)
if you want to
override the existing values.
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.
public CreateClusterRequest withVpcSecurityGroupIds(Collection<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.
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.
public void setClusterSubnetGroupName(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).
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).
public String getClusterSubnetGroupName()
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 CreateClusterRequest withClusterSubnetGroupName(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).
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).
public void setAvailabilityZone(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.
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.
public String getAvailabilityZone()
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 CreateClusterRequest withAvailabilityZone(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.
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.
public void setPreferredMaintenanceWindow(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.
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.
public String getPreferredMaintenanceWindow()
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 CreateClusterRequest withPreferredMaintenanceWindow(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.
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.
public void setClusterParameterGroupName(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:
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:
public String getClusterParameterGroupName()
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:
Default: The default Amazon Redshift cluster parameter group. For information about the default parameter group, go to Working with Amazon Redshift Parameter Groups
Constraints:
public CreateClusterRequest withClusterParameterGroupName(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:
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:
public void setAutomatedSnapshotRetentionPeriod(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.
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.
public Integer getAutomatedSnapshotRetentionPeriod()
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 CreateClusterRequest withAutomatedSnapshotRetentionPeriod(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.
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.
public void setPort(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
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
public Integer getPort()
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 CreateClusterRequest withPort(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
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
public void setClusterVersion(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
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
public String getClusterVersion()
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 CreateClusterRequest withClusterVersion(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
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
public void setAllowVersionUpgrade(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
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
public Boolean getAllowVersionUpgrade()
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 CreateClusterRequest withAllowVersionUpgrade(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
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
public Boolean isAllowVersionUpgrade()
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 void setNumberOfNodes(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.
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.
public Integer getNumberOfNodes()
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 CreateClusterRequest withNumberOfNodes(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.
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.
public void setPubliclyAccessible(Boolean publiclyAccessible)
If true
, the cluster can be accessed from a public network.
publiclyAccessible
- If true
, the cluster can be accessed from a public
network.public Boolean getPubliclyAccessible()
If true
, the cluster can be accessed from a public network.
true
, the cluster can be accessed from a public
network.public CreateClusterRequest withPubliclyAccessible(Boolean publiclyAccessible)
If true
, the cluster can be accessed from a public network.
publiclyAccessible
- If true
, the cluster can be accessed from a public
network.public Boolean isPubliclyAccessible()
If true
, the cluster can be accessed from a public network.
true
, the cluster can be accessed from a public
network.public void setEncrypted(Boolean encrypted)
If true
, the data in the cluster is encrypted at rest.
Default: false
encrypted
- If true
, the data in the cluster is encrypted at
rest.
Default: false
public Boolean getEncrypted()
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 CreateClusterRequest withEncrypted(Boolean encrypted)
If true
, the data in the cluster is encrypted at rest.
Default: false
encrypted
- If true
, the data in the cluster is encrypted at
rest.
Default: false
public Boolean isEncrypted()
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 void setHsmClientCertificateIdentifier(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.
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 getHsmClientCertificateIdentifier()
Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.
public CreateClusterRequest withHsmClientCertificateIdentifier(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.
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 void setHsmConfigurationIdentifier(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.
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 getHsmConfigurationIdentifier()
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 CreateClusterRequest withHsmConfigurationIdentifier(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.
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 void setElasticIp(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.
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.
public String getElasticIp()
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 CreateClusterRequest withElasticIp(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.
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.
public void setTags(Collection<Tag> tags)
A list of tag instances.
tags
- A list of tag instances.public CreateClusterRequest withTags(Tag... tags)
A list of tag instances.
NOTE: This method appends the values to the existing list (if
any). Use setTags(java.util.Collection)
or
withTags(java.util.Collection)
if you want to override the
existing values.
tags
- A list of tag instances.public CreateClusterRequest withTags(Collection<Tag> tags)
A list of tag instances.
tags
- A list of tag instances.public void setKmsKeyId(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.
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 String getKmsKeyId()
The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster.
public CreateClusterRequest withKmsKeyId(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.
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 void setAdditionalInfo(String additionalInfo)
Reserved.
additionalInfo
- Reserved.public String getAdditionalInfo()
Reserved.
public CreateClusterRequest withAdditionalInfo(String additionalInfo)
Reserved.
additionalInfo
- Reserved.public List<String> getIamRoles()
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 at any time.
A cluster can have up to 10 IAM roles associated at any time.
public void setIamRoles(Collection<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 at any time.
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 at any time.
public CreateClusterRequest withIamRoles(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 at any time.
NOTE: This method appends the values to the existing list (if
any). Use setIamRoles(java.util.Collection)
or
withIamRoles(java.util.Collection)
if you want to override the
existing values.
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 at any time.
public CreateClusterRequest withIamRoles(Collection<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 at any time.
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 at any time.
public String toString()
toString
in class Object
Object.toString()
public CreateClusterRequest clone()
clone
in class AmazonWebServiceRequest
Copyright © 2016. All rights reserved.