Deployment

A collection of resources that are deployed and managed together using a configuration file

Warning: This resource is intended only to manage a Deployment resource, and attempts to manage the Deployment’s resources in the provider as well will likely result in errors or unexpected behavior as the two tools fight over ownership. We strongly discourage doing so unless you are an experienced user of both tools.

In addition, due to limitations of the API, the provider will treat deployments in preview as recreate-only for any update operation other than actually deploying an in-preview deployment (i.e. preview=true to preview=false).

Example Usage

Deployment Manager Deployment Basic

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

return await Deployment.RunAsync(() => 
{
    var deployment = new Gcp.DeploymentManager.Deployment("deployment", new()
    {
        Target = new Gcp.DeploymentManager.Inputs.DeploymentTargetArgs
        {
            Config = new Gcp.DeploymentManager.Inputs.DeploymentTargetConfigArgs
            {
                Content = File.ReadAllText("path/to/config.yml"),
            },
        },
        Labels = new[]
        {
            new Gcp.DeploymentManager.Inputs.DeploymentLabelArgs
            {
                Key = "foo",
                Value = "bar",
            },
        },
    });

});
package main

import (
	"io/ioutil"

	"github.com/pulumi/pulumi-gcp/sdk/v6/go/gcp/deploymentmanager"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func readFileOrPanic(path string) pulumi.StringPtrInput {
	data, err := ioutil.ReadFile(path)
	if err != nil {
		panic(err.Error())
	}
	return pulumi.String(string(data))
}

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := deploymentmanager.NewDeployment(ctx, "deployment", &deploymentmanager.DeploymentArgs{
			Target: &deploymentmanager.DeploymentTargetArgs{
				Config: &deploymentmanager.DeploymentTargetConfigArgs{
					Content: readFileOrPanic("path/to/config.yml"),
				},
			},
			Labels: deploymentmanager.DeploymentLabelArray{
				&deploymentmanager.DeploymentLabelArgs{
					Key:   pulumi.String("foo"),
					Value: pulumi.String("bar"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.deploymentmanager.Deployment;
import com.pulumi.gcp.deploymentmanager.DeploymentArgs;
import com.pulumi.gcp.deploymentmanager.inputs.DeploymentTargetArgs;
import com.pulumi.gcp.deploymentmanager.inputs.DeploymentTargetConfigArgs;
import com.pulumi.gcp.deploymentmanager.inputs.DeploymentLabelArgs;
import java.util.List;
import java.util.ArrayList;
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 deployment = new Deployment("deployment", DeploymentArgs.builder()        
            .target(DeploymentTargetArgs.builder()
                .config(DeploymentTargetConfigArgs.builder()
                    .content(Files.readString(Paths.get("path/to/config.yml")))
                    .build())
                .build())
            .labels(DeploymentLabelArgs.builder()
                .key("foo")
                .value("bar")
                .build())
            .build());

    }
}
import pulumi
import pulumi_gcp as gcp

deployment = gcp.deploymentmanager.Deployment("deployment",
    target=gcp.deploymentmanager.DeploymentTargetArgs(
        config=gcp.deploymentmanager.DeploymentTargetConfigArgs(
            content=(lambda path: open(path).read())("path/to/config.yml"),
        ),
    ),
    labels=[gcp.deploymentmanager.DeploymentLabelArgs(
        key="foo",
        value="bar",
    )])
import * as pulumi from "@pulumi/pulumi";
import * as fs from "fs";
import * as gcp from "@pulumi/gcp";

const deployment = new gcp.deploymentmanager.Deployment("deployment", {
    target: {
        config: {
            content: fs.readFileSync("path/to/config.yml"),
        },
    },
    labels: [{
        key: "foo",
        value: "bar",
    }],
});
resources:
  deployment:
    type: gcp:deploymentmanager:Deployment
    properties:
      target:
        config:
          content:
            fn::readFile: path/to/config.yml
      labels:
        - key: foo
          value: bar

Create Deployment Resource

new Deployment(name: string, args: DeploymentArgs, opts?: CustomResourceOptions);
@overload
def Deployment(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               create_policy: Optional[str] = None,
               delete_policy: Optional[str] = None,
               description: Optional[str] = None,
               labels: Optional[Sequence[DeploymentLabelArgs]] = None,
               name: Optional[str] = None,
               preview: Optional[bool] = None,
               project: Optional[str] = None,
               target: Optional[DeploymentTargetArgs] = None)
@overload
def Deployment(resource_name: str,
               args: DeploymentArgs,
               opts: Optional[ResourceOptions] = None)
func NewDeployment(ctx *Context, name string, args DeploymentArgs, opts ...ResourceOption) (*Deployment, error)
public Deployment(string name, DeploymentArgs args, CustomResourceOptions? opts = null)
public Deployment(String name, DeploymentArgs args)
public Deployment(String name, DeploymentArgs args, CustomResourceOptions options)
type: gcp:deploymentmanager:Deployment
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args DeploymentArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args DeploymentArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args DeploymentArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args DeploymentArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args DeploymentArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Deployment Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The Deployment resource accepts the following input properties:

Target DeploymentTargetArgs

Parameters that define your deployment, including the deployment configuration and relevant templates. Structure is documented below.

CreatePolicy string

Set the policy to use for creating new resources. Only used on create and update. Valid values are CREATE_OR_ACQUIRE (default) or ACQUIRE. If set to ACQUIRE and resources do not already exist, the deployment will fail. Note that updating this field does not actually affect the deployment, just how it is updated. Default value is CREATE_OR_ACQUIRE. Possible values are ACQUIRE and CREATE_OR_ACQUIRE.

DeletePolicy string

Set the policy to use for deleting new resources on update/delete. Valid values are DELETE (default) or ABANDON. If DELETE, resource is deleted after removal from Deployment Manager. If ABANDON, the resource is only removed from Deployment Manager and is not actually deleted. Note that updating this field does not actually change the deployment, just how it is updated. Default value is DELETE. Possible values are ABANDON and DELETE.

Description string

Optional user-provided description of deployment.

Labels List<DeploymentLabelArgs>

Key-value pairs to apply to this labels. Structure is documented below.

Name string

The name of the template to import, as declared in the YAML configuration.

Preview bool

If set to true, a deployment is created with "shell" resources that are not actually instantiated. This allows you to preview a deployment. It can be updated to false to actually deploy with real resources. ~>NOTE: Deployment Manager does not allow update of a deployment in preview (unless updating to preview=false). Thus, the provider will force-recreate deployments if either preview is updated to true or if other fields are updated while preview is true.

Project string

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

Target DeploymentTargetArgs

Parameters that define your deployment, including the deployment configuration and relevant templates. Structure is documented below.

CreatePolicy string

Set the policy to use for creating new resources. Only used on create and update. Valid values are CREATE_OR_ACQUIRE (default) or ACQUIRE. If set to ACQUIRE and resources do not already exist, the deployment will fail. Note that updating this field does not actually affect the deployment, just how it is updated. Default value is CREATE_OR_ACQUIRE. Possible values are ACQUIRE and CREATE_OR_ACQUIRE.

DeletePolicy string

Set the policy to use for deleting new resources on update/delete. Valid values are DELETE (default) or ABANDON. If DELETE, resource is deleted after removal from Deployment Manager. If ABANDON, the resource is only removed from Deployment Manager and is not actually deleted. Note that updating this field does not actually change the deployment, just how it is updated. Default value is DELETE. Possible values are ABANDON and DELETE.

Description string

Optional user-provided description of deployment.

Labels []DeploymentLabelArgs

Key-value pairs to apply to this labels. Structure is documented below.

Name string

The name of the template to import, as declared in the YAML configuration.

Preview bool

If set to true, a deployment is created with "shell" resources that are not actually instantiated. This allows you to preview a deployment. It can be updated to false to actually deploy with real resources. ~>NOTE: Deployment Manager does not allow update of a deployment in preview (unless updating to preview=false). Thus, the provider will force-recreate deployments if either preview is updated to true or if other fields are updated while preview is true.

Project string

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

target DeploymentTargetArgs

Parameters that define your deployment, including the deployment configuration and relevant templates. Structure is documented below.

createPolicy String

Set the policy to use for creating new resources. Only used on create and update. Valid values are CREATE_OR_ACQUIRE (default) or ACQUIRE. If set to ACQUIRE and resources do not already exist, the deployment will fail. Note that updating this field does not actually affect the deployment, just how it is updated. Default value is CREATE_OR_ACQUIRE. Possible values are ACQUIRE and CREATE_OR_ACQUIRE.

deletePolicy String

Set the policy to use for deleting new resources on update/delete. Valid values are DELETE (default) or ABANDON. If DELETE, resource is deleted after removal from Deployment Manager. If ABANDON, the resource is only removed from Deployment Manager and is not actually deleted. Note that updating this field does not actually change the deployment, just how it is updated. Default value is DELETE. Possible values are ABANDON and DELETE.

description String

Optional user-provided description of deployment.

labels List<DeploymentLabelArgs>

Key-value pairs to apply to this labels. Structure is documented below.

name String

The name of the template to import, as declared in the YAML configuration.

preview Boolean

If set to true, a deployment is created with "shell" resources that are not actually instantiated. This allows you to preview a deployment. It can be updated to false to actually deploy with real resources. ~>NOTE: Deployment Manager does not allow update of a deployment in preview (unless updating to preview=false). Thus, the provider will force-recreate deployments if either preview is updated to true or if other fields are updated while preview is true.

project String

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

target DeploymentTargetArgs

Parameters that define your deployment, including the deployment configuration and relevant templates. Structure is documented below.

createPolicy string

Set the policy to use for creating new resources. Only used on create and update. Valid values are CREATE_OR_ACQUIRE (default) or ACQUIRE. If set to ACQUIRE and resources do not already exist, the deployment will fail. Note that updating this field does not actually affect the deployment, just how it is updated. Default value is CREATE_OR_ACQUIRE. Possible values are ACQUIRE and CREATE_OR_ACQUIRE.

deletePolicy string

Set the policy to use for deleting new resources on update/delete. Valid values are DELETE (default) or ABANDON. If DELETE, resource is deleted after removal from Deployment Manager. If ABANDON, the resource is only removed from Deployment Manager and is not actually deleted. Note that updating this field does not actually change the deployment, just how it is updated. Default value is DELETE. Possible values are ABANDON and DELETE.

description string

Optional user-provided description of deployment.

labels DeploymentLabelArgs[]

Key-value pairs to apply to this labels. Structure is documented below.

name string

The name of the template to import, as declared in the YAML configuration.

preview boolean

If set to true, a deployment is created with "shell" resources that are not actually instantiated. This allows you to preview a deployment. It can be updated to false to actually deploy with real resources. ~>NOTE: Deployment Manager does not allow update of a deployment in preview (unless updating to preview=false). Thus, the provider will force-recreate deployments if either preview is updated to true or if other fields are updated while preview is true.

project string

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

target DeploymentTargetArgs

Parameters that define your deployment, including the deployment configuration and relevant templates. Structure is documented below.

create_policy str

Set the policy to use for creating new resources. Only used on create and update. Valid values are CREATE_OR_ACQUIRE (default) or ACQUIRE. If set to ACQUIRE and resources do not already exist, the deployment will fail. Note that updating this field does not actually affect the deployment, just how it is updated. Default value is CREATE_OR_ACQUIRE. Possible values are ACQUIRE and CREATE_OR_ACQUIRE.

delete_policy str

Set the policy to use for deleting new resources on update/delete. Valid values are DELETE (default) or ABANDON. If DELETE, resource is deleted after removal from Deployment Manager. If ABANDON, the resource is only removed from Deployment Manager and is not actually deleted. Note that updating this field does not actually change the deployment, just how it is updated. Default value is DELETE. Possible values are ABANDON and DELETE.

description str

Optional user-provided description of deployment.

labels Sequence[DeploymentLabelArgs]

Key-value pairs to apply to this labels. Structure is documented below.

name str

The name of the template to import, as declared in the YAML configuration.

preview bool

If set to true, a deployment is created with "shell" resources that are not actually instantiated. This allows you to preview a deployment. It can be updated to false to actually deploy with real resources. ~>NOTE: Deployment Manager does not allow update of a deployment in preview (unless updating to preview=false). Thus, the provider will force-recreate deployments if either preview is updated to true or if other fields are updated while preview is true.

project str

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

target Property Map

Parameters that define your deployment, including the deployment configuration and relevant templates. Structure is documented below.

createPolicy String

Set the policy to use for creating new resources. Only used on create and update. Valid values are CREATE_OR_ACQUIRE (default) or ACQUIRE. If set to ACQUIRE and resources do not already exist, the deployment will fail. Note that updating this field does not actually affect the deployment, just how it is updated. Default value is CREATE_OR_ACQUIRE. Possible values are ACQUIRE and CREATE_OR_ACQUIRE.

deletePolicy String

Set the policy to use for deleting new resources on update/delete. Valid values are DELETE (default) or ABANDON. If DELETE, resource is deleted after removal from Deployment Manager. If ABANDON, the resource is only removed from Deployment Manager and is not actually deleted. Note that updating this field does not actually change the deployment, just how it is updated. Default value is DELETE. Possible values are ABANDON and DELETE.

description String

Optional user-provided description of deployment.

labels List<Property Map>

Key-value pairs to apply to this labels. Structure is documented below.

name String

The name of the template to import, as declared in the YAML configuration.

preview Boolean

If set to true, a deployment is created with "shell" resources that are not actually instantiated. This allows you to preview a deployment. It can be updated to false to actually deploy with real resources. ~>NOTE: Deployment Manager does not allow update of a deployment in preview (unless updating to preview=false). Thus, the provider will force-recreate deployments if either preview is updated to true or if other fields are updated while preview is true.

project String

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

Outputs

All input properties are implicitly available as output properties. Additionally, the Deployment resource produces the following output properties:

DeploymentId string

Unique identifier for deployment. Output only.

Id string

The provider-assigned unique ID for this managed resource.

Manifest string

Output only. URL of the manifest representing the last manifest that was successfully deployed.

SelfLink string

Output only. Server defined URL for the resource.

DeploymentId string

Unique identifier for deployment. Output only.

Id string

The provider-assigned unique ID for this managed resource.

Manifest string

Output only. URL of the manifest representing the last manifest that was successfully deployed.

SelfLink string

Output only. Server defined URL for the resource.

deploymentId String

Unique identifier for deployment. Output only.

id String

The provider-assigned unique ID for this managed resource.

manifest String

Output only. URL of the manifest representing the last manifest that was successfully deployed.

selfLink String

Output only. Server defined URL for the resource.

deploymentId string

Unique identifier for deployment. Output only.

id string

The provider-assigned unique ID for this managed resource.

manifest string

Output only. URL of the manifest representing the last manifest that was successfully deployed.

selfLink string

Output only. Server defined URL for the resource.

deployment_id str

Unique identifier for deployment. Output only.

id str

The provider-assigned unique ID for this managed resource.

manifest str

Output only. URL of the manifest representing the last manifest that was successfully deployed.

self_link str

Output only. Server defined URL for the resource.

deploymentId String

Unique identifier for deployment. Output only.

id String

The provider-assigned unique ID for this managed resource.

manifest String

Output only. URL of the manifest representing the last manifest that was successfully deployed.

selfLink String

Output only. Server defined URL for the resource.

Look up Existing Deployment Resource

Get an existing Deployment resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: DeploymentState, opts?: CustomResourceOptions): Deployment
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        create_policy: Optional[str] = None,
        delete_policy: Optional[str] = None,
        deployment_id: Optional[str] = None,
        description: Optional[str] = None,
        labels: Optional[Sequence[DeploymentLabelArgs]] = None,
        manifest: Optional[str] = None,
        name: Optional[str] = None,
        preview: Optional[bool] = None,
        project: Optional[str] = None,
        self_link: Optional[str] = None,
        target: Optional[DeploymentTargetArgs] = None) -> Deployment
func GetDeployment(ctx *Context, name string, id IDInput, state *DeploymentState, opts ...ResourceOption) (*Deployment, error)
public static Deployment Get(string name, Input<string> id, DeploymentState? state, CustomResourceOptions? opts = null)
public static Deployment get(String name, Output<String> id, DeploymentState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
CreatePolicy string

Set the policy to use for creating new resources. Only used on create and update. Valid values are CREATE_OR_ACQUIRE (default) or ACQUIRE. If set to ACQUIRE and resources do not already exist, the deployment will fail. Note that updating this field does not actually affect the deployment, just how it is updated. Default value is CREATE_OR_ACQUIRE. Possible values are ACQUIRE and CREATE_OR_ACQUIRE.

DeletePolicy string

Set the policy to use for deleting new resources on update/delete. Valid values are DELETE (default) or ABANDON. If DELETE, resource is deleted after removal from Deployment Manager. If ABANDON, the resource is only removed from Deployment Manager and is not actually deleted. Note that updating this field does not actually change the deployment, just how it is updated. Default value is DELETE. Possible values are ABANDON and DELETE.

DeploymentId string

Unique identifier for deployment. Output only.

Description string

Optional user-provided description of deployment.

Labels List<DeploymentLabelArgs>

Key-value pairs to apply to this labels. Structure is documented below.

Manifest string

Output only. URL of the manifest representing the last manifest that was successfully deployed.

Name string

The name of the template to import, as declared in the YAML configuration.

Preview bool

If set to true, a deployment is created with "shell" resources that are not actually instantiated. This allows you to preview a deployment. It can be updated to false to actually deploy with real resources. ~>NOTE: Deployment Manager does not allow update of a deployment in preview (unless updating to preview=false). Thus, the provider will force-recreate deployments if either preview is updated to true or if other fields are updated while preview is true.

Project string

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

SelfLink string

Output only. Server defined URL for the resource.

Target DeploymentTargetArgs

Parameters that define your deployment, including the deployment configuration and relevant templates. Structure is documented below.

CreatePolicy string

Set the policy to use for creating new resources. Only used on create and update. Valid values are CREATE_OR_ACQUIRE (default) or ACQUIRE. If set to ACQUIRE and resources do not already exist, the deployment will fail. Note that updating this field does not actually affect the deployment, just how it is updated. Default value is CREATE_OR_ACQUIRE. Possible values are ACQUIRE and CREATE_OR_ACQUIRE.

DeletePolicy string

Set the policy to use for deleting new resources on update/delete. Valid values are DELETE (default) or ABANDON. If DELETE, resource is deleted after removal from Deployment Manager. If ABANDON, the resource is only removed from Deployment Manager and is not actually deleted. Note that updating this field does not actually change the deployment, just how it is updated. Default value is DELETE. Possible values are ABANDON and DELETE.

DeploymentId string

Unique identifier for deployment. Output only.

Description string

Optional user-provided description of deployment.

Labels []DeploymentLabelArgs

Key-value pairs to apply to this labels. Structure is documented below.

Manifest string

Output only. URL of the manifest representing the last manifest that was successfully deployed.

Name string

The name of the template to import, as declared in the YAML configuration.

Preview bool

If set to true, a deployment is created with "shell" resources that are not actually instantiated. This allows you to preview a deployment. It can be updated to false to actually deploy with real resources. ~>NOTE: Deployment Manager does not allow update of a deployment in preview (unless updating to preview=false). Thus, the provider will force-recreate deployments if either preview is updated to true or if other fields are updated while preview is true.

Project string

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

SelfLink string

Output only. Server defined URL for the resource.

Target DeploymentTargetArgs

Parameters that define your deployment, including the deployment configuration and relevant templates. Structure is documented below.

createPolicy String

Set the policy to use for creating new resources. Only used on create and update. Valid values are CREATE_OR_ACQUIRE (default) or ACQUIRE. If set to ACQUIRE and resources do not already exist, the deployment will fail. Note that updating this field does not actually affect the deployment, just how it is updated. Default value is CREATE_OR_ACQUIRE. Possible values are ACQUIRE and CREATE_OR_ACQUIRE.

deletePolicy String

Set the policy to use for deleting new resources on update/delete. Valid values are DELETE (default) or ABANDON. If DELETE, resource is deleted after removal from Deployment Manager. If ABANDON, the resource is only removed from Deployment Manager and is not actually deleted. Note that updating this field does not actually change the deployment, just how it is updated. Default value is DELETE. Possible values are ABANDON and DELETE.

deploymentId String

Unique identifier for deployment. Output only.

description String

Optional user-provided description of deployment.

labels List<DeploymentLabelArgs>

Key-value pairs to apply to this labels. Structure is documented below.

manifest String

Output only. URL of the manifest representing the last manifest that was successfully deployed.

name String

The name of the template to import, as declared in the YAML configuration.

preview Boolean

If set to true, a deployment is created with "shell" resources that are not actually instantiated. This allows you to preview a deployment. It can be updated to false to actually deploy with real resources. ~>NOTE: Deployment Manager does not allow update of a deployment in preview (unless updating to preview=false). Thus, the provider will force-recreate deployments if either preview is updated to true or if other fields are updated while preview is true.

project String

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

selfLink String

Output only. Server defined URL for the resource.

target DeploymentTargetArgs

Parameters that define your deployment, including the deployment configuration and relevant templates. Structure is documented below.

createPolicy string

Set the policy to use for creating new resources. Only used on create and update. Valid values are CREATE_OR_ACQUIRE (default) or ACQUIRE. If set to ACQUIRE and resources do not already exist, the deployment will fail. Note that updating this field does not actually affect the deployment, just how it is updated. Default value is CREATE_OR_ACQUIRE. Possible values are ACQUIRE and CREATE_OR_ACQUIRE.

deletePolicy string

Set the policy to use for deleting new resources on update/delete. Valid values are DELETE (default) or ABANDON. If DELETE, resource is deleted after removal from Deployment Manager. If ABANDON, the resource is only removed from Deployment Manager and is not actually deleted. Note that updating this field does not actually change the deployment, just how it is updated. Default value is DELETE. Possible values are ABANDON and DELETE.

deploymentId string

Unique identifier for deployment. Output only.

description string

Optional user-provided description of deployment.

labels DeploymentLabelArgs[]

Key-value pairs to apply to this labels. Structure is documented below.

manifest string

Output only. URL of the manifest representing the last manifest that was successfully deployed.

name string

The name of the template to import, as declared in the YAML configuration.

preview boolean

If set to true, a deployment is created with "shell" resources that are not actually instantiated. This allows you to preview a deployment. It can be updated to false to actually deploy with real resources. ~>NOTE: Deployment Manager does not allow update of a deployment in preview (unless updating to preview=false). Thus, the provider will force-recreate deployments if either preview is updated to true or if other fields are updated while preview is true.

project string

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

selfLink string

Output only. Server defined URL for the resource.

target DeploymentTargetArgs

Parameters that define your deployment, including the deployment configuration and relevant templates. Structure is documented below.

create_policy str

Set the policy to use for creating new resources. Only used on create and update. Valid values are CREATE_OR_ACQUIRE (default) or ACQUIRE. If set to ACQUIRE and resources do not already exist, the deployment will fail. Note that updating this field does not actually affect the deployment, just how it is updated. Default value is CREATE_OR_ACQUIRE. Possible values are ACQUIRE and CREATE_OR_ACQUIRE.

delete_policy str

Set the policy to use for deleting new resources on update/delete. Valid values are DELETE (default) or ABANDON. If DELETE, resource is deleted after removal from Deployment Manager. If ABANDON, the resource is only removed from Deployment Manager and is not actually deleted. Note that updating this field does not actually change the deployment, just how it is updated. Default value is DELETE. Possible values are ABANDON and DELETE.

deployment_id str

Unique identifier for deployment. Output only.

description str

Optional user-provided description of deployment.

labels Sequence[DeploymentLabelArgs]

Key-value pairs to apply to this labels. Structure is documented below.

manifest str

Output only. URL of the manifest representing the last manifest that was successfully deployed.

name str

The name of the template to import, as declared in the YAML configuration.

preview bool

If set to true, a deployment is created with "shell" resources that are not actually instantiated. This allows you to preview a deployment. It can be updated to false to actually deploy with real resources. ~>NOTE: Deployment Manager does not allow update of a deployment in preview (unless updating to preview=false). Thus, the provider will force-recreate deployments if either preview is updated to true or if other fields are updated while preview is true.

project str

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

self_link str

Output only. Server defined URL for the resource.

target DeploymentTargetArgs

Parameters that define your deployment, including the deployment configuration and relevant templates. Structure is documented below.

createPolicy String

Set the policy to use for creating new resources. Only used on create and update. Valid values are CREATE_OR_ACQUIRE (default) or ACQUIRE. If set to ACQUIRE and resources do not already exist, the deployment will fail. Note that updating this field does not actually affect the deployment, just how it is updated. Default value is CREATE_OR_ACQUIRE. Possible values are ACQUIRE and CREATE_OR_ACQUIRE.

deletePolicy String

Set the policy to use for deleting new resources on update/delete. Valid values are DELETE (default) or ABANDON. If DELETE, resource is deleted after removal from Deployment Manager. If ABANDON, the resource is only removed from Deployment Manager and is not actually deleted. Note that updating this field does not actually change the deployment, just how it is updated. Default value is DELETE. Possible values are ABANDON and DELETE.

deploymentId String

Unique identifier for deployment. Output only.

description String

Optional user-provided description of deployment.

labels List<Property Map>

Key-value pairs to apply to this labels. Structure is documented below.

manifest String

Output only. URL of the manifest representing the last manifest that was successfully deployed.

name String

The name of the template to import, as declared in the YAML configuration.

preview Boolean

If set to true, a deployment is created with "shell" resources that are not actually instantiated. This allows you to preview a deployment. It can be updated to false to actually deploy with real resources. ~>NOTE: Deployment Manager does not allow update of a deployment in preview (unless updating to preview=false). Thus, the provider will force-recreate deployments if either preview is updated to true or if other fields are updated while preview is true.

project String

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

selfLink String

Output only. Server defined URL for the resource.

target Property Map

Parameters that define your deployment, including the deployment configuration and relevant templates. Structure is documented below.

Supporting Types

DeploymentLabel

Key string

Key for label.

Value string

Value of label.

Key string

Key for label.

Value string

Value of label.

key String

Key for label.

value String

Value of label.

key string

Key for label.

value string

Value of label.

key str

Key for label.

value str

Value of label.

key String

Key for label.

value String

Value of label.

DeploymentTarget

Config DeploymentTargetConfig

The root configuration file to use for this deployment. Structure is documented below.

Imports List<DeploymentTargetImport>

Specifies import files for this configuration. This can be used to import templates or other files. For example, you might import a text file in order to use the file in a template. Structure is documented below.

Config DeploymentTargetConfig

The root configuration file to use for this deployment. Structure is documented below.

Imports []DeploymentTargetImport

Specifies import files for this configuration. This can be used to import templates or other files. For example, you might import a text file in order to use the file in a template. Structure is documented below.

config DeploymentTargetConfig

The root configuration file to use for this deployment. Structure is documented below.

imports List<DeploymentTargetImport>

Specifies import files for this configuration. This can be used to import templates or other files. For example, you might import a text file in order to use the file in a template. Structure is documented below.

config DeploymentTargetConfig

The root configuration file to use for this deployment. Structure is documented below.

imports DeploymentTargetImport[]

Specifies import files for this configuration. This can be used to import templates or other files. For example, you might import a text file in order to use the file in a template. Structure is documented below.

config DeploymentTargetConfig

The root configuration file to use for this deployment. Structure is documented below.

imports Sequence[DeploymentTargetImport]

Specifies import files for this configuration. This can be used to import templates or other files. For example, you might import a text file in order to use the file in a template. Structure is documented below.

config Property Map

The root configuration file to use for this deployment. Structure is documented below.

imports List<Property Map>

Specifies import files for this configuration. This can be used to import templates or other files. For example, you might import a text file in order to use the file in a template. Structure is documented below.

DeploymentTargetConfig

Content string

The full contents of the template that you want to import.

Content string

The full contents of the template that you want to import.

content String

The full contents of the template that you want to import.

content string

The full contents of the template that you want to import.

content str

The full contents of the template that you want to import.

content String

The full contents of the template that you want to import.

DeploymentTargetImport

Content string

The full contents of the template that you want to import.

Name string

The name of the template to import, as declared in the YAML configuration.

Content string

The full contents of the template that you want to import.

Name string

The name of the template to import, as declared in the YAML configuration.

content String

The full contents of the template that you want to import.

name String

The name of the template to import, as declared in the YAML configuration.

content string

The full contents of the template that you want to import.

name string

The name of the template to import, as declared in the YAML configuration.

content str

The full contents of the template that you want to import.

name str

The name of the template to import, as declared in the YAML configuration.

content String

The full contents of the template that you want to import.

name String

The name of the template to import, as declared in the YAML configuration.

Import

Deployment can be imported using any of these accepted formats

 $ pulumi import gcp:deploymentmanager/deployment:Deployment default projects/{{project}}/deployments/{{name}}
 $ pulumi import gcp:deploymentmanager/deployment:Deployment default {{project}}/{{name}}
 $ pulumi import gcp:deploymentmanager/deployment:Deployment default {{name}}

Package Details

Repository
https://github.com/pulumi/pulumi-gcp
License
Apache-2.0
Notes

This Pulumi package is based on the google-beta Terraform Provider.