deploymentmanager¶

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-gcp repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-google repo.

class pulumi_gcp.deploymentmanager.Deployment(resource_name, opts=None, create_policy=None, delete_policy=None, description=None, labels=None, name=None, preview=None, project=None, target=None, __props__=None, __name__=None, __opts__=None)¶

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).

import pulumi
import pulumi_gcp as gcp

deployment = gcp.deploymentmanager.Deployment("deployment",
    target={
        "config": {
            "content": (lambda path: open(path).read())("path/to/config.yml"),
        },
    },
    labels=[{
        "key": "foo",
        "value": "bar",
    }])

Parameters

• resource_name (str) – The name of the resource.

• opts (pulumi.ResourceOptions) – Options for the resource.

• create_policy (pulumi.Input[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.

• delete_policy (pulumi.Input[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.

• description (pulumi.Input[str]) – Optional user-provided description of deployment.

• labels (pulumi.Input[list]) – Key-value pairs to apply to this labels. Structure is documented below.

• name (pulumi.Input[str]) – The name of the template to import, as declared in the YAML configuration.

• preview (pulumi.Input[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 (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

• target (pulumi.Input[dict]) – Parameters that define your deployment, including the deployment configuration and relevant templates. Structure is documented below.

The labels object supports the following:

• key (pulumi.Input[str]) - Key for label.

• value (pulumi.Input[str]) - Value of label.

The target object supports the following:

• config (pulumi.Input[dict]) - The root configuration file to use for this deployment. Structure is documented below.

  • content (pulumi.Input[str]) - The full contents of the template that you want to import.

• imports (pulumi.Input[list]) - 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.

  • content (pulumi.Input[str]) - The full contents of the template that you want to import.

  • name (pulumi.Input[str]) - The name of the template to import, as declared in the YAML configuration.

create_policy: pulumi.Output[str] = None¶

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.

delete_policy: pulumi.Output[str] = None¶

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.

deployment_id: pulumi.Output[str] = None¶

Unique identifier for deployment. Output only.

description: pulumi.Output[str] = None¶

Optional user-provided description of deployment.

labels: pulumi.Output[list] = None¶

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

• key (str) - Key for label.

• value (str) - Value of label.

manifest: pulumi.Output[str] = None¶

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

name: pulumi.Output[str] = None¶

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

preview: pulumi.Output[bool] = None¶

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: pulumi.Output[str] = None¶

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

self_link: pulumi.Output[str] = None¶

Output only. Server defined URL for the resource.

target: pulumi.Output[dict] = None¶

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

• config (dict) - The root configuration file to use for this deployment. Structure is documented below.

  • content (str) - The full contents of the template that you want to import.

• imports (list) - 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.

  • 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.

static get(resource_name, id, opts=None, create_policy=None, delete_policy=None, deployment_id=None, description=None, labels=None, manifest=None, name=None, preview=None, project=None, self_link=None, target=None)¶

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

Parameters

• resource_name (str) – The unique name of the resulting resource.

• id (str) – The unique provider ID of the resource to lookup.

• opts (pulumi.ResourceOptions) – Options for the resource.

• create_policy (pulumi.Input[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.

• delete_policy (pulumi.Input[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.

• deployment_id (pulumi.Input[str]) – Unique identifier for deployment. Output only.

• description (pulumi.Input[str]) – Optional user-provided description of deployment.

• labels (pulumi.Input[list]) – Key-value pairs to apply to this labels. Structure is documented below.

• manifest (pulumi.Input[str]) – Output only. URL of the manifest representing the last manifest that was successfully deployed.

• name (pulumi.Input[str]) – The name of the template to import, as declared in the YAML configuration.

• preview (pulumi.Input[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 (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

• self_link (pulumi.Input[str]) – Output only. Server defined URL for the resource.

• target (pulumi.Input[dict]) – Parameters that define your deployment, including the deployment configuration and relevant templates. Structure is documented below.

The labels object supports the following:

• key (pulumi.Input[str]) - Key for label.

• value (pulumi.Input[str]) - Value of label.

The target object supports the following:

• config (pulumi.Input[dict]) - The root configuration file to use for this deployment. Structure is documented below.

  • content (pulumi.Input[str]) - The full contents of the template that you want to import.

• imports (pulumi.Input[list]) - 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.

  • content (pulumi.Input[str]) - The full contents of the template that you want to import.

  • name (pulumi.Input[str]) - The name of the template to import, as declared in the YAML configuration.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str