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

Inherits:
Struct
  • Object
show all
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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#creation_timeTime

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)


2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 2941

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

#deployment_statusString

The deployment status of a framework. The statuses are:

CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED | FAILED

Returns:

  • (String)


2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 2941

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

#framework_arnString

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

Returns:

  • (String)


2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 2941

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

#framework_descriptionString

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

Returns:

  • (String)


2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 2941

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

#framework_nameString

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)


2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 2941

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

#number_of_controlsInteger

The number of controls contained by the framework.

Returns:

  • (Integer)


2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 2941

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