Class Cluster

java.lang.Object
com.amazonaws.services.redshift.model.Cluster
All Implemented Interfaces:
Serializable, Cloneable
public class Cluster extends Object implements Serializable, Cloneable

Describes a cluster.

See Also:

  • Constructor Details

    • Cluster

      public Cluster()

  • Method Details

    • setClusterIdentifier

      public void setClusterIdentifier(String clusterIdentifier)

      The unique identifier of the cluster.

      Parameters:
      clusterIdentifier - The unique identifier of the cluster.

    • getClusterIdentifier

      public String getClusterIdentifier()

      The unique identifier of the cluster.

      Returns:
      The unique identifier of the cluster.

    • withClusterIdentifier

      public Cluster withClusterIdentifier(String clusterIdentifier)

      The unique identifier of the cluster.

      Parameters:
      clusterIdentifier - The unique identifier of the cluster.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • setNodeType

      public void setNodeType(String nodeType)

      The node type for the nodes in the cluster.

      Parameters:
      nodeType - The node type for the nodes in the cluster.

    • getNodeType

      public String getNodeType()

      The node type for the nodes in the cluster.

      Returns:
      The node type for the nodes in the cluster.

    • withNodeType

      public Cluster withNodeType(String nodeType)

      The node type for the nodes in the cluster.

      Parameters:
      nodeType - The node type for the nodes in the cluster.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • setClusterStatus

      public void setClusterStatus(String clusterStatus)

      The current state of the cluster. Possible values are:

      • 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

      Parameters:
      clusterStatus - The current state of the cluster. Possible values are:
      • 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

    • getClusterStatus

      public String getClusterStatus()

      The current state of the cluster. Possible values are:

      • 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

      Returns:
      The current state of the cluster. Possible values are:
      • 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

    • withClusterStatus

      public Cluster withClusterStatus(String clusterStatus)

      The current state of the cluster. Possible values are:

      • 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

      Parameters:
      clusterStatus - The current state of the cluster. Possible values are:
      • 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
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • setModifyStatus

      public void setModifyStatus(String modifyStatus)

      The status of a modify operation, if any, initiated for the cluster.

      Parameters:
      modifyStatus - The status of a modify operation, if any, initiated for the cluster.

    • getModifyStatus

      public String getModifyStatus()

      The status of a modify operation, if any, initiated for the cluster.

      Returns:
      The status of a modify operation, if any, initiated for the cluster.

    • withModifyStatus

      public Cluster withModifyStatus(String modifyStatus)

      The status of a modify operation, if any, initiated for the cluster.

      Parameters:
      modifyStatus - The status of a modify operation, if any, initiated for the cluster.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • setMasterUsername

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

      Parameters:
      masterUsername - The master user name for the cluster. This name is used to connect to the database that is specified in DBName.

    • getMasterUsername

      public String getMasterUsername()

      The master user name for the cluster. This name is used to connect to the database that is specified in DBName.

      Returns:
      The master user name for the cluster. This name is used to connect to the database that is specified in DBName.

    • withMasterUsername

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

      Parameters:
      masterUsername - The master user name for the cluster. This name is used to connect to the database that is specified in DBName.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • setDBName

      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" was created by default.

      Parameters:
      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" was created by default.

    • getDBName

      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" was created by default.

      Returns:
      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" was created by default.

    • withDBName

      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" was created by default.

      Parameters:
      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" was created by default.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • setEndpoint

      public void setEndpoint(Endpoint endpoint)

      The connection endpoint.

      Parameters:
      endpoint - The connection endpoint.

    • getEndpoint

      public Endpoint getEndpoint()

      The connection endpoint.

      Returns:
      The connection endpoint.

    • withEndpoint

      public Cluster withEndpoint(Endpoint endpoint)

      The connection endpoint.

      Parameters:
      endpoint - The connection endpoint.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • setClusterCreateTime

      public void setClusterCreateTime(Date clusterCreateTime)

      The date and time that the cluster was created.

      Parameters:
      clusterCreateTime - The date and time that the cluster was created.

    • getClusterCreateTime

      public Date getClusterCreateTime()

      The date and time that the cluster was created.

      Returns:
      The date and time that the cluster was created.

    • withClusterCreateTime

      public Cluster withClusterCreateTime(Date clusterCreateTime)

      The date and time that the cluster was created.

      Parameters:
      clusterCreateTime - The date and time that the cluster was created.
      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 automatic cluster snapshots are retained.

      Parameters:
      automatedSnapshotRetentionPeriod - The number of days that automatic cluster snapshots are retained.

    • getAutomatedSnapshotRetentionPeriod

      public Integer getAutomatedSnapshotRetentionPeriod()

      The number of days that automatic cluster snapshots are retained.

      Returns:
      The number of days that automatic cluster snapshots are retained.

    • withAutomatedSnapshotRetentionPeriod

      public Cluster withAutomatedSnapshotRetentionPeriod(Integer automatedSnapshotRetentionPeriod)

      The number of days that automatic cluster snapshots are retained.

      Parameters:
      automatedSnapshotRetentionPeriod - The number of days that automatic cluster snapshots are retained.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • getClusterSecurityGroups

      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 a VPC. Clusters that are created in a VPC use VPC security groups, which are listed by the VpcSecurityGroups parameter.

      Returns:
      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 a VPC. Clusters that are created in a VPC use VPC security groups, which are listed by the VpcSecurityGroups parameter.

    • setClusterSecurityGroups

      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 a VPC. Clusters that are created in a VPC use VPC security groups, which are listed by the VpcSecurityGroups parameter.

      Parameters:
      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 a VPC. Clusters that are created in a VPC use VPC security groups, which are listed by the VpcSecurityGroups parameter.

    • withClusterSecurityGroups

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

      Parameters:
      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 a VPC. Clusters that are created in a VPC use VPC security groups, which are listed by the VpcSecurityGroups parameter.

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

    • withClusterSecurityGroups

      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 a VPC. Clusters that are created in a VPC use VPC security groups, which are listed by the VpcSecurityGroups parameter.

      Parameters:
      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 a VPC. Clusters that are created in a VPC use VPC security groups, which are listed by the VpcSecurityGroups parameter.

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

    • getVpcSecurityGroups

      public List<VpcSecurityGroupMembership> getVpcSecurityGroups()

      A list of Virtual Private Cloud (VPC) security groups that are associated with the cluster. This parameter is returned only if the cluster is in a VPC.

      Returns:
      A list of Virtual Private Cloud (VPC) security groups that are associated with the cluster. This parameter is returned only if the cluster is in a VPC.

    • setVpcSecurityGroups

      public void setVpcSecurityGroups(Collection<VpcSecurityGroupMembership> vpcSecurityGroups)

      A list of Virtual Private Cloud (VPC) security groups that are associated with the cluster. This parameter is returned only if the cluster is in a VPC.

      Parameters:
      vpcSecurityGroups - A list of Virtual Private Cloud (VPC) security groups that are associated with the cluster. This parameter is returned only if the cluster is in a VPC.

    • withVpcSecurityGroups

      public Cluster withVpcSecurityGroups(VpcSecurityGroupMembership... vpcSecurityGroups)

      A list of Virtual Private Cloud (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.

      Parameters:
      vpcSecurityGroups - A list of Virtual Private Cloud (VPC) security groups that are associated with the cluster. This parameter is returned only if the cluster is in a VPC.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • withVpcSecurityGroups

      public Cluster withVpcSecurityGroups(Collection<VpcSecurityGroupMembership> vpcSecurityGroups)

      A list of Virtual Private Cloud (VPC) security groups that are associated with the cluster. This parameter is returned only if the cluster is in a VPC.

      Parameters:
      vpcSecurityGroups - A list of Virtual Private Cloud (VPC) security groups that are associated with the cluster. This parameter is returned only if the cluster is in a VPC.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • getClusterParameterGroups

      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.

      Returns:
      The list of cluster parameter groups that are associated with this cluster. Each parameter group in the list is returned with its status.

    • setClusterParameterGroups

      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.

      Parameters:
      clusterParameterGroups - The list of cluster parameter groups that are associated with this cluster. Each parameter group in the list is returned with its status.

    • withClusterParameterGroups

      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.

      Parameters:
      clusterParameterGroups - The list of cluster parameter groups that are associated with this cluster. Each parameter group in the list is returned with its status.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • withClusterParameterGroups

      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.

      Parameters:
      clusterParameterGroups - The list of cluster parameter groups that are associated with this cluster. Each parameter group in the list is returned with its status.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • setClusterSubnetGroupName

      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.

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

    • getClusterSubnetGroupName

      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.

      Returns:
      The name of the subnet group that is associated with the cluster. This parameter is valid only when the cluster is in a VPC.

    • withClusterSubnetGroupName

      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.

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

    • setVpcId

      public void setVpcId(String vpcId)

      The identifier of the VPC the cluster is in, if the cluster is in a VPC.

      Parameters:
      vpcId - The identifier of the VPC the cluster is in, if the cluster is in a VPC.

    • getVpcId

      public String getVpcId()

      The identifier of the VPC the cluster is in, if the cluster is in a VPC.

      Returns:
      The identifier of the VPC the cluster is in, if the cluster is in a VPC.

    • withVpcId

      public Cluster withVpcId(String vpcId)

      The identifier of the VPC the cluster is in, if the cluster is in a VPC.

      Parameters:
      vpcId - The identifier of the VPC the cluster is in, if the cluster is in a VPC.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • setAvailabilityZone

      public void setAvailabilityZone(String availabilityZone)

      The name of the Availability Zone in which the cluster is located.

      Parameters:
      availabilityZone - The name of the Availability Zone in which the cluster is located.

    • getAvailabilityZone

      public String getAvailabilityZone()

      The name of the Availability Zone in which the cluster is located.

      Returns:
      The name of the Availability Zone in which the cluster is located.

    • withAvailabilityZone

      public Cluster withAvailabilityZone(String availabilityZone)

      The name of the Availability Zone in which the cluster is located.

      Parameters:
      availabilityZone - The name of the Availability Zone in which the cluster is located.
      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 system maintenance can occur.

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

    • getPreferredMaintenanceWindow

      public String getPreferredMaintenanceWindow()

      The weekly time range (in UTC) during which system maintenance can occur.

      Returns:
      The weekly time range (in UTC) during which system maintenance can occur.

    • withPreferredMaintenanceWindow

      public Cluster withPreferredMaintenanceWindow(String preferredMaintenanceWindow)

      The weekly time range (in UTC) during which system maintenance can occur.

      Parameters:
      preferredMaintenanceWindow - The weekly time range (in UTC) during which system maintenance can occur.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • setPendingModifiedValues

      public void setPendingModifiedValues(PendingModifiedValues pendingModifiedValues)

      If present, changes to the cluster are pending. Specific pending changes are identified by subelements.

      Parameters:
      pendingModifiedValues - If present, changes to the cluster are pending. Specific pending changes are identified by subelements.

    • getPendingModifiedValues

      public PendingModifiedValues getPendingModifiedValues()

      If present, changes to the cluster are pending. Specific pending changes are identified by subelements.

      Returns:
      If present, changes to the cluster are pending. Specific pending changes are identified by subelements.

    • withPendingModifiedValues

      public Cluster withPendingModifiedValues(PendingModifiedValues pendingModifiedValues)

      If present, changes to the cluster are pending. Specific pending changes are identified by subelements.

      Parameters:
      pendingModifiedValues - If present, changes to the cluster are pending. Specific pending changes are identified by subelements.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • setClusterVersion

      public void setClusterVersion(String clusterVersion)

      The version ID of the Amazon Redshift engine that is running on the cluster.

      Parameters:
      clusterVersion - The version ID of the Amazon Redshift engine that is running on the cluster.

    • getClusterVersion

      public String getClusterVersion()

      The version ID of the Amazon Redshift engine that is running on the cluster.

      Returns:
      The version ID of the Amazon Redshift engine that is running on the cluster.

    • withClusterVersion

      public Cluster withClusterVersion(String clusterVersion)

      The version ID of the Amazon Redshift engine that is running on the cluster.

      Parameters:
      clusterVersion - The version ID of the Amazon Redshift engine that is running on the cluster.
      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 will be applied automatically to the cluster during the maintenance window.

      Parameters:
      allowVersionUpgrade - If true, major version upgrades will be applied automatically to the cluster during the maintenance window.

    • getAllowVersionUpgrade

      public Boolean getAllowVersionUpgrade()

      If true, major version upgrades will be applied automatically to the cluster during the maintenance window.

      Returns:
      If true, major version upgrades will be applied automatically to the cluster during the maintenance window.

    • withAllowVersionUpgrade

      public Cluster withAllowVersionUpgrade(Boolean allowVersionUpgrade)

      If true, major version upgrades will be applied automatically to the cluster during the maintenance window.

      Parameters:
      allowVersionUpgrade - If true, major version upgrades will be applied automatically to the cluster during the maintenance window.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • isAllowVersionUpgrade

      public Boolean isAllowVersionUpgrade()

      If true, major version upgrades will be applied automatically to the cluster during the maintenance window.

      Returns:
      If true, major version upgrades will be applied automatically to the cluster during the maintenance window.

    • setNumberOfNodes

      public void setNumberOfNodes(Integer numberOfNodes)

      The number of compute nodes in the cluster.

      Parameters:
      numberOfNodes - The number of compute nodes in the cluster.

    • getNumberOfNodes

      public Integer getNumberOfNodes()

      The number of compute nodes in the cluster.

      Returns:
      The number of compute nodes in the cluster.

    • withNumberOfNodes

      public Cluster withNumberOfNodes(Integer numberOfNodes)

      The number of compute nodes in the cluster.

      Parameters:
      numberOfNodes - The number of compute nodes in the cluster.
      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 - If true, 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 Cluster withPubliclyAccessible(Boolean publiclyAccessible)

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

      Parameters:
      publiclyAccessible - If true, the cluster can be accessed from a public network.
      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, data in the cluster is encrypted at rest.

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

    • getEncrypted

      public Boolean getEncrypted()

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

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

    • withEncrypted

      public Cluster withEncrypted(Boolean encrypted)

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

      Parameters:
      encrypted - If true, data in the cluster is encrypted at rest.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • isEncrypted

      public Boolean isEncrypted()

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

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

    • setRestoreStatus

      public void setRestoreStatus(RestoreStatus restoreStatus)

      Describes the status of a cluster restore action. Returns null if the cluster was not created by restoring a snapshot.

      Parameters:
      restoreStatus - Describes the status of a cluster restore action. Returns null if the cluster was not created by restoring a snapshot.

    • getRestoreStatus

      public RestoreStatus getRestoreStatus()

      Describes the status of a cluster restore action. Returns null if the cluster was not created by restoring a snapshot.

      Returns:
      Describes the status of a cluster restore action. Returns null if the cluster was not created by restoring a snapshot.

    • withRestoreStatus

      public Cluster withRestoreStatus(RestoreStatus restoreStatus)

      Describes the status of a cluster restore action. Returns null if the cluster was not created by restoring a snapshot.

      Parameters:
      restoreStatus - Describes the status of a cluster restore action. Returns null if the cluster was not created by restoring a snapshot.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • setHsmStatus

      public void setHsmStatus(HsmStatus hsmStatus)

      Reports whether the Amazon Redshift cluster has finished applying any HSM settings changes specified in a modify cluster command.

      Values: active, applying

      Parameters:
      hsmStatus - Reports whether the Amazon Redshift cluster has finished applying any HSM settings changes specified in a modify cluster command.

      Values: active, applying

    • getHsmStatus

      public HsmStatus getHsmStatus()

      Reports whether the Amazon Redshift cluster has finished applying any HSM settings changes specified in a modify cluster command.

      Values: active, applying

      Returns:
      Reports whether the Amazon Redshift cluster has finished applying any HSM settings changes specified in a modify cluster command.

      Values: active, applying

    • withHsmStatus

      public Cluster withHsmStatus(HsmStatus hsmStatus)

      Reports whether the Amazon Redshift cluster has finished applying any HSM settings changes specified in a modify cluster command.

      Values: active, applying

      Parameters:
      hsmStatus - Reports whether the Amazon Redshift cluster has finished applying any HSM settings changes specified in a modify cluster command.

      Values: active, applying

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

    • setClusterSnapshotCopyStatus

      public void setClusterSnapshotCopyStatus(ClusterSnapshotCopyStatus clusterSnapshotCopyStatus)

      Returns the destination region and retention period that are configured for cross-region snapshot copy.

      Parameters:
      clusterSnapshotCopyStatus - Returns the destination region and retention period that are configured for cross-region snapshot copy.

    • getClusterSnapshotCopyStatus

      public ClusterSnapshotCopyStatus getClusterSnapshotCopyStatus()

      Returns the destination region and retention period that are configured for cross-region snapshot copy.

      Returns:
      Returns the destination region and retention period that are configured for cross-region snapshot copy.

    • withClusterSnapshotCopyStatus

      public Cluster withClusterSnapshotCopyStatus(ClusterSnapshotCopyStatus clusterSnapshotCopyStatus)

      Returns the destination region and retention period that are configured for cross-region snapshot copy.

      Parameters:
      clusterSnapshotCopyStatus - Returns the destination region and retention period that are configured for cross-region snapshot copy.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • setClusterPublicKey

      public void setClusterPublicKey(String clusterPublicKey)

      The public key for the cluster.

      Parameters:
      clusterPublicKey - The public key for the cluster.

    • getClusterPublicKey

      public String getClusterPublicKey()

      The public key for the cluster.

      Returns:
      The public key for the cluster.

    • withClusterPublicKey

      public Cluster withClusterPublicKey(String clusterPublicKey)

      The public key for the cluster.

      Parameters:
      clusterPublicKey - The public key for the cluster.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • getClusterNodes

      public List<ClusterNode> getClusterNodes()

      The nodes in a cluster.

      Returns:
      The nodes in a cluster.

    • setClusterNodes

      public void setClusterNodes(Collection<ClusterNode> clusterNodes)

      The nodes in a cluster.

      Parameters:
      clusterNodes - The nodes in a cluster.

    • withClusterNodes

      public Cluster withClusterNodes(ClusterNode... clusterNodes)

      The nodes in a 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.

      Parameters:
      clusterNodes - The nodes in a cluster.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • withClusterNodes

      public Cluster withClusterNodes(Collection<ClusterNode> clusterNodes)

      The nodes in a cluster.

      Parameters:
      clusterNodes - The nodes in a cluster.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • setElasticIpStatus

      public void setElasticIpStatus(ElasticIpStatus elasticIpStatus)

      The status of the elastic IP (EIP) address.

      Parameters:
      elasticIpStatus - The status of the elastic IP (EIP) address.

    • getElasticIpStatus

      public ElasticIpStatus getElasticIpStatus()

      The status of the elastic IP (EIP) address.

      Returns:
      The status of the elastic IP (EIP) address.

    • withElasticIpStatus

      public Cluster withElasticIpStatus(ElasticIpStatus elasticIpStatus)

      The status of the elastic IP (EIP) address.

      Parameters:
      elasticIpStatus - The status of the elastic IP (EIP) address.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • setClusterRevisionNumber

      public void setClusterRevisionNumber(String clusterRevisionNumber)

      The specific revision number of the database in the cluster.

      Parameters:
      clusterRevisionNumber - The specific revision number of the database in the cluster.

    • getClusterRevisionNumber

      public String getClusterRevisionNumber()

      The specific revision number of the database in the cluster.

      Returns:
      The specific revision number of the database in the cluster.

    • withClusterRevisionNumber

      public Cluster withClusterRevisionNumber(String clusterRevisionNumber)

      The specific revision number of the database in the cluster.

      Parameters:
      clusterRevisionNumber - The specific revision number of the database in the cluster.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • getTags

      public List<Tag> getTags()

      The list of tags for the cluster.

      Returns:
      The list of tags for the cluster.

    • setTags

      public void setTags(Collection<Tag> tags)

      The list of tags for the cluster.

      Parameters:
      tags - The list of tags for the cluster.

    • withTags

      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.

      Parameters:
      tags - The list of tags for the cluster.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • withTags

      public Cluster withTags(Collection<Tag> tags)

      The list of tags for the cluster.

      Parameters:
      tags - The list of tags for the cluster.
      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 used to encrypt data in the cluster.

      Parameters:
      kmsKeyId - The AWS Key Management Service (KMS) key ID of the encryption key used to encrypt data in the cluster.

    • getKmsKeyId

      public String getKmsKeyId()

      The AWS Key Management Service (KMS) key ID of the encryption key used to encrypt data in the cluster.

      Returns:
      The AWS Key Management Service (KMS) key ID of the encryption key used to encrypt data in the cluster.

    • withKmsKeyId

      public Cluster withKmsKeyId(String kmsKeyId)

      The AWS Key Management Service (KMS) key ID of the encryption key used to encrypt data in the cluster.

      Parameters:
      kmsKeyId - The AWS Key Management Service (KMS) key ID of the encryption key used to encrypt data in the cluster.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • getIamRoles

      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.

      Returns:
      A list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services.

    • setIamRoles

      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.

      Parameters:
      iamRoles - A list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services.

    • withIamRoles

      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.

      Parameters:
      iamRoles - A list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • withIamRoles

      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.

      Parameters:
      iamRoles - A list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services.
      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 class Object
      Returns:
      A string representation of this object.
      See Also:

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • clone

      public Cluster clone()
      Overrides:
      clone in class Object