Module deploymentmanager
This page documents the language specification for the gcp package. If you're looking for help working with the inputs, outputs, or functions of gcp resources in a Pulumi program, please see the resource documentation for examples and API reference.
Resources
Others
Resources
Resource Deployment
class Deployment extends CustomResourceA 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
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
import * from "fs";
const deployment = new gcp.deploymentmanager.Deployment("deployment", {
target: {
config: {
content: fs.readFileSync("path/to/config.yml"),
},
},
labels: [{
key: "foo",
value: "bar",
}],
});constructor
new Deployment(name: string, args: DeploymentArgs, opts?: pulumi.CustomResourceOptions)Create a Deployment resource with the given unique name, arguments, and options.
nameThe unique name of the resource.argsThe arguments to use to populate this resource's properties.optsA bag of options that control this resource's behavior.
method get
public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: DeploymentState, opts?: pulumi.CustomResourceOptions): DeploymentGet an existing Deployment resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
method getProvider
getProvider(moduleMember: string): ProviderResource | undefinedmethod isInstance
public static isInstance(obj: any): obj is DeploymentReturns true if the given object is an instance of Deployment. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.
property createPolicy
public createPolicy: pulumi.Output<string | undefined>;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.
property deletePolicy
public deletePolicy: pulumi.Output<string | undefined>;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.
property deploymentId
public deploymentId: pulumi.Output<string>;Unique identifier for deployment. Output only.
property description
public description: pulumi.Output<string | undefined>;Optional user-provided description of deployment.
property id
id: Output<ID>;id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.
property labels
public labels: pulumi.Output<DeploymentLabel[] | undefined>;Key-value pairs to apply to this labels. Structure is documented below.
property manifest
public manifest: pulumi.Output<string>;Output only. URL of the manifest representing the last manifest that was successfully deployed.
property name
public name: pulumi.Output<string>;The name of the template to import, as declared in the YAML configuration.
property preview
public preview: pulumi.Output<boolean | undefined>;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.
property project
public project: pulumi.Output<string>;The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
property selfLink
public selfLink: pulumi.Output<string>;Output only. Server defined URL for the resource.
property target
public target: pulumi.Output<DeploymentTarget>;Parameters that define your deployment, including the deployment configuration and relevant templates. Structure is documented below.
property urn
urn: Output<URN>;urn is the stable logical URN used to distinctly address a resource, both before and after deployments.
Others
interface DeploymentArgs
interface DeploymentArgsThe set of arguments for constructing a Deployment resource.
property createPolicy
createPolicy?: pulumi.Input<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.
property deletePolicy
deletePolicy?: pulumi.Input<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.
property description
description?: pulumi.Input<string>;Optional user-provided description of deployment.
property labels
labels?: pulumi.Input<pulumi.Input<DeploymentLabel>[]>;Key-value pairs to apply to this labels. Structure is documented below.
property name
name?: pulumi.Input<string>;The name of the template to import, as declared in the YAML configuration.
property preview
preview?: pulumi.Input<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.
property project
project?: pulumi.Input<string>;The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
property target
target: pulumi.Input<DeploymentTarget>;Parameters that define your deployment, including the deployment configuration and relevant templates. Structure is documented below.
interface DeploymentState
interface DeploymentStateInput properties used for looking up and filtering Deployment resources.
property createPolicy
createPolicy?: pulumi.Input<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.
property deletePolicy
deletePolicy?: pulumi.Input<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.
property deploymentId
deploymentId?: pulumi.Input<string>;Unique identifier for deployment. Output only.
property description
description?: pulumi.Input<string>;Optional user-provided description of deployment.
property labels
labels?: pulumi.Input<pulumi.Input<DeploymentLabel>[]>;Key-value pairs to apply to this labels. Structure is documented below.
property manifest
manifest?: pulumi.Input<string>;Output only. URL of the manifest representing the last manifest that was successfully deployed.
property name
name?: pulumi.Input<string>;The name of the template to import, as declared in the YAML configuration.
property preview
preview?: pulumi.Input<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.
property project
project?: pulumi.Input<string>;The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
property selfLink
selfLink?: pulumi.Input<string>;Output only. Server defined URL for the resource.
property target
target?: pulumi.Input<DeploymentTarget>;Parameters that define your deployment, including the deployment configuration and relevant templates. Structure is documented below.