Class: Aws::Backup::Types::ReportPlan

Inherits:

Struct

• Object
• Struct
• Aws::Backup::Types::ReportPlan

Defined in:

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

Overview

Contains detailed information about a report plan.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #creation_time ⇒ Time

  The date and time that a report plan is created, in Unix format and Coordinated Universal Time (UTC).

• #deployment_status ⇒ String

  The deployment status of a report plan.

• #last_attempted_execution_time ⇒ Time

  The date and time that a report job associated with this report plan last attempted to run, in Unix format and Coordinated Universal Time (UTC).

• #last_successful_execution_time ⇒ Time

  The date and time that a report job associated with this report plan last successfully ran, in Unix format and Coordinated Universal Time (UTC).

• #report_delivery_channel ⇒ Types::ReportDeliveryChannel

  Contains information about where and how to deliver your reports, specifically your Amazon S3 bucket name, S3 key prefix, and the formats of your reports.

• #report_plan_arn ⇒ String

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

• #report_plan_description ⇒ String

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

• #report_plan_name ⇒ String

  The unique name of the report plan.

• #report_setting ⇒ Types::ReportSetting

  Identifies the report template for the report.

Instance Attribute Details

#creation_time ⇒ Time

The date and time that a report plan is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

Returns:

• (Time)

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

class ReportPlan < Struct.new(
  :report_plan_arn,
  :report_plan_name,
  :report_plan_description,
  :report_setting,
  :report_delivery_channel,
  :deployment_status,
  :creation_time,
  :last_attempted_execution_time,
  :last_successful_execution_time)
  SENSITIVE = []
  include Aws::Structure
end

#deployment_status ⇒ String

The deployment status of a report plan. The statuses are:

CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED

Returns:

• (String)

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

class ReportPlan < Struct.new(
  :report_plan_arn,
  :report_plan_name,
  :report_plan_description,
  :report_setting,
  :report_delivery_channel,
  :deployment_status,
  :creation_time,
  :last_attempted_execution_time,
  :last_successful_execution_time)
  SENSITIVE = []
  include Aws::Structure
end

#last_attempted_execution_time ⇒ Time

The date and time that a report job associated with this report plan last attempted to run, in Unix format and Coordinated Universal Time (UTC). The value of LastAttemptedExecutionTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

Returns:

• (Time)

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

class ReportPlan < Struct.new(
  :report_plan_arn,
  :report_plan_name,
  :report_plan_description,
  :report_setting,
  :report_delivery_channel,
  :deployment_status,
  :creation_time,
  :last_attempted_execution_time,
  :last_successful_execution_time)
  SENSITIVE = []
  include Aws::Structure
end

#last_successful_execution_time ⇒ Time

The date and time that a report job associated with this report plan last successfully ran, in Unix format and Coordinated Universal Time (UTC). The value of LastSuccessfulExecutionTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

Returns:

• (Time)

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

class ReportPlan < Struct.new(
  :report_plan_arn,
  :report_plan_name,
  :report_plan_description,
  :report_setting,
  :report_delivery_channel,
  :deployment_status,
  :creation_time,
  :last_attempted_execution_time,
  :last_successful_execution_time)
  SENSITIVE = []
  include Aws::Structure
end

#report_delivery_channel ⇒ Types::ReportDeliveryChannel

Contains information about where and how to deliver your reports, specifically your Amazon S3 bucket name, S3 key prefix, and the formats of your reports.

Returns:

• (Types::ReportDeliveryChannel)

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

class ReportPlan < Struct.new(
  :report_plan_arn,
  :report_plan_name,
  :report_plan_description,
  :report_setting,
  :report_delivery_channel,
  :deployment_status,
  :creation_time,
  :last_attempted_execution_time,
  :last_successful_execution_time)
  SENSITIVE = []
  include Aws::Structure
end

#report_plan_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 7368

class ReportPlan < Struct.new(
  :report_plan_arn,
  :report_plan_name,
  :report_plan_description,
  :report_setting,
  :report_delivery_channel,
  :deployment_status,
  :creation_time,
  :last_attempted_execution_time,
  :last_successful_execution_time)
  SENSITIVE = []
  include Aws::Structure
end

#report_plan_description ⇒ String

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

Returns:

• (String)

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

class ReportPlan < Struct.new(
  :report_plan_arn,
  :report_plan_name,
  :report_plan_description,
  :report_setting,
  :report_delivery_channel,
  :deployment_status,
  :creation_time,
  :last_attempted_execution_time,
  :last_successful_execution_time)
  SENSITIVE = []
  include Aws::Structure
end

#report_plan_name ⇒ String

The unique name of the report plan. 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 7368

class ReportPlan < Struct.new(
  :report_plan_arn,
  :report_plan_name,
  :report_plan_description,
  :report_setting,
  :report_delivery_channel,
  :deployment_status,
  :creation_time,
  :last_attempted_execution_time,
  :last_successful_execution_time)
  SENSITIVE = []
  include Aws::Structure
end

#report_setting ⇒ Types::ReportSetting

Identifies the report template for the report. Reports are built using a report template. The report templates are:

RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT

If the report template is RESOURCE_COMPLIANCE_REPORT or CONTROL_COMPLIANCE_REPORT, this API resource also describes the report coverage by Amazon Web Services Regions and frameworks.

Returns:

• (Types::ReportSetting)

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

class ReportPlan < Struct.new(
  :report_plan_arn,
  :report_plan_name,
  :report_plan_description,
  :report_setting,
  :report_delivery_channel,
  :deployment_status,
  :creation_time,
  :last_attempted_execution_time,
  :last_successful_execution_time)
  SENSITIVE = []
  include Aws::Structure
end