Class Framework

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

The file that's used to structure and automate Audit Manager assessments for a given compliance standard.

See Also:

  • Method Details

    • arn

      public final String arn()

      The Amazon Resource Name (ARN) of the framework.

      Returns:
      The Amazon Resource Name (ARN) of the framework.

    • id

      public final String id()

      The unique identifier for the framework.

      Returns:
      The unique identifier for the framework.

    • name

      public final String name()

      The name of the framework.

      Returns:
      The name of the framework.

    • type

      public final FrameworkType type()

      Specifies whether the framework is a standard framework or a custom framework.

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

      Returns:
      Specifies whether the framework is a standard framework or a custom framework.
      See Also:

    • typeAsString

      public final String typeAsString()

      Specifies whether the framework is a standard framework or a custom framework.

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

      Returns:
      Specifies whether the framework is a standard framework or a custom framework.
      See Also:

    • complianceType

      public final String complianceType()

      The compliance type that the framework supports, such as CIS or HIPAA.

      Returns:
      The compliance type that the framework supports, such as CIS or HIPAA.

    • description

      public final String description()

      The description of the framework.

      Returns:
      The description of the framework.

    • logo

      public final String logo()

      The logo that's associated with the framework.

      Returns:
      The logo that's associated with the framework.

    • controlSources

      public final String controlSources()

      The control data sources where Audit Manager collects evidence from.

      Returns:
      The control data sources where Audit Manager collects evidence from.

    • hasControlSets

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

    • controlSets

      public final List<ControlSet> controlSets()

      The control sets that are associated with the framework.

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

      Returns:
      The control sets that are associated with the framework.

    • createdAt

      public final Instant createdAt()

      The time when the framework was created.

      Returns:
      The time when the framework was created.

    • lastUpdatedAt

      public final Instant lastUpdatedAt()

      The time when the framework was most recently updated.

      Returns:
      The time when the framework was most recently updated.

    • createdBy

      public final String createdBy()

      The user or role that created the framework.

      Returns:
      The user or role that created the framework.

    • lastUpdatedBy

      public final String lastUpdatedBy()

      The user or role that most recently updated the framework.

      Returns:
      The user or role that most recently updated the framework.

    • hasTags

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

    • tags

      public final Map<String,String> tags()

      The tags that are associated with the framework.

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

      Returns:
      The tags that are associated with the framework.

    • toBuilder

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

    • builder

      public static Framework.Builder builder()

    • serializableBuilderClass

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