Class Framework
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<Framework.Builder,
Framework>
The file that's used to structure and automate Audit Manager assessments for a given compliance standard.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
arn()
The Amazon Resource Name (ARN) of the framework.static Framework.Builder
builder()
final String
The compliance type that the framework supports, such as CIS or HIPAA.final List
<ControlSet> The control sets that are associated with the framework.final String
The control data sources where Audit Manager collects evidence from.final Instant
The time when the framework was created.final String
The user or role that created the framework.final String
The description of the framework.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the ControlSets property.final int
hashCode()
final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final String
id()
The unique identifier for the framework.final Instant
The time when the framework was most recently updated.final String
The user or role that most recently updated the framework.final String
logo()
The logo that's associated with the framework.final String
name()
The name of the framework.static Class
<? extends Framework.Builder> tags()
The tags that are associated with the framework.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final FrameworkType
type()
Specifies whether the framework is a standard framework or a custom framework.final String
Specifies whether the framework is a standard framework or a custom framework.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
arn
The Amazon Resource Name (ARN) of the framework.
- Returns:
- The Amazon Resource Name (ARN) of the framework.
-
id
The unique identifier for the framework.
- Returns:
- The unique identifier for the framework.
-
name
The name of the framework.
- Returns:
- The name of the framework.
-
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 returnFrameworkType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- Specifies whether the framework is a standard framework or a custom framework.
- See Also:
-
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 returnFrameworkType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- Specifies whether the framework is a standard framework or a custom framework.
- See Also:
-
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
The description of the framework.
- Returns:
- The description of the framework.
-
logo
The logo that's associated with the framework.
- Returns:
- The logo that's associated with the framework.
-
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 theisEmpty()
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
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
The time when the framework was created.
- Returns:
- The time when the framework was created.
-
lastUpdatedAt
The time when the framework was most recently updated.
- Returns:
- The time when the framework was most recently updated.
-
createdBy
The user or role that created the framework.
- Returns:
- The user or role that created the framework.
-
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 theisEmpty()
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
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
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 interfaceToCopyableBuilder<Framework.Builder,
Framework> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-