Class: Aws::Backup::Types::CreateReportPlanInput
- Inherits:
-
Struct
- Object
- Struct
- Aws::Backup::Types::CreateReportPlanInput
- Includes:
- Structure
- Defined in:
- lib/aws-sdk-backup/types.rb
Overview
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#idempotency_token ⇒ String
A customer-chosen string that you can use to distinguish between otherwise identical calls to ‘CreateReportPlanInput`.
-
#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.
-
#report_plan_description ⇒ String
An optional description of the report plan with a maximum of 1,024 characters.
-
#report_plan_name ⇒ String
The unique name of the report plan.
-
#report_plan_tags ⇒ Hash<String,String>
Metadata that you can assign to help organize the report plans that you create.
-
#report_setting ⇒ Types::ReportSetting
Identifies the report template for the report.
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.
2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 |
# File 'lib/aws-sdk-backup/types.rb', line 2003 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.
2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 |
# File 'lib/aws-sdk-backup/types.rb', line 2003 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.
2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 |
# File 'lib/aws-sdk-backup/types.rb', line 2003 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 (_).
2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 |
# File 'lib/aws-sdk-backup/types.rb', line 2003 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.
2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 |
# File 'lib/aws-sdk-backup/types.rb', line 2003 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.
2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 |
# File 'lib/aws-sdk-backup/types.rb', line 2003 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 |