Trigger

Configuration for an automated build in response to source repository changes.

To get more information about Trigger, see:

API documentation
How-to Guides
- Automating builds using build triggers

Create a Trigger Resource

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

def Trigger(resource_name, opts=None, build=None, description=None, disabled=None, filename=None, github=None, ignored_files=None, included_files=None, name=None, project=None, substitutions=None, trigger_template=None, __props__=None);

func NewTrigger(ctx *Context, name string, args *TriggerArgs, opts ...ResourceOption) (*Trigger, error)

public Trigger(string name, TriggerArgs? args = null, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args TriggerArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args TriggerArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args TriggerArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

Trigger Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The Trigger resource accepts the following input properties:

Build TriggerBuildArgs: Contents of the build template. Either a filename or build template must be provided. Structure is documented below.
Description string: Human-readable description of the trigger.
Disabled bool: Whether the trigger is disabled or not. If true, the trigger will never result in a build.
Filename string: Path, from the source root, to a file whose contents is used for the template. Either a filename or build template must be provided.
Github TriggerGithubArgs: Describes the configuration of a trigger that creates a build whenever a GitHub event is received. One of trigger_template or github must be provided. Structure is documented below.
IgnoredFiles List<string>: ignoredFiles and includedFiles are file glob matches using https://golang.org/pkg/path/filepath/#Match extended with support for **. If ignoredFiles and changed files are both empty, then they are not used to determine whether or not to trigger a build. If ignoredFiles is not empty, then we ignore any files that match any of the ignored_file globs. If the change has no files that are outside of the ignoredFiles globs, then we do not trigger a build.
IncludedFiles List<string>: ignoredFiles and includedFiles are file glob matches using https://golang.org/pkg/path/filepath/#Match extended with support for **. If any of the files altered in the commit pass the ignoredFiles filter and includedFiles is empty, then as far as this filter is concerned, we should trigger the build. If any of the files altered in the commit pass the ignoredFiles filter and includedFiles is not empty, then we make sure that at least one of those files matches a includedFiles glob. If not, then we do not trigger a build.
Name string: Name of the volume to mount. Volume names must be unique per build step and must be valid names for Docker volumes. Each named volume must be used by at least two build steps.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
Substitutions Dictionary<string, string>: Substitutions data for Build resource.
TriggerTemplate TriggerTriggerTemplateArgs: Template describing the types of source changes to trigger a build. Branch and tag names in trigger templates are interpreted as regular expressions. Any branch or tag change that matches that regular expression will trigger a build. One of trigger_template or github must be provided. Structure is documented below.

Build TriggerBuild: Contents of the build template. Either a filename or build template must be provided. Structure is documented below.
Description string: Human-readable description of the trigger.
Disabled bool: Whether the trigger is disabled or not. If true, the trigger will never result in a build.
Filename string: Path, from the source root, to a file whose contents is used for the template. Either a filename or build template must be provided.
Github TriggerGithub: Describes the configuration of a trigger that creates a build whenever a GitHub event is received. One of trigger_template or github must be provided. Structure is documented below.
IgnoredFiles []string: ignoredFiles and includedFiles are file glob matches using https://golang.org/pkg/path/filepath/#Match extended with support for **. If ignoredFiles and changed files are both empty, then they are not used to determine whether or not to trigger a build. If ignoredFiles is not empty, then we ignore any files that match any of the ignored_file globs. If the change has no files that are outside of the ignoredFiles globs, then we do not trigger a build.
IncludedFiles []string: ignoredFiles and includedFiles are file glob matches using https://golang.org/pkg/path/filepath/#Match extended with support for **. If any of the files altered in the commit pass the ignoredFiles filter and includedFiles is empty, then as far as this filter is concerned, we should trigger the build. If any of the files altered in the commit pass the ignoredFiles filter and includedFiles is not empty, then we make sure that at least one of those files matches a includedFiles glob. If not, then we do not trigger a build.
Name string: Name of the volume to mount. Volume names must be unique per build step and must be valid names for Docker volumes. Each named volume must be used by at least two build steps.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
Substitutions map[string]string: Substitutions data for Build resource.
TriggerTemplate TriggerTriggerTemplate: Template describing the types of source changes to trigger a build. Branch and tag names in trigger templates are interpreted as regular expressions. Any branch or tag change that matches that regular expression will trigger a build. One of trigger_template or github must be provided. Structure is documented below.

build TriggerBuild: Contents of the build template. Either a filename or build template must be provided. Structure is documented below.
description string: Human-readable description of the trigger.
disabled boolean: Whether the trigger is disabled or not. If true, the trigger will never result in a build.
filename string: Path, from the source root, to a file whose contents is used for the template. Either a filename or build template must be provided.
github TriggerGithub: Describes the configuration of a trigger that creates a build whenever a GitHub event is received. One of trigger_template or github must be provided. Structure is documented below.
ignoredFiles string[]: ignoredFiles and includedFiles are file glob matches using https://golang.org/pkg/path/filepath/#Match extended with support for **. If ignoredFiles and changed files are both empty, then they are not used to determine whether or not to trigger a build. If ignoredFiles is not empty, then we ignore any files that match any of the ignored_file globs. If the change has no files that are outside of the ignoredFiles globs, then we do not trigger a build.
includedFiles string[]: ignoredFiles and includedFiles are file glob matches using https://golang.org/pkg/path/filepath/#Match extended with support for **. If any of the files altered in the commit pass the ignoredFiles filter and includedFiles is empty, then as far as this filter is concerned, we should trigger the build. If any of the files altered in the commit pass the ignoredFiles filter and includedFiles is not empty, then we make sure that at least one of those files matches a includedFiles glob. If not, then we do not trigger a build.
name string: Name of the volume to mount. Volume names must be unique per build step and must be valid names for Docker volumes. Each named volume must be used by at least two build steps.
project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
substitutions {[key: string]: string}: Substitutions data for Build resource.
triggerTemplate TriggerTriggerTemplate: Template describing the types of source changes to trigger a build. Branch and tag names in trigger templates are interpreted as regular expressions. Any branch or tag change that matches that regular expression will trigger a build. One of trigger_template or github must be provided. Structure is documented below.

build Dict[TriggerBuild]: Contents of the build template. Either a filename or build template must be provided. Structure is documented below.
description str: Human-readable description of the trigger.
disabled bool: Whether the trigger is disabled or not. If true, the trigger will never result in a build.
filename str: Path, from the source root, to a file whose contents is used for the template. Either a filename or build template must be provided.
github Dict[TriggerGithub]: Describes the configuration of a trigger that creates a build whenever a GitHub event is received. One of trigger_template or github must be provided. Structure is documented below.
ignored_files List[str]: ignoredFiles and includedFiles are file glob matches using https://golang.org/pkg/path/filepath/#Match extended with support for **. If ignoredFiles and changed files are both empty, then they are not used to determine whether or not to trigger a build. If ignoredFiles is not empty, then we ignore any files that match any of the ignored_file globs. If the change has no files that are outside of the ignoredFiles globs, then we do not trigger a build.
included_files List[str]: ignoredFiles and includedFiles are file glob matches using https://golang.org/pkg/path/filepath/#Match extended with support for **. If any of the files altered in the commit pass the ignoredFiles filter and includedFiles is empty, then as far as this filter is concerned, we should trigger the build. If any of the files altered in the commit pass the ignoredFiles filter and includedFiles is not empty, then we make sure that at least one of those files matches a includedFiles glob. If not, then we do not trigger a build.
name str: Name of the volume to mount. Volume names must be unique per build step and must be valid names for Docker volumes. Each named volume must be used by at least two build steps.
project str: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
substitutions Dict[str, str]: Substitutions data for Build resource.
trigger_template Dict[TriggerTriggerTemplate]: Template describing the types of source changes to trigger a build. Branch and tag names in trigger templates are interpreted as regular expressions. Any branch or tag change that matches that regular expression will trigger a build. One of trigger_template or github must be provided. Structure is documented below.

Outputs

All input properties are implicitly available as output properties. Additionally, the Trigger resource produces the following output properties:

CreateTime string: Time when the trigger was created.
Id string: The provider-assigned unique ID for this managed resource.
TriggerId string: The unique identifier for the trigger.

CreateTime string: Time when the trigger was created.
Id string: The provider-assigned unique ID for this managed resource.
TriggerId string: The unique identifier for the trigger.

createTime string: Time when the trigger was created.
id string: The provider-assigned unique ID for this managed resource.
triggerId string: The unique identifier for the trigger.

create_time str: Time when the trigger was created.
id str: The provider-assigned unique ID for this managed resource.
trigger_id str: The unique identifier for the trigger.

Look up an Existing Trigger Resource

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

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

static get(resource_name, id, opts=None, build=None, create_time=None, description=None, disabled=None, filename=None, github=None, ignored_files=None, included_files=None, name=None, project=None, substitutions=None, trigger_id=None, trigger_template=None, __props__=None);

func GetTrigger(ctx *Context, name string, id IDInput, state *TriggerState, opts ...ResourceOption) (*Trigger, error)

public static Trigger Get(string name, Input<string> id, TriggerState? state, CustomResourceOptions? opts = null)

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

Build TriggerBuildArgs: Contents of the build template. Either a filename or build template must be provided. Structure is documented below.
CreateTime string: Time when the trigger was created.
Description string: Human-readable description of the trigger.
Disabled bool: Whether the trigger is disabled or not. If true, the trigger will never result in a build.
Filename string: Path, from the source root, to a file whose contents is used for the template. Either a filename or build template must be provided.
Github TriggerGithubArgs: Describes the configuration of a trigger that creates a build whenever a GitHub event is received. One of trigger_template or github must be provided. Structure is documented below.
IgnoredFiles List<string>: ignoredFiles and includedFiles are file glob matches using https://golang.org/pkg/path/filepath/#Match extended with support for **. If ignoredFiles and changed files are both empty, then they are not used to determine whether or not to trigger a build. If ignoredFiles is not empty, then we ignore any files that match any of the ignored_file globs. If the change has no files that are outside of the ignoredFiles globs, then we do not trigger a build.
IncludedFiles List<string>: ignoredFiles and includedFiles are file glob matches using https://golang.org/pkg/path/filepath/#Match extended with support for **. If any of the files altered in the commit pass the ignoredFiles filter and includedFiles is empty, then as far as this filter is concerned, we should trigger the build. If any of the files altered in the commit pass the ignoredFiles filter and includedFiles is not empty, then we make sure that at least one of those files matches a includedFiles glob. If not, then we do not trigger a build.
Name string: Name of the volume to mount. Volume names must be unique per build step and must be valid names for Docker volumes. Each named volume must be used by at least two build steps.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
Substitutions Dictionary<string, string>: Substitutions data for Build resource.
TriggerId string: The unique identifier for the trigger.
TriggerTemplate TriggerTriggerTemplateArgs: Template describing the types of source changes to trigger a build. Branch and tag names in trigger templates are interpreted as regular expressions. Any branch or tag change that matches that regular expression will trigger a build. One of trigger_template or github must be provided. Structure is documented below.

Build TriggerBuild: Contents of the build template. Either a filename or build template must be provided. Structure is documented below.
CreateTime string: Time when the trigger was created.
Description string: Human-readable description of the trigger.
Disabled bool: Whether the trigger is disabled or not. If true, the trigger will never result in a build.
Filename string: Path, from the source root, to a file whose contents is used for the template. Either a filename or build template must be provided.
Github TriggerGithub: Describes the configuration of a trigger that creates a build whenever a GitHub event is received. One of trigger_template or github must be provided. Structure is documented below.
IgnoredFiles []string: ignoredFiles and includedFiles are file glob matches using https://golang.org/pkg/path/filepath/#Match extended with support for **. If ignoredFiles and changed files are both empty, then they are not used to determine whether or not to trigger a build. If ignoredFiles is not empty, then we ignore any files that match any of the ignored_file globs. If the change has no files that are outside of the ignoredFiles globs, then we do not trigger a build.
IncludedFiles []string: ignoredFiles and includedFiles are file glob matches using https://golang.org/pkg/path/filepath/#Match extended with support for **. If any of the files altered in the commit pass the ignoredFiles filter and includedFiles is empty, then as far as this filter is concerned, we should trigger the build. If any of the files altered in the commit pass the ignoredFiles filter and includedFiles is not empty, then we make sure that at least one of those files matches a includedFiles glob. If not, then we do not trigger a build.
Name string: Name of the volume to mount. Volume names must be unique per build step and must be valid names for Docker volumes. Each named volume must be used by at least two build steps.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
Substitutions map[string]string: Substitutions data for Build resource.
TriggerId string: The unique identifier for the trigger.
TriggerTemplate TriggerTriggerTemplate: Template describing the types of source changes to trigger a build. Branch and tag names in trigger templates are interpreted as regular expressions. Any branch or tag change that matches that regular expression will trigger a build. One of trigger_template or github must be provided. Structure is documented below.

build TriggerBuild: Contents of the build template. Either a filename or build template must be provided. Structure is documented below.
createTime string: Time when the trigger was created.
description string: Human-readable description of the trigger.
disabled boolean: Whether the trigger is disabled or not. If true, the trigger will never result in a build.
filename string: Path, from the source root, to a file whose contents is used for the template. Either a filename or build template must be provided.
github TriggerGithub: Describes the configuration of a trigger that creates a build whenever a GitHub event is received. One of trigger_template or github must be provided. Structure is documented below.
ignoredFiles string[]: ignoredFiles and includedFiles are file glob matches using https://golang.org/pkg/path/filepath/#Match extended with support for **. If ignoredFiles and changed files are both empty, then they are not used to determine whether or not to trigger a build. If ignoredFiles is not empty, then we ignore any files that match any of the ignored_file globs. If the change has no files that are outside of the ignoredFiles globs, then we do not trigger a build.
includedFiles string[]: ignoredFiles and includedFiles are file glob matches using https://golang.org/pkg/path/filepath/#Match extended with support for **. If any of the files altered in the commit pass the ignoredFiles filter and includedFiles is empty, then as far as this filter is concerned, we should trigger the build. If any of the files altered in the commit pass the ignoredFiles filter and includedFiles is not empty, then we make sure that at least one of those files matches a includedFiles glob. If not, then we do not trigger a build.
name string: Name of the volume to mount. Volume names must be unique per build step and must be valid names for Docker volumes. Each named volume must be used by at least two build steps.
project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
substitutions {[key: string]: string}: Substitutions data for Build resource.
triggerId string: The unique identifier for the trigger.
triggerTemplate TriggerTriggerTemplate: Template describing the types of source changes to trigger a build. Branch and tag names in trigger templates are interpreted as regular expressions. Any branch or tag change that matches that regular expression will trigger a build. One of trigger_template or github must be provided. Structure is documented below.

build Dict[TriggerBuild]: Contents of the build template. Either a filename or build template must be provided. Structure is documented below.
create_time str: Time when the trigger was created.
description str: Human-readable description of the trigger.
disabled bool: Whether the trigger is disabled or not. If true, the trigger will never result in a build.
filename str: Path, from the source root, to a file whose contents is used for the template. Either a filename or build template must be provided.
github Dict[TriggerGithub]: Describes the configuration of a trigger that creates a build whenever a GitHub event is received. One of trigger_template or github must be provided. Structure is documented below.
ignored_files List[str]: ignoredFiles and includedFiles are file glob matches using https://golang.org/pkg/path/filepath/#Match extended with support for **. If ignoredFiles and changed files are both empty, then they are not used to determine whether or not to trigger a build. If ignoredFiles is not empty, then we ignore any files that match any of the ignored_file globs. If the change has no files that are outside of the ignoredFiles globs, then we do not trigger a build.
included_files List[str]: ignoredFiles and includedFiles are file glob matches using https://golang.org/pkg/path/filepath/#Match extended with support for **. If any of the files altered in the commit pass the ignoredFiles filter and includedFiles is empty, then as far as this filter is concerned, we should trigger the build. If any of the files altered in the commit pass the ignoredFiles filter and includedFiles is not empty, then we make sure that at least one of those files matches a includedFiles glob. If not, then we do not trigger a build.
name str: Name of the volume to mount. Volume names must be unique per build step and must be valid names for Docker volumes. Each named volume must be used by at least two build steps.
project str: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
substitutions Dict[str, str]: Substitutions data for Build resource.
trigger_id str: The unique identifier for the trigger.
trigger_template Dict[TriggerTriggerTemplate]: Template describing the types of source changes to trigger a build. Branch and tag names in trigger templates are interpreted as regular expressions. Any branch or tag change that matches that regular expression will trigger a build. One of trigger_template or github must be provided. Structure is documented below.

Supporting Types

TriggerBuild

See the input and output API doc for this type.

Steps List<TriggerBuildStepArgs>: The operations to be performed on the workspace. Structure is documented below.
Images List<string>: A list of images to be pushed upon the successful completion of all build steps. The images are pushed using the builder service account’s credentials. The digests of the pushed images will be stored in the Build resource’s results field. If any of the images fail to be pushed, the build status is marked FAILURE.
Tags List<string>: Tags for annotation of a Build. These are not docker tags.
Timeout string: Time limit for executing this build step. If not defined, the step has no time limit and will be allowed to continue to run until either it completes or the build itself times out.

Steps []TriggerBuildStep: The operations to be performed on the workspace. Structure is documented below.
Images []string: A list of images to be pushed upon the successful completion of all build steps. The images are pushed using the builder service account’s credentials. The digests of the pushed images will be stored in the Build resource’s results field. If any of the images fail to be pushed, the build status is marked FAILURE.
Tags []string: Tags for annotation of a Build. These are not docker tags.
Timeout string: Time limit for executing this build step. If not defined, the step has no time limit and will be allowed to continue to run until either it completes or the build itself times out.

steps TriggerBuildStep[]: The operations to be performed on the workspace. Structure is documented below.
images string[]: A list of images to be pushed upon the successful completion of all build steps. The images are pushed using the builder service account’s credentials. The digests of the pushed images will be stored in the Build resource’s results field. If any of the images fail to be pushed, the build status is marked FAILURE.
tags string[]: Tags for annotation of a Build. These are not docker tags.
timeout string: Time limit for executing this build step. If not defined, the step has no time limit and will be allowed to continue to run until either it completes or the build itself times out.

steps List[TriggerBuildStep]: The operations to be performed on the workspace. Structure is documented below.
images List[str]: A list of images to be pushed upon the successful completion of all build steps. The images are pushed using the builder service account’s credentials. The digests of the pushed images will be stored in the Build resource’s results field. If any of the images fail to be pushed, the build status is marked FAILURE.
tags List[str]: Tags for annotation of a Build. These are not docker tags.
timeout str: Time limit for executing this build step. If not defined, the step has no time limit and will be allowed to continue to run until either it completes or the build itself times out.

TriggerBuildStep

See the input and output API doc for this type.

Name string: Name of the volume to mount. Volume names must be unique per build step and must be valid names for Docker volumes. Each named volume must be used by at least two build steps.
Args List<string>: A list of arguments that will be presented to the step when it is started. If the image used to run the step’s container has an entrypoint, the args are used as arguments to that entrypoint. If the image does not define an entrypoint, the first element in args is used as the entrypoint, and the remainder will be used as arguments.
Dir string: Working directory to use when running this step’s container. If this value is a relative path, it is relative to the build’s working directory. If this value is absolute, it may be outside the build’s working directory, in which case the contents of the path may not be persisted across build step executions, unless a volume for that path is specified. If the build specifies a RepoSource with dir and a step with a dir, which specifies an absolute path, the RepoSource dir is ignored for the step’s execution.
Entrypoint string: Entrypoint to be used instead of the build step image’s default entrypoint. If unset, the image’s default entrypoint is used
Envs List<string>: A list of environment variable definitions to be used when running a step. The elements are of the form “KEY=VALUE” for the environment variable “KEY” being given the value “VALUE”.
Id string: Unique identifier for this build step, used in wait_for to reference this build step as a dependency.
SecretEnvs List<string>: A list of environment variables which are encrypted using a Cloud Key Management Service crypto key. These values must be specified in the build’s Secret.
Timeout string: Time limit for executing this build step. If not defined, the step has no time limit and will be allowed to continue to run until either it completes or the build itself times out.
Timing string: Output only. Stores timing information for executing this build step.
Volumes List<TriggerBuildStepVolumeArgs>: List of volumes to mount into the build step. Each volume is created as an empty volume prior to execution of the build step. Upon completion of the build, volumes and their contents are discarded. Using a named volume in only one step is not valid as it is indicative of a build request with an incorrect configuration. Structure is documented below.
WaitFors List<string>: The ID(s) of the step(s) that this build step depends on. This build step will not start until all the build steps in wait_for have completed successfully. If wait_for is empty, this build step will start when all previous build steps in the Build.Steps list have completed successfully.

Name string: Name of the volume to mount. Volume names must be unique per build step and must be valid names for Docker volumes. Each named volume must be used by at least two build steps.
Args []string: A list of arguments that will be presented to the step when it is started. If the image used to run the step’s container has an entrypoint, the args are used as arguments to that entrypoint. If the image does not define an entrypoint, the first element in args is used as the entrypoint, and the remainder will be used as arguments.
Dir string: Working directory to use when running this step’s container. If this value is a relative path, it is relative to the build’s working directory. If this value is absolute, it may be outside the build’s working directory, in which case the contents of the path may not be persisted across build step executions, unless a volume for that path is specified. If the build specifies a RepoSource with dir and a step with a dir, which specifies an absolute path, the RepoSource dir is ignored for the step’s execution.
Entrypoint string: Entrypoint to be used instead of the build step image’s default entrypoint. If unset, the image’s default entrypoint is used
Envs []string: A list of environment variable definitions to be used when running a step. The elements are of the form “KEY=VALUE” for the environment variable “KEY” being given the value “VALUE”.
Id string: Unique identifier for this build step, used in wait_for to reference this build step as a dependency.
SecretEnvs []string: A list of environment variables which are encrypted using a Cloud Key Management Service crypto key. These values must be specified in the build’s Secret.
Timeout string: Time limit for executing this build step. If not defined, the step has no time limit and will be allowed to continue to run until either it completes or the build itself times out.
Timing string: Output only. Stores timing information for executing this build step.
Volumes []TriggerBuildStepVolume: List of volumes to mount into the build step. Each volume is created as an empty volume prior to execution of the build step. Upon completion of the build, volumes and their contents are discarded. Using a named volume in only one step is not valid as it is indicative of a build request with an incorrect configuration. Structure is documented below.
WaitFors []string: The ID(s) of the step(s) that this build step depends on. This build step will not start until all the build steps in wait_for have completed successfully. If wait_for is empty, this build step will start when all previous build steps in the Build.Steps list have completed successfully.

name string: Name of the volume to mount. Volume names must be unique per build step and must be valid names for Docker volumes. Each named volume must be used by at least two build steps.
args string[]: A list of arguments that will be presented to the step when it is started. If the image used to run the step’s container has an entrypoint, the args are used as arguments to that entrypoint. If the image does not define an entrypoint, the first element in args is used as the entrypoint, and the remainder will be used as arguments.
dir string: Working directory to use when running this step’s container. If this value is a relative path, it is relative to the build’s working directory. If this value is absolute, it may be outside the build’s working directory, in which case the contents of the path may not be persisted across build step executions, unless a volume for that path is specified. If the build specifies a RepoSource with dir and a step with a dir, which specifies an absolute path, the RepoSource dir is ignored for the step’s execution.
entrypoint string: Entrypoint to be used instead of the build step image’s default entrypoint. If unset, the image’s default entrypoint is used
envs string[]: A list of environment variable definitions to be used when running a step. The elements are of the form “KEY=VALUE” for the environment variable “KEY” being given the value “VALUE”.
id string: Unique identifier for this build step, used in wait_for to reference this build step as a dependency.
secretEnvs string[]: A list of environment variables which are encrypted using a Cloud Key Management Service crypto key. These values must be specified in the build’s Secret.
timeout string: Time limit for executing this build step. If not defined, the step has no time limit and will be allowed to continue to run until either it completes or the build itself times out.
timing string: Output only. Stores timing information for executing this build step.
volumes TriggerBuildStepVolume[]: List of volumes to mount into the build step. Each volume is created as an empty volume prior to execution of the build step. Upon completion of the build, volumes and their contents are discarded. Using a named volume in only one step is not valid as it is indicative of a build request with an incorrect configuration. Structure is documented below.
waitFors string[]: The ID(s) of the step(s) that this build step depends on. This build step will not start until all the build steps in wait_for have completed successfully. If wait_for is empty, this build step will start when all previous build steps in the Build.Steps list have completed successfully.

name str: Name of the volume to mount. Volume names must be unique per build step and must be valid names for Docker volumes. Each named volume must be used by at least two build steps.
args List[str]: A list of arguments that will be presented to the step when it is started. If the image used to run the step’s container has an entrypoint, the args are used as arguments to that entrypoint. If the image does not define an entrypoint, the first element in args is used as the entrypoint, and the remainder will be used as arguments.
dir str: Working directory to use when running this step’s container. If this value is a relative path, it is relative to the build’s working directory. If this value is absolute, it may be outside the build’s working directory, in which case the contents of the path may not be persisted across build step executions, unless a volume for that path is specified. If the build specifies a RepoSource with dir and a step with a dir, which specifies an absolute path, the RepoSource dir is ignored for the step’s execution.
entrypoint str: Entrypoint to be used instead of the build step image’s default entrypoint. If unset, the image’s default entrypoint is used
envs List[str]: A list of environment variable definitions to be used when running a step. The elements are of the form “KEY=VALUE” for the environment variable “KEY” being given the value “VALUE”.
id str: Unique identifier for this build step, used in wait_for to reference this build step as a dependency.
secretEnvs List[str]: A list of environment variables which are encrypted using a Cloud Key Management Service crypto key. These values must be specified in the build’s Secret.
timeout str: Time limit for executing this build step. If not defined, the step has no time limit and will be allowed to continue to run until either it completes or the build itself times out.
timing str: Output only. Stores timing information for executing this build step.
volumes List[TriggerBuildStepVolume]: List of volumes to mount into the build step. Each volume is created as an empty volume prior to execution of the build step. Upon completion of the build, volumes and their contents are discarded. Using a named volume in only one step is not valid as it is indicative of a build request with an incorrect configuration. Structure is documented below.
waitFors List[str]: The ID(s) of the step(s) that this build step depends on. This build step will not start until all the build steps in wait_for have completed successfully. If wait_for is empty, this build step will start when all previous build steps in the Build.Steps list have completed successfully.

TriggerBuildStepVolume

See the input and output API doc for this type.

Name string: Name of the volume to mount. Volume names must be unique per build step and must be valid names for Docker volumes. Each named volume must be used by at least two build steps.
Path string: Path at which to mount the volume. Paths must be absolute and cannot conflict with other volume paths on the same build step or with certain reserved volume paths.

Name string: Name of the volume to mount. Volume names must be unique per build step and must be valid names for Docker volumes. Each named volume must be used by at least two build steps.
Path string: Path at which to mount the volume. Paths must be absolute and cannot conflict with other volume paths on the same build step or with certain reserved volume paths.

name string: Name of the volume to mount. Volume names must be unique per build step and must be valid names for Docker volumes. Each named volume must be used by at least two build steps.
path string: Path at which to mount the volume. Paths must be absolute and cannot conflict with other volume paths on the same build step or with certain reserved volume paths.

name str: Name of the volume to mount. Volume names must be unique per build step and must be valid names for Docker volumes. Each named volume must be used by at least two build steps.
path str: Path at which to mount the volume. Paths must be absolute and cannot conflict with other volume paths on the same build step or with certain reserved volume paths.

TriggerGithub

See the input and output API doc for this type.

Name string: Name of the volume to mount. Volume names must be unique per build step and must be valid names for Docker volumes. Each named volume must be used by at least two build steps.
Owner string: Owner of the repository. For example: The owner for https://github.com/googlecloudplatform/cloud-builders is “googlecloudplatform”.
PullRequest TriggerGithubPullRequestArgs: filter to match changes in pull requests. Specify only one of pullRequest or push. Structure is documented below.
Push TriggerGithubPushArgs: filter to match changes in refs, like branches or tags. Specify only one of pullRequest or push. Structure is documented below.

Name string: Name of the volume to mount. Volume names must be unique per build step and must be valid names for Docker volumes. Each named volume must be used by at least two build steps.
Owner string: Owner of the repository. For example: The owner for https://github.com/googlecloudplatform/cloud-builders is “googlecloudplatform”.
PullRequest TriggerGithubPullRequest: filter to match changes in pull requests. Specify only one of pullRequest or push. Structure is documented below.
Push TriggerGithubPush: filter to match changes in refs, like branches or tags. Specify only one of pullRequest or push. Structure is documented below.

name string: Name of the volume to mount. Volume names must be unique per build step and must be valid names for Docker volumes. Each named volume must be used by at least two build steps.
owner string: Owner of the repository. For example: The owner for https://github.com/googlecloudplatform/cloud-builders is “googlecloudplatform”.
pullRequest TriggerGithubPullRequest: filter to match changes in pull requests. Specify only one of pullRequest or push. Structure is documented below.
push TriggerGithubPush: filter to match changes in refs, like branches or tags. Specify only one of pullRequest or push. Structure is documented below.

name str: Name of the volume to mount. Volume names must be unique per build step and must be valid names for Docker volumes. Each named volume must be used by at least two build steps.
owner str: Owner of the repository. For example: The owner for https://github.com/googlecloudplatform/cloud-builders is “googlecloudplatform”.
pullRequest Dict[TriggerGithubPullRequest]: filter to match changes in pull requests. Specify only one of pullRequest or push. Structure is documented below.
push Dict[TriggerGithubPush]: filter to match changes in refs, like branches or tags. Specify only one of pullRequest or push. Structure is documented below.

TriggerGithubPullRequest

See the input and output API doc for this type.

Branch string: Regex of branches to match. Specify only one of branch or tag.
CommentControl string: Whether to block builds on a “/gcbrun” comment from a repository owner or collaborator.
InvertRegex bool: When true, only trigger a build if the revision regex does NOT match the git_ref regex.

Branch string: Regex of branches to match. Specify only one of branch or tag.
CommentControl string: Whether to block builds on a “/gcbrun” comment from a repository owner or collaborator.
InvertRegex bool: When true, only trigger a build if the revision regex does NOT match the git_ref regex.

branch string: Regex of branches to match. Specify only one of branch or tag.
commentControl string: Whether to block builds on a “/gcbrun” comment from a repository owner or collaborator.
invertRegex boolean: When true, only trigger a build if the revision regex does NOT match the git_ref regex.

branch str: Regex of branches to match. Specify only one of branch or tag.
commentControl str: Whether to block builds on a “/gcbrun” comment from a repository owner or collaborator.
invertRegex bool: When true, only trigger a build if the revision regex does NOT match the git_ref regex.

TriggerGithubPush

See the input and output API doc for this type.

Branch string: Regex of branches to match. Specify only one of branch or tag.
InvertRegex bool: When true, only trigger a build if the revision regex does NOT match the git_ref regex.
Tag string: Regex of tags to match. Specify only one of branch or tag.

Branch string: Regex of branches to match. Specify only one of branch or tag.
InvertRegex bool: When true, only trigger a build if the revision regex does NOT match the git_ref regex.
Tag string: Regex of tags to match. Specify only one of branch or tag.

branch string: Regex of branches to match. Specify only one of branch or tag.
invertRegex boolean: When true, only trigger a build if the revision regex does NOT match the git_ref regex.
tag string: Regex of tags to match. Specify only one of branch or tag.

branch str: Regex of branches to match. Specify only one of branch or tag.
invertRegex bool: When true, only trigger a build if the revision regex does NOT match the git_ref regex.
tag str: Regex of tags to match. Specify only one of branch or tag.

TriggerTriggerTemplate

See the input and output API doc for this type.

BranchName string: Name of the branch to build. Exactly one a of branch name, tag, or commit SHA must be provided. This field is a regular expression.
CommitSha string: Explicit commit SHA to build. Exactly one of a branch name, tag, or commit SHA must be provided.
Dir string: Working directory to use when running this step’s container. If this value is a relative path, it is relative to the build’s working directory. If this value is absolute, it may be outside the build’s working directory, in which case the contents of the path may not be persisted across build step executions, unless a volume for that path is specified. If the build specifies a RepoSource with dir and a step with a dir, which specifies an absolute path, the RepoSource dir is ignored for the step’s execution.
InvertRegex bool: When true, only trigger a build if the revision regex does NOT match the git_ref regex.
ProjectId string: ID of the project that owns the Cloud Source Repository. If omitted, the project ID requesting the build is assumed.
RepoName string: Name of the Cloud Source Repository. If omitted, the name “default” is assumed.
TagName string: Name of the tag to build. Exactly one of a branch name, tag, or commit SHA must be provided. This field is a regular expression.

BranchName string: Name of the branch to build. Exactly one a of branch name, tag, or commit SHA must be provided. This field is a regular expression.
CommitSha string: Explicit commit SHA to build. Exactly one of a branch name, tag, or commit SHA must be provided.
Dir string: Working directory to use when running this step’s container. If this value is a relative path, it is relative to the build’s working directory. If this value is absolute, it may be outside the build’s working directory, in which case the contents of the path may not be persisted across build step executions, unless a volume for that path is specified. If the build specifies a RepoSource with dir and a step with a dir, which specifies an absolute path, the RepoSource dir is ignored for the step’s execution.
InvertRegex bool: When true, only trigger a build if the revision regex does NOT match the git_ref regex.
ProjectId string: ID of the project that owns the Cloud Source Repository. If omitted, the project ID requesting the build is assumed.
RepoName string: Name of the Cloud Source Repository. If omitted, the name “default” is assumed.
TagName string: Name of the tag to build. Exactly one of a branch name, tag, or commit SHA must be provided. This field is a regular expression.

branchName string: Name of the branch to build. Exactly one a of branch name, tag, or commit SHA must be provided. This field is a regular expression.
commitSha string: Explicit commit SHA to build. Exactly one of a branch name, tag, or commit SHA must be provided.
dir string: Working directory to use when running this step’s container. If this value is a relative path, it is relative to the build’s working directory. If this value is absolute, it may be outside the build’s working directory, in which case the contents of the path may not be persisted across build step executions, unless a volume for that path is specified. If the build specifies a RepoSource with dir and a step with a dir, which specifies an absolute path, the RepoSource dir is ignored for the step’s execution.
invertRegex boolean: When true, only trigger a build if the revision regex does NOT match the git_ref regex.
projectId string: ID of the project that owns the Cloud Source Repository. If omitted, the project ID requesting the build is assumed.
repoName string: Name of the Cloud Source Repository. If omitted, the name “default” is assumed.
tagName string: Name of the tag to build. Exactly one of a branch name, tag, or commit SHA must be provided. This field is a regular expression.

branchName str: Name of the branch to build. Exactly one a of branch name, tag, or commit SHA must be provided. This field is a regular expression.
commitSha str: Explicit commit SHA to build. Exactly one of a branch name, tag, or commit SHA must be provided.
dir str: Working directory to use when running this step’s container. If this value is a relative path, it is relative to the build’s working directory. If this value is absolute, it may be outside the build’s working directory, in which case the contents of the path may not be persisted across build step executions, unless a volume for that path is specified. If the build specifies a RepoSource with dir and a step with a dir, which specifies an absolute path, the RepoSource dir is ignored for the step’s execution.
invertRegex bool: When true, only trigger a build if the revision regex does NOT match the git_ref regex.
project_id str: ID of the project that owns the Cloud Source Repository. If omitted, the project ID requesting the build is assumed.
repoName str: Name of the Cloud Source Repository. If omitted, the name “default” is assumed.
tagName str: Name of the tag to build. Exactly one of a branch name, tag, or commit SHA must be provided. This field is a regular expression.

Package Details

Repository: https://github.com/pulumi/pulumi-gcp
License: Apache-2.0
Notes: This Pulumi package is based on the google-beta Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

Trigger

Create a Trigger Resource

Trigger Resource Properties

Inputs

Outputs

Look up an Existing Trigger Resource

Supporting Types

TriggerBuild

TriggerBuildStep

TriggerBuildStepVolume

TriggerGithub

TriggerGithubPullRequest

TriggerGithubPush

TriggerTriggerTemplate

Package Details

On This Page