Cluster (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.services.redshift.model.Cluster

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<Cluster.Builder,Cluster>

@Generated(value="software.amazon.awssdk:codegen")
public final class Cluster
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Cluster.Builder,Cluster>

Describes a cluster.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface Cluster.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`Cluster.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Boolean`	`allowVersionUpgrade()` A boolean value that, if `true`, indicates that major version upgrades will be applied automatically to the cluster during the maintenance window.
`Integer`	`automatedSnapshotRetentionPeriod()` The number of days that automatic cluster snapshots are retained.
`String`	`availabilityZone()` The name of the Availability Zone in which the cluster is located.
`static Cluster.Builder`	`builder()`
`Instant`	`clusterCreateTime()` The date and time that the cluster was created.
`String`	`clusterIdentifier()` The unique identifier of the cluster.
`List<ClusterNode>`	`clusterNodes()` The nodes in the cluster.
`List<ClusterParameterGroupStatus>`	`clusterParameterGroups()` The list of cluster parameter groups that are associated with this cluster.
`String`	`clusterPublicKey()` The public key for the cluster.
`String`	`clusterRevisionNumber()` The specific revision number of the database in the cluster.
`List<ClusterSecurityGroupMembership>`	`clusterSecurityGroups()` A list of cluster security group that are associated with the cluster.
`ClusterSnapshotCopyStatus`	`clusterSnapshotCopyStatus()` A value that returns the destination region and retention period that are configured for cross-region snapshot copy.
`String`	`clusterStatus()` The current state of the cluster.
`String`	`clusterSubnetGroupName()` The name of the subnet group that is associated with the cluster.
`String`	`clusterVersion()` The version ID of the Amazon Redshift engine that is running on the cluster.
`DataTransferProgress`	`dataTransferProgress()` Returns the value of the DataTransferProgress property for this object.
`String`	`dbName()` The name of the initial database that was created when the cluster was created.
`List<DeferredMaintenanceWindow>`	`deferredMaintenanceWindows()` Describes a group of `DeferredMaintenanceWindow` objects.
`ElasticIpStatus`	`elasticIpStatus()` The status of the elastic IP (EIP) address.
`String`	`elasticResizeNumberOfNodeOptions()` The number of nodes that you can resize the cluster to with the elastic resize method.
`Boolean`	`encrypted()` A boolean value that, if `true`, indicates that data in the cluster is encrypted at rest.
`Endpoint`	`endpoint()` The connection endpoint.
`Boolean`	`enhancedVpcRouting()` An option that specifies whether to create the cluster with enhanced VPC routing enabled.
`boolean`	`equals(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`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.
`List<ClusterIamRole>`	`iamRoles()` A list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services.
`String`	`kmsKeyId()` The AWS Key Management Service (AWS KMS) key ID of the encryption key used to encrypt data in the cluster.
`String`	`maintenanceTrackName()` The name of the maintenance track for the cluster.
`Integer`	`manualSnapshotRetentionPeriod()` The default number of days to retain a manual snapshot.
`String`	`masterUsername()` The master user name for the cluster.
`String`	`modifyStatus()` The status of a modify operation, if any, initiated for the cluster.
`String`	`nodeType()` The node type for the nodes in the cluster.
`Integer`	`numberOfNodes()` The number of compute nodes in the cluster.
`List<String>`	`pendingActions()` Cluster operations that are waiting to be started.
`PendingModifiedValues`	`pendingModifiedValues()` A value that, if present, indicates that changes to the cluster are pending.
`String`	`preferredMaintenanceWindow()` The weekly time range, in Universal Coordinated Time (UTC), during which system maintenance can occur.
`Boolean`	`publiclyAccessible()` A boolean value that, if `true`, indicates that the cluster can be accessed from a public network.
`ResizeInfo`	`resizeInfo()` Returns the following:
`RestoreStatus`	`restoreStatus()` A value that describes the status of a cluster restore action.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends Cluster.Builder>`	`serializableBuilderClass()`
`String`	`snapshotScheduleIdentifier()` A unique identifier for the cluster snapshot schedule.
`ScheduleState`	`snapshotScheduleState()` The current state of the cluster snapshot schedule.
`String`	`snapshotScheduleStateAsString()` The current state of the cluster snapshot schedule.
`List<Tag>`	`tags()` The list of tags for the cluster.
`Cluster.Builder`	`toBuilder()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`
`String`	`vpcId()` The identifier of the VPC the cluster is in, if the cluster is in a VPC.
`List<VpcSecurityGroupMembership>`	`vpcSecurityGroups()` A list of Amazon Virtual Private Cloud (Amazon VPC) security groups that are associated with the cluster.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - clusterIdentifier
```
public String clusterIdentifier()
```
    The unique identifier of the cluster.
    
    Returns:
    
    The unique identifier of the cluster.
  - nodeType
```
public String nodeType()
```
    The node type for the nodes in the cluster.
    
    Returns:
    
    The node type for the nodes in the cluster.
  - clusterStatus
```
public String clusterStatus()
```
    The current state of the cluster. Possible values are the following:
    - available
    - available, prep-for-resize
    - available, resize-cleanup
    - cancelling-resize
    - 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 the following:
    
    available
    
    available, prep-for-resize
    
    available, resize-cleanup
    
    cancelling-resize
    
    creating
    
    deleting
    
    final-snapshot
    
    hardware-failure
    
    incompatible-hsm
    
    incompatible-network
    
    incompatible-parameters
    
    incompatible-restore
    
    modifying
    
    rebooting
    
    renaming
    
    resizing
    
    rotating-keys
    
    storage-full
    
    updating-hsm
  - modifyStatus
```
public String modifyStatus()
```
    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.
  - masterUsername
```
public 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.
    
    Returns:
    
    The master user name for the cluster. This name is used to connect to the database that is specified in the DBName parameter.
  - dbName
```
public 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 devdev 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 devdev was created by default.
  - endpoint
```
public Endpoint endpoint()
```
    The connection endpoint.
    
    Returns:
    
    The connection endpoint.
  - clusterCreateTime
```
public Instant clusterCreateTime()
```
    The date and time that the cluster was created.
    
    Returns:
    
    The date and time that the cluster was created.
  - automatedSnapshotRetentionPeriod
```
public Integer automatedSnapshotRetentionPeriod()
```
    The number of days that automatic cluster snapshots are retained.
    
    Returns:
    
    The number of days that automatic cluster snapshots are retained.
  - manualSnapshotRetentionPeriod
```
public Integer manualSnapshotRetentionPeriod()
```
    The default number of days to retain a manual snapshot. If the value is -1, the snapshot is retained indefinitely. This setting doesn't change the retention period of existing snapshots.
    
    The value must be either -1 or an integer between 1 and 3,653.
    
    Returns:
    
    The default number of days to retain a manual snapshot. If the value is -1, the snapshot is retained indefinitely. This setting doesn't change the retention period of existing snapshots.
    
    The value must be either -1 or an integer between 1 and 3,653.
  - clusterSecurityGroups
```
public List<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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    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 an Amazon Virtual Private Cloud (VPC). Clusters that are created in a VPC use VPC security groups, which are listed by the VpcSecurityGroups parameter.
  - vpcSecurityGroups
```
public List<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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    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.
  - clusterParameterGroups
```
public List<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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    The list of cluster parameter groups that are associated with this cluster. Each parameter group in the list is returned with its status.
  - clusterSubnetGroupName
```
public 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.
    
    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.
  - vpcId
```
public String vpcId()
```
    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.
  - availabilityZone
```
public String availabilityZone()
```
    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.
  - preferredMaintenanceWindow
```
public String preferredMaintenanceWindow()
```
    The weekly time range, in Universal Coordinated Time (UTC), during which system maintenance can occur.
    
    Returns:
    
    The weekly time range, in Universal Coordinated Time (UTC), during which system maintenance can occur.
  - pendingModifiedValues
```
public PendingModifiedValues pendingModifiedValues()
```
    A value that, if present, indicates that changes to the cluster are pending. Specific pending changes are identified by subelements.
    
    Returns:
    
    A value that, if present, indicates that changes to the cluster are pending. Specific pending changes are identified by subelements.
  - clusterVersion
```
public String clusterVersion()
```
    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.
  - allowVersionUpgrade
```
public Boolean allowVersionUpgrade()
```
    A boolean value that, if true, indicates that major version upgrades will be applied automatically to the cluster during the maintenance window.
    
    Returns:
    
    A boolean value that, if true, indicates that major version upgrades will be applied automatically to the cluster during the maintenance window.
  - numberOfNodes
```
public Integer numberOfNodes()
```
    The number of compute nodes in the cluster.
    
    Returns:
    
    The number of compute nodes in the cluster.
  - publiclyAccessible
```
public Boolean publiclyAccessible()
```
    A boolean value that, if true, indicates that the cluster can be accessed from a public network.
    
    Returns:
    
    A boolean value that, if true, indicates that the cluster can be accessed from a public network.
  - encrypted
```
public Boolean encrypted()
```
    A boolean value that, if true, indicates that data in the cluster is encrypted at rest.
    
    Returns:
    
    A boolean value that, if true, indicates that data in the cluster is encrypted at rest.
  - restoreStatus
```
public 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.
    
    Returns:
    
    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.
  - dataTransferProgress
```
public DataTransferProgress dataTransferProgress()
```
    Returns the value of the DataTransferProgress property for this object.
    
    Returns:
    
    The value of the DataTransferProgress property for this object.
  - hsmStatus
```
public 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
    
    Returns:
    
    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
  - clusterSnapshotCopyStatus
```
public ClusterSnapshotCopyStatus clusterSnapshotCopyStatus()
```
    A value that returns the destination region and retention period that are configured for cross-region snapshot copy.
    
    Returns:
    
    A value that returns the destination region and retention period that are configured for cross-region snapshot copy.
  - clusterPublicKey
```
public String clusterPublicKey()
```
    The public key for the cluster.
    
    Returns:
    
    The public key for the cluster.
  - clusterNodes
```
public List<ClusterNode> clusterNodes()
```
    The nodes in the cluster.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    The nodes in the cluster.
  - elasticIpStatus
```
public ElasticIpStatus elasticIpStatus()
```
    The status of the elastic IP (EIP) address.
    
    Returns:
    
    The status of the elastic IP (EIP) address.
  - clusterRevisionNumber
```
public String clusterRevisionNumber()
```
    The specific revision number of the database in the cluster.
    
    Returns:
    
    The specific revision number of the database in the cluster.
  - tags
```
public List<Tag> tags()
```
    The list of tags for the cluster.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    The list of tags for the cluster.
  - kmsKeyId
```
public String kmsKeyId()
```
    The AWS Key Management Service (AWS KMS) key ID of the encryption key used to encrypt data in the cluster.
    
    Returns:
    
    The AWS Key Management Service (AWS KMS) key ID of the encryption key used to encrypt data in the cluster.
  - enhancedVpcRouting
```
public 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
    
    Returns:
    
    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
  - iamRoles
```
public List<ClusterIamRole> iamRoles()
```
    A list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    A list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services.
  - pendingActions
```
public List<String> pendingActions()
```
    Cluster operations that are waiting to be started.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    Cluster operations that are waiting to be started.
  - maintenanceTrackName
```
public String maintenanceTrackName()
```
    The name of the maintenance track for the cluster.
    
    Returns:
    
    The name of the maintenance track for the cluster.
  - elasticResizeNumberOfNodeOptions
```
public String elasticResizeNumberOfNodeOptions()
```
    The number of nodes that you can resize the cluster to with the elastic resize method.
    
    Returns:
    
    The number of nodes that you can resize the cluster to with the elastic resize method.
  - deferredMaintenanceWindows
```
public List<DeferredMaintenanceWindow> deferredMaintenanceWindows()
```
    Describes a group of DeferredMaintenanceWindow objects.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    Describes a group of DeferredMaintenanceWindow objects.
  - snapshotScheduleIdentifier
```
public String snapshotScheduleIdentifier()
```
    A unique identifier for the cluster snapshot schedule.
    
    Returns:
    
    A unique identifier for the cluster snapshot schedule.
  - snapshotScheduleState
```
public ScheduleState snapshotScheduleState()
```
    The current state of the cluster snapshot schedule.
    
    If the service returns an enum value that is not available in the current SDK version, snapshotScheduleState will return ScheduleState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from snapshotScheduleStateAsString().
    
    Returns:
    
    The current state of the cluster snapshot schedule.
    
    See Also:
    
    ScheduleState
  - snapshotScheduleStateAsString
```
public String snapshotScheduleStateAsString()
```
    The current state of the cluster snapshot schedule.
    
    If the service returns an enum value that is not available in the current SDK version, snapshotScheduleState will return ScheduleState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from snapshotScheduleStateAsString().
    
    Returns:
    
    The current state of the cluster snapshot schedule.
    
    See Also:
    
    ScheduleState
  - resizeInfo
```
public ResizeInfo resizeInfo()
```
    Returns the following:
    - AllowCancelResize: a boolean value indicating if the resize operation can be cancelled.
    - ResizeType: Returns ClassicResize
    Returns:
    Returns the following:
    
    AllowCancelResize: a boolean value indicating if the resize operation can be cancelled.
    
    ResizeType: Returns ClassicResize
  - toBuilder
```
public Cluster.Builder toBuilder()
```
    Description copied from interface: ToCopyableBuilder
    
    Take this object and create a builder that contains all of the current property values of this object.
    
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<Cluster.Builder,Cluster>
    
    Returns:
    
    a builder for type T
  - builder
```
public static Cluster.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends Cluster.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
    
    Returns:
    
    List of SdkField in this POJO. May be empty list but should never be null.

Class Cluster

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

clusterIdentifier

nodeType

clusterStatus

modifyStatus

masterUsername

dbName

endpoint

clusterCreateTime

automatedSnapshotRetentionPeriod

manualSnapshotRetentionPeriod

clusterSecurityGroups

vpcSecurityGroups

clusterParameterGroups

clusterSubnetGroupName

vpcId

availabilityZone

preferredMaintenanceWindow

pendingModifiedValues

clusterVersion

allowVersionUpgrade

numberOfNodes

publiclyAccessible

encrypted

restoreStatus

dataTransferProgress

hsmStatus

clusterSnapshotCopyStatus

clusterPublicKey

clusterNodes

elasticIpStatus

clusterRevisionNumber

tags

kmsKeyId

enhancedVpcRouting

iamRoles

pendingActions

maintenanceTrackName

elasticResizeNumberOfNodeOptions

deferredMaintenanceWindows

snapshotScheduleIdentifier

snapshotScheduleState

snapshotScheduleStateAsString

resizeInfo

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

sdkFields