@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)
152 lines (151 loc) • 5.32 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
import * as enums from "../types/enums";
/**
* Represents a plan that specifies Regions, IAM roles, and workflows of logic required to perform the desired change to your multi-Region application
*/
export declare class Plan extends pulumi.CustomResource {
/**
* Get an existing Plan 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): Plan;
/**
* Returns true if the given object is an instance of Plan. 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 Plan;
/**
* The Amazon Resource Name (ARN) of the plan.
*/
readonly arn: pulumi.Output<string>;
/**
* The associated application health alarms for a plan.
*/
readonly associatedAlarms: pulumi.Output<{
[key: string]: outputs.arcregionswitch.PlanAssociatedAlarm;
} | undefined>;
/**
* The description for a plan.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* The execution role for a plan.
*/
readonly executionRole: pulumi.Output<string>;
readonly healthChecksForPlan: pulumi.Output<{
[key: string]: outputs.arcregionswitch.PlanHealthCheckState[];
}>;
/**
* The name for a plan.
*/
readonly name: pulumi.Output<string>;
/**
* The owner of a plan.
*/
readonly owner: pulumi.Output<string>;
readonly planHealthChecks: pulumi.Output<string[]>;
/**
* The primary Region for a plan.
*/
readonly primaryRegion: pulumi.Output<string | undefined>;
/**
* The recovery approach for a Region switch plan, which can be active/active (activeActive) or active/passive (activePassive).
*/
readonly recoveryApproach: pulumi.Output<enums.arcregionswitch.PlanRecoveryApproach>;
/**
* The recovery time objective for a plan.
*/
readonly recoveryTimeObjectiveMinutes: pulumi.Output<number | undefined>;
/**
* The AWS Regions for a plan.
*/
readonly regions: pulumi.Output<string[]>;
/**
* The report configuration for a plan.
*/
readonly reportConfiguration: pulumi.Output<outputs.arcregionswitch.PlanReportConfiguration | undefined>;
readonly route53HealthChecks: pulumi.Output<outputs.arcregionswitch.Route53HealthChecksProperties>;
readonly tags: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* The triggers for a plan.
*/
readonly triggers: pulumi.Output<outputs.arcregionswitch.PlanTrigger[] | undefined>;
/**
* The version for the plan.
*/
readonly version: pulumi.Output<string>;
/**
* The workflows for a plan.
*/
readonly workflows: pulumi.Output<outputs.arcregionswitch.PlanWorkflow[]>;
/**
* Create a Plan 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: PlanArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a Plan resource.
*/
export interface PlanArgs {
/**
* The associated application health alarms for a plan.
*/
associatedAlarms?: pulumi.Input<{
[key: string]: pulumi.Input<inputs.arcregionswitch.PlanAssociatedAlarmArgs>;
}>;
/**
* The description for a plan.
*/
description?: pulumi.Input<string>;
/**
* The execution role for a plan.
*/
executionRole: pulumi.Input<string>;
/**
* The name for a plan.
*/
name?: pulumi.Input<string>;
/**
* The primary Region for a plan.
*/
primaryRegion?: pulumi.Input<string>;
/**
* The recovery approach for a Region switch plan, which can be active/active (activeActive) or active/passive (activePassive).
*/
recoveryApproach: pulumi.Input<enums.arcregionswitch.PlanRecoveryApproach>;
/**
* The recovery time objective for a plan.
*/
recoveryTimeObjectiveMinutes?: pulumi.Input<number>;
/**
* The AWS Regions for a plan.
*/
regions: pulumi.Input<pulumi.Input<string>[]>;
/**
* The report configuration for a plan.
*/
reportConfiguration?: pulumi.Input<inputs.arcregionswitch.PlanReportConfigurationArgs>;
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* The triggers for a plan.
*/
triggers?: pulumi.Input<pulumi.Input<inputs.arcregionswitch.PlanTriggerArgs>[]>;
/**
* The workflows for a plan.
*/
workflows: pulumi.Input<pulumi.Input<inputs.arcregionswitch.PlanWorkflowArgs>[]>;
}