software.amazon.awssdk.services.auditmanager.model

Class Framework

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 that's used to structure and automate 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

Method Summary

Modifier and Type	Method and Description
String	arn() The Amazon Resource Name (ARN) of the framework.
static Framework.Builder	builder()
String	complianceType() The compliance type that the framework supports, such as CIS or HIPAA.
List<ControlSet>	controlSets() The control sets that are associated with the framework.
String	controlSources() The control data sources where Audit Manager collects evidence from.
Instant	createdAt() The time when the framework was created.
String	createdBy() The user or role that created the framework.
String	description() The description of the framework.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasControlSets() For responses, this returns true if the service returned a value for the ControlSets property.
int	hashCode()
boolean	hasTags() For responses, this returns true if the service returned a value for the Tags property.
String	id() The unique identifier for the framework.
Instant	lastUpdatedAt() The time when the framework was most recently updated.
String	lastUpdatedBy() The user or role that most recently updated the framework.
String	logo() The logo that's associated with the framework.
String	name() The name of the framework.
List<SdkField<?>>	sdkFields()
static Class<? extends Framework.Builder>	serializableBuilderClass()
Map<String,String>	tags() The tags that are associated with the framework.
Framework.Builder	toBuilder()
String	toString() Returns a string representation of this object.
FrameworkType	type() Specifies whether the framework is a standard framework or a custom framework.
String	typeAsString() Specifies whether the framework is a standard framework or a custom framework.

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 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:

FrameworkType

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:

FrameworkType

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()

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