Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. backup
  5. getReportPlan

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.backup.getReportPlan

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

Contains detailed information about a report plan in AWS Backup Audit Manager.

Using getReportPlan

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getReportPlan(args: GetReportPlanArgs, opts?: InvokeOptions): Promise<GetReportPlanResult>
function getReportPlanOutput(args: GetReportPlanOutputArgs, opts?: InvokeOptions): Output<GetReportPlanResult>
Copy
def get_report_plan(report_plan_arn: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetReportPlanResult
def get_report_plan_output(report_plan_arn: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetReportPlanResult]
Copy
func LookupReportPlan(ctx *Context, args *LookupReportPlanArgs, opts ...InvokeOption) (*LookupReportPlanResult, error)
func LookupReportPlanOutput(ctx *Context, args *LookupReportPlanOutputArgs, opts ...InvokeOption) LookupReportPlanResultOutput
Copy

> Note: This function is named LookupReportPlan in the Go SDK.

public static class GetReportPlan 
{
    public static Task<GetReportPlanResult> InvokeAsync(GetReportPlanArgs args, InvokeOptions? opts = null)
    public static Output<GetReportPlanResult> Invoke(GetReportPlanInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetReportPlanResult> getReportPlan(GetReportPlanArgs args, InvokeOptions options)
public static Output<GetReportPlanResult> getReportPlan(GetReportPlanArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: aws-native:backup:getReportPlan
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ReportPlanArn This property is required. string
An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
ReportPlanArn This property is required. string
An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
reportPlanArn This property is required. String
An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
reportPlanArn This property is required. string
An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
report_plan_arn This property is required. str
An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
reportPlanArn This property is required. String
An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.

getReportPlan Result

The following output properties are available:

ReportDeliveryChannel Pulumi.AwsNative.Backup.Outputs.ReportDeliveryChannelProperties
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.
ReportPlanArn string
An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
ReportPlanDescription string
An optional description of the report plan with a maximum of 1,024 characters.
ReportPlanTags List<Pulumi.AwsNative.Outputs.Tag>
Metadata that you can assign to help organize the report plans that you create. Each tag is a key-value pair.
ReportSetting Pulumi.AwsNative.Backup.Outputs.ReportSettingProperties
Identifies the report template for the report. Reports are built using a report template.
ReportDeliveryChannel ReportDeliveryChannelProperties
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.
ReportPlanArn string
An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
ReportPlanDescription string
An optional description of the report plan with a maximum of 1,024 characters.
ReportPlanTags Tag
Metadata that you can assign to help organize the report plans that you create. Each tag is a key-value pair.
ReportSetting ReportSettingProperties
Identifies the report template for the report. Reports are built using a report template.
reportDeliveryChannel ReportDeliveryChannelProperties
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.
reportPlanArn String
An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
reportPlanDescription String
An optional description of the report plan with a maximum of 1,024 characters.
reportPlanTags List<Tag>
Metadata that you can assign to help organize the report plans that you create. Each tag is a key-value pair.
reportSetting ReportSettingProperties
Identifies the report template for the report. Reports are built using a report template.
reportDeliveryChannel ReportDeliveryChannelProperties
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.
reportPlanArn string
An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
reportPlanDescription string
An optional description of the report plan with a maximum of 1,024 characters.
reportPlanTags Tag[]
Metadata that you can assign to help organize the report plans that you create. Each tag is a key-value pair.
reportSetting ReportSettingProperties
Identifies the report template for the report. Reports are built using a report template.
report_delivery_channel ReportDeliveryChannelProperties
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_arn str
An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
report_plan_description str
An optional description of the report plan with a maximum of 1,024 characters.
report_plan_tags Sequence[root_Tag]
Metadata that you can assign to help organize the report plans that you create. Each tag is a key-value pair.
report_setting ReportSettingProperties
Identifies the report template for the report. Reports are built using a report template.
reportDeliveryChannel Property Map
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.
reportPlanArn String
An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
reportPlanDescription String
An optional description of the report plan with a maximum of 1,024 characters.
reportPlanTags List<Property Map>
Metadata that you can assign to help organize the report plans that you create. Each tag is a key-value pair.
reportSetting Property Map
Identifies the report template for the report. Reports are built using a report template.

Supporting Types

ReportDeliveryChannelProperties

S3BucketName This property is required. string
The unique name of the S3 bucket that receives your reports.
Formats List<string>
A list of the format of your reports: CSV, JSON, or both. If not specified, the default format is CSV.
S3KeyPrefix string
The prefix for where AWS Backup Audit Manager delivers your reports to Amazon S3. The prefix is this part of the following path: s3://your-bucket-name/prefix/Backup/us-west-2/year/month/day/report-name. If not specified, there is no prefix.
S3BucketName This property is required. string
The unique name of the S3 bucket that receives your reports.
Formats []string
A list of the format of your reports: CSV, JSON, or both. If not specified, the default format is CSV.
S3KeyPrefix string
The prefix for where AWS Backup Audit Manager delivers your reports to Amazon S3. The prefix is this part of the following path: s3://your-bucket-name/prefix/Backup/us-west-2/year/month/day/report-name. If not specified, there is no prefix.
s3BucketName This property is required. String
The unique name of the S3 bucket that receives your reports.
formats List<String>
A list of the format of your reports: CSV, JSON, or both. If not specified, the default format is CSV.
s3KeyPrefix String
The prefix for where AWS Backup Audit Manager delivers your reports to Amazon S3. The prefix is this part of the following path: s3://your-bucket-name/prefix/Backup/us-west-2/year/month/day/report-name. If not specified, there is no prefix.
s3BucketName This property is required. string
The unique name of the S3 bucket that receives your reports.
formats string[]
A list of the format of your reports: CSV, JSON, or both. If not specified, the default format is CSV.
s3KeyPrefix string
The prefix for where AWS Backup Audit Manager delivers your reports to Amazon S3. The prefix is this part of the following path: s3://your-bucket-name/prefix/Backup/us-west-2/year/month/day/report-name. If not specified, there is no prefix.
s3_bucket_name This property is required. str
The unique name of the S3 bucket that receives your reports.
formats Sequence[str]
A list of the format of your reports: CSV, JSON, or both. If not specified, the default format is CSV.
s3_key_prefix str
The prefix for where AWS Backup Audit Manager delivers your reports to Amazon S3. The prefix is this part of the following path: s3://your-bucket-name/prefix/Backup/us-west-2/year/month/day/report-name. If not specified, there is no prefix.
s3BucketName This property is required. String
The unique name of the S3 bucket that receives your reports.
formats List<String>
A list of the format of your reports: CSV, JSON, or both. If not specified, the default format is CSV.
s3KeyPrefix String
The prefix for where AWS Backup Audit Manager delivers your reports to Amazon S3. The prefix is this part of the following path: s3://your-bucket-name/prefix/Backup/us-west-2/year/month/day/report-name. If not specified, there is no prefix.

ReportSettingProperties

ReportTemplate This property is required. string
Identifies the report template for the report. Reports are built using a report template. The report templates are: BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT
Accounts List<string>
The list of AWS accounts that a report covers.
FrameworkArns List<string>
The Amazon Resource Names (ARNs) of the frameworks a report covers.
OrganizationUnits List<string>
The list of AWS organization units that a report covers.
Regions List<string>
The list of AWS regions that a report covers.
ReportTemplate This property is required. string
Identifies the report template for the report. Reports are built using a report template. The report templates are: BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT
Accounts []string
The list of AWS accounts that a report covers.
FrameworkArns []string
The Amazon Resource Names (ARNs) of the frameworks a report covers.
OrganizationUnits []string
The list of AWS organization units that a report covers.
Regions []string
The list of AWS regions that a report covers.
reportTemplate This property is required. String
Identifies the report template for the report. Reports are built using a report template. The report templates are: BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT
accounts List<String>
The list of AWS accounts that a report covers.
frameworkArns List<String>
The Amazon Resource Names (ARNs) of the frameworks a report covers.
organizationUnits List<String>
The list of AWS organization units that a report covers.
regions List<String>
The list of AWS regions that a report covers.
reportTemplate This property is required. string
Identifies the report template for the report. Reports are built using a report template. The report templates are: BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT
accounts string[]
The list of AWS accounts that a report covers.
frameworkArns string[]
The Amazon Resource Names (ARNs) of the frameworks a report covers.
organizationUnits string[]
The list of AWS organization units that a report covers.
regions string[]
The list of AWS regions that a report covers.
report_template This property is required. str
Identifies the report template for the report. Reports are built using a report template. The report templates are: BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT
accounts Sequence[str]
The list of AWS accounts that a report covers.
framework_arns Sequence[str]
The Amazon Resource Names (ARNs) of the frameworks a report covers.
organization_units Sequence[str]
The list of AWS organization units that a report covers.
regions Sequence[str]
The list of AWS regions that a report covers.
reportTemplate This property is required. String
Identifies the report template for the report. Reports are built using a report template. The report templates are: BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT
accounts List<String>
The list of AWS accounts that a report covers.
frameworkArns List<String>
The Amazon Resource Names (ARNs) of the frameworks a report covers.
organizationUnits List<String>
The list of AWS organization units that a report covers.
regions List<String>
The list of AWS regions that a report covers.

Tag

Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag
key This property is required. string
The key name of the tag
value This property is required. string
The value of the tag
key This property is required. str
The key name of the tag
value This property is required. str
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag

Package Details

Repository
AWS Native pulumi/pulumi-aws-native
License
Apache-2.0

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native