Class: Aws::Backup::Types::DescribeFrameworkOutput
- Inherits:
-
Struct
- Object
- Struct
- Aws::Backup::Types::DescribeFrameworkOutput
- Defined in:
- gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb
Overview
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#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_controls ⇒ Array<Types::FrameworkControl>
A list of the controls that make up the framework.
-
#framework_description ⇒ String
An optional description of the framework.
-
#framework_name ⇒ String
The unique name of a framework.
-
#framework_status ⇒ String
A framework consists of one or more controls.
-
#idempotency_token ⇒ String
A customer-chosen string that you can use to distinguish between otherwise identical calls to
DescribeFrameworkOutput
.
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.
2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 2476 class DescribeFrameworkOutput < Struct.new( :framework_name, :framework_arn, :framework_description, :framework_controls, :creation_time, :deployment_status, :framework_status, :idempotency_token) 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
2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 2476 class DescribeFrameworkOutput < Struct.new( :framework_name, :framework_arn, :framework_description, :framework_controls, :creation_time, :deployment_status, :framework_status, :idempotency_token) 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.
2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 2476 class DescribeFrameworkOutput < Struct.new( :framework_name, :framework_arn, :framework_description, :framework_controls, :creation_time, :deployment_status, :framework_status, :idempotency_token) SENSITIVE = [] include Aws::Structure end |
#framework_controls ⇒ Array<Types::FrameworkControl>
A list of the controls that make up the framework. Each control in the list has a name, input parameters, and scope.
2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 2476 class DescribeFrameworkOutput < Struct.new( :framework_name, :framework_arn, :framework_description, :framework_controls, :creation_time, :deployment_status, :framework_status, :idempotency_token) SENSITIVE = [] include Aws::Structure end |
#framework_description ⇒ String
An optional description of the framework.
2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 2476 class DescribeFrameworkOutput < Struct.new( :framework_name, :framework_arn, :framework_description, :framework_controls, :creation_time, :deployment_status, :framework_status, :idempotency_token) SENSITIVE = [] include Aws::Structure end |
#framework_name ⇒ String
The unique name of a framework.
2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 2476 class DescribeFrameworkOutput < Struct.new( :framework_name, :framework_arn, :framework_description, :framework_controls, :creation_time, :deployment_status, :framework_status, :idempotency_token) SENSITIVE = [] include Aws::Structure end |
#framework_status ⇒ String
A framework consists of one or more controls. Each control governs a resource, such as backup plans, backup selections, backup vaults, or recovery points. You can also turn Config recording on or off for each resource. The statuses are:
ACTIVE
when recording is turned on for all resources governed by the framework.PARTIALLY_ACTIVE
when recording is turned off for at least one resource governed by the framework.INACTIVE
when recording is turned off for all resources governed by the framework.UNAVAILABLE
when Backup is unable to validate recording status at this time.
2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 2476 class DescribeFrameworkOutput < Struct.new( :framework_name, :framework_arn, :framework_description, :framework_controls, :creation_time, :deployment_status, :framework_status, :idempotency_token) SENSITIVE = [] include Aws::Structure end |
#idempotency_token ⇒ String
A customer-chosen string that you can use to distinguish between
otherwise identical calls to DescribeFrameworkOutput
. Retrying a
successful request with the same idempotency token results in a
success message with no action taken.
2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 2476 class DescribeFrameworkOutput < Struct.new( :framework_name, :framework_arn, :framework_description, :framework_controls, :creation_time, :deployment_status, :framework_status, :idempotency_token) SENSITIVE = [] include Aws::Structure end |