@Generated(value="software.amazon.awssdk:codegen") public final class AwsRedshiftClusterDetails extends Object implements SdkPojo, Serializable, ToCopyableBuilder<AwsRedshiftClusterDetails.Builder,AwsRedshiftClusterDetails>
Details about an Amazon Redshift cluster.
| Modifier and Type | Class and Description |
|---|---|
static interface |
AwsRedshiftClusterDetails.Builder |
| Modifier and Type | Method and Description |
|---|---|
Boolean |
allowVersionUpgrade()
Indicates whether major version upgrades are 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 AwsRedshiftClusterDetails.Builder |
builder() |
String |
clusterAvailabilityStatus()
The availability status of the cluster for queries.
|
String |
clusterCreateTime()
Indicates when the cluster was created.
|
String |
clusterIdentifier()
The unique identifier of the cluster.
|
List<AwsRedshiftClusterClusterNode> |
clusterNodes()
The nodes in the cluster.
|
List<AwsRedshiftClusterClusterParameterGroup> |
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<AwsRedshiftClusterClusterSecurityGroup> |
clusterSecurityGroups()
A list of cluster security groups that are associated with the cluster.
|
AwsRedshiftClusterClusterSnapshotCopyStatus |
clusterSnapshotCopyStatus()
Information about the destination Region and retention period for the cross-Region snapshot copy.
|
String |
clusterStatus()
The current status 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 runs on the cluster.
|
String |
dbName()
The name of the initial database that was created when the cluster was created.
|
List<AwsRedshiftClusterDeferredMaintenanceWindow> |
deferredMaintenanceWindows()
List of time windows during which maintenance was deferred.
|
AwsRedshiftClusterElasticIpStatus |
elasticIpStatus()
Information about the status of the Elastic IP (EIP) address.
|
String |
elasticResizeNumberOfNodeOptions()
The number of nodes that you can use the elastic resize method to resize the cluster to.
|
Boolean |
encrypted()
Indicates whether the data in the cluster is encrypted at rest.
|
AwsRedshiftClusterEndpoint |
endpoint()
The connection endpoint.
|
Boolean |
enhancedVpcRouting()
Indicates whether to create the cluster with enhanced VPC routing enabled.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
String |
expectedNextSnapshotScheduleTime()
Indicates when the next snapshot is expected to be taken.
|
String |
expectedNextSnapshotScheduleTimeStatus()
The status of the next expected snapshot.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
boolean |
hasClusterNodes()
For responses, this returns true if the service returned a value for the ClusterNodes property.
|
boolean |
hasClusterParameterGroups()
For responses, this returns true if the service returned a value for the ClusterParameterGroups property.
|
boolean |
hasClusterSecurityGroups()
For responses, this returns true if the service returned a value for the ClusterSecurityGroups property.
|
boolean |
hasDeferredMaintenanceWindows()
For responses, this returns true if the service returned a value for the DeferredMaintenanceWindows property.
|
int |
hashCode() |
boolean |
hasIamRoles()
For responses, this returns true if the service returned a value for the IamRoles property.
|
boolean |
hasPendingActions()
For responses, this returns true if the service returned a value for the PendingActions property.
|
boolean |
hasVpcSecurityGroups()
For responses, this returns true if the service returned a value for the VpcSecurityGroups property.
|
AwsRedshiftClusterHsmStatus |
hsmStatus()
Information about whether the Amazon Redshift cluster finished applying any changes to hardware security module
(HSM) settings that were specified in a modify cluster command.
|
List<AwsRedshiftClusterIamRole> |
iamRoles()
A list of IAM roles that the cluster can use to access other Amazon Web Services services.
|
String |
kmsKeyId()
The identifier of the KMS encryption key that is used to encrypt data in the cluster.
|
AwsRedshiftClusterLoggingStatus |
loggingStatus()
Information about the logging status of 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 |
nextMaintenanceWindowStartTime()
Indicates the start of the next maintenance window.
|
String |
nodeType()
The node type for the nodes in the cluster.
|
Integer |
numberOfNodes()
The number of compute nodes in the cluster.
|
List<String> |
pendingActions()
A list of cluster operations that are waiting to start.
|
AwsRedshiftClusterPendingModifiedValues |
pendingModifiedValues()
A list of changes to the cluster that are currently pending.
|
String |
preferredMaintenanceWindow()
The weekly time range, in Universal Coordinated Time (UTC), during which system maintenance can occur.
|
Boolean |
publiclyAccessible()
Whether the cluster can be accessed from a public network.
|
AwsRedshiftClusterResizeInfo |
resizeInfo()
Information about the resize operation for the cluster.
|
AwsRedshiftClusterRestoreStatus |
restoreStatus()
Information about the status of a cluster restore action.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends AwsRedshiftClusterDetails.Builder> |
serializableBuilderClass() |
String |
snapshotScheduleIdentifier()
A unique identifier for the cluster snapshot schedule.
|
String |
snapshotScheduleState()
The current state of the cluster snapshot schedule.
|
AwsRedshiftClusterDetails.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
String |
vpcId()
The identifier of the VPC that the cluster is in, if the cluster is in a VPC.
|
List<AwsRedshiftClusterVpcSecurityGroup> |
vpcSecurityGroups()
The list of VPC security groups that the cluster belongs to, if the cluster is in a VPC.
|
clone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic final Boolean allowVersionUpgrade()
Indicates whether major version upgrades are applied automatically to the cluster during the maintenance window.
public final Integer automatedSnapshotRetentionPeriod()
The number of days that automatic cluster snapshots are retained.
public final String availabilityZone()
The name of the Availability Zone in which the cluster is located.
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 clusterCreateTime()
Indicates when the cluster was created.
Uses the date-time format specified in RFC
3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces, and date and time should be
separated by T. For example, 2020-03-22T13:22:13.933Z.
Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
Format. The value cannot contain spaces, and date and time should be separated by T. For
example, 2020-03-22T13:22:13.933Z.
public final String clusterIdentifier()
The unique identifier of the cluster.
public final boolean hasClusterNodes()
isEmpty() method on the property).
This is useful because the SDK will never return a null collection or map, but you may need to differentiate
between the service returning nothing (or null) and the service returning an empty collection or map. For
requests, this returns true if a value for the property was specified in the request builder, and false if a
value was not specified.public final List<AwsRedshiftClusterClusterNode> clusterNodes()
The nodes in the cluster.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasClusterNodes() method.
public final boolean hasClusterParameterGroups()
isEmpty() method on the
property). This is useful because the SDK will never return a null collection or map, but you may need to
differentiate between the service returning nothing (or null) and the service returning an empty collection or
map. For requests, this returns true if a value for the property was specified in the request builder, and false
if a value was not specified.public final List<AwsRedshiftClusterClusterParameterGroup> clusterParameterGroups()
The list of cluster parameter groups that are associated with this cluster.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasClusterParameterGroups() method.
public final String clusterPublicKey()
The public key for the cluster.
public final String clusterRevisionNumber()
The specific revision number of the database in the cluster.
public final boolean hasClusterSecurityGroups()
isEmpty() method on the
property). This is useful because the SDK will never return a null collection or map, but you may need to
differentiate between the service returning nothing (or null) and the service returning an empty collection or
map. For requests, this returns true if a value for the property was specified in the request builder, and false
if a value was not specified.public final List<AwsRedshiftClusterClusterSecurityGroup> clusterSecurityGroups()
A list of cluster security groups that are associated with the cluster.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasClusterSecurityGroups() method.
public final AwsRedshiftClusterClusterSnapshotCopyStatus clusterSnapshotCopyStatus()
Information about the destination Region and retention period for the cross-Region snapshot copy.
public final String clusterStatus()
The current status of the cluster.
Valid values: 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
Valid values: 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 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 clusterVersion()
The version ID of the Amazon Redshift engine that runs on the cluster.
public final String dbName()
The name of the initial database that was created when the cluster was created.
The same name is returned for the life of the cluster.
If an initial database is not specified, a database named devdev is created by default.
The same name is returned for the life of the cluster.
If an initial database is not specified, a database named devdev is created by default.
public final boolean hasDeferredMaintenanceWindows()
isEmpty() method on the
property). This is useful because the SDK will never return a null collection or map, but you may need to
differentiate between the service returning nothing (or null) and the service returning an empty collection or
map. For requests, this returns true if a value for the property was specified in the request builder, and false
if a value was not specified.public final List<AwsRedshiftClusterDeferredMaintenanceWindow> deferredMaintenanceWindows()
List of time windows during which maintenance was deferred.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasDeferredMaintenanceWindows() method.
public final AwsRedshiftClusterElasticIpStatus elasticIpStatus()
Information about the status of the Elastic IP (EIP) address.
public final String elasticResizeNumberOfNodeOptions()
The number of nodes that you can use the elastic resize method to resize the cluster to.
public final Boolean encrypted()
Indicates whether the data in the cluster is encrypted at rest.
public final AwsRedshiftClusterEndpoint endpoint()
The connection endpoint.
public final Boolean enhancedVpcRouting()
Indicates whether to create the cluster with enhanced VPC routing enabled.
public final String expectedNextSnapshotScheduleTime()
Indicates when the next snapshot is expected to be taken. The cluster must have a valid snapshot schedule and have backups enabled.
Uses the date-time format specified in RFC
3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces, and date and time should be
separated by T. For example, 2020-03-22T13:22:13.933Z.
Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
Format. The value cannot contain spaces, and date and time should be separated by T. For
example, 2020-03-22T13:22:13.933Z.
public final String expectedNextSnapshotScheduleTimeStatus()
The status of the next expected snapshot.
Valid values: OnTrack | Pending
Valid values: OnTrack | Pending
public final AwsRedshiftClusterHsmStatus hsmStatus()
Information about whether the Amazon Redshift cluster finished applying any changes to hardware security module (HSM) settings that were specified in a modify cluster command.
public final boolean hasIamRoles()
isEmpty() method on the property). This is
useful because the SDK will never return a null collection or map, but you may need to differentiate between the
service returning nothing (or null) and the service returning an empty collection or map. For requests, this
returns true if a value for the property was specified in the request builder, and false if a value was not
specified.public final List<AwsRedshiftClusterIamRole> iamRoles()
A list of IAM roles that the cluster can use to access other Amazon Web Services services.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasIamRoles() method.
public final String kmsKeyId()
The identifier of the KMS encryption key that is used to encrypt data in the cluster.
public final String maintenanceTrackName()
The name of the maintenance track for the cluster.
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.
Valid values: Either -1 or an integer between 1 and 3,653
If the value is -1, the snapshot is retained indefinitely.
This setting doesn't change the retention period of existing snapshots.
Valid values: Either -1 or an integer between 1 and 3,653
public final String masterUsername()
The master user name for the cluster. This name is used to connect to the database that is specified in as the
value of DBName.
DBName.public final String nextMaintenanceWindowStartTime()
Indicates the start of the next maintenance window.
Uses the date-time format specified in RFC
3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces, and date and time should be
separated by T. For example, 2020-03-22T13:22:13.933Z.
Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
Format. The value cannot contain spaces, and date and time should be separated by T. For
example, 2020-03-22T13:22:13.933Z.
public final String nodeType()
The node type for the nodes in the cluster.
public final Integer numberOfNodes()
The number of compute nodes in the cluster.
public final boolean hasPendingActions()
isEmpty() method on the property).
This is useful because the SDK will never return a null collection or map, but you may need to differentiate
between the service returning nothing (or null) and the service returning an empty collection or map. For
requests, this returns true if a value for the property was specified in the request builder, and false if a
value was not specified.public final List<String> pendingActions()
A list of cluster operations that are waiting to start.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasPendingActions() method.
public final AwsRedshiftClusterPendingModifiedValues pendingModifiedValues()
A list of changes to the cluster that are currently pending.
public final String preferredMaintenanceWindow()
The weekly time range, in Universal Coordinated Time (UTC), during which system maintenance can occur.
Format: <day>:HH:MM-<day>:HH:MM
For the day values, use mon | tue | wed | thu |
fri | sat | sun
For example, sun:09:32-sun:10:02
Format: <day>:HH:MM-<day>:HH:MM
For the day values, use mon | tue | wed | thu |
fri | sat | sun
For example, sun:09:32-sun:10:02
public final Boolean publiclyAccessible()
Whether the cluster can be accessed from a public network.
public final AwsRedshiftClusterResizeInfo resizeInfo()
Information about the resize operation for the cluster.
public final AwsRedshiftClusterRestoreStatus restoreStatus()
Information about the status of a cluster restore action. Only applies to a cluster that was created by restoring a snapshot.
public final String snapshotScheduleIdentifier()
A unique identifier for the cluster snapshot schedule.
public final String snapshotScheduleState()
The current state of the cluster snapshot schedule.
Valid values: MODIFYING | ACTIVE | FAILED
Valid values: MODIFYING | ACTIVE | FAILED
public final String vpcId()
The identifier of the VPC that the cluster is in, if the cluster is in a VPC.
public final boolean hasVpcSecurityGroups()
isEmpty() method on the property).
This is useful because the SDK will never return a null collection or map, but you may need to differentiate
between the service returning nothing (or null) and the service returning an empty collection or map. For
requests, this returns true if a value for the property was specified in the request builder, and false if a
value was not specified.public final List<AwsRedshiftClusterVpcSecurityGroup> vpcSecurityGroups()
The list of VPC security groups that the cluster belongs to, if the cluster is in a VPC.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasVpcSecurityGroups() method.
public final AwsRedshiftClusterLoggingStatus loggingStatus()
Information about the logging status of the cluster.
public AwsRedshiftClusterDetails.Builder toBuilder()
toBuilder in interface ToCopyableBuilder<AwsRedshiftClusterDetails.Builder,AwsRedshiftClusterDetails>public static AwsRedshiftClusterDetails.Builder builder()
public static Class<? extends AwsRedshiftClusterDetails.Builder> serializableBuilderClass()
public final boolean equalsBySdkFields(Object obj)
equalsBySdkFields in interface SdkPojopublic final String toString()
Copyright © 2023. All rights reserved.