RolloutPlan class

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.

To get more information about RolloutPlan, see:

API documentation

Example Usage

Rollout Plan Basic

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const _default = new gcp.compute.RolloutPlan("default", {
    name: "tf-test-rollout-plan-_91980",
    description: "A test rollout plan",
    locationScope: "ZONAL",
    waves: [{
        displayName: "wave-1",
        selectors: [{
            locationSelector: {
                includedLocations: ["us-central1-a"],
            },
        }],
        validation: {
            type: "manual",
        },
    }],
});

import pulumi
import pulumi_gcp as gcp

default = gcp.compute.RolloutPlan("default",
    name="tf-test-rollout-plan-_91980",
    description="A test rollout plan",
    location_scope="ZONAL",
    waves=[{
        "display_name": "wave-1",
        "selectors": [{
            "location_selector": {
                "included_locations": ["us-central1-a"],
            },
        }],
        "validation": {
            "type": "manual",
        },
    }])

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() =>
{
    var @default = new Gcp.Compute.RolloutPlan("default", new()
    {
        Name = "tf-test-rollout-plan-_91980",
        Description = "A test rollout plan",
        LocationScope = "ZONAL",
        Waves = new[]
        {
            new Gcp.Compute.Inputs.RolloutPlanWaveArgs
            {
                DisplayName = "wave-1",
                Selectors = new[]
                {
                    new Gcp.Compute.Inputs.RolloutPlanWaveSelectorArgs
                    {
                        LocationSelector = new Gcp.Compute.Inputs.RolloutPlanWaveSelectorLocationSelectorArgs
                        {
                            IncludedLocations = new[]
                            {
                                "us-central1-a",
                            },
                        },
                    },
                },
                Validation = new Gcp.Compute.Inputs.RolloutPlanWaveValidationArgs
                {
                    Type = "manual",
                },
            },
        },
    });

});

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/compute"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := compute.NewRolloutPlan(ctx, "default", &compute.RolloutPlanArgs{
			Name:          pulumi.String("tf-test-rollout-plan-_91980"),
			Description:   pulumi.String("A test rollout plan"),
			LocationScope: pulumi.String("ZONAL"),
			Waves: compute.RolloutPlanWaveArray{
				&compute.RolloutPlanWaveArgs{
					DisplayName: pulumi.String("wave-1"),
					Selectors: compute.RolloutPlanWaveSelectorArray{
						&compute.RolloutPlanWaveSelectorArgs{
							LocationSelector: &compute.RolloutPlanWaveSelectorLocationSelectorArgs{
								IncludedLocations: pulumi.StringArray{
									pulumi.String("us-central1-a"),
								},
							},
						},
					},
					Validation: &compute.RolloutPlanWaveValidationArgs{
						Type: pulumi.String("manual"),
					},
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

resource "gcp_compute_rolloutplan" "default" {
  name           = "tf-test-rollout-plan-_91980"
  description    = "A test rollout plan"
  location_scope = "ZONAL"
  waves {
    display_name = "wave-1"
    selectors {
      location_selector = {
        included_locations = ["us-central1-a"]
      }
    }
    validation = {
      type = "manual"
    }
  }
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.compute.RolloutPlan;
import com.pulumi.gcp.compute.RolloutPlanArgs;
import com.pulumi.gcp.compute.inputs.RolloutPlanWaveArgs;
import com.pulumi.gcp.compute.inputs.RolloutPlanWaveSelectorArgs;
import com.pulumi.gcp.compute.inputs.RolloutPlanWaveSelectorLocationSelectorArgs;
import com.pulumi.gcp.compute.inputs.RolloutPlanWaveValidationArgs;
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 default_ = new RolloutPlan("default", RolloutPlanArgs.builder()
            .name("tf-test-rollout-plan-_91980")
            .description("A test rollout plan")
            .locationScope("ZONAL")
            .waves(RolloutPlanWaveArgs.builder()
                .displayName("wave-1")
                .selectors(RolloutPlanWaveSelectorArgs.builder()
                    .locationSelector(RolloutPlanWaveSelectorLocationSelectorArgs.builder()
                        .includedLocations("us-central1-a")
                        .build())
                    .build())
                .validation(RolloutPlanWaveValidationArgs.builder()
                    .type("manual")
                    .build())
                .build())
            .build());

    }
}

resources:
  default:
    type: gcp:compute:RolloutPlan
    properties:
      name: tf-test-rollout-plan-_91980
      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:

$ 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}}

Constructors

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

Properties

childResources → Set<Resource>: finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>: latefinalinherited
deletionPolicy ↔ Output<String>: Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.
latefinal
description ↔ Output<String?>: An optional description of this resource.
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
locationScope ↔ Output<String?>: The location scope of the rollout plan. Possible values are: LOCATION_SCOPE_UNSPECIFIED, ZONAL, REGIONAL.
latefinal
name ↔ Output<String>: 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.
latefinal
project ↔ Output<String>: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
latefinal
resourceTransforms → List<ResourceTransform>: Inherited/explicit async transforms.
no setterinherited
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
selfLink ↔ Output<String>: The URI of the created resource.
latefinal
transformations → List<ResourceTransformation>: Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>: latefinalinherited
waves ↔ Output<List<RolloutPlanWave>>: The waves included in this rollout plan. Structure is documented below.
latefinal

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, {RolloutPlanState? state, CustomResourceOptions? options}) → RolloutPlan: Gets an existing RolloutPlan resource's state with the given name and id.