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

Class SecurityHubPolicy

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

An object that defines how Security Hub is configured. The configuration policy 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

    • serviceEnabled

      public final Boolean serviceEnabled()

      Indicates whether Security Hub is enabled in the policy.

      Returns:
      Indicates whether Security Hub is enabled in the policy.

    • hasEnabledStandardIdentifiers

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

    • enabledStandardIdentifiers

      public final List<String> enabledStandardIdentifiers()

      A list that defines which security standards are enabled in the configuration policy.

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

      Returns:
      A list that defines which security standards are enabled in the configuration policy.

    • securityControlsConfiguration

      public final SecurityControlsConfiguration securityControlsConfiguration()

      An object that defines which security controls are enabled in the configuration policy. The enablement status of a control is aligned across all of the enabled standards in an account.

      Returns:
      An object that defines which security controls are enabled in the configuration policy. The enablement status of a control is aligned across all of the enabled standards in an account.

    • toBuilder

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

    • builder

      public static SecurityHubPolicy.Builder builder()

    • serializableBuilderClass

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