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

Class SecurityControlDefinition

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

Provides metadata for a security control, including its unique standard-agnostic identifier, title, description, severity, availability in Amazon Web Services Regions, and a link to remediation steps.

See Also:

  • Method Details

    • securityControlId

      public final String securityControlId()

      The unique identifier of a security control across standards. Values for this field typically consist of an Amazon Web Service name and a number (for example, APIGateway.3). This parameter differs from SecurityControlArn, which is a unique Amazon Resource Name (ARN) assigned to a control. The ARN references the security control ID (for example, arn:aws:securityhub:eu-central-1:123456789012:security-control/APIGateway.3).

      Returns:
      The unique identifier of a security control across standards. Values for this field typically consist of an Amazon Web Service name and a number (for example, APIGateway.3). This parameter differs from SecurityControlArn, which is a unique Amazon Resource Name (ARN) assigned to a control. The ARN references the security control ID (for example, arn:aws:securityhub:eu-central-1:123456789012:security-control/APIGateway.3).

    • title

      public final String title()

      The title of a security control.

      Returns:
      The title of a security control.

    • description

      public final String description()

      The description of a security control across standards. This typically summarizes how Security Hub evaluates the control and the conditions under which it produces a failed finding. This parameter doesn't reference a specific standard.

      Returns:
      The description of a security control across standards. This typically summarizes how Security Hub evaluates the control and the conditions under which it produces a failed finding. This parameter doesn't reference a specific standard.

    • remediationUrl

      public final String remediationUrl()

      A link to Security Hub documentation that explains how to remediate a failed finding for a security control.

      Returns:
      A link to Security Hub documentation that explains how to remediate a failed finding for a security control.

    • severityRating

      public final SeverityRating severityRating()

      The severity of a security control. For more information about how Security Hub determines control severity, see Assigning severity to control findings in the Security Hub User Guide.

      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 a security control. For more information about how Security Hub determines control severity, see Assigning severity to control findings in the Security Hub User Guide.
      See Also:

    • severityRatingAsString

      public final String severityRatingAsString()

      The severity of a security control. For more information about how Security Hub determines control severity, see Assigning severity to control findings in the Security Hub User Guide.

      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 a security control. For more information about how Security Hub determines control severity, see Assigning severity to control findings in the Security Hub User Guide.
      See Also:

    • currentRegionAvailability

      public final RegionAvailabilityStatus currentRegionAvailability()

      Specifies whether a security control is available in the current Amazon Web Services Region.

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

      Returns:
      Specifies whether a security control is available in the current Amazon Web Services Region.
      See Also:

    • currentRegionAvailabilityAsString

      public final String currentRegionAvailabilityAsString()

      Specifies whether a security control is available in the current Amazon Web Services Region.

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

      Returns:
      Specifies whether a security control is available in the current Amazon Web Services Region.
      See Also:

    • toBuilder

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

    • builder

      public static SecurityControlDefinition.Builder builder()

    • serializableBuilderClass

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