ReportPlan class

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", {
    reportDeliveryChannel: {
        formats: [
            "CSV",
            "JSON",
        ],
        s3BucketName: "example-bucket-name",
    },
    reportSetting: {
        reportTemplate: "RESTORE_JOB_REPORT",
    },
    name: "example_name",
    description: "example description",
    tags: {
        Name: "Example Report Plan",
    },
});

import pulumi
import pulumi_aws as aws

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

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

});

package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/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{
			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"),
			},
			Name:        pulumi.String("example_name"),
			Description: pulumi.String("example description"),
			Tags: pulumi.StringMap{
				"Name": pulumi.String("Example Report Plan"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_backup_reportplan" "example" {
  report_delivery_channel = {
    formats        = ["CSV", "JSON"]
    s3_bucket_name = "example-bucket-name"
  }
  report_setting = {
    report_template = "RESTORE_JOB_REPORT"
  }
  name        = "example_name"
  description = "example description"
  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.ArrayList;
import java.util.Arrays;
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()
            .reportDeliveryChannel(ReportPlanReportDeliveryChannelArgs.builder()
                .formats(
                    "CSV",
                    "JSON")
                .s3BucketName("example-bucket-name")
                .build())
            .reportSetting(ReportPlanReportSettingArgs.builder()
                .reportTemplate("RESTORE_JOB_REPORT")
                .build())
            .name("example_name")
            .description("example description")
            .tags(Map.of("Name", "Example Report Plan"))
            .build());

    }
}

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

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>

Constructors

ReportPlan(String name, {ReportPlanArgs? args, CustomResourceOptions? options})
Creates a new ReportPlan. name The Pulumi resource name. args Arguments used to configure this ReportPlan. The set of arguments for ReportPlan. options Resource options controlling this resource's behavior.
ReportPlan.reference(String urn)
Creates a typed reference to an existing ReportPlan resource.

Properties

arn ↔ Output<String>
ARN of the backup report plan.
latefinal
childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
creationTime ↔ Output<String>
Date and time that a report plan is created, in Unix format and Coordinated Universal Time (UTC).
latefinal
deploymentStatus ↔ Output<String>
Deployment status of a report plan. The statuses are: CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED.
latefinal
description ↔ Output<String?>
Description of the report plan with a maximum of 1,024 characters.
latefinal
hashCode → int
The hash code for this object.
no setterinherited
id ↔ Output<String>
getter/setter pairinherited
isCustom → bool
Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool
Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool
Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool
Whether this instance represents a resource value returned over RPC.
finalinherited
name ↔ Output<String>
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.
latefinal
region ↔ Output<String>
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
reportDeliveryChannel ↔ Output<ReportPlanReportDeliveryChannel>
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.
latefinal
reportSetting ↔ Output<ReportPlanReportSetting>
Object that identifies the report template for the report. Reports are built using a report template. Detailed below.
latefinal
resourceTransforms → List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
tags ↔ Output<Map<String, String>?>
Metadata that you can assign to help organize the report plans you create. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
latefinal
tagsAll ↔ Output<Map<String, String>>
Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
latefinal
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>
latefinalinherited

Methods

failId(Object error) → void
Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void
Completes all output properties with error.
inherited
failUrn(Object error) → void
Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?
Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String
Returns this resource's logical name.
inherited
getResourceType() → String
Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>
Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void
Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void
Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void
Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>
Serializes resource properties for RPC transmission.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {ReportPlanState? state, CustomResourceOptions? options}) → ReportPlan
Gets an existing ReportPlan resource's state with the given name and id.