@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class Cluster extends Object implements Serializable, Cloneable
Describes a cluster.
Constructor and Description |
---|
Cluster() |
Modifier and Type | Method and Description |
---|---|
Cluster |
clone() |
boolean |
equals(Object obj) |
Boolean |
getAllowVersionUpgrade()
A Boolean value that, if
true , indicates that major version upgrades will be applied automatically
to the cluster during the maintenance window. |
Integer |
getAutomatedSnapshotRetentionPeriod()
The number of days that automatic cluster snapshots are retained.
|
String |
getAvailabilityZone()
The name of the Availability Zone in which the cluster is located.
|
Date |
getClusterCreateTime()
The date and time that the cluster was created.
|
String |
getClusterIdentifier()
The unique identifier of the cluster.
|
List<ClusterNode> |
getClusterNodes()
The nodes in the cluster.
|
List<ClusterParameterGroupStatus> |
getClusterParameterGroups()
The list of cluster parameter groups that are associated with this cluster.
|
String |
getClusterPublicKey()
The public key for the cluster.
|
String |
getClusterRevisionNumber()
The specific revision number of the database in the cluster.
|
List<ClusterSecurityGroupMembership> |
getClusterSecurityGroups()
A list of cluster security group that are associated with the cluster.
|
ClusterSnapshotCopyStatus |
getClusterSnapshotCopyStatus()
A value that returns the destination region and retention period that are configured for cross-region snapshot
copy.
|
String |
getClusterStatus()
The current state of the cluster.
|
String |
getClusterSubnetGroupName()
The name of the subnet group that is associated with the cluster.
|
String |
getClusterVersion()
The version ID of the Amazon Redshift engine that is running on the cluster.
|
String |
getDBName()
The name of the initial database that was created when the cluster was created.
|
ElasticIpStatus |
getElasticIpStatus()
The status of the elastic IP (EIP) address.
|
Boolean |
getEncrypted()
A Boolean value that, if
true , indicates that data in the cluster is encrypted at rest. |
Endpoint |
getEndpoint()
The connection endpoint.
|
Boolean |
getEnhancedVpcRouting()
An option that specifies whether to create the cluster with enhanced VPC routing enabled.
|
HsmStatus |
getHsmStatus()
A value that reports whether the Amazon Redshift cluster has finished applying any hardware security module (HSM)
settings changes specified in a modify cluster command.
|
List<ClusterIamRole> |
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 (AWS KMS) key ID of the encryption key used to encrypt data in the cluster.
|
String |
getMasterUsername()
The master user name for the cluster.
|
String |
getModifyStatus()
The status of a modify operation, if any, initiated for the cluster.
|
String |
getNodeType()
The node type for the nodes in the cluster.
|
Integer |
getNumberOfNodes()
The number of compute nodes in the cluster.
|
PendingModifiedValues |
getPendingModifiedValues()
A value that, if present, indicates that changes to the cluster are pending.
|
String |
getPreferredMaintenanceWindow()
The weekly time range, in Universal Coordinated Time (UTC), during which system maintenance can occur.
|
Boolean |
getPubliclyAccessible()
A Boolean value that, if
true , indicates that the cluster can be accessed from a public network. |
RestoreStatus |
getRestoreStatus()
A value that describes the status of a cluster restore action.
|
List<Tag> |
getTags()
The list of tags for the cluster.
|
String |
getVpcId()
The identifier of the VPC the cluster is in, if the cluster is in a VPC.
|
List<VpcSecurityGroupMembership> |
getVpcSecurityGroups()
A list of Amazon Virtual Private Cloud (Amazon VPC) security groups that are associated with the cluster.
|
int |
hashCode() |
Boolean |
isAllowVersionUpgrade()
A Boolean value that, if
true , indicates that major version upgrades will be applied automatically
to the cluster during the maintenance window. |
Boolean |
isEncrypted()
A Boolean value that, if
true , indicates that data in the cluster is encrypted at rest. |
Boolean |
isEnhancedVpcRouting()
An option that specifies whether to create the cluster with enhanced VPC routing enabled.
|
Boolean |
isPubliclyAccessible()
A Boolean value that, if
true , indicates that the cluster can be accessed from a public network. |
void |
setAllowVersionUpgrade(Boolean allowVersionUpgrade)
A Boolean value that, if
true , indicates that major version upgrades will be applied automatically
to the cluster during the maintenance window. |
void |
setAutomatedSnapshotRetentionPeriod(Integer automatedSnapshotRetentionPeriod)
The number of days that automatic cluster snapshots are retained.
|
void |
setAvailabilityZone(String availabilityZone)
The name of the Availability Zone in which the cluster is located.
|
void |
setClusterCreateTime(Date clusterCreateTime)
The date and time that the cluster was created.
|
void |
setClusterIdentifier(String clusterIdentifier)
The unique identifier of the cluster.
|
void |
setClusterNodes(Collection<ClusterNode> clusterNodes)
The nodes in the cluster.
|
void |
setClusterParameterGroups(Collection<ClusterParameterGroupStatus> clusterParameterGroups)
The list of cluster parameter groups that are associated with this cluster.
|
void |
setClusterPublicKey(String clusterPublicKey)
The public key for the cluster.
|
void |
setClusterRevisionNumber(String clusterRevisionNumber)
The specific revision number of the database in the cluster.
|
void |
setClusterSecurityGroups(Collection<ClusterSecurityGroupMembership> clusterSecurityGroups)
A list of cluster security group that are associated with the cluster.
|
void |
setClusterSnapshotCopyStatus(ClusterSnapshotCopyStatus clusterSnapshotCopyStatus)
A value that returns the destination region and retention period that are configured for cross-region snapshot
copy.
|
void |
setClusterStatus(String clusterStatus)
The current state of the cluster.
|
void |
setClusterSubnetGroupName(String clusterSubnetGroupName)
The name of the subnet group that is associated with the cluster.
|
void |
setClusterVersion(String clusterVersion)
The version ID of the Amazon Redshift engine that is running on the cluster.
|
void |
setDBName(String dBName)
The name of the initial database that was created when the cluster was created.
|
void |
setElasticIpStatus(ElasticIpStatus elasticIpStatus)
The status of the elastic IP (EIP) address.
|
void |
setEncrypted(Boolean encrypted)
A Boolean value that, if
true , indicates that data in the cluster is encrypted at rest. |
void |
setEndpoint(Endpoint endpoint)
The connection endpoint.
|
void |
setEnhancedVpcRouting(Boolean enhancedVpcRouting)
An option that specifies whether to create the cluster with enhanced VPC routing enabled.
|
void |
setHsmStatus(HsmStatus hsmStatus)
A value that reports whether the Amazon Redshift cluster has finished applying any hardware security module (HSM)
settings changes specified in a modify cluster command.
|
void |
setIamRoles(Collection<ClusterIamRole> 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 (AWS KMS) key ID of the encryption key used to encrypt data in the cluster.
|
void |
setMasterUsername(String masterUsername)
The master user name for the cluster.
|
void |
setModifyStatus(String modifyStatus)
The status of a modify operation, if any, initiated for the cluster.
|
void |
setNodeType(String nodeType)
The node type for the nodes in the cluster.
|
void |
setNumberOfNodes(Integer numberOfNodes)
The number of compute nodes in the cluster.
|
void |
setPendingModifiedValues(PendingModifiedValues pendingModifiedValues)
A value that, if present, indicates that changes to the cluster are pending.
|
void |
setPreferredMaintenanceWindow(String preferredMaintenanceWindow)
The weekly time range, in Universal Coordinated Time (UTC), during which system maintenance can occur.
|
void |
setPubliclyAccessible(Boolean publiclyAccessible)
A Boolean value that, if
true , indicates that the cluster can be accessed from a public network. |
void |
setRestoreStatus(RestoreStatus restoreStatus)
A value that describes the status of a cluster restore action.
|
void |
setTags(Collection<Tag> tags)
The list of tags for the cluster.
|
void |
setVpcId(String vpcId)
The identifier of the VPC the cluster is in, if the cluster is in a VPC.
|
void |
setVpcSecurityGroups(Collection<VpcSecurityGroupMembership> vpcSecurityGroups)
A list of Amazon Virtual Private Cloud (Amazon VPC) security groups that are associated with the cluster.
|
String |
toString()
Returns a string representation of this object; useful for testing and debugging.
|
Cluster |
withAllowVersionUpgrade(Boolean allowVersionUpgrade)
A Boolean value that, if
true , indicates that major version upgrades will be applied automatically
to the cluster during the maintenance window. |
Cluster |
withAutomatedSnapshotRetentionPeriod(Integer automatedSnapshotRetentionPeriod)
The number of days that automatic cluster snapshots are retained.
|
Cluster |
withAvailabilityZone(String availabilityZone)
The name of the Availability Zone in which the cluster is located.
|
Cluster |
withClusterCreateTime(Date clusterCreateTime)
The date and time that the cluster was created.
|
Cluster |
withClusterIdentifier(String clusterIdentifier)
The unique identifier of the cluster.
|
Cluster |
withClusterNodes(ClusterNode... clusterNodes)
The nodes in the cluster.
|
Cluster |
withClusterNodes(Collection<ClusterNode> clusterNodes)
The nodes in the cluster.
|
Cluster |
withClusterParameterGroups(ClusterParameterGroupStatus... clusterParameterGroups)
The list of cluster parameter groups that are associated with this cluster.
|
Cluster |
withClusterParameterGroups(Collection<ClusterParameterGroupStatus> clusterParameterGroups)
The list of cluster parameter groups that are associated with this cluster.
|
Cluster |
withClusterPublicKey(String clusterPublicKey)
The public key for the cluster.
|
Cluster |
withClusterRevisionNumber(String clusterRevisionNumber)
The specific revision number of the database in the cluster.
|
Cluster |
withClusterSecurityGroups(ClusterSecurityGroupMembership... clusterSecurityGroups)
A list of cluster security group that are associated with the cluster.
|
Cluster |
withClusterSecurityGroups(Collection<ClusterSecurityGroupMembership> clusterSecurityGroups)
A list of cluster security group that are associated with the cluster.
|
Cluster |
withClusterSnapshotCopyStatus(ClusterSnapshotCopyStatus clusterSnapshotCopyStatus)
A value that returns the destination region and retention period that are configured for cross-region snapshot
copy.
|
Cluster |
withClusterStatus(String clusterStatus)
The current state of the cluster.
|
Cluster |
withClusterSubnetGroupName(String clusterSubnetGroupName)
The name of the subnet group that is associated with the cluster.
|
Cluster |
withClusterVersion(String clusterVersion)
The version ID of the Amazon Redshift engine that is running on the cluster.
|
Cluster |
withDBName(String dBName)
The name of the initial database that was created when the cluster was created.
|
Cluster |
withElasticIpStatus(ElasticIpStatus elasticIpStatus)
The status of the elastic IP (EIP) address.
|
Cluster |
withEncrypted(Boolean encrypted)
A Boolean value that, if
true , indicates that data in the cluster is encrypted at rest. |
Cluster |
withEndpoint(Endpoint endpoint)
The connection endpoint.
|
Cluster |
withEnhancedVpcRouting(Boolean enhancedVpcRouting)
An option that specifies whether to create the cluster with enhanced VPC routing enabled.
|
Cluster |
withHsmStatus(HsmStatus hsmStatus)
A value that reports whether the Amazon Redshift cluster has finished applying any hardware security module (HSM)
settings changes specified in a modify cluster command.
|
Cluster |
withIamRoles(ClusterIamRole... iamRoles)
A list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS
services.
|
Cluster |
withIamRoles(Collection<ClusterIamRole> iamRoles)
A list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS
services.
|
Cluster |
withKmsKeyId(String kmsKeyId)
The AWS Key Management Service (AWS KMS) key ID of the encryption key used to encrypt data in the cluster.
|
Cluster |
withMasterUsername(String masterUsername)
The master user name for the cluster.
|
Cluster |
withModifyStatus(String modifyStatus)
The status of a modify operation, if any, initiated for the cluster.
|
Cluster |
withNodeType(String nodeType)
The node type for the nodes in the cluster.
|
Cluster |
withNumberOfNodes(Integer numberOfNodes)
The number of compute nodes in the cluster.
|
Cluster |
withPendingModifiedValues(PendingModifiedValues pendingModifiedValues)
A value that, if present, indicates that changes to the cluster are pending.
|
Cluster |
withPreferredMaintenanceWindow(String preferredMaintenanceWindow)
The weekly time range, in Universal Coordinated Time (UTC), during which system maintenance can occur.
|
Cluster |
withPubliclyAccessible(Boolean publiclyAccessible)
A Boolean value that, if
true , indicates that the cluster can be accessed from a public network. |
Cluster |
withRestoreStatus(RestoreStatus restoreStatus)
A value that describes the status of a cluster restore action.
|
Cluster |
withTags(Collection<Tag> tags)
The list of tags for the cluster.
|
Cluster |
withTags(Tag... tags)
The list of tags for the cluster.
|
Cluster |
withVpcId(String vpcId)
The identifier of the VPC the cluster is in, if the cluster is in a VPC.
|
Cluster |
withVpcSecurityGroups(Collection<VpcSecurityGroupMembership> vpcSecurityGroups)
A list of Amazon Virtual Private Cloud (Amazon VPC) security groups that are associated with the cluster.
|
Cluster |
withVpcSecurityGroups(VpcSecurityGroupMembership... vpcSecurityGroups)
A list of Amazon Virtual Private Cloud (Amazon VPC) security groups that are associated with the cluster.
|
public void setClusterIdentifier(String clusterIdentifier)
The unique identifier of the cluster.
clusterIdentifier
- The unique identifier of the cluster.public String getClusterIdentifier()
The unique identifier of the cluster.
public Cluster withClusterIdentifier(String clusterIdentifier)
The unique identifier of the cluster.
clusterIdentifier
- The unique identifier of the cluster.public void setNodeType(String nodeType)
The node type for the nodes in the cluster.
nodeType
- The node type for the nodes in the cluster.public String getNodeType()
The node type for the nodes in the cluster.
public Cluster withNodeType(String nodeType)
The node type for the nodes in the cluster.
nodeType
- The node type for the nodes in the cluster.public void setClusterStatus(String clusterStatus)
The current state of the cluster. Possible values are the following:
available
creating
deleting
final-snapshot
hardware-failure
incompatible-hsm
incompatible-network
incompatible-parameters
incompatible-restore
modifying
rebooting
renaming
resizing
rotating-keys
storage-full
updating-hsm
clusterStatus
- The current state of the cluster. Possible values are the following:
available
creating
deleting
final-snapshot
hardware-failure
incompatible-hsm
incompatible-network
incompatible-parameters
incompatible-restore
modifying
rebooting
renaming
resizing
rotating-keys
storage-full
updating-hsm
public String getClusterStatus()
The current state of the cluster. Possible values are the following:
available
creating
deleting
final-snapshot
hardware-failure
incompatible-hsm
incompatible-network
incompatible-parameters
incompatible-restore
modifying
rebooting
renaming
resizing
rotating-keys
storage-full
updating-hsm
available
creating
deleting
final-snapshot
hardware-failure
incompatible-hsm
incompatible-network
incompatible-parameters
incompatible-restore
modifying
rebooting
renaming
resizing
rotating-keys
storage-full
updating-hsm
public Cluster withClusterStatus(String clusterStatus)
The current state of the cluster. Possible values are the following:
available
creating
deleting
final-snapshot
hardware-failure
incompatible-hsm
incompatible-network
incompatible-parameters
incompatible-restore
modifying
rebooting
renaming
resizing
rotating-keys
storage-full
updating-hsm
clusterStatus
- The current state of the cluster. Possible values are the following:
available
creating
deleting
final-snapshot
hardware-failure
incompatible-hsm
incompatible-network
incompatible-parameters
incompatible-restore
modifying
rebooting
renaming
resizing
rotating-keys
storage-full
updating-hsm
public void setModifyStatus(String modifyStatus)
The status of a modify operation, if any, initiated for the cluster.
modifyStatus
- The status of a modify operation, if any, initiated for the cluster.public String getModifyStatus()
The status of a modify operation, if any, initiated for the cluster.
public Cluster withModifyStatus(String modifyStatus)
The status of a modify operation, if any, initiated for the cluster.
modifyStatus
- The status of a modify operation, if any, initiated for the cluster.public void setMasterUsername(String masterUsername)
The master user name for the cluster. This name is used to connect to the database that is specified in the DBName parameter.
masterUsername
- The master user name for the cluster. This name is used to connect to the database that is specified in
the DBName parameter.public String getMasterUsername()
The master user name for the cluster. This name is used to connect to the database that is specified in the DBName parameter.
public Cluster withMasterUsername(String masterUsername)
The master user name for the cluster. This name is used to connect to the database that is specified in the DBName parameter.
masterUsername
- The master user name for the cluster. This name is used to connect to the database that is specified in
the DBName parameter.public void setDBName(String dBName)
The name of the initial database that was created when the cluster was created. This same name is returned for
the life of the cluster. If an initial database was not specified, a database named dev
dev was
created by default.
dBName
- The name of the initial database that was created when the cluster was created. This same name is returned
for the life of the cluster. If an initial database was not specified, a database named dev
dev was created by default.public String getDBName()
The name of the initial database that was created when the cluster was created. This same name is returned for
the life of the cluster. If an initial database was not specified, a database named dev
dev was
created by default.
dev
dev was created by default.public Cluster withDBName(String dBName)
The name of the initial database that was created when the cluster was created. This same name is returned for
the life of the cluster. If an initial database was not specified, a database named dev
dev was
created by default.
dBName
- The name of the initial database that was created when the cluster was created. This same name is returned
for the life of the cluster. If an initial database was not specified, a database named dev
dev was created by default.public void setEndpoint(Endpoint endpoint)
The connection endpoint.
endpoint
- The connection endpoint.public Endpoint getEndpoint()
The connection endpoint.
public Cluster withEndpoint(Endpoint endpoint)
The connection endpoint.
endpoint
- The connection endpoint.public void setClusterCreateTime(Date clusterCreateTime)
The date and time that the cluster was created.
clusterCreateTime
- The date and time that the cluster was created.public Date getClusterCreateTime()
The date and time that the cluster was created.
public Cluster withClusterCreateTime(Date clusterCreateTime)
The date and time that the cluster was created.
clusterCreateTime
- The date and time that the cluster was created.public void setAutomatedSnapshotRetentionPeriod(Integer automatedSnapshotRetentionPeriod)
The number of days that automatic cluster snapshots are retained.
automatedSnapshotRetentionPeriod
- The number of days that automatic cluster snapshots are retained.public Integer getAutomatedSnapshotRetentionPeriod()
The number of days that automatic cluster snapshots are retained.
public Cluster withAutomatedSnapshotRetentionPeriod(Integer automatedSnapshotRetentionPeriod)
The number of days that automatic cluster snapshots are retained.
automatedSnapshotRetentionPeriod
- The number of days that automatic cluster snapshots are retained.public List<ClusterSecurityGroupMembership> getClusterSecurityGroups()
A list of cluster security group that are associated with the cluster. Each security group is represented by an
element that contains ClusterSecurityGroup.Name
and ClusterSecurityGroup.Status
subelements.
Cluster security groups are used when the cluster is not created in an Amazon Virtual Private Cloud (VPC). Clusters that are created in a VPC use VPC security groups, which are listed by the VpcSecurityGroups parameter.
ClusterSecurityGroup.Name
and
ClusterSecurityGroup.Status
subelements.
Cluster security groups are used when the cluster is not created in an Amazon Virtual Private Cloud (VPC). Clusters that are created in a VPC use VPC security groups, which are listed by the VpcSecurityGroups parameter.
public void setClusterSecurityGroups(Collection<ClusterSecurityGroupMembership> clusterSecurityGroups)
A list of cluster security group that are associated with the cluster. Each security group is represented by an
element that contains ClusterSecurityGroup.Name
and ClusterSecurityGroup.Status
subelements.
Cluster security groups are used when the cluster is not created in an Amazon Virtual Private Cloud (VPC). Clusters that are created in a VPC use VPC security groups, which are listed by the VpcSecurityGroups parameter.
clusterSecurityGroups
- A list of cluster security group that are associated with the cluster. Each security group is represented
by an element that contains ClusterSecurityGroup.Name
and
ClusterSecurityGroup.Status
subelements.
Cluster security groups are used when the cluster is not created in an Amazon Virtual Private Cloud (VPC). Clusters that are created in a VPC use VPC security groups, which are listed by the VpcSecurityGroups parameter.
public Cluster withClusterSecurityGroups(ClusterSecurityGroupMembership... clusterSecurityGroups)
A list of cluster security group that are associated with the cluster. Each security group is represented by an
element that contains ClusterSecurityGroup.Name
and ClusterSecurityGroup.Status
subelements.
Cluster security groups are used when the cluster is not created in an Amazon Virtual Private Cloud (VPC). Clusters that are created in a VPC use VPC security groups, which are listed by the VpcSecurityGroups parameter.
NOTE: This method appends the values to the existing list (if any). Use
setClusterSecurityGroups(java.util.Collection)
or
withClusterSecurityGroups(java.util.Collection)
if you want to override the existing values.
clusterSecurityGroups
- A list of cluster security group that are associated with the cluster. Each security group is represented
by an element that contains ClusterSecurityGroup.Name
and
ClusterSecurityGroup.Status
subelements.
Cluster security groups are used when the cluster is not created in an Amazon Virtual Private Cloud (VPC). Clusters that are created in a VPC use VPC security groups, which are listed by the VpcSecurityGroups parameter.
public Cluster withClusterSecurityGroups(Collection<ClusterSecurityGroupMembership> clusterSecurityGroups)
A list of cluster security group that are associated with the cluster. Each security group is represented by an
element that contains ClusterSecurityGroup.Name
and ClusterSecurityGroup.Status
subelements.
Cluster security groups are used when the cluster is not created in an Amazon Virtual Private Cloud (VPC). Clusters that are created in a VPC use VPC security groups, which are listed by the VpcSecurityGroups parameter.
clusterSecurityGroups
- A list of cluster security group that are associated with the cluster. Each security group is represented
by an element that contains ClusterSecurityGroup.Name
and
ClusterSecurityGroup.Status
subelements.
Cluster security groups are used when the cluster is not created in an Amazon Virtual Private Cloud (VPC). Clusters that are created in a VPC use VPC security groups, which are listed by the VpcSecurityGroups parameter.
public List<VpcSecurityGroupMembership> getVpcSecurityGroups()
A list of Amazon Virtual Private Cloud (Amazon VPC) security groups that are associated with the cluster. This parameter is returned only if the cluster is in a VPC.
public void setVpcSecurityGroups(Collection<VpcSecurityGroupMembership> vpcSecurityGroups)
A list of Amazon Virtual Private Cloud (Amazon VPC) security groups that are associated with the cluster. This parameter is returned only if the cluster is in a VPC.
vpcSecurityGroups
- A list of Amazon Virtual Private Cloud (Amazon VPC) security groups that are associated with the cluster.
This parameter is returned only if the cluster is in a VPC.public Cluster withVpcSecurityGroups(VpcSecurityGroupMembership... vpcSecurityGroups)
A list of Amazon Virtual Private Cloud (Amazon VPC) security groups that are associated with the cluster. This parameter is returned only if the cluster is in a VPC.
NOTE: This method appends the values to the existing list (if any). Use
setVpcSecurityGroups(java.util.Collection)
or withVpcSecurityGroups(java.util.Collection)
if
you want to override the existing values.
vpcSecurityGroups
- A list of Amazon Virtual Private Cloud (Amazon VPC) security groups that are associated with the cluster.
This parameter is returned only if the cluster is in a VPC.public Cluster withVpcSecurityGroups(Collection<VpcSecurityGroupMembership> vpcSecurityGroups)
A list of Amazon Virtual Private Cloud (Amazon VPC) security groups that are associated with the cluster. This parameter is returned only if the cluster is in a VPC.
vpcSecurityGroups
- A list of Amazon Virtual Private Cloud (Amazon VPC) security groups that are associated with the cluster.
This parameter is returned only if the cluster is in a VPC.public List<ClusterParameterGroupStatus> getClusterParameterGroups()
The list of cluster parameter groups that are associated with this cluster. Each parameter group in the list is returned with its status.
public void setClusterParameterGroups(Collection<ClusterParameterGroupStatus> clusterParameterGroups)
The list of cluster parameter groups that are associated with this cluster. Each parameter group in the list is returned with its status.
clusterParameterGroups
- The list of cluster parameter groups that are associated with this cluster. Each parameter group in the
list is returned with its status.public Cluster withClusterParameterGroups(ClusterParameterGroupStatus... clusterParameterGroups)
The list of cluster parameter groups that are associated with this cluster. Each parameter group in the list is returned with its status.
NOTE: This method appends the values to the existing list (if any). Use
setClusterParameterGroups(java.util.Collection)
or
withClusterParameterGroups(java.util.Collection)
if you want to override the existing values.
clusterParameterGroups
- The list of cluster parameter groups that are associated with this cluster. Each parameter group in the
list is returned with its status.public Cluster withClusterParameterGroups(Collection<ClusterParameterGroupStatus> clusterParameterGroups)
The list of cluster parameter groups that are associated with this cluster. Each parameter group in the list is returned with its status.
clusterParameterGroups
- The list of cluster parameter groups that are associated with this cluster. Each parameter group in the
list is returned with its status.public void setClusterSubnetGroupName(String clusterSubnetGroupName)
The name of the subnet group that is associated with the cluster. This parameter is valid only when the cluster is in a VPC.
clusterSubnetGroupName
- The name of the subnet group that is associated with the cluster. This parameter is valid only when the
cluster is in a VPC.public String getClusterSubnetGroupName()
The name of the subnet group that is associated with the cluster. This parameter is valid only when the cluster is in a VPC.
public Cluster withClusterSubnetGroupName(String clusterSubnetGroupName)
The name of the subnet group that is associated with the cluster. This parameter is valid only when the cluster is in a VPC.
clusterSubnetGroupName
- The name of the subnet group that is associated with the cluster. This parameter is valid only when the
cluster is in a VPC.public void setVpcId(String vpcId)
The identifier of the VPC the cluster is in, if the cluster is in a VPC.
vpcId
- The identifier of the VPC the cluster is in, if the cluster is in a VPC.public String getVpcId()
The identifier of the VPC the cluster is in, if the cluster is in a VPC.
public Cluster withVpcId(String vpcId)
The identifier of the VPC the cluster is in, if the cluster is in a VPC.
vpcId
- The identifier of the VPC the cluster is in, if the cluster is in a VPC.public void setAvailabilityZone(String availabilityZone)
The name of the Availability Zone in which the cluster is located.
availabilityZone
- The name of the Availability Zone in which the cluster is located.public String getAvailabilityZone()
The name of the Availability Zone in which the cluster is located.
public Cluster withAvailabilityZone(String availabilityZone)
The name of the Availability Zone in which the cluster is located.
availabilityZone
- The name of the Availability Zone in which the cluster is located.public void setPreferredMaintenanceWindow(String preferredMaintenanceWindow)
The weekly time range, in Universal Coordinated Time (UTC), during which system maintenance can occur.
preferredMaintenanceWindow
- The weekly time range, in Universal Coordinated Time (UTC), during which system maintenance can occur.public String getPreferredMaintenanceWindow()
The weekly time range, in Universal Coordinated Time (UTC), during which system maintenance can occur.
public Cluster withPreferredMaintenanceWindow(String preferredMaintenanceWindow)
The weekly time range, in Universal Coordinated Time (UTC), during which system maintenance can occur.
preferredMaintenanceWindow
- The weekly time range, in Universal Coordinated Time (UTC), during which system maintenance can occur.public void setPendingModifiedValues(PendingModifiedValues pendingModifiedValues)
A value that, if present, indicates that changes to the cluster are pending. Specific pending changes are identified by subelements.
pendingModifiedValues
- A value that, if present, indicates that changes to the cluster are pending. Specific pending changes are
identified by subelements.public PendingModifiedValues getPendingModifiedValues()
A value that, if present, indicates that changes to the cluster are pending. Specific pending changes are identified by subelements.
public Cluster withPendingModifiedValues(PendingModifiedValues pendingModifiedValues)
A value that, if present, indicates that changes to the cluster are pending. Specific pending changes are identified by subelements.
pendingModifiedValues
- A value that, if present, indicates that changes to the cluster are pending. Specific pending changes are
identified by subelements.public void setClusterVersion(String clusterVersion)
The version ID of the Amazon Redshift engine that is running on the cluster.
clusterVersion
- The version ID of the Amazon Redshift engine that is running on the cluster.public String getClusterVersion()
The version ID of the Amazon Redshift engine that is running on the cluster.
public Cluster withClusterVersion(String clusterVersion)
The version ID of the Amazon Redshift engine that is running on the cluster.
clusterVersion
- The version ID of the Amazon Redshift engine that is running on the cluster.public void setAllowVersionUpgrade(Boolean allowVersionUpgrade)
A Boolean value that, if true
, indicates that major version upgrades will be applied automatically
to the cluster during the maintenance window.
allowVersionUpgrade
- A Boolean value that, if true
, indicates that major version upgrades will be applied
automatically to the cluster during the maintenance window.public Boolean getAllowVersionUpgrade()
A Boolean value that, if true
, indicates that major version upgrades will be applied automatically
to the cluster during the maintenance window.
true
, indicates that major version upgrades will be applied
automatically to the cluster during the maintenance window.public Cluster withAllowVersionUpgrade(Boolean allowVersionUpgrade)
A Boolean value that, if true
, indicates that major version upgrades will be applied automatically
to the cluster during the maintenance window.
allowVersionUpgrade
- A Boolean value that, if true
, indicates that major version upgrades will be applied
automatically to the cluster during the maintenance window.public Boolean isAllowVersionUpgrade()
A Boolean value that, if true
, indicates that major version upgrades will be applied automatically
to the cluster during the maintenance window.
true
, indicates that major version upgrades will be applied
automatically to the cluster during the maintenance window.public void setNumberOfNodes(Integer numberOfNodes)
The number of compute nodes in the cluster.
numberOfNodes
- The number of compute nodes in the cluster.public Integer getNumberOfNodes()
The number of compute nodes in the cluster.
public Cluster withNumberOfNodes(Integer numberOfNodes)
The number of compute nodes in the cluster.
numberOfNodes
- The number of compute nodes in the cluster.public void setPubliclyAccessible(Boolean publiclyAccessible)
A Boolean value that, if true
, indicates that the cluster can be accessed from a public network.
publiclyAccessible
- A Boolean value that, if true
, indicates that the cluster can be accessed from a public
network.public Boolean getPubliclyAccessible()
A Boolean value that, if true
, indicates that the cluster can be accessed from a public network.
true
, indicates that the cluster can be accessed from a public
network.public Cluster withPubliclyAccessible(Boolean publiclyAccessible)
A Boolean value that, if true
, indicates that the cluster can be accessed from a public network.
publiclyAccessible
- A Boolean value that, if true
, indicates that the cluster can be accessed from a public
network.public Boolean isPubliclyAccessible()
A Boolean value that, if true
, indicates that the cluster can be accessed from a public network.
true
, indicates that the cluster can be accessed from a public
network.public void setEncrypted(Boolean encrypted)
A Boolean value that, if true
, indicates that data in the cluster is encrypted at rest.
encrypted
- A Boolean value that, if true
, indicates that data in the cluster is encrypted at rest.public Boolean getEncrypted()
A Boolean value that, if true
, indicates that data in the cluster is encrypted at rest.
true
, indicates that data in the cluster is encrypted at rest.public Cluster withEncrypted(Boolean encrypted)
A Boolean value that, if true
, indicates that data in the cluster is encrypted at rest.
encrypted
- A Boolean value that, if true
, indicates that data in the cluster is encrypted at rest.public Boolean isEncrypted()
A Boolean value that, if true
, indicates that data in the cluster is encrypted at rest.
true
, indicates that data in the cluster is encrypted at rest.public void setRestoreStatus(RestoreStatus restoreStatus)
A value that describes the status of a cluster restore action. This parameter returns null if the cluster was not created by restoring a snapshot.
restoreStatus
- A value that describes the status of a cluster restore action. This parameter returns null if the cluster
was not created by restoring a snapshot.public RestoreStatus getRestoreStatus()
A value that describes the status of a cluster restore action. This parameter returns null if the cluster was not created by restoring a snapshot.
public Cluster withRestoreStatus(RestoreStatus restoreStatus)
A value that describes the status of a cluster restore action. This parameter returns null if the cluster was not created by restoring a snapshot.
restoreStatus
- A value that describes the status of a cluster restore action. This parameter returns null if the cluster
was not created by restoring a snapshot.public void setHsmStatus(HsmStatus hsmStatus)
A value that reports whether the Amazon Redshift cluster has finished applying any hardware security module (HSM) settings changes specified in a modify cluster command.
Values: active, applying
hsmStatus
- A value that reports whether the Amazon Redshift cluster has finished applying any hardware security
module (HSM) settings changes specified in a modify cluster command.
Values: active, applying
public HsmStatus getHsmStatus()
A value that reports whether the Amazon Redshift cluster has finished applying any hardware security module (HSM) settings changes specified in a modify cluster command.
Values: active, applying
Values: active, applying
public Cluster withHsmStatus(HsmStatus hsmStatus)
A value that reports whether the Amazon Redshift cluster has finished applying any hardware security module (HSM) settings changes specified in a modify cluster command.
Values: active, applying
hsmStatus
- A value that reports whether the Amazon Redshift cluster has finished applying any hardware security
module (HSM) settings changes specified in a modify cluster command.
Values: active, applying
public void setClusterSnapshotCopyStatus(ClusterSnapshotCopyStatus clusterSnapshotCopyStatus)
A value that returns the destination region and retention period that are configured for cross-region snapshot copy.
clusterSnapshotCopyStatus
- A value that returns the destination region and retention period that are configured for cross-region
snapshot copy.public ClusterSnapshotCopyStatus getClusterSnapshotCopyStatus()
A value that returns the destination region and retention period that are configured for cross-region snapshot copy.
public Cluster withClusterSnapshotCopyStatus(ClusterSnapshotCopyStatus clusterSnapshotCopyStatus)
A value that returns the destination region and retention period that are configured for cross-region snapshot copy.
clusterSnapshotCopyStatus
- A value that returns the destination region and retention period that are configured for cross-region
snapshot copy.public void setClusterPublicKey(String clusterPublicKey)
The public key for the cluster.
clusterPublicKey
- The public key for the cluster.public String getClusterPublicKey()
The public key for the cluster.
public Cluster withClusterPublicKey(String clusterPublicKey)
The public key for the cluster.
clusterPublicKey
- The public key for the cluster.public List<ClusterNode> getClusterNodes()
The nodes in the cluster.
public void setClusterNodes(Collection<ClusterNode> clusterNodes)
The nodes in the cluster.
clusterNodes
- The nodes in the cluster.public Cluster withClusterNodes(ClusterNode... clusterNodes)
The nodes in the cluster.
NOTE: This method appends the values to the existing list (if any). Use
setClusterNodes(java.util.Collection)
or withClusterNodes(java.util.Collection)
if you want to
override the existing values.
clusterNodes
- The nodes in the cluster.public Cluster withClusterNodes(Collection<ClusterNode> clusterNodes)
The nodes in the cluster.
clusterNodes
- The nodes in the cluster.public void setElasticIpStatus(ElasticIpStatus elasticIpStatus)
The status of the elastic IP (EIP) address.
elasticIpStatus
- The status of the elastic IP (EIP) address.public ElasticIpStatus getElasticIpStatus()
The status of the elastic IP (EIP) address.
public Cluster withElasticIpStatus(ElasticIpStatus elasticIpStatus)
The status of the elastic IP (EIP) address.
elasticIpStatus
- The status of the elastic IP (EIP) address.public void setClusterRevisionNumber(String clusterRevisionNumber)
The specific revision number of the database in the cluster.
clusterRevisionNumber
- The specific revision number of the database in the cluster.public String getClusterRevisionNumber()
The specific revision number of the database in the cluster.
public Cluster withClusterRevisionNumber(String clusterRevisionNumber)
The specific revision number of the database in the cluster.
clusterRevisionNumber
- The specific revision number of the database in the cluster.public List<Tag> getTags()
The list of tags for the cluster.
public void setTags(Collection<Tag> tags)
The list of tags for the cluster.
tags
- The list of tags for the cluster.public Cluster withTags(Tag... tags)
The list of tags for the cluster.
NOTE: This method appends the values to the existing list (if any). Use
setTags(java.util.Collection)
or withTags(java.util.Collection)
if you want to override the
existing values.
tags
- The list of tags for the cluster.public Cluster withTags(Collection<Tag> tags)
The list of tags for the cluster.
tags
- The list of tags for the cluster.public void setKmsKeyId(String kmsKeyId)
The AWS Key Management Service (AWS KMS) key ID of the encryption key used to encrypt data in the cluster.
kmsKeyId
- The AWS Key Management Service (AWS KMS) key ID of the encryption key used to encrypt data in the cluster.public String getKmsKeyId()
The AWS Key Management Service (AWS KMS) key ID of the encryption key used to encrypt data in the cluster.
public Cluster withKmsKeyId(String kmsKeyId)
The AWS Key Management Service (AWS KMS) key ID of the encryption key used to encrypt data in the cluster.
kmsKeyId
- The AWS Key Management Service (AWS KMS) key ID of the encryption key used to encrypt data in the cluster.public void setEnhancedVpcRouting(Boolean enhancedVpcRouting)
An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.
If this option is true
, enhanced VPC routing is enabled.
Default: false
enhancedVpcRouting
- An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a
cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing
in the Amazon Redshift Cluster Management Guide.
If this option is true
, enhanced VPC routing is enabled.
Default: false
public Boolean getEnhancedVpcRouting()
An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.
If this option is true
, enhanced VPC routing is enabled.
Default: false
If this option is true
, enhanced VPC routing is enabled.
Default: false
public Cluster withEnhancedVpcRouting(Boolean enhancedVpcRouting)
An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.
If this option is true
, enhanced VPC routing is enabled.
Default: false
enhancedVpcRouting
- An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a
cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing
in the Amazon Redshift Cluster Management Guide.
If this option is true
, enhanced VPC routing is enabled.
Default: false
public Boolean isEnhancedVpcRouting()
An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.
If this option is true
, enhanced VPC routing is enabled.
Default: false
If this option is true
, enhanced VPC routing is enabled.
Default: false
public List<ClusterIamRole> getIamRoles()
A list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services.
public void setIamRoles(Collection<ClusterIamRole> iamRoles)
A list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services.
iamRoles
- A list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other
AWS services.public Cluster withIamRoles(ClusterIamRole... iamRoles)
A list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services.
NOTE: This method appends the values to the existing list (if any). Use
setIamRoles(java.util.Collection)
or withIamRoles(java.util.Collection)
if you want to override
the existing values.
iamRoles
- A list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other
AWS services.public Cluster withIamRoles(Collection<ClusterIamRole> iamRoles)
A list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services.
iamRoles
- A list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other
AWS services.public String toString()
toString
in class Object
Object.toString()
Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.