Class AwsRedshiftClusterDetails
- java.lang.Object
-
- software.amazon.awssdk.services.securityhub.model.AwsRedshiftClusterDetails
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<AwsRedshiftClusterDetails.Builder,AwsRedshiftClusterDetails>
@Generated("software.amazon.awssdk:codegen") public final class AwsRedshiftClusterDetails extends Object implements SdkPojo, Serializable, ToCopyableBuilder<AwsRedshiftClusterDetails.Builder,AwsRedshiftClusterDetails>
Details about an Amazon Redshift cluster.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceAwsRedshiftClusterDetails.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description BooleanallowVersionUpgrade()Indicates whether major version upgrades are applied automatically to the cluster during the maintenance window.IntegerautomatedSnapshotRetentionPeriod()The number of days that automatic cluster snapshots are retained.StringavailabilityZone()The name of the Availability Zone in which the cluster is located.static AwsRedshiftClusterDetails.Builderbuilder()StringclusterAvailabilityStatus()The availability status of the cluster for queries.StringclusterCreateTime()Indicates when the cluster was created.StringclusterIdentifier()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.StringclusterPublicKey()The public key for the cluster.StringclusterRevisionNumber()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.AwsRedshiftClusterClusterSnapshotCopyStatusclusterSnapshotCopyStatus()Information about the destination Region and retention period for the cross-Region snapshot copy.StringclusterStatus()The current status of the cluster.StringclusterSubnetGroupName()The name of the subnet group that is associated with the cluster.StringclusterVersion()The version ID of the Amazon Redshift engine that runs on the cluster.StringdbName()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.AwsRedshiftClusterElasticIpStatuselasticIpStatus()Information about the status of the Elastic IP (EIP) address.StringelasticResizeNumberOfNodeOptions()The number of nodes that you can use the elastic resize method to resize the cluster to.Booleanencrypted()Indicates whether the data in the cluster is encrypted at rest.AwsRedshiftClusterEndpointendpoint()The connection endpoint.BooleanenhancedVpcRouting()Indicates whether to create the cluster with enhanced VPC routing enabled.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)StringexpectedNextSnapshotScheduleTime()Indicates when the next snapshot is expected to be taken.StringexpectedNextSnapshotScheduleTimeStatus()The status of the next expected snapshot.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasClusterNodes()For responses, this returns true if the service returned a value for the ClusterNodes property.booleanhasClusterParameterGroups()For responses, this returns true if the service returned a value for the ClusterParameterGroups property.booleanhasClusterSecurityGroups()For responses, this returns true if the service returned a value for the ClusterSecurityGroups property.booleanhasDeferredMaintenanceWindows()For responses, this returns true if the service returned a value for the DeferredMaintenanceWindows property.inthashCode()booleanhasIamRoles()For responses, this returns true if the service returned a value for the IamRoles property.booleanhasPendingActions()For responses, this returns true if the service returned a value for the PendingActions property.booleanhasVpcSecurityGroups()For responses, this returns true if the service returned a value for the VpcSecurityGroups property.AwsRedshiftClusterHsmStatushsmStatus()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.StringkmsKeyId()The identifier of the KMS encryption key that is used to encrypt data in the cluster.AwsRedshiftClusterLoggingStatusloggingStatus()Information about the logging status of the cluster.StringmaintenanceTrackName()The name of the maintenance track for the cluster.IntegermanualSnapshotRetentionPeriod()The default number of days to retain a manual snapshot.StringmasterUsername()The master user name for the cluster.StringnextMaintenanceWindowStartTime()Indicates the start of the next maintenance window.StringnodeType()The node type for the nodes in the cluster.IntegernumberOfNodes()The number of compute nodes in the cluster.List<String>pendingActions()A list of cluster operations that are waiting to start.AwsRedshiftClusterPendingModifiedValuespendingModifiedValues()A list of changes to the cluster that are currently pending.StringpreferredMaintenanceWindow()The weekly time range, in Universal Coordinated Time (UTC), during which system maintenance can occur.BooleanpubliclyAccessible()Whether the cluster can be accessed from a public network.AwsRedshiftClusterResizeInforesizeInfo()Information about the resize operation for the cluster.AwsRedshiftClusterRestoreStatusrestoreStatus()Information about the status of a cluster restore action.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends AwsRedshiftClusterDetails.Builder>serializableBuilderClass()StringsnapshotScheduleIdentifier()A unique identifier for the cluster snapshot schedule.StringsnapshotScheduleState()The current state of the cluster snapshot schedule.AwsRedshiftClusterDetails.BuildertoBuilder()StringtoString()Returns a string representation of this object.StringvpcId()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.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
allowVersionUpgrade
public final Boolean allowVersionUpgrade()
Indicates whether major version upgrades are applied automatically to the cluster during the maintenance window.
- Returns:
- Indicates whether major version upgrades are applied automatically to the cluster during the maintenance window.
-
automatedSnapshotRetentionPeriod
public final Integer automatedSnapshotRetentionPeriod()
The number of days that automatic cluster snapshots are retained.
- Returns:
- The number of days that automatic cluster snapshots are retained.
-
availabilityZone
public final 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.
-
clusterAvailabilityStatus
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.
- Returns:
- 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.
-
-
-
clusterCreateTime
public final String clusterCreateTime()
Indicates when the cluster was created.
For more information about the validation and formatting of timestamp fields in Security Hub, see Timestamps.
- Returns:
- Indicates when the cluster was created.
For more information about the validation and formatting of timestamp fields in Security Hub, see Timestamps.
-
clusterIdentifier
public final String clusterIdentifier()
The unique identifier of the cluster.
- Returns:
- The unique identifier of the cluster.
-
hasClusterNodes
public final boolean hasClusterNodes()
For responses, this returns true if the service returned a value for the ClusterNodes property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()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.
-
clusterNodes
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.- Returns:
- The nodes in the cluster.
-
hasClusterParameterGroups
public final boolean hasClusterParameterGroups()
For responses, this returns true if the service returned a value for the ClusterParameterGroups property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()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.
-
clusterParameterGroups
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.- Returns:
- The list of cluster parameter groups that are associated with this cluster.
-
clusterPublicKey
public final String clusterPublicKey()
The public key for the cluster.
- Returns:
- The public key for the cluster.
-
clusterRevisionNumber
public final String clusterRevisionNumber()
The specific revision number of the database in the cluster.
- Returns:
- The specific revision number of the database in the cluster.
-
hasClusterSecurityGroups
public final boolean hasClusterSecurityGroups()
For responses, this returns true if the service returned a value for the ClusterSecurityGroups property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()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.
-
clusterSecurityGroups
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.- Returns:
- A list of cluster security groups that are associated with the cluster.
-
clusterSnapshotCopyStatus
public final AwsRedshiftClusterClusterSnapshotCopyStatus clusterSnapshotCopyStatus()
Information about the destination Region and retention period for the cross-Region snapshot copy.
- Returns:
- Information about the destination Region and retention period for the cross-Region snapshot copy.
-
clusterStatus
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- Returns:
- 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
-
clusterSubnetGroupName
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.
- 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.
-
clusterVersion
public final String clusterVersion()
The version ID of the Amazon Redshift engine that runs on the cluster.
- Returns:
- The version ID of the Amazon Redshift engine that runs on the cluster.
-
dbName
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
devdevis created by default.- Returns:
- 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
devdevis created by default.
-
hasDeferredMaintenanceWindows
public final boolean hasDeferredMaintenanceWindows()
For responses, this returns true if the service returned a value for the DeferredMaintenanceWindows property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()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.
-
deferredMaintenanceWindows
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.- Returns:
- List of time windows during which maintenance was deferred.
-
elasticIpStatus
public final AwsRedshiftClusterElasticIpStatus elasticIpStatus()
Information about the status of the Elastic IP (EIP) address.
- Returns:
- Information about the status of the Elastic IP (EIP) address.
-
elasticResizeNumberOfNodeOptions
public final String elasticResizeNumberOfNodeOptions()
The number of nodes that you can use the elastic resize method to resize the cluster to.
- Returns:
- The number of nodes that you can use the elastic resize method to resize the cluster to.
-
encrypted
public final Boolean encrypted()
Indicates whether the data in the cluster is encrypted at rest.
- Returns:
- Indicates whether the data in the cluster is encrypted at rest.
-
endpoint
public final AwsRedshiftClusterEndpoint endpoint()
The connection endpoint.
- Returns:
- The connection endpoint.
-
enhancedVpcRouting
public final Boolean enhancedVpcRouting()
Indicates whether to create the cluster with enhanced VPC routing enabled.
- Returns:
- Indicates whether to create the cluster with enhanced VPC routing enabled.
-
expectedNextSnapshotScheduleTime
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.
For more information about the validation and formatting of timestamp fields in Security Hub, see Timestamps.
- Returns:
- Indicates when the next snapshot is expected to be taken. The cluster must have a valid snapshot schedule
and have backups enabled.
For more information about the validation and formatting of timestamp fields in Security Hub, see Timestamps.
-
expectedNextSnapshotScheduleTimeStatus
public final String expectedNextSnapshotScheduleTimeStatus()
The status of the next expected snapshot.
Valid values:
OnTrack|Pending- Returns:
- The status of the next expected snapshot.
Valid values:
OnTrack|Pending
-
hsmStatus
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.
- Returns:
- 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.
-
hasIamRoles
public final boolean hasIamRoles()
For responses, this returns true if the service returned a value for the IamRoles property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()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.
-
iamRoles
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.- Returns:
- A list of IAM roles that the cluster can use to access other Amazon Web Services services.
-
kmsKeyId
public final String kmsKeyId()
The identifier of the KMS encryption key that is used to encrypt data in the cluster.
- Returns:
- The identifier of the KMS encryption key that is used to encrypt data in the cluster.
-
maintenanceTrackName
public final String maintenanceTrackName()
The name of the maintenance track for the cluster.
- Returns:
- The name of the maintenance track for the cluster.
-
manualSnapshotRetentionPeriod
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
-1or 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.
Valid values: Either
-1or an integer between 1 and 3,653
-
masterUsername
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.- Returns:
- 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.
-
nextMaintenanceWindowStartTime
public final String nextMaintenanceWindowStartTime()
Indicates the start of the next maintenance window.
For more information about the validation and formatting of timestamp fields in Security Hub, see Timestamps.
- Returns:
- Indicates the start of the next maintenance window.
For more information about the validation and formatting of timestamp fields in Security Hub, see Timestamps.
-
nodeType
public final String nodeType()
The node type for the nodes in the cluster.
- Returns:
- The node type for the nodes in the cluster.
-
numberOfNodes
public final Integer numberOfNodes()
The number of compute nodes in the cluster.
- Returns:
- The number of compute nodes in the cluster.
-
hasPendingActions
public final boolean hasPendingActions()
For responses, this returns true if the service returned a value for the PendingActions property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()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.
-
pendingActions
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.- Returns:
- A list of cluster operations that are waiting to start.
-
pendingModifiedValues
public final AwsRedshiftClusterPendingModifiedValues pendingModifiedValues()
A list of changes to the cluster that are currently pending.
- Returns:
- A list of changes to the cluster that are currently pending.
-
preferredMaintenanceWindow
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:MMFor the day values, use
mon|tue|wed|thu|fri|sat|sunFor example,
sun:09:32-sun:10:02- Returns:
- The weekly time range, in Universal Coordinated Time (UTC), during which system maintenance can
occur.
Format:
<day>:HH:MM-<day>:HH:MMFor the day values, use
mon|tue|wed|thu|fri|sat|sunFor example,
sun:09:32-sun:10:02
-
publiclyAccessible
public final Boolean publiclyAccessible()
Whether the cluster can be accessed from a public network.
- Returns:
- Whether the cluster can be accessed from a public network.
-
resizeInfo
public final AwsRedshiftClusterResizeInfo resizeInfo()
Information about the resize operation for the cluster.
- Returns:
- Information about the resize operation for the cluster.
-
restoreStatus
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.
- Returns:
- Information about the status of a cluster restore action. Only applies to a cluster that was created by restoring a snapshot.
-
snapshotScheduleIdentifier
public final String snapshotScheduleIdentifier()
A unique identifier for the cluster snapshot schedule.
- Returns:
- A unique identifier for the cluster snapshot schedule.
-
snapshotScheduleState
public final String snapshotScheduleState()
The current state of the cluster snapshot schedule.
Valid values:
MODIFYING|ACTIVE|FAILED- Returns:
- The current state of the cluster snapshot schedule.
Valid values:
MODIFYING|ACTIVE|FAILED
-
vpcId
public final String vpcId()
The identifier of the VPC that the cluster is in, if the cluster is in a VPC.
- Returns:
- The identifier of the VPC that the cluster is in, if the cluster is in a VPC.
-
hasVpcSecurityGroups
public final boolean hasVpcSecurityGroups()
For responses, this returns true if the service returned a value for the VpcSecurityGroups property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()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.
-
vpcSecurityGroups
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.- Returns:
- The list of VPC security groups that the cluster belongs to, if the cluster is in a VPC.
-
loggingStatus
public final AwsRedshiftClusterLoggingStatus loggingStatus()
Information about the logging status of the cluster.
- Returns:
- Information about the logging status of the cluster.
-
toBuilder
public AwsRedshiftClusterDetails.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<AwsRedshiftClusterDetails.Builder,AwsRedshiftClusterDetails>
-
builder
public static AwsRedshiftClusterDetails.Builder builder()
-
serializableBuilderClass
public static Class<? extends AwsRedshiftClusterDetails.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
toString
public final String toString()
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-