Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. backup
  5. getReportPlan
AWS v6.75.0 published on Wednesday, Apr 2, 2025 by Pulumi
pulumi/pulumi-aws

aws.backup.getReportPlan

Explore with Pulumi AI

AWS v6.75.0 published on Wednesday, Apr 2, 2025 by Pulumi
pulumi/pulumi-aws

Use this data source to get information on an existing backup report plan.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = aws.backup.getReportPlan({
    name: "my_example_backup_report_plan_name",
});
Copy
import pulumi
import pulumi_aws as aws

example = aws.backup.get_report_plan(name="my_example_backup_report_plan_name")
Copy
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/backup"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := backup.LookupReportPlan(ctx, &backup.LookupReportPlanArgs{
			Name: "my_example_backup_report_plan_name",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = Aws.Backup.GetReportPlan.Invoke(new()
    {
        Name = "my_example_backup_report_plan_name",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.backup.BackupFunctions;
import com.pulumi.aws.backup.inputs.GetReportPlanArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var example = BackupFunctions.getReportPlan(GetReportPlanArgs.builder()
            .name("my_example_backup_report_plan_name")
            .build());

    }
}
Copy
variables:
  example:
    fn::invoke:
      function: aws:backup:getReportPlan
      arguments:
        name: my_example_backup_report_plan_name
Copy

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(name: Optional[str] = None,
                    tags: Optional[Mapping[str, str]] = None,
                    opts: Optional[InvokeOptions] = None) -> GetReportPlanResult
def get_report_plan_output(name: Optional[pulumi.Input[str]] = None,
                    tags: Optional[pulumi.Input[Mapping[str, 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:backup/getReportPlan:getReportPlan
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Name This property is required. string
Backup report plan name.
Tags Dictionary<string, string>
Metadata that you can assign to help organize the report plans you create.
Name This property is required. string
Backup report plan name.
Tags map[string]string
Metadata that you can assign to help organize the report plans you create.
name This property is required. String
Backup report plan name.
tags Map<String,String>
Metadata that you can assign to help organize the report plans you create.
name This property is required. string
Backup report plan name.
tags {[key: string]: string}
Metadata that you can assign to help organize the report plans you create.
name This property is required. str
Backup report plan name.
tags Mapping[str, str]
Metadata that you can assign to help organize the report plans you create.
name This property is required. String
Backup report plan name.
tags Map<String>
Metadata that you can assign to help organize the report plans you create.

getReportPlan Result

The following output properties are available:

Arn string
ARN of the backup report plan.
CreationTime string
Date and time that a report plan is created, in Unix format and Coordinated Universal Time (UTC).
DeploymentStatus string
Deployment status of a report plan. The statuses are: CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED.
Description string
Description of the report plan.
Id string
The provider-assigned unique ID for this managed resource.
Name string
ReportDeliveryChannels List<GetReportPlanReportDeliveryChannel>
An object 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. Detailed below.
ReportSettings List<GetReportPlanReportSetting>
An object that identifies the report template for the report. Reports are built using a report template. Detailed below.
Tags Dictionary<string, string>
Metadata that you can assign to help organize the report plans you create.
Arn string
ARN of the backup report plan.
CreationTime string
Date and time that a report plan is created, in Unix format and Coordinated Universal Time (UTC).
DeploymentStatus string
Deployment status of a report plan. The statuses are: CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED.
Description string
Description of the report plan.
Id string
The provider-assigned unique ID for this managed resource.
Name string
ReportDeliveryChannels []GetReportPlanReportDeliveryChannel
An object 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. Detailed below.
ReportSettings []GetReportPlanReportSetting
An object that identifies the report template for the report. Reports are built using a report template. Detailed below.
Tags map[string]string
Metadata that you can assign to help organize the report plans you create.
arn String
ARN of the backup report plan.
creationTime String
Date and time that a report plan is created, in Unix format and Coordinated Universal Time (UTC).
deploymentStatus String
Deployment status of a report plan. The statuses are: CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED.
description String
Description of the report plan.
id String
The provider-assigned unique ID for this managed resource.
name String
reportDeliveryChannels List<GetReportPlanReportDeliveryChannel>
An object 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. Detailed below.
reportSettings List<GetReportPlanReportSetting>
An object that identifies the report template for the report. Reports are built using a report template. Detailed below.
tags Map<String,String>
Metadata that you can assign to help organize the report plans you create.
arn string
ARN of the backup report plan.
creationTime string
Date and time that a report plan is created, in Unix format and Coordinated Universal Time (UTC).
deploymentStatus string
Deployment status of a report plan. The statuses are: CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED.
description string
Description of the report plan.
id string
The provider-assigned unique ID for this managed resource.
name string
reportDeliveryChannels GetReportPlanReportDeliveryChannel[]
An object 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. Detailed below.
reportSettings GetReportPlanReportSetting[]
An object that identifies the report template for the report. Reports are built using a report template. Detailed below.
tags {[key: string]: string}
Metadata that you can assign to help organize the report plans you create.
arn str
ARN of the backup report plan.
creation_time str
Date and time that a report plan is created, in Unix format and Coordinated Universal Time (UTC).
deployment_status str
Deployment status of a report plan. The statuses are: CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED.
description str
Description of the report plan.
id str
The provider-assigned unique ID for this managed resource.
name str
report_delivery_channels Sequence[GetReportPlanReportDeliveryChannel]
An object 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. Detailed below.
report_settings Sequence[GetReportPlanReportSetting]
An object that identifies the report template for the report. Reports are built using a report template. Detailed below.
tags Mapping[str, str]
Metadata that you can assign to help organize the report plans you create.
arn String
ARN of the backup report plan.
creationTime String
Date and time that a report plan is created, in Unix format and Coordinated Universal Time (UTC).
deploymentStatus String
Deployment status of a report plan. The statuses are: CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED.
description String
Description of the report plan.
id String
The provider-assigned unique ID for this managed resource.
name String
reportDeliveryChannels List<Property Map>
An object 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. Detailed below.
reportSettings List<Property Map>
An object that identifies the report template for the report. Reports are built using a report template. Detailed below.
tags Map<String>
Metadata that you can assign to help organize the report plans you create.

Supporting Types

GetReportPlanReportDeliveryChannel

Formats This property is required. List<string>
List of the format of your reports: CSV, JSON, or both.
S3BucketName This property is required. string
Unique name of the S3 bucket that receives your reports.
S3KeyPrefix This property is required. string
Prefix for where 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.
Formats This property is required. []string
List of the format of your reports: CSV, JSON, or both.
S3BucketName This property is required. string
Unique name of the S3 bucket that receives your reports.
S3KeyPrefix This property is required. string
Prefix for where 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.
formats This property is required. List<String>
List of the format of your reports: CSV, JSON, or both.
s3BucketName This property is required. String
Unique name of the S3 bucket that receives your reports.
s3KeyPrefix This property is required. String
Prefix for where 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.
formats This property is required. string[]
List of the format of your reports: CSV, JSON, or both.
s3BucketName This property is required. string
Unique name of the S3 bucket that receives your reports.
s3KeyPrefix This property is required. string
Prefix for where 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.
formats This property is required. Sequence[str]
List of the format of your reports: CSV, JSON, or both.
s3_bucket_name This property is required. str
Unique name of the S3 bucket that receives your reports.
s3_key_prefix This property is required. str
Prefix for where 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.
formats This property is required. List<String>
List of the format of your reports: CSV, JSON, or both.
s3BucketName This property is required. String
Unique name of the S3 bucket that receives your reports.
s3KeyPrefix This property is required. String
Prefix for where 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.

GetReportPlanReportSetting

Accounts This property is required. List<string>
(Optional) Specifies the list of accounts a report covers.
FrameworkArns This property is required. List<string>
ARNs of the frameworks a report covers.
NumberOfFrameworks This property is required. int
Specifies the number of frameworks a report covers.
OrganizationUnits This property is required. List<string>
(Optional) Specifies the list of Organizational Units a report covers.
Regions This property is required. List<string>
(Optional) Specifies the list of regions a report covers.
ReportTemplate This property is required. string
Identifies the report template for the report. Reports are built using a report template.
Accounts This property is required. []string
(Optional) Specifies the list of accounts a report covers.
FrameworkArns This property is required. []string
ARNs of the frameworks a report covers.
NumberOfFrameworks This property is required. int
Specifies the number of frameworks a report covers.
OrganizationUnits This property is required. []string
(Optional) Specifies the list of Organizational Units a report covers.
Regions This property is required. []string
(Optional) Specifies the list of regions a report covers.
ReportTemplate This property is required. string
Identifies the report template for the report. Reports are built using a report template.
accounts This property is required. List<String>
(Optional) Specifies the list of accounts a report covers.
frameworkArns This property is required. List<String>
ARNs of the frameworks a report covers.
numberOfFrameworks This property is required. Integer
Specifies the number of frameworks a report covers.
organizationUnits This property is required. List<String>
(Optional) Specifies the list of Organizational Units a report covers.
regions This property is required. List<String>
(Optional) Specifies the list of regions a report covers.
reportTemplate This property is required. String
Identifies the report template for the report. Reports are built using a report template.
accounts This property is required. string[]
(Optional) Specifies the list of accounts a report covers.
frameworkArns This property is required. string[]
ARNs of the frameworks a report covers.
numberOfFrameworks This property is required. number
Specifies the number of frameworks a report covers.
organizationUnits This property is required. string[]
(Optional) Specifies the list of Organizational Units a report covers.
regions This property is required. string[]
(Optional) Specifies the list of regions a report covers.
reportTemplate This property is required. string
Identifies the report template for the report. Reports are built using a report template.
accounts This property is required. Sequence[str]
(Optional) Specifies the list of accounts a report covers.
framework_arns This property is required. Sequence[str]
ARNs of the frameworks a report covers.
number_of_frameworks This property is required. int
Specifies the number of frameworks a report covers.
organization_units This property is required. Sequence[str]
(Optional) Specifies the list of Organizational Units a report covers.
regions This property is required. Sequence[str]
(Optional) Specifies the list of regions a report covers.
report_template This property is required. str
Identifies the report template for the report. Reports are built using a report template.
accounts This property is required. List<String>
(Optional) Specifies the list of accounts a report covers.
frameworkArns This property is required. List<String>
ARNs of the frameworks a report covers.
numberOfFrameworks This property is required. Number
Specifies the number of frameworks a report covers.
organizationUnits This property is required. List<String>
(Optional) Specifies the list of Organizational Units a report covers.
regions This property is required. List<String>
(Optional) Specifies the list of regions a report covers.
reportTemplate This property is required. String
Identifies the report template for the report. Reports are built using a report template.

Package Details

Repository
AWS Classic pulumi/pulumi-aws
License
Apache-2.0
Notes
This Pulumi package is based on the aws Terraform Provider.
AWS v6.75.0 published on Wednesday, Apr 2, 2025 by Pulumi
pulumi/pulumi-aws