Class: Aws::Backup::Types::DescribeFrameworkOutput

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb

Overview

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)


2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 2326

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_statusString

The deployment status of a framework. The statuses are:

CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED | FAILED

Returns:

  • (String)


2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 2326

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_arnString

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

Returns:

  • (String)


2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 2326

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_controlsArray<Types::FrameworkControl>

A list of the controls that make up the framework. Each control in the list has a name, input parameters, and scope.

Returns:



2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 2326

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_descriptionString

An optional description of the framework.

Returns:

  • (String)


2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 2326

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_nameString

The unique name of a framework.

Returns:

  • (String)


2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 2326

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_statusString

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.

Returns:

  • (String)


2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 2326

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_tokenString

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.

Returns:

  • (String)


2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 2326

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