@Generated(value="software.amazon.awssdk:codegen") public final class Cluster extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Cluster.Builder,Cluster>
Describes a cluster.
Modifier and Type | Class and Description |
---|---|
static interface |
Cluster.Builder |
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.
|
String |
availabilityZoneRelocationStatus()
Describes the status of the Availability Zone relocation operation.
|
static Cluster.Builder |
builder() |
String |
clusterAvailabilityStatus()
The availability status of the cluster for queries.
|
Instant |
clusterCreateTime()
The date and time that the cluster was created.
|
String |
clusterIdentifier()
The unique identifier of the cluster.
|
String |
clusterNamespaceArn()
The namespace Amazon Resource Name (ARN) 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()
|
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) |
boolean |
equalsBySdkFields(Object obj)
Indicates whether some other object is "equal to" this one by SDK fields.
|
Instant |
expectedNextSnapshotScheduleTime()
The date and time when the next snapshot is expected to be taken for clusters with a valid snapshot schedule and
backups enabled.
|
String |
expectedNextSnapshotScheduleTimeStatus()
The status of next expected snapshot for clusters having a valid snapshot schedule and backups enabled.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
boolean |
hasClusterNodes()
Returns true if the ClusterNodes property was specified by the sender (it may be empty), or false if the sender
did not specify the value (it will be empty).
|
boolean |
hasClusterParameterGroups()
Returns true if the ClusterParameterGroups property was specified by the sender (it may be empty), or false if
the sender did not specify the value (it will be empty).
|
boolean |
hasClusterSecurityGroups()
Returns true if the ClusterSecurityGroups property was specified by the sender (it may be empty), or false if the
sender did not specify the value (it will be empty).
|
boolean |
hasDeferredMaintenanceWindows()
Returns true if the DeferredMaintenanceWindows property was specified by the sender (it may be empty), or false
if the sender did not specify the value (it will be empty).
|
int |
hashCode() |
boolean |
hasIamRoles()
Returns true if the IamRoles property was specified by the sender (it may be empty), or false if the sender did
not specify the value (it will be empty).
|
boolean |
hasPendingActions()
Returns true if the PendingActions property was specified by the sender (it may be empty), or false if the sender
did not specify the value (it will be empty).
|
boolean |
hasTags()
Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not
specify the value (it will be empty).
|
boolean |
hasVpcSecurityGroups()
Returns true if the VpcSecurityGroups property was specified by the sender (it may be empty), or false if the
sender did not specify the value (it will be empty).
|
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.
|
Instant |
nextMaintenanceWindowStartTime()
The date and time in UTC when system maintenance can begin.
|
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()
Returns a string representation of this object.
|
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.
|
copy
public final String clusterIdentifier()
The unique identifier of the cluster.
public final String nodeType()
The node type for the nodes in the cluster.
public final 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
paused
rebooting
renaming
resizing
rotating-keys
storage-full
updating-hsm
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
paused
rebooting
renaming
resizing
rotating-keys
storage-full
updating-hsm
public final String clusterAvailabilityStatus()
The availability status of the cluster for queries. Possible values are the following:
Available - The cluster is available for queries.
Unavailable - The cluster is not available for queries.
Maintenance - The cluster is intermittently available for queries due to maintenance activities.
Modifying - The cluster is intermittently available for queries due to changes that modify the cluster.
Failed - The cluster failed and is not available for queries.
Available - The cluster is available for queries.
Unavailable - The cluster is not available for queries.
Maintenance - The cluster is intermittently available for queries due to maintenance activities.
Modifying - The cluster is intermittently available for queries due to changes that modify the cluster.
Failed - The cluster failed and is not available for queries.
public final String modifyStatus()
The status of a modify operation, if any, initiated for the cluster.
public final 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.
public final 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.
dev
dev was created by default.public final Endpoint endpoint()
The connection endpoint.
public final Instant clusterCreateTime()
The date and time that the cluster was created.
public final Integer automatedSnapshotRetentionPeriod()
The number of days that automatic cluster snapshots are retained.
public final 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.
The value must be either -1 or an integer between 1 and 3,653.
public final boolean hasClusterSecurityGroups()
public final 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.
You can use hasClusterSecurityGroups()
to see if a value was sent in this field.
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 final boolean hasVpcSecurityGroups()
public final 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.
You can use hasVpcSecurityGroups()
to see if a value was sent in this field.
public final boolean hasClusterParameterGroups()
public final 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.
You can use hasClusterParameterGroups()
to see if a value was sent in this field.
public final 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.
public final String vpcId()
The identifier of the VPC the cluster is in, if the cluster is in a VPC.
public final String availabilityZone()
The name of the Availability Zone in which the cluster is located.
public final String preferredMaintenanceWindow()
The weekly time range, in Universal Coordinated Time (UTC), during which system maintenance can occur.
public final PendingModifiedValues pendingModifiedValues()
A value that, if present, indicates that changes to the cluster are pending. Specific pending changes are identified by subelements.
public final String clusterVersion()
The version ID of the Amazon Redshift engine that is running on the cluster.
public final Boolean allowVersionUpgrade()
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 final Integer numberOfNodes()
The number of compute nodes in the cluster.
public final Boolean publiclyAccessible()
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 final Boolean encrypted()
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 final 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.
public final DataTransferProgress dataTransferProgress()
public final 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
Values: active, applying
public final ClusterSnapshotCopyStatus clusterSnapshotCopyStatus()
A value that returns the destination region and retention period that are configured for cross-region snapshot copy.
public final String clusterPublicKey()
The public key for the cluster.
public final boolean hasClusterNodes()
public final List<ClusterNode> clusterNodes()
The nodes in the cluster.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasClusterNodes()
to see if a value was sent in this field.
public final ElasticIpStatus elasticIpStatus()
The status of the elastic IP (EIP) address.
public final String clusterRevisionNumber()
The specific revision number of the database in the cluster.
public final boolean hasTags()
public final List<Tag> tags()
The list of tags for the cluster.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasTags()
to see if a value was sent in this field.
public final String kmsKeyId()
The AWS Key Management Service (AWS KMS) key ID of the encryption key used to encrypt data in the cluster.
public final 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
If this option is true
, enhanced VPC routing is enabled.
Default: false
public final boolean hasIamRoles()
public final 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.
You can use hasIamRoles()
to see if a value was sent in this field.
public final boolean hasPendingActions()
public final 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.
You can use hasPendingActions()
to see if a value was sent in this field.
public final String maintenanceTrackName()
The name of the maintenance track for the cluster.
public final String elasticResizeNumberOfNodeOptions()
The number of nodes that you can resize the cluster to with the elastic resize method.
public final boolean hasDeferredMaintenanceWindows()
public final List<DeferredMaintenanceWindow> deferredMaintenanceWindows()
Describes a group of DeferredMaintenanceWindow
objects.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasDeferredMaintenanceWindows()
to see if a value was sent in this field.
DeferredMaintenanceWindow
objects.public final String snapshotScheduleIdentifier()
A unique identifier for the cluster snapshot schedule.
public final 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()
.
ScheduleState
public final 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()
.
ScheduleState
public final Instant expectedNextSnapshotScheduleTime()
The date and time when the next snapshot is expected to be taken for clusters with a valid snapshot schedule and backups enabled.
public final String expectedNextSnapshotScheduleTimeStatus()
The status of next expected snapshot for clusters having a valid snapshot schedule and backups enabled. Possible values are the following:
OnTrack - The next snapshot is expected to be taken on time.
Pending - The next snapshot is pending to be taken.
OnTrack - The next snapshot is expected to be taken on time.
Pending - The next snapshot is pending to be taken.
public final Instant nextMaintenanceWindowStartTime()
The date and time in UTC when system maintenance can begin.
public final ResizeInfo resizeInfo()
Returns the following:
AllowCancelResize: a boolean value indicating if the resize operation can be cancelled.
ResizeType: Returns ClassicResize
AllowCancelResize: a boolean value indicating if the resize operation can be cancelled.
ResizeType: Returns ClassicResize
public final String availabilityZoneRelocationStatus()
Describes the status of the Availability Zone relocation operation.
public final String clusterNamespaceArn()
The namespace Amazon Resource Name (ARN) of the cluster.
public Cluster.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<Cluster.Builder,Cluster>
public static Cluster.Builder builder()
public static Class<? extends Cluster.Builder> serializableBuilderClass()
public final boolean equalsBySdkFields(Object obj)
SdkPojo
SdkPojo
class,
and is generated based on a service model.
If an SdkPojo
class does not have any inherited fields, equalsBySdkFields
and equals
are essentially the same.
equalsBySdkFields
in interface SdkPojo
obj
- the object to be compared withpublic final String toString()
Copyright © 2021 Amazon Web Services, Inc. All Rights Reserved.