Framework (AWS Java SDK :: Services :: Audit Manager 2.16.60 API)

java.lang.Object
- software.amazon.awssdk.services.auditmanager.model.Framework

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Framework.Builder,Framework>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class Framework
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Framework.Builder,Framework>
```
The file used to structure and automate AWS Audit Manager assessments for a given compliance standard.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface Framework.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`Framework.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`arn()` The Amazon Resource Name (ARN) of the specified framework.
`static Framework.Builder`	`builder()`
`String`	`complianceType()` The compliance type that the new custom framework supports, such as CIS or HIPAA.
`List<ControlSet>`	`controlSets()` The control sets associated with the framework.
`String`	`controlSources()` The sources from which AWS Audit Manager collects evidence for the control.
`Instant`	`createdAt()` Specifies when the framework was created.
`String`	`createdBy()` The IAM user or role that created the framework.
`String`	`description()` The description of the specified framework.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasControlSets()` Returns true if the ControlSets property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`int`	`hashCode()`
`boolean`	`hasTags()` Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`String`	`id()` The unique identifier for the specified framework.
`Instant`	`lastUpdatedAt()` Specifies when the framework was most recently updated.
`String`	`lastUpdatedBy()` The IAM user or role that most recently updated the framework.
`String`	`logo()` The logo associated with the framework.
`String`	`name()` The name of the specified framework.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends Framework.Builder>`	`serializableBuilderClass()`
`Map<String,String>`	`tags()` The tags associated with the framework.
`Framework.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`FrameworkType`	`type()` The framework type, such as custom or standard.
`String`	`typeAsString()` The framework type, such as custom or standard.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - arn
```
public final String arn()
```
    The Amazon Resource Name (ARN) of the specified framework.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the specified framework.
  - id
```
public final String id()
```
    The unique identifier for the specified framework.
    
    Returns:
    
    The unique identifier for the specified framework.
  - name
```
public final String name()
```
    The name of the specified framework.
    
    Returns:
    
    The name of the specified framework.
  - type
```
public final FrameworkType type()
```
    The framework type, such as custom or standard.
    
    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:
    
    The framework type, such as custom or standard.
    
    See Also:
    
    FrameworkType
  - typeAsString
```
public final String typeAsString()
```
    The framework type, such as custom or standard.
    
    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:
    
    The framework type, such as custom or standard.
    
    See Also:
    
    FrameworkType
  - complianceType
```
public final String complianceType()
```
    The compliance type that the new custom framework supports, such as CIS or HIPAA.
    
    Returns:
    
    The compliance type that the new custom framework supports, such as CIS or HIPAA.
  - description
```
public final String description()
```
    The description of the specified framework.
    
    Returns:
    
    The description of the specified framework.
  - logo
```
public final String logo()
```
    The logo associated with the framework.
    
    Returns:
    
    The logo associated with the framework.
  - controlSources
```
public final String controlSources()
```
    The sources from which AWS Audit Manager collects evidence for the control.
    
    Returns:
    
    The sources from which AWS Audit Manager collects evidence for the control.
  - hasControlSets
```
public final boolean hasControlSets()
```
    Returns true if the ControlSets property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - controlSets
```
public final List<ControlSet> controlSets()
```
    The control sets associated with the framework.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasControlSets() to see if a value was sent in this field.
    
    Returns:
    
    The control sets associated with the framework.
  - createdAt
```
public final Instant createdAt()
```
    Specifies when the framework was created.
    
    Returns:
    
    Specifies when the framework was created.
  - lastUpdatedAt
```
public final Instant lastUpdatedAt()
```
    Specifies when the framework was most recently updated.
    
    Returns:
    
    Specifies when the framework was most recently updated.
  - createdBy
```
public final String createdBy()
```
    The IAM user or role that created the framework.
    
    Returns:
    
    The IAM user or role that created the framework.
  - lastUpdatedBy
```
public final String lastUpdatedBy()
```
    The IAM user or role that most recently updated the framework.
    
    Returns:
    
    The IAM user or role that most recently updated the framework.
  - hasTags
```
public final boolean hasTags()
```
    Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - tags
```
public final Map<String,String> tags()
```
    The tags associated with the framework.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasTags() to see if a value was sent in this field.
    
    Returns:
    
    The tags associated with the framework.
  - toBuilder
```
public Framework.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<Framework.Builder,Framework>
  - 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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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

Class Framework

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

arn

id

name

type

typeAsString

complianceType

description

logo

controlSources

hasControlSets

controlSets

createdAt

lastUpdatedAt

createdBy

lastUpdatedBy

hasTags

tags

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields