Deployment

import type { Deployment } from "https://googleapis.deno.dev/v1/config:v1.ts";

A Deployment is a group of resources and configs managed and provisioned by Infra Manager.

interface Deployment {

annotations?: {

[key: string]: string;

};

artifactsGcsBucket?: string;

readonly createTime?: Date;

readonly deleteBuild?: string;

readonly deleteLogs?: string;

readonly deleteResults?: ApplyResults;

readonly errorCode?:

| "ERROR_CODE_UNSPECIFIED"

| "REVISION_FAILED"

| "CLOUD_BUILD_PERMISSION_DENIED"

| "DELETE_BUILD_API_FAILED"

| "DELETE_BUILD_RUN_FAILED"

| "BUCKET_CREATION_PERMISSION_DENIED"

| "BUCKET_CREATION_FAILED";

readonly errorLogs?: string;

importExistingResources?: boolean;

labels?: {

[key: string]: string;

};

readonly latestRevision?: string;

readonly lockState?:

| "LOCK_STATE_UNSPECIFIED"

| "LOCKED"

| "UNLOCKED"

| "LOCKING"

| "UNLOCKING"

| "LOCK_FAILED"

| "UNLOCK_FAILED";

name?: string;

quotaValidation?: "QUOTA_VALIDATION_UNSPECIFIED" | "ENABLED" | "ENFORCED";

serviceAccount?: string;

readonly state?:

| "STATE_UNSPECIFIED"

| "CREATING"

| "ACTIVE"

| "UPDATING"

| "DELETING"

| "FAILED"

| "SUSPENDED"

| "DELETED";

readonly stateDetail?: string;

terraformBlueprint?: TerraformBlueprint;

readonly tfErrors?: TerraformError[];

readonly tfVersion?: string;

tfVersionConstraint?: string;

readonly updateTime?: Date;

workerPool?: string;

}

§Properties

annotations?: {

[key: string]: string;

}

[src]

Optional. Arbitrary key-value metadata storage e.g. to help client tools identify deployments during automation. See https://google.aip.dev/148#annotations for details on format and size limitations.

artifactsGcsBucket?: string

[src]

Optional. User-defined location of Cloud Build logs and artifacts in Google Cloud Storage. Format: gs://{bucket}/{folder} A default bucket will be bootstrapped if the field is not set or empty. Default bucket format: gs://--blueprint-config Constraints: - The bucket needs to be in the same project as the deployment - The path cannot be within the path of gcs_source - The field cannot be updated, including changing its presence

readonly createTime?: Date

[src]

Output only. Time when the deployment was created.

readonly deleteBuild?: string

[src]

Output only. Cloud Build instance UUID associated with deleting this deployment.

readonly deleteLogs?: string

[src]

Output only. Location of Cloud Build logs in Google Cloud Storage, populated when deleting this deployment. Format: gs://{bucket}/{object}.

readonly deleteResults?: ApplyResults

[src]

Output only. Location of artifacts from a DeleteDeployment operation.

[src]

Output only. Error code describing errors that may have occurred.

readonly errorLogs?: string

[src]

Output only. Location of Terraform error logs in Google Cloud Storage. Format: gs://{bucket}/{object}.

importExistingResources?: boolean

[src]

By default, Infra Manager will return a failure when Terraform encounters a 409 code (resource conflict error) during actuation. If this flag is set to true, Infra Manager will instead attempt to automatically import the resource into the Terraform state (for supported resource types) and continue actuation. Not all resource types are supported, refer to documentation.

labels?: {

[key: string]: string;

}

[src]

User-defined metadata for the deployment.

readonly latestRevision?: string

[src]

Output only. Revision name that was most recently applied. Format: projects/{project}/locations/{location}/deployments/{deployment}/ revisions/{revision}

[src]

Output only. Current lock state of the deployment.

name?: string

[src]

Resource name of the deployment. Format: projects/{project}/locations/{location}/deployments/{deployment}

quotaValidation?: "QUOTA_VALIDATION_UNSPECIFIED" | "ENABLED" | "ENFORCED"

[src]

Optional. Input to control quota checks for resources in terraform configuration files. There are limited resources on which quota validation applies.

serviceAccount?: string

[src]

Optional. User-specified Service Account (SA) credentials to be used when actuating resources. Format: projects/{projectID}/serviceAccounts/{serviceAccount}

[src]

Output only. Current state of the deployment.

readonly stateDetail?: string

[src]

Output only. Additional information regarding the current state.

terraformBlueprint?: TerraformBlueprint

[src]

A blueprint described using Terraform's HashiCorp Configuration Language as a root module.

readonly tfErrors?: TerraformError[]

[src]

Output only. Errors encountered when deleting this deployment. Errors are truncated to 10 entries, see delete_results and error_logs for full details.

readonly tfVersion?: string

[src]

Output only. The current Terraform version set on the deployment. It is in the format of "Major.Minor.Patch", for example, "1.3.10".

tfVersionConstraint?: string

[src]

Optional. The user-specified Terraform version constraint. Example: "=1.3.10".

readonly updateTime?: Date

[src]

Output only. Time when the deployment was last modified.

workerPool?: string

[src]

Optional. The user-specified Cloud Build worker pool resource in which the Cloud Build job will execute. Format: projects/{project}/locations/{location}/workerPools/{workerPoolId}. If this field is unspecified, the default Cloud Build worker pool will be used.