Fork me on GitHub

Module cloudbuild

@pulumi/gcp > cloudbuild

Index

cloudbuild/trigger.ts

class Trigger

Creates a new build trigger within GCR. For more information, see the official documentation and API.

constructor

new Trigger(name: string, args?: TriggerArgs, opts?: pulumi.CustomResourceOptions)

Create a Trigger resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: TriggerState): Trigger

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property build

public build: pulumi.Output<{ ... } | undefined>;

A build resource in the Container Builder API. Structure is documented below. At a high level, a build describes where to find source code, how to build it (for example, the builder image to run on the source), and where to store the built artifacts. Fields can include the following variables, which will be expanded when the build is created:

  • $PROJECT_ID: the project ID of the build.
  • $BUILD_ID: the autogenerated ID of the build.
  • $REPO_NAME: the source repository name specified by RepoSource.
  • $BRANCH_NAME: the branch name specified by RepoSource.
  • $TAG_NAME: the tag name specified by RepoSource.
  • $REVISION_ID or $COMMIT_SHA: the commit SHA specified by RepoSource or resolved from the specified branch or tag.
  • $SHORT_SHA: first 7 characters of $REVISION_ID or $COMMIT_SHA.

property description

public description: pulumi.Output<string | undefined>;

A brief description of this resource.

property filename

public filename: pulumi.Output<string | undefined>;

Specify the path to a Cloud Build configuration file in the Git repo. This is mutually exclusive with build. This is typically cloudbuild.yaml however it can be specified by the user.

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 project

public project: pulumi.Output<string>;

The ID of the project that the trigger will be created in. Defaults to the provider project configuration.

property substitutions

public substitutions: pulumi.Output<{ ... } | undefined>;

property triggerTemplate

public triggerTemplate: pulumi.Output<{ ... } | undefined>;

Location of the source in a Google Cloud Source Repository. 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.

interface TriggerArgs

The set of arguments for constructing a Trigger resource.

property build

build?: pulumi.Input<{ ... }>;

A build resource in the Container Builder API. Structure is documented below. At a high level, a build describes where to find source code, how to build it (for example, the builder image to run on the source), and where to store the built artifacts. Fields can include the following variables, which will be expanded when the build is created:

  • $PROJECT_ID: the project ID of the build.
  • $BUILD_ID: the autogenerated ID of the build.
  • $REPO_NAME: the source repository name specified by RepoSource.
  • $BRANCH_NAME: the branch name specified by RepoSource.
  • $TAG_NAME: the tag name specified by RepoSource.
  • $REVISION_ID or $COMMIT_SHA: the commit SHA specified by RepoSource or resolved from the specified branch or tag.
  • $SHORT_SHA: first 7 characters of $REVISION_ID or $COMMIT_SHA.

property description

description?: pulumi.Input<string>;

A brief description of this resource.

property filename

filename?: pulumi.Input<string>;

Specify the path to a Cloud Build configuration file in the Git repo. This is mutually exclusive with build. This is typically cloudbuild.yaml however it can be specified by the user.

property project

project?: pulumi.Input<string>;

The ID of the project that the trigger will be created in. Defaults to the provider project configuration.

property substitutions

substitutions?: pulumi.Input<{ ... }>;

property triggerTemplate

triggerTemplate?: pulumi.Input<{ ... }>;

Location of the source in a Google Cloud Source Repository. Structure is documented below.

interface TriggerState

Input properties used for looking up and filtering Trigger resources.

property build

build?: pulumi.Input<{ ... }>;

A build resource in the Container Builder API. Structure is documented below. At a high level, a build describes where to find source code, how to build it (for example, the builder image to run on the source), and where to store the built artifacts. Fields can include the following variables, which will be expanded when the build is created:

  • $PROJECT_ID: the project ID of the build.
  • $BUILD_ID: the autogenerated ID of the build.
  • $REPO_NAME: the source repository name specified by RepoSource.
  • $BRANCH_NAME: the branch name specified by RepoSource.
  • $TAG_NAME: the tag name specified by RepoSource.
  • $REVISION_ID or $COMMIT_SHA: the commit SHA specified by RepoSource or resolved from the specified branch or tag.
  • $SHORT_SHA: first 7 characters of $REVISION_ID or $COMMIT_SHA.

property description

description?: pulumi.Input<string>;

A brief description of this resource.

property filename

filename?: pulumi.Input<string>;

Specify the path to a Cloud Build configuration file in the Git repo. This is mutually exclusive with build. This is typically cloudbuild.yaml however it can be specified by the user.

property project

project?: pulumi.Input<string>;

The ID of the project that the trigger will be created in. Defaults to the provider project configuration.

property substitutions

substitutions?: pulumi.Input<{ ... }>;

property triggerTemplate

triggerTemplate?: pulumi.Input<{ ... }>;

Location of the source in a Google Cloud Source Repository. Structure is documented below.