Class Policy

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

An object that defines how Security Hub is configured. It includes whether Security Hub is enabled or disabled, a list of enabled security standards, a list of enabled or disabled security controls, and a list of custom parameter values for specified controls. If you provide a list of security controls that are enabled in the configuration policy, Security Hub disables all other controls (including newly released controls). If you provide a list of security controls that are disabled in the configuration policy, Security Hub enables all other controls (including newly released controls).

See Also:

  • Method Details

    • securityHub

      public final SecurityHubPolicy securityHub()

      The Amazon Web Services service that the configuration policy applies to.

      Returns:
      The Amazon Web Services service that the configuration policy applies to.

    • toBuilder

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

    • builder

      public static Policy.Builder builder()

    • serializableBuilderClass

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

    • fromSecurityHub

      public static Policy fromSecurityHub(SecurityHubPolicy securityHub)
      Create an instance of this class with securityHub() initialized to the given value.

      The Amazon Web Services service that the configuration policy applies to.

      Parameters:
      securityHub - The Amazon Web Services service that the configuration policy applies to.

    • fromSecurityHub

      public static Policy fromSecurityHub(Consumer<SecurityHubPolicy.Builder> securityHub)
      Create an instance of this class with securityHub() initialized to the given value.

      The Amazon Web Services service that the configuration policy applies to.

      Parameters:
      securityHub - The Amazon Web Services service that the configuration policy applies to.

    • type

      public Policy.Type type()
      Retrieve an enum value representing which member of this object is populated. When this class is returned in a service response, this will be Policy.Type.UNKNOWN_TO_SDK_VERSION if the service returned a member that is only known to a newer SDK version. When this class is created directly in your code, this will be Policy.Type.UNKNOWN_TO_SDK_VERSION if zero members are set, and null if more than one member is set.

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