Skip to main content

report_plan

Gets an individual report_plan resource

Overview

Namereport_plan
TypeResource
Descriptionreport_plan
Idawscc.backup.report_plan

Fields

NameDatatypeDescription
report_plan_namestringThe 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 (_).
report_plan_arnstringAn Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
report_plan_descriptionstringAn optional description of the report plan with a maximum of 1,024 characters.
report_plan_tagsarrayMetadata that you can assign to help organize the report plans that you create. Each tag is a key-value pair.
report_delivery_channelobjectA 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_settingobjectIdentifies the report template for the report. Reports are built using a report template.
regionstringAWS region.

Methods

Currently only SELECT is supported for this resource resource.

Example

SELECT
region,
report_plan_name,
report_plan_arn,
report_plan_description,
report_plan_tags,
report_delivery_channel,
report_setting
FROM awscc.backup.report_plan
WHERE data__Identifier = '<ReportPlanArn>';

Permissions

To operate on the report_plan resource, the following permissions are required:

Read

backup:DescribeReportPlan,
backup:ListTags

Update

backup:DescribeReportPlan,
backup:UpdateReportPlan,
backup:ListTags,
backup:UntagResource,
backup:TagResource

Delete

backup:DeleteReportPlan,
backup:DescribeReportPlan