Class StandardsControlAssociationSummary

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

An array that provides the enablement status and other details for each control that applies to each enabled standard.

See Also:

  • Method Details

    • standardsArn

      public final String standardsArn()

      The Amazon Resource Name (ARN) of a standard.

      Returns:
      The Amazon Resource Name (ARN) of a standard.

    • securityControlId

      public final String securityControlId()

      A unique standard-agnostic identifier for a control. Values for this field typically consist of an Amazon Web Services service and a number, such as APIGateway.5. This field doesn't reference a specific standard.

      Returns:
      A unique standard-agnostic identifier for a control. Values for this field typically consist of an Amazon Web Services service and a number, such as APIGateway.5. This field doesn't reference a specific standard.

    • securityControlArn

      public final String securityControlArn()

      The ARN of a control, such as arn:aws:securityhub:eu-central-1:123456789012:security-control/S3.1. This parameter doesn't mention a specific standard.

      Returns:
      The ARN of a control, such as arn:aws:securityhub:eu-central-1:123456789012:security-control/S3.1. This parameter doesn't mention a specific standard.

    • associationStatus

      public final AssociationStatus associationStatus()

      The enablement status of a control in a specific standard.

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

      Returns:
      The enablement status of a control in a specific standard.
      See Also:

    • associationStatusAsString

      public final String associationStatusAsString()

      The enablement status of a control in a specific standard.

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

      Returns:
      The enablement status of a control in a specific standard.
      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 requirement that underlies this control in the compliance framework related to the standard.

      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 requirement that underlies this control in the compliance framework related to the standard.

    • updatedAt

      public final Instant updatedAt()

      The last time that a control's enablement status in a specified standard was updated.

      Returns:
      The last time that a control's enablement status in a specified standard was updated.

    • updatedReason

      public final String updatedReason()

      The reason for updating a control's enablement status in a specified standard.

      Returns:
      The reason for updating a control's enablement status in a specified standard.

    • standardsControlTitle

      public final String standardsControlTitle()

      The title of a control.

      Returns:
      The title of a control.

    • standardsControlDescription

      public final String standardsControlDescription()

      The description of a control. This typically summarizes how Security Hub evaluates the control and the conditions under which it produces a failed finding. The parameter may reference a specific standard.

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

    • toBuilder

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

    • builder

      public static StandardsControlAssociationSummary.Builder builder()

    • serializableBuilderClass

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