Class ParameterConfiguration

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

An object that provides the current value of a security control parameter and identifies whether it has been customized.

See Also:

  • Method Details

    • valueType

      public final ParameterValueType valueType()

      Identifies whether a control parameter uses a custom user-defined value or subscribes to the default Security Hub behavior.

      When ValueType is set equal to DEFAULT, the default behavior can be a specific Security Hub default value, or the default behavior can be to ignore a specific parameter. When ValueType is set equal to DEFAULT, Security Hub ignores user-provided input for the Value field.

      When ValueType is set equal to CUSTOM, the Value field can't be empty.

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

      Returns:
      Identifies whether a control parameter uses a custom user-defined value or subscribes to the default Security Hub behavior.

      When ValueType is set equal to DEFAULT, the default behavior can be a specific Security Hub default value, or the default behavior can be to ignore a specific parameter. When ValueType is set equal to DEFAULT, Security Hub ignores user-provided input for the Value field.

      When ValueType is set equal to CUSTOM, the Value field can't be empty.

      See Also:

    • valueTypeAsString

      public final String valueTypeAsString()

      Identifies whether a control parameter uses a custom user-defined value or subscribes to the default Security Hub behavior.

      When ValueType is set equal to DEFAULT, the default behavior can be a specific Security Hub default value, or the default behavior can be to ignore a specific parameter. When ValueType is set equal to DEFAULT, Security Hub ignores user-provided input for the Value field.

      When ValueType is set equal to CUSTOM, the Value field can't be empty.

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

      Returns:
      Identifies whether a control parameter uses a custom user-defined value or subscribes to the default Security Hub behavior.

      When ValueType is set equal to DEFAULT, the default behavior can be a specific Security Hub default value, or the default behavior can be to ignore a specific parameter. When ValueType is set equal to DEFAULT, Security Hub ignores user-provided input for the Value field.

      When ValueType is set equal to CUSTOM, the Value field can't be empty.

      See Also:

    • value

      public final ParameterValue value()

      The current value of a control parameter.

      Returns:
      The current value of a control parameter.

    • toBuilder

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

    • builder

      public static ParameterConfiguration.Builder builder()

    • serializableBuilderClass

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