Class CreateClusterRequest
- java.lang.Object
-
- com.amazonaws.AmazonWebServiceRequest
-
- com.amazonaws.services.redshift.model.CreateClusterRequest
-
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
public class CreateClusterRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
-
Constructor Summary
Constructors Constructor Description CreateClusterRequest()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description CreateClusterRequest
clone()
Creates a shallow clone of this request.boolean
equals(Object obj)
String
getAdditionalInfo()
Reserved.Boolean
getAllowVersionUpgrade()
Iftrue
, 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()
Iftrue
, 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()
Iftrue
, 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()
Iftrue
, major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster.Boolean
isEncrypted()
Iftrue
, the data in the cluster is encrypted at rest.Boolean
isPubliclyAccessible()
Iftrue
, the cluster can be accessed from a public network.void
setAdditionalInfo(String additionalInfo)
Reserved.void
setAllowVersionUpgrade(Boolean allowVersionUpgrade)
Iftrue
, 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)
Iftrue
, 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)
Iftrue
, 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)
Iftrue
, 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(String... clusterSecurityGroups)
A list of security groups to be associated with this cluster.CreateClusterRequest
withClusterSecurityGroups(Collection<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)
Iftrue
, 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(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(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
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)
Iftrue
, the cluster can be accessed from a public network.CreateClusterRequest
withTags(Tag... tags)
A list of tag instances.CreateClusterRequest
withTags(Collection<Tag> tags)
A list of tag instances.CreateClusterRequest
withVpcSecurityGroupIds(String... vpcSecurityGroupIds)
A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.CreateClusterRequest
withVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)
A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.-
Methods inherited from class com.amazonaws.AmazonWebServiceRequest
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
-
-
-
-
Method Detail
-
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 Database Developer Guide.
Default:
dev
Constraints:
- Must contain 1 to 64 alphanumeric characters.
- Must contain only lowercase letters.
- Cannot be a word that is reserved by the service. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.
- Parameters:
dBName
- The name of the first database to be created when the cluster is created.To create additional databases after the cluster is created, connect to the cluster with a SQL client and use SQL commands to create a database. For more information, go to Create a Database in the Amazon Redshift Database Developer Guide.
Default:
dev
Constraints:
- Must contain 1 to 64 alphanumeric characters.
- Must contain only lowercase letters.
- Cannot be a word that is reserved by the service. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.
-
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 Database Developer Guide.
Default:
dev
Constraints:
- Must contain 1 to 64 alphanumeric characters.
- Must contain only lowercase letters.
- Cannot be a word that is reserved by the service. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.
- Returns:
- The name of the first database to be created when the cluster is
created.
To create additional databases after the cluster is created, connect to the cluster with a SQL client and use SQL commands to create a database. For more information, go to Create a Database in the Amazon Redshift Database Developer Guide.
Default:
dev
Constraints:
- Must contain 1 to 64 alphanumeric characters.
- Must contain only lowercase letters.
- Cannot be a word that is reserved by the service. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.
-
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 Database Developer Guide.
Default:
dev
Constraints:
- Must contain 1 to 64 alphanumeric characters.
- Must contain only lowercase letters.
- Cannot be a word that is reserved by the service. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.
- Parameters:
dBName
- The name of the first database to be created when the cluster is created.To create additional databases after the cluster is created, connect to the cluster with a SQL client and use SQL commands to create a database. For more information, go to Create a Database in the Amazon Redshift Database Developer Guide.
Default:
dev
Constraints:
- Must contain 1 to 64 alphanumeric characters.
- Must contain only lowercase letters.
- Cannot be a word that is reserved by the service. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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:
- 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
- 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
-
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:
- 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 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:
- 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
- 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:
- Returns a reference to this object so that method calls can be chained together.
-
setClusterType
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
- Parameters:
clusterType
- The type of the cluster. When cluster type is specified assingle-node
, the NumberOfNodes parameter is not required.multi-node
, the NumberOfNodes parameter is required.
Valid Values:
multi-node
|single-node
Default:
multi-node
-
getClusterType
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
- 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
-
withClusterType
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
- Parameters:
clusterType
- The type of the cluster. When cluster type is specified assingle-node
, the NumberOfNodes parameter is not required.multi-node
, the NumberOfNodes parameter is required.
Valid Values:
multi-node
|single-node
Default:
multi-node
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 Cluster Management Guide.
Valid Values:
ds1.xlarge
|ds1.8xlarge
|ds2.xlarge
|ds2.8xlarge
|dc1.large
|dc1.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 Cluster Management Guide.Valid Values:
ds1.xlarge
|ds1.8xlarge
|ds2.xlarge
|ds2.8xlarge
|dc1.large
|dc1.8xlarge
.
-
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 Cluster Management Guide.
Valid Values:
ds1.xlarge
|ds1.8xlarge
|ds2.xlarge
|ds2.8xlarge
|dc1.large
|dc1.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 Cluster
Management Guide.
Valid Values:
ds1.xlarge
|ds1.8xlarge
|ds2.xlarge
|ds2.8xlarge
|dc1.large
|dc1.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 Cluster Management Guide.
Valid Values:
ds1.xlarge
|ds1.8xlarge
|ds2.xlarge
|ds2.8xlarge
|dc1.large
|dc1.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 Cluster Management Guide.Valid Values:
ds1.xlarge
|ds1.8xlarge
|ds2.xlarge
|ds2.8xlarge
|dc1.large
|dc1.8xlarge
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setMasterUsername
public void setMasterUsername(String masterUsername)
The user name associated with the master user account for the cluster that is being created.
Constraints:
- Must be 1 - 128 alphanumeric characters.
- First character must be a letter.
- Cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.
- 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 Database Developer Guide.
-
getMasterUsername
public String getMasterUsername()
The user name associated with the master user account for the cluster that is being created.
Constraints:
- Must be 1 - 128 alphanumeric characters.
- First character must be a letter.
- Cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.
- 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 Database 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:
- Must be 1 - 128 alphanumeric characters.
- First character must be a letter.
- Cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.
- 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 Database Developer Guide.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setMasterUserPassword
public void setMasterUserPassword(String masterUserPassword)
The password associated with the master user account for the cluster that is being created.
Constraints:
- Must be between 8 and 64 characters in length.
- Must contain at least one uppercase letter.
- Must contain at least one lowercase letter.
- Must contain one number.
- Can be any printable ASCII character (ASCII code 33 to 126) except ' (single quote), " (double quote), \, /, @, or space.
- 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.
- Can be any printable ASCII character (ASCII code 33 to 126) except ' (single quote), " (double quote), \, /, @, or space.
-
getMasterUserPassword
public String getMasterUserPassword()
The password associated with the master user account for the cluster that is being created.
Constraints:
- Must be between 8 and 64 characters in length.
- Must contain at least one uppercase letter.
- Must contain at least one lowercase letter.
- Must contain one number.
- Can be any printable ASCII character (ASCII code 33 to 126) except ' (single quote), " (double quote), \, /, @, or space.
- 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.
- Can be any printable ASCII character (ASCII code 33 to 126) except ' (single quote), " (double quote), \, /, @, or space.
-
withMasterUserPassword
public CreateClusterRequest withMasterUserPassword(String masterUserPassword)
The password associated with the master user account for the cluster that is being created.
Constraints:
- Must be between 8 and 64 characters in length.
- Must contain at least one uppercase letter.
- Must contain at least one lowercase letter.
- Must contain one number.
- Can be any printable ASCII character (ASCII code 33 to 126) except ' (single quote), " (double quote), \, /, @, or space.
- 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.
- Can be any printable ASCII character (ASCII code 33 to 126) except ' (single quote), " (double quote), \, /, @, or space.
- Returns:
- Returns a reference to this 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.
NOTE: This method appends the values to the existing list (if any). Use
setClusterSecurityGroups(java.util.Collection)
orwithClusterSecurityGroups(java.util.Collection)
if you want to override the existing values.- Parameters:
clusterSecurityGroups
- A list of security groups to be associated with this cluster.Default: The default cluster security group for Amazon Redshift.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
clusterSecurityGroups
- A list of security groups to be associated with this cluster.Default: The default cluster security group for Amazon Redshift.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
NOTE: This method appends the values to the existing list (if any). Use
setVpcSecurityGroupIds(java.util.Collection)
orwithVpcSecurityGroupIds(java.util.Collection)
if you want to override the existing values.- Parameters:
vpcSecurityGroupIds
- A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.Default: The default VPC security group is associated with the cluster.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
vpcSecurityGroupIds
- A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.Default: The default VPC security group is associated with the cluster.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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).
-
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).
-
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).
- Parameters:
clusterSubnetGroupName
- The name of a cluster subnet group to be associated with this cluster.If this parameter is not provided the resulting cluster will be deployed outside virtual private cloud (VPC).
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
-
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.
-
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.
- 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:
- Returns a reference to this object so that method calls can be chained together.
-
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. For more information about the time blocks for each region, see Maintenance Windows in Amazon Redshift Cluster Management Guide.
Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun
Constraints: Minimum 30-minute window.
- Parameters:
preferredMaintenanceWindow
- The weekly time range (in UTC) during which automated cluster maintenance can occur.Format:
ddd:hh24:mi-ddd:hh24:mi
Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. For more information about the time blocks for each region, see Maintenance Windows in Amazon Redshift Cluster Management Guide.
Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun
Constraints: Minimum 30-minute window.
-
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. For more information about the time blocks for each region, see Maintenance Windows in Amazon Redshift Cluster Management Guide.
Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun
Constraints: Minimum 30-minute window.
- Returns:
- 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.
-
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. For more information about the time blocks for each region, see Maintenance Windows in Amazon Redshift Cluster Management Guide.
Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun
Constraints: Minimum 30-minute window.
- Parameters:
preferredMaintenanceWindow
- The weekly time range (in UTC) during which automated cluster maintenance can occur.Format:
ddd:hh24:mi-ddd:hh24:mi
Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. For more information about the time blocks for each region, see Maintenance Windows in Amazon Redshift Cluster Management Guide.
Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun
Constraints: Minimum 30-minute window.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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:
- Must be 1 to 255 alphanumeric characters or hyphens.
- First character must be a letter.
- Cannot end with a hyphen or contain two consecutive hyphens.
- Parameters:
clusterParameterGroupName
- The name of the parameter group to be associated with this cluster.Default: The default Amazon Redshift cluster parameter group. For information about the default parameter group, go to Working with Amazon Redshift Parameter Groups
Constraints:
- Must be 1 to 255 alphanumeric characters or hyphens.
- First character must be a letter.
- Cannot end with a hyphen or contain two consecutive hyphens.
-
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:
- 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:
- 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:
- Must be 1 to 255 alphanumeric characters or hyphens.
- First character must be a letter.
- Cannot end with a hyphen or contain two consecutive hyphens.
- Parameters:
clusterParameterGroupName
- The name of the parameter group to be associated with this cluster.Default: The default Amazon Redshift cluster parameter group. For information about the default parameter group, go to Working with Amazon Redshift Parameter Groups
Constraints:
- Must be 1 to 255 alphanumeric characters or hyphens.
- First character must be a letter.
- Cannot end with a hyphen or contain two consecutive hyphens.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
-
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.
-
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.
- 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:
- Returns a reference to this object so that method calls can be chained together.
-
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
-
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
-
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
- 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:
- Returns a reference to this object so that method calls can be chained together.
-
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
-
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
-
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
- Parameters:
clusterVersion
- The version of the Amazon Redshift engine software that you want to deploy on the cluster.The version selected runs on all the nodes in the cluster.
Constraints: Only version 1.0 is currently available.
Example:
1.0
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setAllowVersionUpgrade
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
- Parameters:
allowVersionUpgrade
- Iftrue
, major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster.When a new major version of the Amazon Redshift engine is released, you can request that the service automatically apply upgrades during the maintenance window to the Amazon Redshift engine that is running on your cluster.
Default:
true
-
getAllowVersionUpgrade
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
- Returns:
- 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
-
withAllowVersionUpgrade
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
- Parameters:
allowVersionUpgrade
- Iftrue
, major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster.When a new major version of the Amazon Redshift engine is released, you can request that the service automatically apply upgrades during the maintenance window to the Amazon Redshift engine that is running on your cluster.
Default:
true
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
isAllowVersionUpgrade
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
- Returns:
- 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
-
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 Cluster Management Guide.
If you don't specify this parameter, you get a single-node cluster. When requesting a multi-node cluster, you must specify the number of nodes that you want in the cluster.
Default:
1
Constraints: Value must be at least 1 and no more than 100.
- Parameters:
numberOfNodes
- The number of compute nodes in the cluster. This parameter is required when the ClusterType parameter is specified asmulti-node
.For information about determining how many nodes you need, go to Working with Clusters in the Amazon Redshift Cluster Management Guide.
If you don't specify this parameter, you get a single-node cluster. When requesting a multi-node cluster, you must specify the number of nodes that you want in the cluster.
Default:
1
Constraints: Value must be at least 1 and no more than 100.
-
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 Cluster Management Guide.
If you don't specify this parameter, you get a single-node cluster. When requesting a multi-node cluster, you must specify the number of nodes that you want in the cluster.
Default:
1
Constraints: Value must be at least 1 and no more than 100.
- Returns:
- 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.
-
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 Cluster Management Guide.
If you don't specify this parameter, you get a single-node cluster. When requesting a multi-node cluster, you must specify the number of nodes that you want in the cluster.
Default:
1
Constraints: Value must be at least 1 and no more than 100.
- Parameters:
numberOfNodes
- The number of compute nodes in the cluster. This parameter is required when the ClusterType parameter is specified asmulti-node
.For information about determining how many nodes you need, go to Working with Clusters in the Amazon Redshift Cluster Management Guide.
If you don't specify this parameter, you get a single-node cluster. When requesting a multi-node cluster, you must specify the number of nodes that you want in the cluster.
Default:
1
Constraints: Value must be at least 1 and no more than 100.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setPubliclyAccessible
public void setPubliclyAccessible(Boolean publiclyAccessible)
If
true
, the cluster can be accessed from a public network.- Parameters:
publiclyAccessible
- Iftrue
, the cluster can be accessed from a public network.
-
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.
-
withPubliclyAccessible
public CreateClusterRequest withPubliclyAccessible(Boolean publiclyAccessible)
If
true
, the cluster can be accessed from a public network.- Parameters:
publiclyAccessible
- Iftrue
, the cluster can be accessed from a public network.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
-
setEncrypted
public void setEncrypted(Boolean encrypted)
If
true
, the data in the cluster is encrypted at rest.Default: false
- Parameters:
encrypted
- Iftrue
, the data in the cluster is encrypted at rest.Default: false
-
getEncrypted
public Boolean getEncrypted()
If
true
, the data in the cluster is encrypted at rest.Default: false
- Returns:
- If
true
, the data in the cluster is encrypted at rest.Default: false
-
withEncrypted
public CreateClusterRequest withEncrypted(Boolean encrypted)
If
true
, the data in the cluster is encrypted at rest.Default: false
- Parameters:
encrypted
- Iftrue
, the data in the cluster is encrypted at rest.Default: false
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
isEncrypted
public Boolean isEncrypted()
If
true
, the data in the cluster is encrypted at rest.Default: false
- Returns:
- If
true
, the data in the cluster is encrypted at rest.Default: false
-
setHsmClientCertificateIdentifier
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.
- Parameters:
hsmClientCertificateIdentifier
- Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.
-
getHsmClientCertificateIdentifier
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.
- Returns:
- Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.
-
withHsmClientCertificateIdentifier
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.
- Parameters:
hsmClientCertificateIdentifier
- Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setHsmConfigurationIdentifier
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.
- Parameters:
hsmConfigurationIdentifier
- Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM.
-
getHsmConfigurationIdentifier
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.
- Returns:
- 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.
-
withHsmConfigurationIdentifier
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.
- Parameters:
hsmConfigurationIdentifier
- Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setElasticIp
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.
- Parameters:
elasticIp
- The Elastic IP (EIP) address for the cluster.Constraints: The cluster must be provisioned in EC2-VPC and publicly-accessible through an Internet gateway. For more information about provisioning clusters in EC2-VPC, go to Supported Platforms to Launch Your Cluster in the Amazon Redshift Cluster Management Guide.
-
getElasticIp
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.
- Returns:
- 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.
-
withElasticIp
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.
- Parameters:
elasticIp
- The Elastic IP (EIP) address for the cluster.Constraints: The cluster must be provisioned in EC2-VPC and publicly-accessible through an Internet gateway. For more information about provisioning clusters in EC2-VPC, go to Supported Platforms to Launch Your Cluster in the Amazon Redshift Cluster Management Guide.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setTags
public void setTags(Collection<Tag> tags)
A list of tag instances.
- Parameters:
tags
- A list of tag instances.
-
withTags
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)
orwithTags(java.util.Collection)
if you want to override the existing values.- Parameters:
tags
- A list of tag instances.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withTags
public CreateClusterRequest withTags(Collection<Tag> tags)
A list of tag instances.
- Parameters:
tags
- A list of tag instances.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setKmsKeyId
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.
- Parameters:
kmsKeyId
- The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster.
-
getKmsKeyId
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.
- Returns:
- The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster.
-
withKmsKeyId
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.
- Parameters:
kmsKeyId
- The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setAdditionalInfo
public void setAdditionalInfo(String additionalInfo)
Reserved.
- Parameters:
additionalInfo
- Reserved.
-
getAdditionalInfo
public String getAdditionalInfo()
Reserved.
- Returns:
- Reserved.
-
withAdditionalInfo
public CreateClusterRequest withAdditionalInfo(String additionalInfo)
Reserved.
- Parameters:
additionalInfo
- Reserved.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
getIamRoles
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.
- Returns:
- 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.
-
setIamRoles
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.
- Parameters:
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.
-
withIamRoles
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)
orwithIamRoles(java.util.Collection)
if you want to override the existing values.- Parameters:
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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withIamRoles
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.
- Parameters:
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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
toString
public String toString()
Returns a string representation of this object; useful for testing and debugging.- Overrides:
toString
in classObject
- Returns:
- A string representation of this object.
- See Also:
Object.toString()
-
clone
public CreateClusterRequest clone()
Description copied from class:AmazonWebServiceRequest
Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.- Overrides:
clone
in classAmazonWebServiceRequest
- See Also:
Object.clone()
-
-