Overview  Package   Class  Index  Help 

Did this page help you?

   Yes   No   Tell us about it...
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.amazonaws.services.redshift.model
Class CreateClusterRequest

java.lang.Object
  extended by com.amazonaws.AmazonWebServiceRequest
      extended by com.amazonaws.services.redshift.model.CreateClusterRequest
All Implemented Interfaces:
Serializable
public class CreateClusterRequest
extends AmazonWebServiceRequest
implements Serializable

Container for the parameters to the CreateCluster operation.

Creates a new cluster. To create the cluster in virtual private cloud (VPC), you must provide cluster subnet group name. If you don't provide a cluster subnet group name or the cluster security group parameter, Amazon Redshift creates a non-VPC cluster, it associates the default cluster security group with the cluster. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Management Guide .

See Also:
AmazonRedshift.createCluster(CreateClusterRequest), Serialized Form

Constructor Summary
CreateClusterRequest()
           
 
Method Summary
 boolean equals(Object obj)
           
 Boolean getAllowVersionUpgrade()
          If true, 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.
 Boolean getEncrypted()
          If true, the data in cluster is encrypted at rest.
 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<String> getVpcSecurityGroupIds()
          A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.
 int hashCode()
           
 Boolean isAllowVersionUpgrade()
          If true, 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 cluster is encrypted at rest.
 Boolean isPubliclyAccessible()
          If true, the cluster can be accessed from a public network.
 void setAllowVersionUpgrade(Boolean allowVersionUpgrade)
          If true, 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 setEncrypted(Boolean encrypted)
          If true, the data in cluster is encrypted at rest.
 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 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 withAllowVersionUpgrade(Boolean allowVersionUpgrade)
          If true, 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 withEncrypted(Boolean encrypted)
          If true, the data in cluster is encrypted at rest.
 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 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.
 
Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, setRequestCredentials
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

CreateClusterRequest

public CreateClusterRequest()
Method Detail

getDBName

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 Developer Guide.

Default: dev

Constraints:

Returns:
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 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 Developer Guide.

setDBName

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 Developer Guide.

Default: dev

Constraints:

Parameters:
dBName - The name of the first database to be created when the cluster is created.

To create additional databases after the cluster is created, connect to the cluster with a SQL client and use SQL commands to create a database. For more information, go to Create a Database in the Amazon Redshift 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 Developer Guide.

withDBName

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 Developer Guide.

Default: dev

Constraints:

Returns a reference to this object so that method calls can be chained together.

Parameters:
dBName - The name of the first database to be created when the cluster is created.

To create additional databases after the cluster is created, connect to the cluster with a SQL client and use SQL commands to create a database. For more information, go to Create a Database in the Amazon Redshift 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 Developer Guide.
Returns:
A reference to this updated object so that method calls can be chained together.

getClusterIdentifier

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

Returns:
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

setClusterIdentifier

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

Parameters:
clusterIdentifier - A unique identifier for the cluster. You use this identifier to refer to the cluster for any subsequent cluster operations such as deleting or modifying. The identifier also appears in the Amazon Redshift console.

Constraints:

  • Must contain from 1 to 63 alphanumeric characters or hyphens.
  • Alphabetic characters must be lowercase.
  • First character must be a letter.
  • Cannot end with a hyphen or contain two consecutive hyphens.
  • Must be unique for all clusters within an AWS account.

Example: myexamplecluster

withClusterIdentifier

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

Returns a reference to this object so that method calls can be chained together.

Parameters:
clusterIdentifier - A unique identifier for the cluster. You use this identifier to refer to the cluster for any subsequent cluster operations such as deleting or modifying. The identifier also appears in the Amazon Redshift console.

Constraints:

  • Must contain from 1 to 63 alphanumeric characters or hyphens.
  • Alphabetic characters must be lowercase.
  • First character must be a letter.
  • Cannot end with a hyphen or contain two consecutive hyphens.
  • Must be unique for all clusters within an AWS account.

Example: myexamplecluster

Returns:
A reference to this updated object so that method calls can be chained together.

getClusterType

public String getClusterType()
The type of the cluster. When cluster type is specified as

Valid Values: multi-node | single-node

Default: multi-node

Returns:
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

setClusterType

public void setClusterType(String clusterType)
The type of the cluster. When cluster type is specified as

Valid Values: multi-node | single-node

Default: multi-node

Parameters:
clusterType - The type of the cluster. When cluster type is specified as
  • single-node, the NumberOfNodes parameter is not required.
  • multi-node, the NumberOfNodes parameter is required.

Valid Values: multi-node | single-node

Default: multi-node

withClusterType

public CreateClusterRequest withClusterType(String clusterType)
The type of the cluster. When cluster type is specified as

Valid Values: multi-node | single-node

Default: multi-node

Returns a reference to this object so that method calls can be chained together.

Parameters:
clusterType - The type of the cluster. When cluster type is specified as
  • single-node, the NumberOfNodes parameter is not required.
  • multi-node, the NumberOfNodes parameter is required.

Valid Values: multi-node | single-node

Default: multi-node

Returns:
A reference to this updated object so that method calls can be chained together.

getNodeType

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 Management Guide.

Valid Values: dw.hs1.xlarge | dw.hs1.8xlarge.

Returns:
The node type to be provisioned for the cluster. For information about node types, go to Working with Clusters in the Amazon Redshift Management Guide.

Valid Values: dw.hs1.xlarge | dw.hs1.8xlarge.

setNodeType

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 Management Guide.

Valid Values: dw.hs1.xlarge | dw.hs1.8xlarge.

Parameters:
nodeType - The node type to be provisioned for the cluster. For information about node types, go to Working with Clusters in the Amazon Redshift Management Guide.

Valid Values: dw.hs1.xlarge | dw.hs1.8xlarge.

withNodeType

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 Management Guide.

Valid Values: dw.hs1.xlarge | dw.hs1.8xlarge.

Returns a reference to this object so that method calls can be chained together.

Parameters:
nodeType - The node type to be provisioned for the cluster. For information about node types, go to Working with Clusters in the Amazon Redshift Management Guide.

Valid Values: dw.hs1.xlarge | dw.hs1.8xlarge.

Returns:
A reference to this updated object so that method calls can be chained together.

getMasterUsername

public String getMasterUsername()
The user name associated with the master user account for the cluster that is being created.

Constraints:

Returns:
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 Developer Guide.

setMasterUsername

public void setMasterUsername(String masterUsername)
The user name associated with the master user account for the cluster that is being created.

Constraints:

Parameters:
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 Developer Guide.

withMasterUsername

public CreateClusterRequest withMasterUsername(String masterUsername)
The user name associated with the master user account for the cluster that is being created.

Constraints:

Returns a reference to this object so that method calls can be chained together.

Parameters:
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 Developer Guide.
Returns:
A reference to this updated object so that method calls can be chained together.

getMasterUserPassword

public String getMasterUserPassword()
The password associated with the master user account for the cluster that is being created.

Constraints:

Returns:
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.

setMasterUserPassword

public void setMasterUserPassword(String masterUserPassword)
The password associated with the master user account for the cluster that is being created.

Constraints:

Parameters:
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.

withMasterUserPassword

public CreateClusterRequest withMasterUserPassword(String masterUserPassword)
The password associated with the master user account for the cluster that is being created.

Constraints:

Returns a reference to this object so that method calls can be chained together.

Parameters:
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.
Returns:
A reference to this updated object so that method calls can be chained together.

getClusterSecurityGroups

public List<String> getClusterSecurityGroups()
A list of security groups to be associated with this cluster.

Default: The default cluster security group for Amazon Redshift.

Returns:
A list of security groups to be associated with this cluster.

Default: The default cluster security group for Amazon Redshift.

setClusterSecurityGroups

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.

Parameters:
clusterSecurityGroups - A list of security groups to be associated with this cluster.

Default: The default cluster security group for Amazon Redshift.

withClusterSecurityGroups

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.

Returns a reference to this object so that method calls can be chained together.

Parameters:
clusterSecurityGroups - A list of security groups to be associated with this cluster.

Default: The default cluster security group for Amazon Redshift.

Returns:
A reference to this updated object so that method calls can be chained together.

withClusterSecurityGroups

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.

Returns a reference to this object so that method calls can be chained together.

Parameters:
clusterSecurityGroups - A list of security groups to be associated with this cluster.

Default: The default cluster security group for Amazon Redshift.

Returns:
A reference to this updated object so that method calls can be chained together.

getVpcSecurityGroupIds

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.

Returns:
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.

setVpcSecurityGroupIds

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.

Parameters:
vpcSecurityGroupIds - A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.

Default: The default VPC security group is associated with the cluster.

withVpcSecurityGroupIds

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.

Returns a reference to this object so that method calls can be chained together.

Parameters:
vpcSecurityGroupIds - A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.

Default: The default VPC security group is associated with the cluster.

Returns:
A reference to this updated object so that method calls can be chained together.

withVpcSecurityGroupIds

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.

Returns a reference to this object so that method calls can be chained together.

Parameters:
vpcSecurityGroupIds - A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.

Default: The default VPC security group is associated with the cluster.

Returns:
A reference to this updated object so that method calls can be chained together.

getClusterSubnetGroupName

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).

Returns:
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).

setClusterSubnetGroupName

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).

Parameters:
clusterSubnetGroupName - The name of a cluster subnet group to be associated with this cluster.

If this parameter is not provided the resulting cluster will be deployed outside virtual private cloud (VPC).

withClusterSubnetGroupName

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).

Returns a reference to this object so that method calls can be chained together.

Parameters:
clusterSubnetGroupName - The name of a cluster subnet group to be associated with this cluster.

If this parameter is not provided the resulting cluster will be deployed outside virtual private cloud (VPC).

Returns:
A reference to this updated object so that method calls can be chained together.

getAvailabilityZone

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.

Returns:
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.

setAvailabilityZone

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.

Parameters:
availabilityZone - The EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the cluster. For example, if you have several EC2 instances running in a specific Availability Zone, then you might want the cluster to be provisioned in the same zone in order to decrease network latency.

Default: A random, system-chosen Availability Zone in the region that is specified by the endpoint.

Example: us-east-1d

Constraint: The specified Availability Zone must be in the same region as the current endpoint.

withAvailabilityZone

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.

Returns a reference to this object so that method calls can be chained together.

Parameters:
availabilityZone - The EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the cluster. For example, if you have several EC2 instances running in a specific Availability Zone, then you might want the cluster to be provisioned in the same zone in order to decrease network latency.

Default: A random, system-chosen Availability Zone in the region that is specified by the endpoint.

Example: us-east-1d

Constraint: The specified Availability Zone must be in the same region as the current endpoint.

Returns:
A reference to this updated object so that method calls can be chained together.

getPreferredMaintenanceWindow

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. The following list shows the time blocks for each region from which the default maintenance windows are assigned.

Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun

Constraints: Minimum 30-minute window.

Returns:
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. The following list shows the time blocks for each region from which the default maintenance windows are assigned.

  • US-East (Northern Virginia) Region: 03:00-11:00 UTC
  • US-West (Northern California) Region: 06:00-14:00 UTC
  • EU (Ireland) Region: 22:00-06:00 UTC
  • Asia Pacific (Singapore) Region: 14:00-22:00 UTC
  • Asia Pacific (Tokyo) Region: 17:00-03:00 UTC

Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun

Constraints: Minimum 30-minute window.

setPreferredMaintenanceWindow

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. The following list shows the time blocks for each region from which the default maintenance windows are assigned.

Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun

Constraints: Minimum 30-minute window.

Parameters:
preferredMaintenanceWindow - The weekly time range (in UTC) during which automated cluster maintenance can occur.

Format: ddd:hh24:mi-ddd:hh24:mi

Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. The following list shows the time blocks for each region from which the default maintenance windows are assigned.

  • US-East (Northern Virginia) Region: 03:00-11:00 UTC
  • US-West (Northern California) Region: 06:00-14:00 UTC
  • EU (Ireland) Region: 22:00-06:00 UTC
  • Asia Pacific (Singapore) Region: 14:00-22:00 UTC
  • Asia Pacific (Tokyo) Region: 17:00-03:00 UTC

Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun

Constraints: Minimum 30-minute window.

withPreferredMaintenanceWindow

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. The following list shows the time blocks for each region from which the default maintenance windows are assigned.

Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun

Constraints: Minimum 30-minute window.

Returns a reference to this object so that method calls can be chained together.

Parameters:
preferredMaintenanceWindow - The weekly time range (in UTC) during which automated cluster maintenance can occur.

Format: ddd:hh24:mi-ddd:hh24:mi

Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. The following list shows the time blocks for each region from which the default maintenance windows are assigned.

  • US-East (Northern Virginia) Region: 03:00-11:00 UTC
  • US-West (Northern California) Region: 06:00-14:00 UTC
  • EU (Ireland) Region: 22:00-06:00 UTC
  • Asia Pacific (Singapore) Region: 14:00-22:00 UTC
  • Asia Pacific (Tokyo) Region: 17:00-03:00 UTC

Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun

Constraints: Minimum 30-minute window.

Returns:
A reference to this updated object so that method calls can be chained together.

getClusterParameterGroupName

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:

Returns:
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.

setClusterParameterGroupName

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:

Parameters:
clusterParameterGroupName - The name of the parameter group to be associated with this cluster.

Default: The default Amazon Redshift cluster parameter group. For information about the default parameter group, go to Working with Amazon Redshift Parameter Groups

Constraints:

  • Must be 1 to 255 alphanumeric characters or hyphens.
  • First character must be a letter.
  • Cannot end with a hyphen or contain two consecutive hyphens.

withClusterParameterGroupName

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:

Returns a reference to this object so that method calls can be chained together.

Parameters:
clusterParameterGroupName - The name of the parameter group to be associated with this cluster.

Default: The default Amazon Redshift cluster parameter group. For information about the default parameter group, go to Working with Amazon Redshift Parameter Groups

Constraints:

  • Must be 1 to 255 alphanumeric characters or hyphens.
  • First character must be a letter.
  • Cannot end with a hyphen or contain two consecutive hyphens.
Returns:
A reference to this updated object so that method calls can be chained together.

getAutomatedSnapshotRetentionPeriod

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.

Returns:
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.

setAutomatedSnapshotRetentionPeriod

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.

Parameters:
automatedSnapshotRetentionPeriod - The number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Even if automated snapshots are disabled, you can still create manual snapshots when you want with CreateClusterSnapshot.

Default: 1

Constraints: Must be a value from 0 to 35.

withAutomatedSnapshotRetentionPeriod

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.

Returns a reference to this object so that method calls can be chained together.

Parameters:
automatedSnapshotRetentionPeriod - The number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Even if automated snapshots are disabled, you can still create manual snapshots when you want with CreateClusterSnapshot.

Default: 1

Constraints: Must be a value from 0 to 35.

Returns:
A reference to this updated object so that method calls can be chained together.

getPort

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

Returns:
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

setPort

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

Parameters:
port - The port number on which the cluster accepts incoming connections.

The cluster is accessible only via the JDBC and ODBC connection strings. Part of the connection string requires the port on which the cluster will listen for incoming connections.

Default: 5439

Valid Values: 1150-65535

withPort

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

Returns a reference to this object so that method calls can be chained together.

Parameters:
port - The port number on which the cluster accepts incoming connections.

The cluster is accessible only via the JDBC and ODBC connection strings. Part of the connection string requires the port on which the cluster will listen for incoming connections.

Default: 5439

Valid Values: 1150-65535

Returns:
A reference to this updated object so that method calls can be chained together.

getClusterVersion

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

Returns:
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

setClusterVersion

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

Parameters:
clusterVersion - The version of the Amazon Redshift engine software that you want to deploy on the cluster.

The version selected runs on all the nodes in the cluster.

Constraints: Only version 1.0 is currently available.

Example: 1.0

withClusterVersion

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

Returns a reference to this object so that method calls can be chained together.

Parameters:
clusterVersion - The version of the Amazon Redshift engine software that you want to deploy on the cluster.

The version selected runs on all the nodes in the cluster.

Constraints: Only version 1.0 is currently available.

Example: 1.0

Returns:
A reference to this updated object so that method calls can be chained together.

isAllowVersionUpgrade

public Boolean isAllowVersionUpgrade()
If true, upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster.

When a new version of the Amazon Redshift engine is released, you can request that the service automatically apply upgrades during the maintenance window to the Amazon Redshift engine that is running on your cluster.

Default: true

Returns:
If true, upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster.

When a new 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

setAllowVersionUpgrade

public void setAllowVersionUpgrade(Boolean allowVersionUpgrade)
If true, upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster.

When a new version of the Amazon Redshift engine is released, you can request that the service automatically apply upgrades during the maintenance window to the Amazon Redshift engine that is running on your cluster.

Default: true

Parameters:
allowVersionUpgrade - If true, upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster.

When a new 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

withAllowVersionUpgrade

public CreateClusterRequest withAllowVersionUpgrade(Boolean allowVersionUpgrade)
If true, upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster.

When a new version of the Amazon Redshift engine is released, you can request that the service automatically apply upgrades during the maintenance window to the Amazon Redshift engine that is running on your cluster.

Default: true

Returns a reference to this object so that method calls can be chained together.

Parameters:
allowVersionUpgrade - If true, upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster.

When a new version of the Amazon Redshift engine is released, you can request that the service automatically apply upgrades during the maintenance window to the Amazon Redshift engine that is running on your cluster.

Default: true

Returns:
A reference to this updated object so that method calls can be chained together.

getAllowVersionUpgrade

public Boolean getAllowVersionUpgrade()
If true, upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster.

When a new version of the Amazon Redshift engine is released, you can request that the service automatically apply upgrades during the maintenance window to the Amazon Redshift engine that is running on your cluster.

Default: true

Returns:
If true, upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster.

When a new 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

getNumberOfNodes

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 Management Guide.

If you don't specify this parameter, you get a single-node cluster. When requesting a multi-node cluster, you must specify the number of nodes that you want in the cluster.

Default: 1

Constraints: Value must be at least 1 and no more than 100.

Returns:
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 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.

setNumberOfNodes

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 Management Guide.

If you don't specify this parameter, you get a single-node cluster. When requesting a multi-node cluster, you must specify the number of nodes that you want in the cluster.

Default: 1

Constraints: Value must be at least 1 and no more than 100.

Parameters:
numberOfNodes - The number of compute nodes in the cluster. This parameter is required when the ClusterType parameter is specified as multi-node.

For information about determining how many nodes you need, go to Working with Clusters in the Amazon Redshift 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.

withNumberOfNodes

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 Management Guide.

If you don't specify this parameter, you get a single-node cluster. When requesting a multi-node cluster, you must specify the number of nodes that you want in the cluster.

Default: 1

Constraints: Value must be at least 1 and no more than 100.

Returns a reference to this object so that method calls can be chained together.

Parameters:
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 Management Guide.

If you don't specify this parameter, you get a single-node cluster. When requesting a multi-node cluster, you must specify the number of nodes that you want in the cluster.

Default: 1

Constraints: Value must be at least 1 and no more than 100.

Returns:
A reference to this updated object so that method calls can be chained together.

isPubliclyAccessible

public Boolean isPubliclyAccessible()
If true, the cluster can be accessed from a public network.

Returns:
If true, the cluster can be accessed from a public network.

setPubliclyAccessible

public void setPubliclyAccessible(Boolean publiclyAccessible)
If true, the cluster can be accessed from a public network.

Parameters:
publiclyAccessible - If true, the cluster can be accessed from a public network.

withPubliclyAccessible

public CreateClusterRequest withPubliclyAccessible(Boolean publiclyAccessible)
If true, the cluster can be accessed from a public network.

Returns a reference to this object so that method calls can be chained together.

Parameters:
publiclyAccessible - If true, the cluster can be accessed from a public network.
Returns:
A reference to this updated object so that method calls can be chained together.

getPubliclyAccessible

public Boolean getPubliclyAccessible()
If true, the cluster can be accessed from a public network.

Returns:
If true, the cluster can be accessed from a public network.

isEncrypted

public Boolean isEncrypted()
If true, the data in cluster is encrypted at rest.

Default: false

Returns:
If true, the data in cluster is encrypted at rest.

Default: false

setEncrypted

public void setEncrypted(Boolean encrypted)
If true, the data in cluster is encrypted at rest.

Default: false

Parameters:
encrypted - If true, the data in cluster is encrypted at rest.

Default: false

withEncrypted

public CreateClusterRequest withEncrypted(Boolean encrypted)
If true, the data in cluster is encrypted at rest.

Default: false

Returns a reference to this object so that method calls can be chained together.

Parameters:
encrypted - If true, the data in cluster is encrypted at rest.

Default: false

Returns:
A reference to this updated object so that method calls can be chained together.

getEncrypted

public Boolean getEncrypted()
If true, the data in cluster is encrypted at rest.

Default: false

Returns:
If true, the data in cluster is encrypted at rest.

Default: false

toString

public String toString()
Returns a string representation of this object; useful for testing and debugging.

Overrides:
toString in class Object
Returns:
A string representation of this object.
See Also:
Object.toString()

hashCode

public int hashCode()
Overrides:
hashCode in class Object

equals

public boolean equals(Object obj)
Overrides:
equals in class Object
Overview  Package   Class  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Copyright © 2010 Amazon Web Services, Inc. All Rights Reserved.