AWS v6.75.0 published on Wednesday, Apr 2, 2025 by Pulumi
aws.backup.getReportPlan
Explore with Pulumi AI
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",
});
import pulumi
import pulumi_aws as aws
example = aws.backup.get_report_plan(name="my_example_backup_report_plan_name")
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
})
}
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",
});
});
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());
}
}
variables:
example:
fn::invoke:
function: aws:backup:getReportPlan
arguments:
name: my_example_backup_report_plan_name
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>
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]
func LookupReportPlan(ctx *Context, args *LookupReportPlanArgs, opts ...InvokeOption) (*LookupReportPlanResult, error)
func LookupReportPlanOutput(ctx *Context, args *LookupReportPlanOutputArgs, opts ...InvokeOption) LookupReportPlanResultOutput
> 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)
}
public static CompletableFuture<GetReportPlanResult> getReportPlan(GetReportPlanArgs args, InvokeOptions options)
public static Output<GetReportPlanResult> getReportPlan(GetReportPlanArgs args, InvokeOptions options)
fn::invoke:
function: aws:backup/getReportPlan:getReportPlan
arguments:
# arguments dictionary
The following arguments are supported:
- Name
This property is required. string - Backup report plan name.
- 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.
- 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.
- 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.
- {[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.
- 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.
- 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.
- Creation
Time string - Date and time that a report plan is created, in Unix format and Coordinated Universal Time (UTC).
- Deployment
Status 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
- Report
Delivery List<GetChannels Report Plan Report Delivery Channel> - 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 List<GetReport Plan Report Setting> - An object that identifies the report template for the report. Reports are built using a report template. Detailed below.
- Dictionary<string, string>
- Metadata that you can assign to help organize the report plans you create.
- Arn string
- ARN of the backup report plan.
- Creation
Time string - Date and time that a report plan is created, in Unix format and Coordinated Universal Time (UTC).
- Deployment
Status 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
- Report
Delivery []GetChannels Report Plan Report Delivery Channel - 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 []GetReport Plan Report Setting - An object that identifies the report template for the report. Reports are built using a report template. Detailed below.
- map[string]string
- Metadata that you can assign to help organize the report plans you create.
- arn String
- ARN of the backup report plan.
- creation
Time String - Date and time that a report plan is created, in Unix format and Coordinated Universal Time (UTC).
- deployment
Status 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
- report
Delivery List<GetChannels Report Plan Report Delivery Channel> - 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 List<GetReport Plan Report Setting> - An object that identifies the report template for the report. Reports are built using a report template. Detailed below.
- Map<String,String>
- Metadata that you can assign to help organize the report plans you create.
- arn string
- ARN of the backup report plan.
- creation
Time string - Date and time that a report plan is created, in Unix format and Coordinated Universal Time (UTC).
- deployment
Status 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
- report
Delivery GetChannels Report Plan Report Delivery Channel[] - 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 GetReport Plan Report Setting[] - An object that identifies the report template for the report. Reports are built using a report template. Detailed below.
- {[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_ Sequence[Getchannels Report Plan Report Delivery Channel] - 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[GetReport Plan Report Setting] - An object that identifies the report template for the report. Reports are built using a report template. Detailed below.
- Mapping[str, str]
- Metadata that you can assign to help organize the report plans you create.
- arn String
- ARN of the backup report plan.
- creation
Time String - Date and time that a report plan is created, in Unix format and Coordinated Universal Time (UTC).
- deployment
Status 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
- report
Delivery List<Property Map>Channels - 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 List<Property Map> - An object that identifies the report template for the report. Reports are built using a report template. Detailed below.
- 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.
- S3Bucket
Name This property is required. string - Unique name of the S3 bucket that receives your reports.
- S3Key
Prefix 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.
- S3Bucket
Name This property is required. string - Unique name of the S3 bucket that receives your reports.
- S3Key
Prefix 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.
- s3Bucket
Name This property is required. String - Unique name of the S3 bucket that receives your reports.
- s3Key
Prefix 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.
- s3Bucket
Name This property is required. string - Unique name of the S3 bucket that receives your reports.
- s3Key
Prefix 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.
- s3Bucket
Name This property is required. String - Unique name of the S3 bucket that receives your reports.
- s3Key
Prefix 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.
- Framework
Arns This property is required. List<string> - 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. 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.
- Report
Template 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.
- Framework
Arns This property is required. []string - 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. []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.
- Report
Template 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.
- framework
Arns This property is required. List<String> - ARNs of the frameworks a report covers.
- number
Of Frameworks This property is required. Integer - Specifies the number of frameworks a report covers.
- organization
Units 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.
- report
Template 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.
- framework
Arns This property is required. string[] - ARNs of the frameworks a report covers.
- number
Of Frameworks This property is required. number - Specifies the number of frameworks a report covers.
- organization
Units 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.
- report
Template 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.
- framework
Arns This property is required. List<String> - ARNs of the frameworks a report covers.
- number
Of Frameworks This property is required. Number - Specifies the number of frameworks a report covers.
- organization
Units 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.
- report
Template 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.