Class: Aws::Backup::Types::CreateReportPlanInput

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#idempotency_token ⇒ String

A customer-chosen string that you can use to distinguish between otherwise identical calls to CreateReportPlanInput. Retrying a successful request with the same idempotency token results in a success message with no action taken.

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

  • (String) 


1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
 
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 1671

class CreateReportPlanInput < Struct.new(
  :report_plan_name,
  :report_plan_description,
  :report_delivery_channel,
  :report_setting,
  :report_plan_tags,
  :idempotency_token)
  SENSITIVE = []
  include Aws::Structure
end

#report_delivery_channel ⇒ Types::ReportDeliveryChannel

A structure that 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:



1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
 
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 1671

class CreateReportPlanInput < Struct.new(
  :report_plan_name,
  :report_plan_description,
  :report_delivery_channel,
  :report_setting,
  :report_plan_tags,
  :idempotency_token)
  SENSITIVE = []
  include Aws::Structure
end

#report_plan_description ⇒ String

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

Returns:

  • (String) 


1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
 
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 1671

class CreateReportPlanInput < Struct.new(
  :report_plan_name,
  :report_plan_description,
  :report_delivery_channel,
  :report_setting,
  :report_plan_tags,
  :idempotency_token)
  SENSITIVE = []
  include Aws::Structure
end

#report_plan_name ⇒ String

The unique name of the report plan. The name must be between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).

Returns:

  • (String) 


1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
 
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 1671

class CreateReportPlanInput < Struct.new(
  :report_plan_name,
  :report_plan_description,
  :report_delivery_channel,
  :report_setting,
  :report_plan_tags,
  :idempotency_token)
  SENSITIVE = []
  include Aws::Structure
end

#report_plan_tags ⇒ Hash<String,String>

Metadata that you can assign to help organize the report plans that you create. Each tag is a key-value pair.

Returns:

  • (Hash<String,String>) 


1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
 
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 1671

class CreateReportPlanInput < Struct.new(
  :report_plan_name,
  :report_plan_description,
  :report_delivery_channel,
  :report_setting,
  :report_plan_tags,
  :idempotency_token)
  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:



1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
 
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 1671

class CreateReportPlanInput < Struct.new(
  :report_plan_name,
  :report_plan_description,
  :report_delivery_channel,
  :report_setting,
  :report_plan_tags,
  :idempotency_token)
  SENSITIVE = []
  include Aws::Structure
end