Class Annotation

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

The Annotation data type.

A GetHookResult call returns detailed information and remediation guidance from Control Tower, Guard, Lambda, or custom Hooks for a Hook invocation result.

See Also:

  • Method Details

    • annotationName

      public final String annotationName()

      An identifier for the evaluation logic that was used when invoking the Hook. For Control Tower, this is the control ID. For Guard, this is the rule ID. For Lambda and custom Hooks, this is a user-defined identifier.

      Returns:
      An identifier for the evaluation logic that was used when invoking the Hook. For Control Tower, this is the control ID. For Guard, this is the rule ID. For Lambda and custom Hooks, this is a user-defined identifier.

    • status

      public final AnnotationStatus status()

      The status of the Hook invocation from the downstream service.

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

      Returns:
      The status of the Hook invocation from the downstream service.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the Hook invocation from the downstream service.

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

      Returns:
      The status of the Hook invocation from the downstream service.
      See Also:

    • statusMessage

      public final String statusMessage()

      The explanation for the specific status assigned to this Hook invocation. For example, "Bucket does not block public access".

      Returns:
      The explanation for the specific status assigned to this Hook invocation. For example, "Bucket does not block public access".

    • remediationMessage

      public final String remediationMessage()

      Suggests what to change if your Hook returns a FAILED status. For example, "Block public access to the bucket".

      Returns:
      Suggests what to change if your Hook returns a FAILED status. For example, "Block public access to the bucket".

    • remediationLink

      public final String remediationLink()

      A URL that you can access for additional remediation guidance.

      Returns:
      A URL that you can access for additional remediation guidance.

    • severityLevel

      public final AnnotationSeverityLevel severityLevel()

      The relative risk associated with any violations of this type.

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

      Returns:
      The relative risk associated with any violations of this type.
      See Also:

    • severityLevelAsString

      public final String severityLevelAsString()

      The relative risk associated with any violations of this type.

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

      Returns:
      The relative risk associated with any violations of this type.
      See Also:

    • toBuilder

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

    • builder

      public static Annotation.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.