Class: Aws::AuditManager::Types::Framework

Inherits:

Struct

• Object
• Struct
• Aws::AuditManager::Types::Framework

Defined in:

gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/types.rb

Overview

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

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:compliance_type, :control_sets, :created_by, :last_updated_by]

Instance Attribute Summary

• #arn ⇒ String

  The Amazon Resource Name (ARN) of the framework.

• #compliance_type ⇒ String

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

• #control_sets ⇒ Array<Types::ControlSet>

  The control sets that are associated with the framework.

• #control_sources ⇒ String

  The control data sources where Audit Manager collects evidence from.

• #created_at ⇒ Time

  The time when the framework was created.

• #created_by ⇒ String

  The user or role that created the framework.

• #description ⇒ String

  The description of the framework.

• #id ⇒ String

  The unique identifier for the framework.

• #last_updated_at ⇒ Time

  The time when the framework was most recently updated.

• #last_updated_by ⇒ String

  The user or role that most recently updated the framework.

• #logo ⇒ String

  The logo that's associated with the framework.

• #name ⇒ String

  The name of the framework.

• #tags ⇒ Hash<String,String>

  The tags that are associated with the framework.

• #type ⇒ String

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

Instance Attribute Details

#arn ⇒ String

The Amazon Resource Name (ARN) of the framework.

Returns:

• (String)

# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/types.rb', line 2541

class Framework < Struct.new(
  :arn,
  :id,
  :name,
  :type,
  :compliance_type,
  :description,
  :logo,
  :control_sources,
  :control_sets,
  :created_at,
  :last_updated_at,
  :created_by,
  :last_updated_by,
  :tags)
  SENSITIVE = [:compliance_type, :control_sets, :created_by, :last_updated_by]
  include Aws::Structure
end

#compliance_type ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/types.rb', line 2541

class Framework < Struct.new(
  :arn,
  :id,
  :name,
  :type,
  :compliance_type,
  :description,
  :logo,
  :control_sources,
  :control_sets,
  :created_at,
  :last_updated_at,
  :created_by,
  :last_updated_by,
  :tags)
  SENSITIVE = [:compliance_type, :control_sets, :created_by, :last_updated_by]
  include Aws::Structure
end

#control_sets ⇒ Array<Types::ControlSet>

The control sets that are associated with the framework.

The Controls object returns a partial response when called through Framework APIs. For a complete Controls object, use GetControl.

Returns:

• (Array<Types::ControlSet>)

# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/types.rb', line 2541

class Framework < Struct.new(
  :arn,
  :id,
  :name,
  :type,
  :compliance_type,
  :description,
  :logo,
  :control_sources,
  :control_sets,
  :created_at,
  :last_updated_at,
  :created_by,
  :last_updated_by,
  :tags)
  SENSITIVE = [:compliance_type, :control_sets, :created_by, :last_updated_by]
  include Aws::Structure
end

#control_sources ⇒ String

The control data sources where Audit Manager collects evidence from.

This API parameter is no longer supported.

Returns:

• (String)

# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/types.rb', line 2541

class Framework < Struct.new(
  :arn,
  :id,
  :name,
  :type,
  :compliance_type,
  :description,
  :logo,
  :control_sources,
  :control_sets,
  :created_at,
  :last_updated_at,
  :created_by,
  :last_updated_by,
  :tags)
  SENSITIVE = [:compliance_type, :control_sets, :created_by, :last_updated_by]
  include Aws::Structure
end

#created_at ⇒ Time

The time when the framework was created.

Returns:

• (Time)

# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/types.rb', line 2541

class Framework < Struct.new(
  :arn,
  :id,
  :name,
  :type,
  :compliance_type,
  :description,
  :logo,
  :control_sources,
  :control_sets,
  :created_at,
  :last_updated_at,
  :created_by,
  :last_updated_by,
  :tags)
  SENSITIVE = [:compliance_type, :control_sets, :created_by, :last_updated_by]
  include Aws::Structure
end

#created_by ⇒ String

The user or role that created the framework.

Returns:

• (String)

# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/types.rb', line 2541

class Framework < Struct.new(
  :arn,
  :id,
  :name,
  :type,
  :compliance_type,
  :description,
  :logo,
  :control_sources,
  :control_sets,
  :created_at,
  :last_updated_at,
  :created_by,
  :last_updated_by,
  :tags)
  SENSITIVE = [:compliance_type, :control_sets, :created_by, :last_updated_by]
  include Aws::Structure
end

#description ⇒ String

The description of the framework.

Returns:

• (String)

# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/types.rb', line 2541

class Framework < Struct.new(
  :arn,
  :id,
  :name,
  :type,
  :compliance_type,
  :description,
  :logo,
  :control_sources,
  :control_sets,
  :created_at,
  :last_updated_at,
  :created_by,
  :last_updated_by,
  :tags)
  SENSITIVE = [:compliance_type, :control_sets, :created_by, :last_updated_by]
  include Aws::Structure
end

#id ⇒ String

The unique identifier for the framework.

Returns:

• (String)

# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/types.rb', line 2541

class Framework < Struct.new(
  :arn,
  :id,
  :name,
  :type,
  :compliance_type,
  :description,
  :logo,
  :control_sources,
  :control_sets,
  :created_at,
  :last_updated_at,
  :created_by,
  :last_updated_by,
  :tags)
  SENSITIVE = [:compliance_type, :control_sets, :created_by, :last_updated_by]
  include Aws::Structure
end

#last_updated_at ⇒ Time

The time when the framework was most recently updated.

Returns:

• (Time)

# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/types.rb', line 2541

class Framework < Struct.new(
  :arn,
  :id,
  :name,
  :type,
  :compliance_type,
  :description,
  :logo,
  :control_sources,
  :control_sets,
  :created_at,
  :last_updated_at,
  :created_by,
  :last_updated_by,
  :tags)
  SENSITIVE = [:compliance_type, :control_sets, :created_by, :last_updated_by]
  include Aws::Structure
end

#last_updated_by ⇒ String

The user or role that most recently updated the framework.

Returns:

• (String)

# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/types.rb', line 2541

class Framework < Struct.new(
  :arn,
  :id,
  :name,
  :type,
  :compliance_type,
  :description,
  :logo,
  :control_sources,
  :control_sets,
  :created_at,
  :last_updated_at,
  :created_by,
  :last_updated_by,
  :tags)
  SENSITIVE = [:compliance_type, :control_sets, :created_by, :last_updated_by]
  include Aws::Structure
end

#logo ⇒ String

The logo that's associated with the framework.

Returns:

• (String)

# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/types.rb', line 2541

class Framework < Struct.new(
  :arn,
  :id,
  :name,
  :type,
  :compliance_type,
  :description,
  :logo,
  :control_sources,
  :control_sets,
  :created_at,
  :last_updated_at,
  :created_by,
  :last_updated_by,
  :tags)
  SENSITIVE = [:compliance_type, :control_sets, :created_by, :last_updated_by]
  include Aws::Structure
end

#name ⇒ String

The name of the framework.

Returns:

• (String)

# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/types.rb', line 2541

class Framework < Struct.new(
  :arn,
  :id,
  :name,
  :type,
  :compliance_type,
  :description,
  :logo,
  :control_sources,
  :control_sets,
  :created_at,
  :last_updated_at,
  :created_by,
  :last_updated_by,
  :tags)
  SENSITIVE = [:compliance_type, :control_sets, :created_by, :last_updated_by]
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

The tags that are associated with the framework.

Returns:

• (Hash<String,String>)

# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/types.rb', line 2541

class Framework < Struct.new(
  :arn,
  :id,
  :name,
  :type,
  :compliance_type,
  :description,
  :logo,
  :control_sources,
  :control_sets,
  :created_at,
  :last_updated_at,
  :created_by,
  :last_updated_by,
  :tags)
  SENSITIVE = [:compliance_type, :control_sets, :created_by, :last_updated_by]
  include Aws::Structure
end

#type ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-auditmanager/lib/aws-sdk-auditmanager/types.rb', line 2541

class Framework < Struct.new(
  :arn,
  :id,
  :name,
  :type,
  :compliance_type,
  :description,
  :logo,
  :control_sources,
  :control_sets,
  :created_at,
  :last_updated_at,
  :created_by,
  :last_updated_by,
  :tags)
  SENSITIVE = [:compliance_type, :control_sets, :created_by, :last_updated_by]
  include Aws::Structure
end