@pulumi/gcp/configdeployment/deployment.d.ts

A Pulumi package for creating and managing Google Cloud Platform resources.

import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
 * A group of Google Cloud resources described by a Terraform blueprint.
 *
 * To get more information about Deployment, see:
 *
 * * [API documentation](https://cloud.google.com/infrastructure-manager/docs/reference/rest/v1/projects.locations.deployments)
 *
 * ## Example Usage
 *
 * ### Config Deployment Basic
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as gcp from "@pulumi/gcp";
 *
 * const _default = new gcp.configdeployment.Deployment("default", {
 *     name: "my-deployment",
 *     location: "us-central1",
 *     serviceAccount: "projects/<no value>/serviceAccounts/my-service-account@my-project.iam.gserviceaccount.com",
 *     terraformBlueprint: {
 *         gitSource: {
 *             repo: "https://github.com/terraform-google-modules/terraform-google-network",
 *             directory: "modules/vpc",
 *             ref: "main",
 *         },
 *         inputValues: [
 *             {
 *                 variableName: "project_id",
 *                 inputValue: "<no value>",
 *             },
 *             {
 *                 variableName: "network_name",
 *                 inputValue: "my-network",
 *             },
 *         ],
 *     },
 * });
 * ```
 *
 * ## Import
 *
 * Deployment can be imported using any of these accepted formats:
 *
 * * `projects/{{project}}/locations/{{location}}/deployments/{{name}}`
 * * `{{project}}/{{location}}/{{name}}`
 * * `{{location}}/{{name}}`
 *
 * When using the `pulumi import` command, Deployment can be imported using one of the formats above. For example:
 *
 * ```sh
 * $ pulumi import gcp:configdeployment/deployment:Deployment default projects/{{project}}/locations/{{location}}/deployments/{{name}}
 * $ pulumi import gcp:configdeployment/deployment:Deployment default {{project}}/{{location}}/{{name}}
 * $ pulumi import gcp:configdeployment/deployment:Deployment default {{location}}/{{name}}
 * ```
 */
export declare class Deployment extends pulumi.CustomResource {
    /**
     * Get an existing Deployment 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<pulumi.ID>, state?: DeploymentState, opts?: pulumi.CustomResourceOptions): Deployment;
    /**
     * Returns 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.
     */
    static isInstance(obj: any): obj is Deployment;
    /**
     * Optional. Arbitrary key-value metadata storage.
     * **Note**: This field is non-authoritative, and will only manage the annotations present in your configuration.
     * Please refer to the field `effectiveAnnotations` for all of the annotations present on the resource.
     */
    readonly annotations: pulumi.Output<{
        [key: string]: string;
    } | undefined>;
    /**
     * Location for Cloud Build logs and artifacts.
     */
    readonly artifactsGcsBucket: pulumi.Output<string | undefined>;
    /**
     * 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.
     */
    readonly deletionPolicy: pulumi.Output<string>;
    /**
     * All of annotations (key/value pairs) present on the resource in GCP, including the annotations configured through Terraform, other clients and services.
     */
    readonly effectiveAnnotations: pulumi.Output<{
        [key: string]: string;
    }>;
    /**
     * All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
     */
    readonly effectiveLabels: pulumi.Output<{
        [key: string]: string;
    }>;
    /**
     * If true, deletes the deployment and its nested resources.
     */
    readonly forceDestroy: pulumi.Output<boolean | undefined>;
    /**
     * If true, attempts to automatically import resources on 409 conflict.
     */
    readonly importExistingResources: pulumi.Output<boolean | undefined>;
    /**
     * Optional. User-defined metadata for the deployment.
     * **Note**: This field is non-authoritative, and will only manage the labels present in your configuration.
     * Please refer to the field `effectiveLabels` for all of the labels present on the resource.
     */
    readonly labels: pulumi.Output<{
        [key: string]: string;
    } | undefined>;
    /**
     * Output only. Revision name most recently applied.
     */
    readonly latestRevision: pulumi.Output<string>;
    /**
     * The location for the resource
     */
    readonly location: pulumi.Output<string>;
    /**
     * The user-specified ID of the deployment.
     */
    readonly name: pulumi.Output<string>;
    /**
     * The ID of the project in which the resource belongs.
     * If it is not provided, the provider project is used.
     */
    readonly project: pulumi.Output<string>;
    /**
     * The combination of labels configured directly on the resource
     *  and default labels configured on the provider.
     */
    readonly pulumiLabels: pulumi.Output<{
        [key: string]: string;
    }>;
    /**
     * Controls quota checks.
     * Possible values are: `ENABLED`, `ENFORCED`.
     */
    readonly quotaValidation: pulumi.Output<string | undefined>;
    /**
     * Required. User-specified Service Account (SA) credentials to be used when actuating resources.
     */
    readonly serviceAccount: pulumi.Output<string>;
    /**
     * Output only. Current state of the deployment.
     */
    readonly state: pulumi.Output<string>;
    /**
     * A bundle of HCL files in a GCS bucket or Git repo.
     * Structure is documented below.
     */
    readonly terraformBlueprint: pulumi.Output<outputs.configdeployment.DeploymentTerraformBlueprint>;
    /**
     * Optional constraint on the Terraform version.
     */
    readonly tfVersionConstraint: pulumi.Output<string | undefined>;
    /**
     * Custom Cloud Build worker pool resource name.
     */
    readonly workerPool: pulumi.Output<string | undefined>;
    /**
     * Create a Deployment 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: DeploymentArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering Deployment resources.
 */
export interface DeploymentState {
    /**
     * Optional. Arbitrary key-value metadata storage.
     * **Note**: This field is non-authoritative, and will only manage the annotations present in your configuration.
     * Please refer to the field `effectiveAnnotations` for all of the annotations present on the resource.
     */
    annotations?: pulumi.Input<{
        [key: string]: pulumi.Input<string>;
    } | undefined>;
    /**
     * Location for Cloud Build logs and artifacts.
     */
    artifactsGcsBucket?: pulumi.Input<string | undefined>;
    /**
     * 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.
     */
    deletionPolicy?: pulumi.Input<string | undefined>;
    /**
     * All of annotations (key/value pairs) present on the resource in GCP, including the annotations configured through Terraform, other clients and services.
     */
    effectiveAnnotations?: pulumi.Input<{
        [key: string]: pulumi.Input<string>;
    } | undefined>;
    /**
     * All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
     */
    effectiveLabels?: pulumi.Input<{
        [key: string]: pulumi.Input<string>;
    } | undefined>;
    /**
     * If true, deletes the deployment and its nested resources.
     */
    forceDestroy?: pulumi.Input<boolean | undefined>;
    /**
     * If true, attempts to automatically import resources on 409 conflict.
     */
    importExistingResources?: pulumi.Input<boolean | undefined>;
    /**
     * Optional. User-defined metadata for the deployment.
     * **Note**: This field is non-authoritative, and will only manage the labels present in your configuration.
     * Please refer to the field `effectiveLabels` for all of the labels present on the resource.
     */
    labels?: pulumi.Input<{
        [key: string]: pulumi.Input<string>;
    } | undefined>;
    /**
     * Output only. Revision name most recently applied.
     */
    latestRevision?: pulumi.Input<string | undefined>;
    /**
     * The location for the resource
     */
    location?: pulumi.Input<string | undefined>;
    /**
     * The user-specified ID of the deployment.
     */
    name?: pulumi.Input<string | undefined>;
    /**
     * The ID of the project in which the resource belongs.
     * If it is not provided, the provider project is used.
     */
    project?: pulumi.Input<string | undefined>;
    /**
     * The combination of labels configured directly on the resource
     *  and default labels configured on the provider.
     */
    pulumiLabels?: pulumi.Input<{
        [key: string]: pulumi.Input<string>;
    } | undefined>;
    /**
     * Controls quota checks.
     * Possible values are: `ENABLED`, `ENFORCED`.
     */
    quotaValidation?: pulumi.Input<string | undefined>;
    /**
     * Required. User-specified Service Account (SA) credentials to be used when actuating resources.
     */
    serviceAccount?: pulumi.Input<string | undefined>;
    /**
     * Output only. Current state of the deployment.
     */
    state?: pulumi.Input<string | undefined>;
    /**
     * A bundle of HCL files in a GCS bucket or Git repo.
     * Structure is documented below.
     */
    terraformBlueprint?: pulumi.Input<inputs.configdeployment.DeploymentTerraformBlueprint | undefined>;
    /**
     * Optional constraint on the Terraform version.
     */
    tfVersionConstraint?: pulumi.Input<string | undefined>;
    /**
     * Custom Cloud Build worker pool resource name.
     */
    workerPool?: pulumi.Input<string | undefined>;
}
/**
 * The set of arguments for constructing a Deployment resource.
 */
export interface DeploymentArgs {
    /**
     * Optional. Arbitrary key-value metadata storage.
     * **Note**: This field is non-authoritative, and will only manage the annotations present in your configuration.
     * Please refer to the field `effectiveAnnotations` for all of the annotations present on the resource.
     */
    annotations?: pulumi.Input<{
        [key: string]: pulumi.Input<string>;
    } | undefined>;
    /**
     * Location for Cloud Build logs and artifacts.
     */
    artifactsGcsBucket?: pulumi.Input<string | undefined>;
    /**
     * 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.
     */
    deletionPolicy?: pulumi.Input<string | undefined>;
    /**
     * If true, deletes the deployment and its nested resources.
     */
    forceDestroy?: pulumi.Input<boolean | undefined>;
    /**
     * If true, attempts to automatically import resources on 409 conflict.
     */
    importExistingResources?: pulumi.Input<boolean | undefined>;
    /**
     * Optional. User-defined metadata for the deployment.
     * **Note**: This field is non-authoritative, and will only manage the labels present in your configuration.
     * Please refer to the field `effectiveLabels` for all of the labels present on the resource.
     */
    labels?: pulumi.Input<{
        [key: string]: pulumi.Input<string>;
    } | undefined>;
    /**
     * The location for the resource
     */
    location: pulumi.Input<string>;
    /**
     * The user-specified ID of the deployment.
     */
    name?: pulumi.Input<string | undefined>;
    /**
     * The ID of the project in which the resource belongs.
     * If it is not provided, the provider project is used.
     */
    project?: pulumi.Input<string | undefined>;
    /**
     * Controls quota checks.
     * Possible values are: `ENABLED`, `ENFORCED`.
     */
    quotaValidation?: pulumi.Input<string | undefined>;
    /**
     * Required. User-specified Service Account (SA) credentials to be used when actuating resources.
     */
    serviceAccount: pulumi.Input<string>;
    /**
     * A bundle of HCL files in a GCS bucket or Git repo.
     * Structure is documented below.
     */
    terraformBlueprint: pulumi.Input<inputs.configdeployment.DeploymentTerraformBlueprint>;
    /**
     * Optional constraint on the Terraform version.
     */
    tfVersionConstraint?: pulumi.Input<string | undefined>;
    /**
     * Custom Cloud Build worker pool resource name.
     */
    workerPool?: pulumi.Input<string | undefined>;
}
//# sourceMappingURL=deployment.d.ts.map