Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. backup
  5. ReportPlan
AWS v6.73.0 published on Wednesday, Mar 19, 2025 by Pulumi
pulumi/pulumi-aws

aws.backup.ReportPlan

Explore with Pulumi AI

aws logo
AWS v6.73.0 published on Wednesday, Mar 19, 2025 by Pulumi
pulumi/pulumi-aws

    Provides an AWS Backup Report Plan resource.

    Example Usage

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

const example = new aws.backup.ReportPlan("example", {
    name: "example_name",
    description: "example description",
    reportDeliveryChannel: {
        formats: [
            "CSV",
            "JSON",
        ],
        s3BucketName: "example-bucket-name",
    },
    reportSetting: {
        reportTemplate: "RESTORE_JOB_REPORT",
    },
    tags: {
        Name: "Example Report Plan",
    },
});

    import pulumi
import pulumi_aws as aws

example = aws.backup.ReportPlan("example",
    name="example_name",
    description="example description",
    report_delivery_channel={
        "formats": [
            "CSV",
            "JSON",
        ],
        "s3_bucket_name": "example-bucket-name",
    },
    report_setting={
        "report_template": "RESTORE_JOB_REPORT",
    },
    tags={
        "Name": "Example Report Plan",
    })

    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.NewReportPlan(ctx, "example", &backup.ReportPlanArgs{
			Name:        pulumi.String("example_name"),
			Description: pulumi.String("example description"),
			ReportDeliveryChannel: &backup.ReportPlanReportDeliveryChannelArgs{
				Formats: pulumi.StringArray{
					pulumi.String("CSV"),
					pulumi.String("JSON"),
				},
				S3BucketName: pulumi.String("example-bucket-name"),
			},
			ReportSetting: &backup.ReportPlanReportSettingArgs{
				ReportTemplate: pulumi.String("RESTORE_JOB_REPORT"),
			},
			Tags: pulumi.StringMap{
				"Name": pulumi.String("Example Report Plan"),
			},
		})
		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 = new Aws.Backup.ReportPlan("example", new()
    {
        Name = "example_name",
        Description = "example description",
        ReportDeliveryChannel = new Aws.Backup.Inputs.ReportPlanReportDeliveryChannelArgs
        {
            Formats = new[]
            {
                "CSV",
                "JSON",
            },
            S3BucketName = "example-bucket-name",
        },
        ReportSetting = new Aws.Backup.Inputs.ReportPlanReportSettingArgs
        {
            ReportTemplate = "RESTORE_JOB_REPORT",
        },
        Tags = 
        {
            { "Name", "Example Report Plan" },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.backup.ReportPlan;
import com.pulumi.aws.backup.ReportPlanArgs;
import com.pulumi.aws.backup.inputs.ReportPlanReportDeliveryChannelArgs;
import com.pulumi.aws.backup.inputs.ReportPlanReportSettingArgs;
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) {
        var example = new ReportPlan("example", ReportPlanArgs.builder()
            .name("example_name")
            .description("example description")
            .reportDeliveryChannel(ReportPlanReportDeliveryChannelArgs.builder()
                .formats(                
                    "CSV",
                    "JSON")
                .s3BucketName("example-bucket-name")
                .build())
            .reportSetting(ReportPlanReportSettingArgs.builder()
                .reportTemplate("RESTORE_JOB_REPORT")
                .build())
            .tags(Map.of("Name", "Example Report Plan"))
            .build());

    }
}

    resources:
  example:
    type: aws:backup:ReportPlan
    properties:
      name: example_name
      description: example description
      reportDeliveryChannel:
        formats:
          - CSV
          - JSON
        s3BucketName: example-bucket-name
      reportSetting:
        reportTemplate: RESTORE_JOB_REPORT
      tags:
        Name: Example Report Plan

    Create ReportPlan Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new ReportPlan(name: string, args: ReportPlanArgs, opts?: CustomResourceOptions);
    @overload
def ReportPlan(resource_name: str,
               args: ReportPlanArgs,
               opts: Optional[ResourceOptions] = None)

@overload
def ReportPlan(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               report_delivery_channel: Optional[ReportPlanReportDeliveryChannelArgs] = None,
               report_setting: Optional[ReportPlanReportSettingArgs] = None,
               description: Optional[str] = None,
               name: Optional[str] = None,
               tags: Optional[Mapping[str, str]] = None)
    func NewReportPlan(ctx *Context, name string, args ReportPlanArgs, opts ...ResourceOption) (*ReportPlan, error)
    public ReportPlan(string name, ReportPlanArgs args, CustomResourceOptions? opts = null)
    public ReportPlan(String name, ReportPlanArgs args)
public ReportPlan(String name, ReportPlanArgs args, CustomResourceOptions options)

    type: aws:backup:ReportPlan
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args ReportPlanArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ReportPlanArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ReportPlanArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ReportPlanArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ReportPlanArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var reportPlanResource = new Aws.Backup.ReportPlan("reportPlanResource", new()
{
    ReportDeliveryChannel = new Aws.Backup.Inputs.ReportPlanReportDeliveryChannelArgs
    {
        S3BucketName = "string",
        Formats = new[]
        {
            "string",
        },
        S3KeyPrefix = "string",
    },
    ReportSetting = new Aws.Backup.Inputs.ReportPlanReportSettingArgs
    {
        ReportTemplate = "string",
        Accounts = new[]
        {
            "string",
        },
        FrameworkArns = new[]
        {
            "string",
        },
        NumberOfFrameworks = 0,
        OrganizationUnits = new[]
        {
            "string",
        },
        Regions = new[]
        {
            "string",
        },
    },
    Description = "string",
    Name = "string",
    Tags = 
    {
        { "string", "string" },
    },
});

    example, err := backup.NewReportPlan(ctx, "reportPlanResource", &backup.ReportPlanArgs{
	ReportDeliveryChannel: &backup.ReportPlanReportDeliveryChannelArgs{
		S3BucketName: pulumi.String("string"),
		Formats: pulumi.StringArray{
			pulumi.String("string"),
		},
		S3KeyPrefix: pulumi.String("string"),
	},
	ReportSetting: &backup.ReportPlanReportSettingArgs{
		ReportTemplate: pulumi.String("string"),
		Accounts: pulumi.StringArray{
			pulumi.String("string"),
		},
		FrameworkArns: pulumi.StringArray{
			pulumi.String("string"),
		},
		NumberOfFrameworks: pulumi.Int(0),
		OrganizationUnits: pulumi.StringArray{
			pulumi.String("string"),
		},
		Regions: pulumi.StringArray{
			pulumi.String("string"),
		},
	},
	Description: pulumi.String("string"),
	Name:        pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

    var reportPlanResource = new ReportPlan("reportPlanResource", ReportPlanArgs.builder()
    .reportDeliveryChannel(ReportPlanReportDeliveryChannelArgs.builder()
        .s3BucketName("string")
        .formats("string")
        .s3KeyPrefix("string")
        .build())
    .reportSetting(ReportPlanReportSettingArgs.builder()
        .reportTemplate("string")
        .accounts("string")
        .frameworkArns("string")
        .numberOfFrameworks(0)
        .organizationUnits("string")
        .regions("string")
        .build())
    .description("string")
    .name("string")
    .tags(Map.of("string", "string"))
    .build());

    report_plan_resource = aws.backup.ReportPlan("reportPlanResource",
    report_delivery_channel={
        "s3_bucket_name": "string",
        "formats": ["string"],
        "s3_key_prefix": "string",
    },
    report_setting={
        "report_template": "string",
        "accounts": ["string"],
        "framework_arns": ["string"],
        "number_of_frameworks": 0,
        "organization_units": ["string"],
        "regions": ["string"],
    },
    description="string",
    name="string",
    tags={
        "string": "string",
    })

    const reportPlanResource = new aws.backup.ReportPlan("reportPlanResource", {
    reportDeliveryChannel: {
        s3BucketName: "string",
        formats: ["string"],
        s3KeyPrefix: "string",
    },
    reportSetting: {
        reportTemplate: "string",
        accounts: ["string"],
        frameworkArns: ["string"],
        numberOfFrameworks: 0,
        organizationUnits: ["string"],
        regions: ["string"],
    },
    description: "string",
    name: "string",
    tags: {
        string: "string",
    },
});

    type: aws:backup:ReportPlan
properties:
    description: string
    name: string
    reportDeliveryChannel:
        formats:
            - string
        s3BucketName: string
        s3KeyPrefix: string
    reportSetting:
        accounts:
            - string
        frameworkArns:
            - string
        numberOfFrameworks: 0
        organizationUnits:
            - string
        regions:
            - string
        reportTemplate: string
    tags:
        string: string

    ReportPlan Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The ReportPlan resource accepts the following input properties:

    ReportDeliveryChannel ReportPlanReportDeliveryChannel
    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.
    ReportSetting ReportPlanReportSetting
    An object that identifies the report template for the report. Reports are built using a report template. Detailed below.
    Description string
    The description of the report plan with a maximum of 1,024 characters
    Name string
    The unique name of the report plan. The name must be between 1 and 256 characters, starting with a letter, and consisting of letters, numbers, and underscores.
    Tags Dictionary<string, string>
    Metadata that you can assign to help organize the report plans you create. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    ReportDeliveryChannel ReportPlanReportDeliveryChannelArgs
    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.
    ReportSetting ReportPlanReportSettingArgs
    An object that identifies the report template for the report. Reports are built using a report template. Detailed below.
    Description string
    The description of the report plan with a maximum of 1,024 characters
    Name string
    The unique name of the report plan. The name must be between 1 and 256 characters, starting with a letter, and consisting of letters, numbers, and underscores.
    Tags map[string]string
    Metadata that you can assign to help organize the report plans you create. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    reportDeliveryChannel ReportPlanReportDeliveryChannel
    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.
    reportSetting ReportPlanReportSetting
    An object that identifies the report template for the report. Reports are built using a report template. Detailed below.
    description String
    The description of the report plan with a maximum of 1,024 characters
    name String
    The unique name of the report plan. The name must be between 1 and 256 characters, starting with a letter, and consisting of letters, numbers, and underscores.
    tags Map<String,String>
    Metadata that you can assign to help organize the report plans you create. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    reportDeliveryChannel ReportPlanReportDeliveryChannel
    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.
    reportSetting ReportPlanReportSetting
    An object that identifies the report template for the report. Reports are built using a report template. Detailed below.
    description string
    The description of the report plan with a maximum of 1,024 characters
    name string
    The unique name of the report plan. The name must be between 1 and 256 characters, starting with a letter, and consisting of letters, numbers, and underscores.
    tags {[key: string]: string}
    Metadata that you can assign to help organize the report plans you create. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    report_delivery_channel ReportPlanReportDeliveryChannelArgs
    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_setting ReportPlanReportSettingArgs
    An object that identifies the report template for the report. Reports are built using a report template. Detailed below.
    description str
    The description of the report plan with a maximum of 1,024 characters
    name str
    The unique name of the report plan. The name must be between 1 and 256 characters, starting with a letter, and consisting of letters, numbers, and underscores.
    tags Mapping[str, str]
    Metadata that you can assign to help organize the report plans you create. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    reportDeliveryChannel 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.
    reportSetting Property Map
    An object that identifies the report template for the report. Reports are built using a report template. Detailed below.
    description String
    The description of the report plan with a maximum of 1,024 characters
    name String
    The unique name of the report plan. The name must be between 1 and 256 characters, starting with a letter, and consisting of letters, numbers, and underscores.
    tags Map<String>
    Metadata that you can assign to help organize the report plans you create. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ReportPlan resource produces the following output properties:

    Arn string
    The ARN of the backup report plan.
    CreationTime string
    The date and time that a report plan is created, in Unix format and Coordinated Universal Time (UTC).
    DeploymentStatus string
    The deployment status of a report plan. The statuses are: CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED.
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Arn string
    The ARN of the backup report plan.
    CreationTime string
    The date and time that a report plan is created, in Unix format and Coordinated Universal Time (UTC).
    DeploymentStatus string
    The deployment status of a report plan. The statuses are: CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED.
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    The ARN of the backup report plan.
    creationTime String
    The date and time that a report plan is created, in Unix format and Coordinated Universal Time (UTC).
    deploymentStatus String
    The deployment status of a report plan. The statuses are: CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED.
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn string
    The ARN of the backup report plan.
    creationTime string
    The date and time that a report plan is created, in Unix format and Coordinated Universal Time (UTC).
    deploymentStatus string
    The deployment status of a report plan. The statuses are: CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED.
    id string
    The provider-assigned unique ID for this managed resource.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn str
    The ARN of the backup report plan.
    creation_time str
    The date and time that a report plan is created, in Unix format and Coordinated Universal Time (UTC).
    deployment_status str
    The deployment status of a report plan. The statuses are: CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED.
    id str
    The provider-assigned unique ID for this managed resource.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    The ARN of the backup report plan.
    creationTime String
    The date and time that a report plan is created, in Unix format and Coordinated Universal Time (UTC).
    deploymentStatus String
    The deployment status of a report plan. The statuses are: CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED.
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Look up Existing ReportPlan Resource

    Get an existing ReportPlan resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: ReportPlanState, opts?: CustomResourceOptions): ReportPlan
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        creation_time: Optional[str] = None,
        deployment_status: Optional[str] = None,
        description: Optional[str] = None,
        name: Optional[str] = None,
        report_delivery_channel: Optional[ReportPlanReportDeliveryChannelArgs] = None,
        report_setting: Optional[ReportPlanReportSettingArgs] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None) -> ReportPlan
    func GetReportPlan(ctx *Context, name string, id IDInput, state *ReportPlanState, opts ...ResourceOption) (*ReportPlan, error)
    public static ReportPlan Get(string name, Input<string> id, ReportPlanState? state, CustomResourceOptions? opts = null)
    public static ReportPlan get(String name, Output<String> id, ReportPlanState state, CustomResourceOptions options)
    resources:  _:    type: aws:backup:ReportPlan    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Arn string
    The ARN of the backup report plan.
    CreationTime string
    The date and time that a report plan is created, in Unix format and Coordinated Universal Time (UTC).
    DeploymentStatus string
    The deployment status of a report plan. The statuses are: CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED.
    Description string
    The description of the report plan with a maximum of 1,024 characters
    Name string
    The unique name of the report plan. The name must be between 1 and 256 characters, starting with a letter, and consisting of letters, numbers, and underscores.
    ReportDeliveryChannel ReportPlanReportDeliveryChannel
    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.
    ReportSetting ReportPlanReportSetting
    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. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Arn string
    The ARN of the backup report plan.
    CreationTime string
    The date and time that a report plan is created, in Unix format and Coordinated Universal Time (UTC).
    DeploymentStatus string
    The deployment status of a report plan. The statuses are: CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED.
    Description string
    The description of the report plan with a maximum of 1,024 characters
    Name string
    The unique name of the report plan. The name must be between 1 and 256 characters, starting with a letter, and consisting of letters, numbers, and underscores.
    ReportDeliveryChannel ReportPlanReportDeliveryChannelArgs
    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.
    ReportSetting ReportPlanReportSettingArgs
    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. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    The ARN of the backup report plan.
    creationTime String
    The date and time that a report plan is created, in Unix format and Coordinated Universal Time (UTC).
    deploymentStatus String
    The deployment status of a report plan. The statuses are: CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED.
    description String
    The description of the report plan with a maximum of 1,024 characters
    name String
    The unique name of the report plan. The name must be between 1 and 256 characters, starting with a letter, and consisting of letters, numbers, and underscores.
    reportDeliveryChannel ReportPlanReportDeliveryChannel
    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.
    reportSetting ReportPlanReportSetting
    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. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn string
    The ARN of the backup report plan.
    creationTime string
    The date and time that a report plan is created, in Unix format and Coordinated Universal Time (UTC).
    deploymentStatus string
    The deployment status of a report plan. The statuses are: CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED.
    description string
    The description of the report plan with a maximum of 1,024 characters
    name string
    The unique name of the report plan. The name must be between 1 and 256 characters, starting with a letter, and consisting of letters, numbers, and underscores.
    reportDeliveryChannel ReportPlanReportDeliveryChannel
    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.
    reportSetting ReportPlanReportSetting
    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. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn str
    The ARN of the backup report plan.
    creation_time str
    The date and time that a report plan is created, in Unix format and Coordinated Universal Time (UTC).
    deployment_status str
    The deployment status of a report plan. The statuses are: CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED.
    description str
    The description of the report plan with a maximum of 1,024 characters
    name str
    The unique name of the report plan. The name must be between 1 and 256 characters, starting with a letter, and consisting of letters, numbers, and underscores.
    report_delivery_channel ReportPlanReportDeliveryChannelArgs
    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_setting ReportPlanReportSettingArgs
    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. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    The ARN of the backup report plan.
    creationTime String
    The date and time that a report plan is created, in Unix format and Coordinated Universal Time (UTC).
    deploymentStatus String
    The deployment status of a report plan. The statuses are: CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED.
    description String
    The description of the report plan with a maximum of 1,024 characters
    name String
    The unique name of the report plan. The name must be between 1 and 256 characters, starting with a letter, and consisting of letters, numbers, and underscores.
    reportDeliveryChannel 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.
    reportSetting 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. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Supporting Types

    ReportPlanReportDeliveryChannel, ReportPlanReportDeliveryChannelArgs

    S3BucketName 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 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 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 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 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 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 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 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 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 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 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 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.

    ReportPlanReportSetting, ReportPlanReportSettingArgs

    ReportTemplate string
    Identifies the report template for the report. Reports are built using a report template. The report templates are: RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT.
    Accounts List<string>
    Specifies the list of accounts a report covers.
    FrameworkArns List<string>
    Specifies the Amazon Resource Names (ARNs) of the frameworks a report covers.
    NumberOfFrameworks int
    Specifies the number of frameworks a report covers.
    OrganizationUnits List<string>
    Specifies the list of Organizational Units a report covers.
    Regions List<string>
    Specifies the list of regions a report covers.
    ReportTemplate string
    Identifies the report template for the report. Reports are built using a report template. The report templates are: RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT.
    Accounts []string
    Specifies the list of accounts a report covers.
    FrameworkArns []string
    Specifies the Amazon Resource Names (ARNs) of the frameworks a report covers.
    NumberOfFrameworks int
    Specifies the number of frameworks a report covers.
    OrganizationUnits []string
    Specifies the list of Organizational Units a report covers.
    Regions []string
    Specifies the list of regions a report covers.
    reportTemplate String
    Identifies the report template for the report. Reports are built using a report template. The report templates are: RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT.
    accounts List<String>
    Specifies the list of accounts a report covers.
    frameworkArns List<String>
    Specifies the Amazon Resource Names (ARNs) of the frameworks a report covers.
    numberOfFrameworks Integer
    Specifies the number of frameworks a report covers.
    organizationUnits List<String>
    Specifies the list of Organizational Units a report covers.
    regions List<String>
    Specifies the list of regions a report covers.
    reportTemplate string
    Identifies the report template for the report. Reports are built using a report template. The report templates are: RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT.
    accounts string[]
    Specifies the list of accounts a report covers.
    frameworkArns string[]
    Specifies the Amazon Resource Names (ARNs) of the frameworks a report covers.
    numberOfFrameworks number
    Specifies the number of frameworks a report covers.
    organizationUnits string[]
    Specifies the list of Organizational Units a report covers.
    regions string[]
    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. The report templates are: RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT.
    accounts Sequence[str]
    Specifies the list of accounts a report covers.
    framework_arns Sequence[str]
    Specifies the Amazon Resource Names (ARNs) of the frameworks a report covers.
    number_of_frameworks int
    Specifies the number of frameworks a report covers.
    organization_units Sequence[str]
    Specifies the list of Organizational Units a report covers.
    regions Sequence[str]
    Specifies the list of regions a report covers.
    reportTemplate String
    Identifies the report template for the report. Reports are built using a report template. The report templates are: RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT.
    accounts List<String>
    Specifies the list of accounts a report covers.
    frameworkArns List<String>
    Specifies the Amazon Resource Names (ARNs) of the frameworks a report covers.
    numberOfFrameworks Number
    Specifies the number of frameworks a report covers.
    organizationUnits List<String>
    Specifies the list of Organizational Units a report covers.
    regions List<String>
    Specifies the list of regions a report covers.

    Import

    Using pulumi import, import Backup Report Plan using the id which corresponds to the name of the Backup Report Plan. For example:

    $ pulumi import aws:backup/reportPlan:ReportPlan test <id>

    To learn more about importing existing cloud resources, see Importing resources.

    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.73.0 published on Wednesday, Mar 19, 2025 by Pulumi
    pulumi/pulumi-aws