import * as pulumi from "@pulumi/pulumi"; import * as inputs from "../types/input"; import * as outputs from "../types/output"; /** * A RolloutPlan is the customer-defined strategy to divide a large-scale change * into smaller increments, referred to as "waves". Each wave targets a specific * portion of the overall affected area and defines criteria that must be met * before progressing to the subsequent wave. * * > **Warning:** This resource is in beta, and should be used with the terraform-provider-google-beta provider. * See Provider Versions for more details on beta resources. * * To get more information about RolloutPlan, see: * * * [API documentation](https://cloud.google.com/compute/docs/reference/rest/beta/rolloutPlans) * * ## Example Usage * * ### Rollout Plan Basic * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const _default = new gcp.compute.RolloutPlan("default", { * name: "tf-test-rollout-plan-_52865", * description: "A test rollout plan", * locationScope: "ZONAL", * waves: [{ * displayName: "wave-1", * selectors: [{ * locationSelector: { * includedLocations: ["us-central1-a"], * }, * }], * validation: { * type: "manual", * }, * }], * }); * ``` * * ## Import * * RolloutPlan can be imported using any of these accepted formats: * * * `projects/{{project}}/global/rolloutPlans/{{name}}` * * `{{project}}/{{name}}` * * `{{name}}` * * When using the `pulumi import` command, RolloutPlan can be imported using one of the formats above. For example: * * ```sh * $ pulumi import gcp:compute/rolloutPlan:RolloutPlan default projects/{{project}}/global/rolloutPlans/{{name}} * $ pulumi import gcp:compute/rolloutPlan:RolloutPlan default {{project}}/{{name}} * $ pulumi import gcp:compute/rolloutPlan:RolloutPlan default {{name}} * ``` */ export declare class RolloutPlan extends pulumi.CustomResource { /** * Get an existing RolloutPlan 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, state?: RolloutPlanState, opts?: pulumi.CustomResourceOptions): RolloutPlan; /** * Returns true if the given object is an instance of RolloutPlan. 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 RolloutPlan; /** * An optional description of this resource. */ readonly description: pulumi.Output; /** * The location scope of the rollout plan. * Possible values are: `LOCATION_SCOPE_UNSPECIFIED`, `ZONAL`, `REGIONAL`. */ readonly locationScope: pulumi.Output; /** * Name of the resource. Provided by the client when the resource is created. * The name must be 1-63 characters long, and comply with RFC1035. */ readonly name: pulumi.Output; /** * The ID of the project in which the resource belongs. * If it is not provided, the provider project is used. */ readonly project: pulumi.Output; /** * The URI of the created resource. */ readonly selfLink: pulumi.Output; /** * The waves included in this rollout plan. * Structure is documented below. */ readonly waves: pulumi.Output; /** * Create a RolloutPlan 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: RolloutPlanArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering RolloutPlan resources. */ export interface RolloutPlanState { /** * An optional description of this resource. */ description?: pulumi.Input; /** * The location scope of the rollout plan. * Possible values are: `LOCATION_SCOPE_UNSPECIFIED`, `ZONAL`, `REGIONAL`. */ locationScope?: pulumi.Input; /** * Name of the resource. Provided by the client when the resource is created. * The name must be 1-63 characters long, and comply with RFC1035. */ name?: pulumi.Input; /** * The ID of the project in which the resource belongs. * If it is not provided, the provider project is used. */ project?: pulumi.Input; /** * The URI of the created resource. */ selfLink?: pulumi.Input; /** * The waves included in this rollout plan. * Structure is documented below. */ waves?: pulumi.Input[]>; } /** * The set of arguments for constructing a RolloutPlan resource. */ export interface RolloutPlanArgs { /** * An optional description of this resource. */ description?: pulumi.Input; /** * The location scope of the rollout plan. * Possible values are: `LOCATION_SCOPE_UNSPECIFIED`, `ZONAL`, `REGIONAL`. */ locationScope?: pulumi.Input; /** * Name of the resource. Provided by the client when the resource is created. * The name must be 1-63 characters long, and comply with RFC1035. */ name?: pulumi.Input; /** * The ID of the project in which the resource belongs. * If it is not provided, the provider project is used. */ project?: pulumi.Input; /** * The waves included in this rollout plan. * Structure is documented below. */ waves: pulumi.Input[]>; }