Class StandardsControl

java.lang.Object
software.amazon.awssdk.services.securityhub.model.StandardsControl
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<StandardsControl.Builder,StandardsControl>
@Generated("software.amazon.awssdk:codegen") public final class StandardsControl extends Object implements SdkPojo, Serializable, ToCopyableBuilder<StandardsControl.Builder,StandardsControl>

Details for an individual security standard control.

See Also:

  • Method Details

    • standardsControlArn

      public final String standardsControlArn()

      The ARN of the security standard control.

      Returns:
      The ARN of the security standard control.

    • controlStatus

      public final ControlStatus controlStatus()

      The current status of the security standard control. Indicates whether the control is enabled or disabled. Security Hub does not check against disabled controls.

      If the service returns an enum value that is not available in the current SDK version, controlStatus will return ControlStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from controlStatusAsString().

      Returns:
      The current status of the security standard control. Indicates whether the control is enabled or disabled. Security Hub does not check against disabled controls.
      See Also:

    • controlStatusAsString

      public final String controlStatusAsString()

      The current status of the security standard control. Indicates whether the control is enabled or disabled. Security Hub does not check against disabled controls.

      If the service returns an enum value that is not available in the current SDK version, controlStatus will return ControlStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from controlStatusAsString().

      Returns:
      The current status of the security standard control. Indicates whether the control is enabled or disabled. Security Hub does not check against disabled controls.
      See Also:

    • disabledReason

      public final String disabledReason()

      The reason provided for the most recent change in status for the control.

      Returns:
      The reason provided for the most recent change in status for the control.

    • controlStatusUpdatedAt

      public final Instant controlStatusUpdatedAt()

      The date and time that the status of the security standard control was most recently updated.

      Returns:
      The date and time that the status of the security standard control was most recently updated.

    • controlId

      public final String controlId()

      The identifier of the security standard control.

      Returns:
      The identifier of the security standard control.

    • title

      public final String title()

      The title of the security standard control.

      Returns:
      The title of the security standard control.

    • description

      public final String description()

      The longer description of the security standard control. Provides information about what the control is checking for.

      Returns:
      The longer description of the security standard control. Provides information about what the control is checking for.

    • remediationUrl

      public final String remediationUrl()

      A link to remediation information for the control in the Security Hub user documentation.

      Returns:
      A link to remediation information for the control in the Security Hub user documentation.

    • severityRating

      public final SeverityRating severityRating()

      The severity of findings generated from this security standard control.

      The finding severity is based on an assessment of how easy it would be to compromise Amazon Web Services resources if the issue is detected.

      If the service returns an enum value that is not available in the current SDK version, severityRating will return SeverityRating.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from severityRatingAsString().

      Returns:
      The severity of findings generated from this security standard control.

      The finding severity is based on an assessment of how easy it would be to compromise Amazon Web Services resources if the issue is detected.

      See Also:

    • severityRatingAsString

      public final String severityRatingAsString()

      The severity of findings generated from this security standard control.

      The finding severity is based on an assessment of how easy it would be to compromise Amazon Web Services resources if the issue is detected.

      If the service returns an enum value that is not available in the current SDK version, severityRating will return SeverityRating.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from severityRatingAsString().

      Returns:
      The severity of findings generated from this security standard control.

      The finding severity is based on an assessment of how easy it would be to compromise Amazon Web Services resources if the issue is detected.

      See Also:

    • hasRelatedRequirements

      public final boolean hasRelatedRequirements()
      For responses, this returns true if the service returned a value for the RelatedRequirements 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.

    • relatedRequirements

      public final List<String> relatedRequirements()

      The list of requirements that are related to this control.

      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 hasRelatedRequirements() method.

      Returns:
      The list of requirements that are related to this control.

    • toBuilder

      public StandardsControl.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<StandardsControl.Builder,StandardsControl>
      Returns:
      a builder for type T

    • builder

      public static StandardsControl.Builder builder()

    • serializableBuilderClass

      public static Class<? extends StandardsControl.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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.