Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. backup
  5. getReportPlan
AWS v6.54.0 published on Friday, Sep 27, 2024 by Pulumi
pulumi/pulumi-aws

aws.backup.getReportPlan

Explore with Pulumi AI

aws logo
AWS v6.54.0 published on Friday, Sep 27, 2024 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",
});

    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)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: aws:backup/getReportPlan:getReportPlan
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Name string
    Backup report plan name.
    Tags Dictionary<string, string>
    Metadata that you can assign to help organize the report plans you create.
    Name string
    Backup report plan name.
    Tags map[string]string
    Metadata that you can assign to help organize the report plans you create.
    name String
    Backup report plan name.
    tags Map<String,String>
    Metadata that you can assign to help organize the report plans you create.
    name string
    Backup report plan name.
    tags {[key: string]: string}
    Metadata that you can assign to help organize the report plans you create.
    name str
    Backup report plan name.
    tags Mapping[str, str]
    Metadata that you can assign to help organize the report plans you create.
    name 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 List<string>
    List of the format of your reports: CSV, JSON, or both.
    S3BucketName string
    Unique name of the S3 bucket that receives your reports.
    S3KeyPrefix 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 []string
    List of the format of your reports: CSV, JSON, or both.
    S3BucketName string
    Unique name of the S3 bucket that receives your reports.
    S3KeyPrefix 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 List<String>
    List of the format of your reports: CSV, JSON, or both.
    s3BucketName String
    Unique name of the S3 bucket that receives your reports.
    s3KeyPrefix 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 string[]
    List of the format of your reports: CSV, JSON, or both.
    s3BucketName string
    Unique name of the S3 bucket that receives your reports.
    s3KeyPrefix 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 Sequence[str]
    List of the format of your reports: CSV, JSON, or both.
    s3_bucket_name str
    Unique name of the S3 bucket that receives your reports.
    s3_key_prefix 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 List<String>
    List of the format of your reports: CSV, JSON, or both.
    s3BucketName String
    Unique name of the S3 bucket that receives your reports.
    s3KeyPrefix 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 List<string>
    (Optional) Specifies the list of accounts a report covers.
    FrameworkArns List<string>
    ARNs of the frameworks a report covers.
    NumberOfFrameworks int
    Specifies the number of frameworks a report covers.
    OrganizationUnits List<string>
    (Optional) Specifies the list of Organizational Units a report covers.
    Regions List<string>
    (Optional) Specifies the list of regions a report covers.
    ReportTemplate string
    Identifies the report template for the report. Reports are built using a report template.
    Accounts []string
    (Optional) Specifies the list of accounts a report covers.
    FrameworkArns []string
    ARNs of the frameworks a report covers.
    NumberOfFrameworks int
    Specifies the number of frameworks a report covers.
    OrganizationUnits []string
    (Optional) Specifies the list of Organizational Units a report covers.
    Regions []string
    (Optional) Specifies the list of regions a report covers.
    ReportTemplate string
    Identifies the report template for the report. Reports are built using a report template.
    accounts List<String>
    (Optional) Specifies the list of accounts a report covers.
    frameworkArns List<String>
    ARNs of the frameworks a report covers.
    numberOfFrameworks Integer
    Specifies the number of frameworks a report covers.
    organizationUnits List<String>
    (Optional) Specifies the list of Organizational Units a report covers.
    regions List<String>
    (Optional) Specifies the list of regions a report covers.
    reportTemplate String
    Identifies the report template for the report. Reports are built using a report template.
    accounts string[]
    (Optional) Specifies the list of accounts a report covers.
    frameworkArns string[]
    ARNs of the frameworks a report covers.
    numberOfFrameworks number
    Specifies the number of frameworks a report covers.
    organizationUnits string[]
    (Optional) Specifies the list of Organizational Units a report covers.
    regions string[]
    (Optional) Specifies the list of regions a report covers.
    reportTemplate string
    Identifies the report template for the report. Reports are built using a report template.
    accounts Sequence[str]
    (Optional) Specifies the list of accounts a report covers.
    framework_arns Sequence[str]
    ARNs of the frameworks a report covers.
    number_of_frameworks int
    Specifies the number of frameworks a report covers.
    organization_units Sequence[str]
    (Optional) Specifies the list of Organizational Units a report covers.
    regions Sequence[str]
    (Optional) Specifies the list of regions a report covers.
    report_template str
    Identifies the report template for the report. Reports are built using a report template.
    accounts List<String>
    (Optional) Specifies the list of accounts a report covers.
    frameworkArns List<String>
    ARNs of the frameworks a report covers.
    numberOfFrameworks Number
    Specifies the number of frameworks a report covers.
    organizationUnits List<String>
    (Optional) Specifies the list of Organizational Units a report covers.
    regions List<String>
    (Optional) Specifies the list of regions a report covers.
    reportTemplate 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 logo
    AWS v6.54.0 published on Friday, Sep 27, 2024 by Pulumi
    pulumi/pulumi-aws