Framework (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.auditmanager.model.Framework

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Framework
extends Object
implements Serializable, Cloneable, StructuredPojo
```
The file that's used to structure and automate Audit Manager assessments for a given compliance standard.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Framework()

Constructors
Constructor and Description
`Framework()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Framework`	`addTagsEntry(String key, String value)` Add a single Tags entry
`Framework`	`clearTagsEntries()` Removes all the entries added into Tags.
`Framework`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getArn()` The Amazon Resource Name (ARN) of the framework.
`String`	`getComplianceType()` The compliance type that the new custom framework supports, such as CIS or HIPAA.
`List<ControlSet>`	`getControlSets()` The control sets that are associated with the framework.
`String`	`getControlSources()` The sources that Audit Manager collects evidence from for the control.
`Date`	`getCreatedAt()` Specifies when the framework was created.
`String`	`getCreatedBy()` The IAM user or role that created the framework.
`String`	`getDescription()` The description of the framework.
`String`	`getId()` The unique identifier for the framework.
`Date`	`getLastUpdatedAt()` Specifies when the framework was most recently updated.
`String`	`getLastUpdatedBy()` The IAM user or role that most recently updated the framework.
`String`	`getLogo()` The logo that's associated with the framework.
`String`	`getName()` The name of the framework.
`Map<String,String>`	`getTags()` The tags that are associated with the framework.
`String`	`getType()` The framework type, such as a custom framework or a standard framework.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setArn(String arn)` The Amazon Resource Name (ARN) of the framework.
`void`	`setComplianceType(String complianceType)` The compliance type that the new custom framework supports, such as CIS or HIPAA.
`void`	`setControlSets(Collection<ControlSet> controlSets)` The control sets that are associated with the framework.
`void`	`setControlSources(String controlSources)` The sources that Audit Manager collects evidence from for the control.
`void`	`setCreatedAt(Date createdAt)` Specifies when the framework was created.
`void`	`setCreatedBy(String createdBy)` The IAM user or role that created the framework.
`void`	`setDescription(String description)` The description of the framework.
`void`	`setId(String id)` The unique identifier for the framework.
`void`	`setLastUpdatedAt(Date lastUpdatedAt)` Specifies when the framework was most recently updated.
`void`	`setLastUpdatedBy(String lastUpdatedBy)` The IAM user or role that most recently updated the framework.
`void`	`setLogo(String logo)` The logo that's associated with the framework.
`void`	`setName(String name)` The name of the framework.
`void`	`setTags(Map<String,String> tags)` The tags that are associated with the framework.
`void`	`setType(String type)` The framework type, such as a custom framework or a standard framework.
`String`	`toString()` Returns a string representation of this object.
`Framework`	`withArn(String arn)` The Amazon Resource Name (ARN) of the framework.
`Framework`	`withComplianceType(String complianceType)` The compliance type that the new custom framework supports, such as CIS or HIPAA.
`Framework`	`withControlSets(Collection<ControlSet> controlSets)` The control sets that are associated with the framework.
`Framework`	`withControlSets(ControlSet... controlSets)` The control sets that are associated with the framework.
`Framework`	`withControlSources(String controlSources)` The sources that Audit Manager collects evidence from for the control.
`Framework`	`withCreatedAt(Date createdAt)` Specifies when the framework was created.
`Framework`	`withCreatedBy(String createdBy)` The IAM user or role that created the framework.
`Framework`	`withDescription(String description)` The description of the framework.
`Framework`	`withId(String id)` The unique identifier for the framework.
`Framework`	`withLastUpdatedAt(Date lastUpdatedAt)` Specifies when the framework was most recently updated.
`Framework`	`withLastUpdatedBy(String lastUpdatedBy)` The IAM user or role that most recently updated the framework.
`Framework`	`withLogo(String logo)` The logo that's associated with the framework.
`Framework`	`withName(String name)` The name of the framework.
`Framework`	`withTags(Map<String,String> tags)` The tags that are associated with the framework.
`Framework`	`withType(FrameworkType type)` The framework type, such as a custom framework or a standard framework.
`Framework`	`withType(String type)` The framework type, such as a custom framework or a standard framework.

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

- Constructor Detail
  - Framework
```
public Framework()
```
- Method Detail
  - setArn
```
public void setArn(String arn)
```
    The Amazon Resource Name (ARN) of the framework.
    
    Parameters:
    
    arn - The Amazon Resource Name (ARN) of the framework.
  - getArn
```
public String getArn()
```
    The Amazon Resource Name (ARN) of the framework.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the framework.
  - withArn
```
public Framework withArn(String arn)
```
    The Amazon Resource Name (ARN) of the framework.
    
    Parameters:
    
    arn - The Amazon Resource Name (ARN) of the framework.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setId
```
public void setId(String id)
```
    The unique identifier for the framework.
    
    Parameters:
    
    id - The unique identifier for the framework.
  - getId
```
public String getId()
```
    The unique identifier for the framework.
    
    Returns:
    
    The unique identifier for the framework.
  - withId
```
public Framework withId(String id)
```
    The unique identifier for the framework.
    
    Parameters:
    
    id - The unique identifier for the framework.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setName
```
public void setName(String name)
```
    The name of the framework.
    
    Parameters:
    
    name - The name of the framework.
  - getName
```
public String getName()
```
    The name of the framework.
    
    Returns:
    
    The name of the framework.
  - withName
```
public Framework withName(String name)
```
    The name of the framework.
    
    Parameters:
    
    name - The name of the framework.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setType
```
public void setType(String type)
```
    The framework type, such as a custom framework or a standard framework.
    
    Parameters:
    
    type - The framework type, such as a custom framework or a standard framework.
    
    See Also:
    
    FrameworkType
  - getType
```
public String getType()
```
    The framework type, such as a custom framework or a standard framework.
    
    Returns:
    
    The framework type, such as a custom framework or a standard framework.
    
    See Also:
    
    FrameworkType
  - withType
```
public Framework withType(String type)
```
    The framework type, such as a custom framework or a standard framework.
    
    Parameters:
    
    type - The framework type, such as a custom framework or a standard framework.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    FrameworkType
  - withType
```
public Framework withType(FrameworkType type)
```
    The framework type, such as a custom framework or a standard framework.
    
    Parameters:
    
    type - The framework type, such as a custom framework or a standard framework.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    FrameworkType
  - setComplianceType
```
public void setComplianceType(String complianceType)
```
    The compliance type that the new custom framework supports, such as CIS or HIPAA.
    
    Parameters:
    
    complianceType - The compliance type that the new custom framework supports, such as CIS or HIPAA.
  - getComplianceType
```
public String getComplianceType()
```
    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.
  - withComplianceType
```
public Framework withComplianceType(String complianceType)
```
    The compliance type that the new custom framework supports, such as CIS or HIPAA.
    
    Parameters:
    
    complianceType - The compliance type that the new custom framework supports, such as CIS or HIPAA.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDescription
```
public void setDescription(String description)
```
    The description of the framework.
    
    Parameters:
    
    description - The description of the framework.
  - getDescription
```
public String getDescription()
```
    The description of the framework.
    
    Returns:
    
    The description of the framework.
  - withDescription
```
public Framework withDescription(String description)
```
    The description of the framework.
    
    Parameters:
    
    description - The description of the framework.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLogo
```
public void setLogo(String logo)
```
    The logo that's associated with the framework.
    
    Parameters:
    
    logo - The logo that's associated with the framework.
  - getLogo
```
public String getLogo()
```
    The logo that's associated with the framework.
    
    Returns:
    
    The logo that's associated with the framework.
  - withLogo
```
public Framework withLogo(String logo)
```
    The logo that's associated with the framework.
    
    Parameters:
    
    logo - The logo that's associated with the framework.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setControlSources
```
public void setControlSources(String controlSources)
```
    The sources that Audit Manager collects evidence from for the control.
    
    Parameters:
    
    controlSources - The sources that Audit Manager collects evidence from for the control.
  - getControlSources
```
public String getControlSources()
```
    The sources that Audit Manager collects evidence from for the control.
    
    Returns:
    
    The sources that Audit Manager collects evidence from for the control.
  - withControlSources
```
public Framework withControlSources(String controlSources)
```
    The sources that Audit Manager collects evidence from for the control.
    
    Parameters:
    
    controlSources - The sources that Audit Manager collects evidence from for the control.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getControlSets
```
public List<ControlSet> getControlSets()
```
    The control sets that are associated with the framework.
    
    Returns:
    
    The control sets that are associated with the framework.
  - setControlSets
```
public void setControlSets(Collection<ControlSet> controlSets)
```
    The control sets that are associated with the framework.
    
    Parameters:
    
    controlSets - The control sets that are associated with the framework.
  - withControlSets
```
public Framework withControlSets(ControlSet... controlSets)
```
    The control sets that are associated with the framework.
    
    NOTE: This method appends the values to the existing list (if any). Use setControlSets(java.util.Collection) or withControlSets(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    controlSets - The control sets that are associated with the framework.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withControlSets
```
public Framework withControlSets(Collection<ControlSet> controlSets)
```
    The control sets that are associated with the framework.
    
    Parameters:
    
    controlSets - The control sets that are associated with the framework.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreatedAt
```
public void setCreatedAt(Date createdAt)
```
    Specifies when the framework was created.
    
    Parameters:
    
    createdAt - Specifies when the framework was created.
  - getCreatedAt
```
public Date getCreatedAt()
```
    Specifies when the framework was created.
    
    Returns:
    
    Specifies when the framework was created.
  - withCreatedAt
```
public Framework withCreatedAt(Date createdAt)
```
    Specifies when the framework was created.
    
    Parameters:
    
    createdAt - Specifies when the framework was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLastUpdatedAt
```
public void setLastUpdatedAt(Date lastUpdatedAt)
```
    Specifies when the framework was most recently updated.
    
    Parameters:
    
    lastUpdatedAt - Specifies when the framework was most recently updated.
  - getLastUpdatedAt
```
public Date getLastUpdatedAt()
```
    Specifies when the framework was most recently updated.
    
    Returns:
    
    Specifies when the framework was most recently updated.
  - withLastUpdatedAt
```
public Framework withLastUpdatedAt(Date lastUpdatedAt)
```
    Specifies when the framework was most recently updated.
    
    Parameters:
    
    lastUpdatedAt - Specifies when the framework was most recently updated.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreatedBy
```
public void setCreatedBy(String createdBy)
```
    The IAM user or role that created the framework.
    
    Parameters:
    
    createdBy - The IAM user or role that created the framework.
  - getCreatedBy
```
public String getCreatedBy()
```
    The IAM user or role that created the framework.
    
    Returns:
    
    The IAM user or role that created the framework.
  - withCreatedBy
```
public Framework withCreatedBy(String createdBy)
```
    The IAM user or role that created the framework.
    
    Parameters:
    
    createdBy - The IAM user or role that created the framework.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLastUpdatedBy
```
public void setLastUpdatedBy(String lastUpdatedBy)
```
    The IAM user or role that most recently updated the framework.
    
    Parameters:
    
    lastUpdatedBy - The IAM user or role that most recently updated the framework.
  - getLastUpdatedBy
```
public String getLastUpdatedBy()
```
    The IAM user or role that most recently updated the framework.
    
    Returns:
    
    The IAM user or role that most recently updated the framework.
  - withLastUpdatedBy
```
public Framework withLastUpdatedBy(String lastUpdatedBy)
```
    The IAM user or role that most recently updated the framework.
    
    Parameters:
    
    lastUpdatedBy - The IAM user or role that most recently updated the framework.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getTags
```
public Map<String,String> getTags()
```
    The tags that are associated with the framework.
    
    Returns:
    
    The tags that are associated with the framework.
  - setTags
```
public void setTags(Map<String,String> tags)
```
    The tags that are associated with the framework.
    
    Parameters:
    
    tags - The tags that are associated with the framework.
  - withTags
```
public Framework withTags(Map<String,String> tags)
```
    The tags that are associated with the framework.
    
    Parameters:
    
    tags - The tags that are associated with the framework.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addTagsEntry
```
public Framework addTagsEntry(String key,
                              String value)
```
    Add a single Tags entry
    
    See Also:
    
    withTags(java.util.Map<java.lang.String, java.lang.String>)
  - clearTagsEntries
```
public Framework clearTagsEntries()
```
    Removes all the entries added into Tags.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public Framework clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class Framework

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Framework

Method Detail

setArn

getArn

withArn

setId

getId

withId

setName

getName

withName

setType

getType

withType

withType

setComplianceType

getComplianceType

withComplianceType

setDescription

getDescription

withDescription

setLogo

getLogo

withLogo

setControlSources

getControlSources

withControlSources

getControlSets

setControlSets

withControlSets

withControlSets

setCreatedAt

getCreatedAt

withCreatedAt

setLastUpdatedAt

getLastUpdatedAt

withLastUpdatedAt

setCreatedBy

getCreatedBy

withCreatedBy

setLastUpdatedBy

getLastUpdatedBy

withLastUpdatedBy

getTags

setTags

withTags

addTagsEntry

clearTagsEntries

toString

equals

hashCode

clone

marshall