@pulumi/aws-native
Version:
The Pulumi AWS Cloud Control Provider enables you to build, deploy, and manage [any AWS resource that's supported by the AWS Cloud Control API](https://github.com/pulumi/pulumi-aws-native/blob/master/provider/cmd/pulumi-gen-aws-native/supported-types.txt)
80 lines (79 loc) • 3.95 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Contains detailed information about a report plan in AWS Backup Audit Manager.
*/
export declare class ReportPlan extends pulumi.CustomResource {
/**
* Get an existing ReportPlan resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): ReportPlan;
/**
* Returns true if the given object is an instance of ReportPlan. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is ReportPlan;
/**
* A structure 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.
*/
readonly reportDeliveryChannel: pulumi.Output<outputs.backup.ReportDeliveryChannelProperties>;
/**
* An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
*/
readonly reportPlanArn: pulumi.Output<string>;
/**
* An optional description of the report plan with a maximum of 1,024 characters.
*/
readonly reportPlanDescription: pulumi.Output<string | undefined>;
/**
* The unique name of the report plan. The name must be between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).
*/
readonly reportPlanName: pulumi.Output<string | undefined>;
/**
* Metadata that you can assign to help organize the report plans that you create. Each tag is a key-value pair.
*/
readonly reportPlanTags: pulumi.Output<outputs.Tag[] | undefined>;
/**
* Identifies the report template for the report. Reports are built using a report template.
*/
readonly reportSetting: pulumi.Output<outputs.backup.ReportSettingProperties>;
/**
* Create a ReportPlan resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: ReportPlanArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a ReportPlan resource.
*/
export interface ReportPlanArgs {
/**
* A structure 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.
*/
reportDeliveryChannel: pulumi.Input<inputs.backup.ReportDeliveryChannelPropertiesArgs>;
/**
* An optional description of the report plan with a maximum of 1,024 characters.
*/
reportPlanDescription?: pulumi.Input<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 (a-z, A-Z), numbers (0-9), and underscores (_).
*/
reportPlanName?: pulumi.Input<string>;
/**
* Metadata that you can assign to help organize the report plans that you create. Each tag is a key-value pair.
*/
reportPlanTags?: pulumi.Input<pulumi.Input<inputs.TagArgs>[]>;
/**
* Identifies the report template for the report. Reports are built using a report template.
*/
reportSetting: pulumi.Input<inputs.backup.ReportSettingPropertiesArgs>;
}