Package software.amazon.awssdk.services.securityhub.model

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:

  • Method Details

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

      This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

      • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

      • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

      • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

      • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

      • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

      Returns:
      Indicates when the cluster was created.

      This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

      • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

      • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

      • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

      • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

      • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

    • 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 the 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.

    • 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 the 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.

    • 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 the 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.

    • 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 devdev is 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 devdev is 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 the 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.

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

      This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

      • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

      • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

      • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

      • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

      • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

      Returns:
      Indicates when the next snapshot is expected to be taken. The cluster must have a valid snapshot schedule and have backups enabled.

      This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

      • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

      • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

      • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

      • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

      • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

    • 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 the 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.

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

      Valid values: Either -1 or 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.

      This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

      • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

      • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

      • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

      • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

      • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

      Returns:
      Indicates the start of the next maintenance window.

      This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

      • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

      • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

      • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

      • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

      • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

    • 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 the 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.

    • 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:MM

      For the day values, use mon | tue | wed | thu | fri | sat | sun

      For 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:MM

      For the day values, use mon | tue | wed | thu | fri | sat | sun

      For 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 the 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.

    • 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()
      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<AwsRedshiftClusterDetails.Builder,AwsRedshiftClusterDetails>
      Returns:
      a builder for type T

    • builder

      public static AwsRedshiftClusterDetails.Builder builder()

    • serializableBuilderClass

      public static Class<? extends AwsRedshiftClusterDetails.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

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

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an 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.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final 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.