Class: Aws::Backup::Types::Framework

Inherits:

Struct

• Object
• Struct
• Aws::Backup::Types::Framework

Defined in:

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

Overview

Contains detailed information about a framework. Frameworks contain controls, which evaluate and report on your backup events and resources. Frameworks generate daily compliance results.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #creation_time ⇒ Time

  The date and time that a framework is created, in ISO 8601 representation.

• #deployment_status ⇒ String

  The deployment status of a framework.

• #framework_arn ⇒ String

  An Amazon Resource Name (ARN) that uniquely identifies a resource.

• #framework_description ⇒ String

  An optional description of the framework with a maximum 1,024 characters.

• #framework_name ⇒ String

  The unique name of a framework.

• #number_of_controls ⇒ Integer

  The number of controls contained by the framework.

Instance Attribute Details

#creation_time ⇒ Time

The date and time that a framework is created, in ISO 8601 representation. The value of CreationTime is accurate to milliseconds. For example, 2020-07-10T15:00:00.000-08:00 represents the 10th of July 2020 at 3:00 PM 8 hours behind UTC.

Returns:

• (Time)

# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 3563

class Framework < Struct.new(
  :framework_name,
  :framework_arn,
  :framework_description,
  :number_of_controls,
  :creation_time,
  :deployment_status)
  SENSITIVE = []
  include Aws::Structure
end

#deployment_status ⇒ String

The deployment status of a framework. The statuses are:

CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED | FAILED

Returns:

• (String)

# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 3563

class Framework < Struct.new(
  :framework_name,
  :framework_arn,
  :framework_description,
  :number_of_controls,
  :creation_time,
  :deployment_status)
  SENSITIVE = []
  include Aws::Structure
end

#framework_arn ⇒ String

An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.

Returns:

• (String)

# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 3563

class Framework < Struct.new(
  :framework_name,
  :framework_arn,
  :framework_description,
  :number_of_controls,
  :creation_time,
  :deployment_status)
  SENSITIVE = []
  include Aws::Structure
end

#framework_description ⇒ String

An optional description of the framework with a maximum 1,024 characters.

Returns:

• (String)

# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 3563

class Framework < Struct.new(
  :framework_name,
  :framework_arn,
  :framework_description,
  :number_of_controls,
  :creation_time,
  :deployment_status)
  SENSITIVE = []
  include Aws::Structure
end

#framework_name ⇒ String

The unique name of a framework. This name is between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).

Returns:

• (String)

# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 3563

class Framework < Struct.new(
  :framework_name,
  :framework_arn,
  :framework_description,
  :number_of_controls,
  :creation_time,
  :deployment_status)
  SENSITIVE = []
  include Aws::Structure
end

#number_of_controls ⇒ Integer

The number of controls contained by the framework.

Returns:

• (Integer)

# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 3563

class Framework < Struct.new(
  :framework_name,
  :framework_arn,
  :framework_description,
  :number_of_controls,
  :creation_time,
  :deployment_status)
  SENSITIVE = []
  include Aws::Structure
end