@pulumi/aws
Version:
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
170 lines (169 loc) • 6.84 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Resource for managing an AWS Backup Restore Testing Plan.
*
* ## Example Usage
*
* ### Basic Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const example = new aws.backup.RestoreTestingPlan("example", {
* name: "example_restore_testing_plan",
* recoveryPointSelection: {
* algorithm: "LATEST_WITHIN_WINDOW",
* includeVaults: ["*"],
* recoveryPointTypes: ["CONTINUOUS"],
* },
* scheduleExpression: "cron(0 12 ? * * *)",
* });
* ```
*
* ## Import
*
* Using `pulumi import`, import Backup Restore Testing Plan using the `name`. For example:
*
* ```sh
* $ pulumi import aws:backup/restoreTestingPlan:RestoreTestingPlan example my_testing_plan
* ```
*/
export declare class RestoreTestingPlan extends pulumi.CustomResource {
/**
* Get an existing RestoreTestingPlan 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 state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: RestoreTestingPlanState, opts?: pulumi.CustomResourceOptions): RestoreTestingPlan;
/**
* Returns true if the given object is an instance of RestoreTestingPlan. 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 RestoreTestingPlan;
/**
* ARN of the Restore Testing Plan.
*/
readonly arn: pulumi.Output<string>;
/**
* The name of the restore testing plan. Must be between 1 and 50 characters long and contain only alphanumeric characters and underscores.
*/
readonly name: pulumi.Output<string>;
/**
* Specifies the recovery point selection configuration. See RecoveryPointSelection section for more details.
*/
readonly recoveryPointSelection: pulumi.Output<outputs.backup.RestoreTestingPlanRecoveryPointSelection | undefined>;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
readonly region: pulumi.Output<string>;
/**
* The schedule expression for the restore testing plan.
*/
readonly scheduleExpression: pulumi.Output<string>;
/**
* The timezone for the schedule expression. If not provided, the state value will be used.
*/
readonly scheduleExpressionTimezone: pulumi.Output<string>;
/**
* The number of hours in the start window for the restore testing plan. Must be between 1 and 168.
*/
readonly startWindowHours: pulumi.Output<number>;
readonly tags: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
*/
readonly tagsAll: pulumi.Output<{
[key: string]: string;
}>;
/**
* Create a RestoreTestingPlan 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: RestoreTestingPlanArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering RestoreTestingPlan resources.
*/
export interface RestoreTestingPlanState {
/**
* ARN of the Restore Testing Plan.
*/
arn?: pulumi.Input<string>;
/**
* The name of the restore testing plan. Must be between 1 and 50 characters long and contain only alphanumeric characters and underscores.
*/
name?: pulumi.Input<string>;
/**
* Specifies the recovery point selection configuration. See RecoveryPointSelection section for more details.
*/
recoveryPointSelection?: pulumi.Input<inputs.backup.RestoreTestingPlanRecoveryPointSelection>;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
region?: pulumi.Input<string>;
/**
* The schedule expression for the restore testing plan.
*/
scheduleExpression?: pulumi.Input<string>;
/**
* The timezone for the schedule expression. If not provided, the state value will be used.
*/
scheduleExpressionTimezone?: pulumi.Input<string>;
/**
* The number of hours in the start window for the restore testing plan. Must be between 1 and 168.
*/
startWindowHours?: pulumi.Input<number>;
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
*/
tagsAll?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
}
/**
* The set of arguments for constructing a RestoreTestingPlan resource.
*/
export interface RestoreTestingPlanArgs {
/**
* The name of the restore testing plan. Must be between 1 and 50 characters long and contain only alphanumeric characters and underscores.
*/
name?: pulumi.Input<string>;
/**
* Specifies the recovery point selection configuration. See RecoveryPointSelection section for more details.
*/
recoveryPointSelection?: pulumi.Input<inputs.backup.RestoreTestingPlanRecoveryPointSelection>;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
region?: pulumi.Input<string>;
/**
* The schedule expression for the restore testing plan.
*/
scheduleExpression: pulumi.Input<string>;
/**
* The timezone for the schedule expression. If not provided, the state value will be used.
*/
scheduleExpressionTimezone?: pulumi.Input<string>;
/**
* The number of hours in the start window for the restore testing plan. Must be between 1 and 168.
*/
startWindowHours?: pulumi.Input<number>;
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
}