Welcome to Pulumi Registry, your window into the cloud. Read the announcement.

Google Native

v0.9.0 published on Wednesday, Nov 24, 2021 by Pulumi

Trigger

Create a new trigger in a particular project and location.

Create a Trigger Resource

new Trigger(name: string, args: TriggerArgs, opts?: CustomResourceOptions);
@overload
def Trigger(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            destination: Optional[DestinationArgs] = None,
            labels: Optional[Mapping[str, str]] = None,
            location: Optional[str] = None,
            matching_criteria: Optional[Sequence[MatchingCriteriaArgs]] = None,
            name: Optional[str] = None,
            project: Optional[str] = None,
            service_account: Optional[str] = None,
            trigger_id: Optional[str] = None,
            validate_only: Optional[str] = None)
@overload
def Trigger(resource_name: str,
            args: TriggerArgs,
            opts: Optional[ResourceOptions] = None)
func NewTrigger(ctx *Context, name string, args TriggerArgs, opts ...ResourceOption) (*Trigger, error)
public Trigger(string name, TriggerArgs args, 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.
args TriggerArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control 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 Architecture and Concepts docs.

Inputs

The Trigger resource accepts the following input properties:

Destination Pulumi.GoogleNative.Eventarc.V1Beta1.Inputs.DestinationArgs
Destination specifies where the events should be sent to.
MatchingCriteria List<Pulumi.GoogleNative.Eventarc.V1Beta1.Inputs.MatchingCriteriaArgs>
null The criteria by which events are filtered. Only events that match with this criteria will be sent to the destination.
TriggerId string
ValidateOnly string
Labels Dictionary<string, string>
Optional. User labels attached to the triggers that can be used to group resources.
Location string
Name string
The resource name of the trigger. Must be unique within the location on the project and must in projects/{project}/locations/{location}/triggers/{trigger} format.
Project string
ServiceAccount string
Optional. The IAM service account email associated with the trigger. The service account represents the identity of the trigger. The principal who calls this API must have iam.serviceAccounts.actAs permission in the service account. See https://cloud.google.com/iam/docs/understanding-service-accounts?hl=en#sa_common for more information. For Cloud Run destinations, this service account is used to generate identity tokens when invoking the service. See https://cloud.google.com/run/docs/triggering/pubsub-push#create-service-account for information on how to invoke authenticated Cloud Run services. In order to create Audit Log triggers, the service account should also have ‘eventarc.events.receiveAuditLogV1Written’ permission.
Destination DestinationArgs
Destination specifies where the events should be sent to.
MatchingCriteria []MatchingCriteriaArgs
null The criteria by which events are filtered. Only events that match with this criteria will be sent to the destination.
TriggerId string
ValidateOnly string
Labels map[string]string
Optional. User labels attached to the triggers that can be used to group resources.
Location string
Name string
The resource name of the trigger. Must be unique within the location on the project and must in projects/{project}/locations/{location}/triggers/{trigger} format.
Project string
ServiceAccount string
Optional. The IAM service account email associated with the trigger. The service account represents the identity of the trigger. The principal who calls this API must have iam.serviceAccounts.actAs permission in the service account. See https://cloud.google.com/iam/docs/understanding-service-accounts?hl=en#sa_common for more information. For Cloud Run destinations, this service account is used to generate identity tokens when invoking the service. See https://cloud.google.com/run/docs/triggering/pubsub-push#create-service-account for information on how to invoke authenticated Cloud Run services. In order to create Audit Log triggers, the service account should also have ‘eventarc.events.receiveAuditLogV1Written’ permission.
destination DestinationArgs
Destination specifies where the events should be sent to.
matchingCriteria MatchingCriteriaArgs[]
null The criteria by which events are filtered. Only events that match with this criteria will be sent to the destination.
triggerId string
validateOnly string
labels {[key: string]: string}
Optional. User labels attached to the triggers that can be used to group resources.
location string
name string
The resource name of the trigger. Must be unique within the location on the project and must in projects/{project}/locations/{location}/triggers/{trigger} format.
project string
serviceAccount string
Optional. The IAM service account email associated with the trigger. The service account represents the identity of the trigger. The principal who calls this API must have iam.serviceAccounts.actAs permission in the service account. See https://cloud.google.com/iam/docs/understanding-service-accounts?hl=en#sa_common for more information. For Cloud Run destinations, this service account is used to generate identity tokens when invoking the service. See https://cloud.google.com/run/docs/triggering/pubsub-push#create-service-account for information on how to invoke authenticated Cloud Run services. In order to create Audit Log triggers, the service account should also have ‘eventarc.events.receiveAuditLogV1Written’ permission.
destination DestinationArgs
Destination specifies where the events should be sent to.
matching_criteria Sequence[MatchingCriteriaArgs]
null The criteria by which events are filtered. Only events that match with this criteria will be sent to the destination.
trigger_id str
validate_only str
labels Mapping[str, str]
Optional. User labels attached to the triggers that can be used to group resources.
location str
name str
The resource name of the trigger. Must be unique within the location on the project and must in projects/{project}/locations/{location}/triggers/{trigger} format.
project str
service_account str
Optional. The IAM service account email associated with the trigger. The service account represents the identity of the trigger. The principal who calls this API must have iam.serviceAccounts.actAs permission in the service account. See https://cloud.google.com/iam/docs/understanding-service-accounts?hl=en#sa_common for more information. For Cloud Run destinations, this service account is used to generate identity tokens when invoking the service. See https://cloud.google.com/run/docs/triggering/pubsub-push#create-service-account for information on how to invoke authenticated Cloud Run services. In order to create Audit Log triggers, the service account should also have ‘eventarc.events.receiveAuditLogV1Written’ permission.

Outputs

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

CreateTime string
The creation time.
Etag string
This checksum is computed by the server based on the value of other fields, and may be sent only on create requests to ensure the client has an up-to-date value before proceeding.
Id string
The provider-assigned unique ID for this managed resource.
Transport Pulumi.GoogleNative.Eventarc.V1Beta1.Outputs.TransportResponse
In order to deliver messages, Eventarc may use other GCP products as transport intermediary. This field contains a reference to that transport intermediary. This information can be used for debugging purposes.
UpdateTime string
The last-modified time.
CreateTime string
The creation time.
Etag string
This checksum is computed by the server based on the value of other fields, and may be sent only on create requests to ensure the client has an up-to-date value before proceeding.
Id string
The provider-assigned unique ID for this managed resource.
Transport TransportResponse
In order to deliver messages, Eventarc may use other GCP products as transport intermediary. This field contains a reference to that transport intermediary. This information can be used for debugging purposes.
UpdateTime string
The last-modified time.
createTime string
The creation time.
etag string
This checksum is computed by the server based on the value of other fields, and may be sent only on create requests to ensure the client has an up-to-date value before proceeding.
id string
The provider-assigned unique ID for this managed resource.
transport TransportResponse
In order to deliver messages, Eventarc may use other GCP products as transport intermediary. This field contains a reference to that transport intermediary. This information can be used for debugging purposes.
updateTime string
The last-modified time.
create_time str
The creation time.
etag str
This checksum is computed by the server based on the value of other fields, and may be sent only on create requests to ensure the client has an up-to-date value before proceeding.
id str
The provider-assigned unique ID for this managed resource.
transport TransportResponse
In order to deliver messages, Eventarc may use other GCP products as transport intermediary. This field contains a reference to that transport intermediary. This information can be used for debugging purposes.
update_time str
The last-modified time.

Supporting Types

CloudRunService

Region string
The region the Cloud Run service is deployed in.
Service string
The name of the Cloud run service being addressed (see https://cloud.google.com/run/docs/reference/rest/v1/namespaces.services). Only services located in the same project of the trigger object can be addressed.
Path string
Optional. The relative path on the Cloud Run service the events should be sent to. The value must conform to the definition of URI path segment (section 3.3 of RFC2396). Examples: “/route”, “route”, “route/subroute”.
Region string
The region the Cloud Run service is deployed in.
Service string
The name of the Cloud run service being addressed (see https://cloud.google.com/run/docs/reference/rest/v1/namespaces.services). Only services located in the same project of the trigger object can be addressed.
Path string
Optional. The relative path on the Cloud Run service the events should be sent to. The value must conform to the definition of URI path segment (section 3.3 of RFC2396). Examples: “/route”, “route”, “route/subroute”.
region string
The region the Cloud Run service is deployed in.
service string
The name of the Cloud run service being addressed (see https://cloud.google.com/run/docs/reference/rest/v1/namespaces.services). Only services located in the same project of the trigger object can be addressed.
path string
Optional. The relative path on the Cloud Run service the events should be sent to. The value must conform to the definition of URI path segment (section 3.3 of RFC2396). Examples: “/route”, “route”, “route/subroute”.
region str
The region the Cloud Run service is deployed in.
service str
The name of the Cloud run service being addressed (see https://cloud.google.com/run/docs/reference/rest/v1/namespaces.services). Only services located in the same project of the trigger object can be addressed.
path str
Optional. The relative path on the Cloud Run service the events should be sent to. The value must conform to the definition of URI path segment (section 3.3 of RFC2396). Examples: “/route”, “route”, “route/subroute”.

CloudRunServiceResponse

Path string
Optional. The relative path on the Cloud Run service the events should be sent to. The value must conform to the definition of URI path segment (section 3.3 of RFC2396). Examples: “/route”, “route”, “route/subroute”.
Region string
The region the Cloud Run service is deployed in.
Service string
The name of the Cloud run service being addressed (see https://cloud.google.com/run/docs/reference/rest/v1/namespaces.services). Only services located in the same project of the trigger object can be addressed.
Path string
Optional. The relative path on the Cloud Run service the events should be sent to. The value must conform to the definition of URI path segment (section 3.3 of RFC2396). Examples: “/route”, “route”, “route/subroute”.
Region string
The region the Cloud Run service is deployed in.
Service string
The name of the Cloud run service being addressed (see https://cloud.google.com/run/docs/reference/rest/v1/namespaces.services). Only services located in the same project of the trigger object can be addressed.
path string
Optional. The relative path on the Cloud Run service the events should be sent to. The value must conform to the definition of URI path segment (section 3.3 of RFC2396). Examples: “/route”, “route”, “route/subroute”.
region string
The region the Cloud Run service is deployed in.
service string
The name of the Cloud run service being addressed (see https://cloud.google.com/run/docs/reference/rest/v1/namespaces.services). Only services located in the same project of the trigger object can be addressed.
path str
Optional. The relative path on the Cloud Run service the events should be sent to. The value must conform to the definition of URI path segment (section 3.3 of RFC2396). Examples: “/route”, “route”, “route/subroute”.
region str
The region the Cloud Run service is deployed in.
service str
The name of the Cloud run service being addressed (see https://cloud.google.com/run/docs/reference/rest/v1/namespaces.services). Only services located in the same project of the trigger object can be addressed.

Destination

CloudRunService Pulumi.GoogleNative.Eventarc.V1Beta1.Inputs.CloudRunService
Cloud Run fully-managed service that receives the events. The service should be running in the same project as the trigger.
CloudRunService CloudRunService
Cloud Run fully-managed service that receives the events. The service should be running in the same project as the trigger.
cloudRunService CloudRunService
Cloud Run fully-managed service that receives the events. The service should be running in the same project as the trigger.
cloud_run_service CloudRunService
Cloud Run fully-managed service that receives the events. The service should be running in the same project as the trigger.

DestinationResponse

CloudRunService Pulumi.GoogleNative.Eventarc.V1Beta1.Inputs.CloudRunServiceResponse
Cloud Run fully-managed service that receives the events. The service should be running in the same project as the trigger.
CloudRunService CloudRunServiceResponse
Cloud Run fully-managed service that receives the events. The service should be running in the same project as the trigger.
cloudRunService CloudRunServiceResponse
Cloud Run fully-managed service that receives the events. The service should be running in the same project as the trigger.
cloud_run_service CloudRunServiceResponse
Cloud Run fully-managed service that receives the events. The service should be running in the same project as the trigger.

MatchingCriteria

Attribute string
The name of a CloudEvents attribute. Currently, only a subset of attributes can be specified. All triggers MUST provide a matching criteria for the ‘type’ attribute.
Value string
The value for the attribute.
Attribute string
The name of a CloudEvents attribute. Currently, only a subset of attributes can be specified. All triggers MUST provide a matching criteria for the ‘type’ attribute.
Value string
The value for the attribute.
attribute string
The name of a CloudEvents attribute. Currently, only a subset of attributes can be specified. All triggers MUST provide a matching criteria for the ‘type’ attribute.
value string
The value for the attribute.
attribute str
The name of a CloudEvents attribute. Currently, only a subset of attributes can be specified. All triggers MUST provide a matching criteria for the ‘type’ attribute.
value str
The value for the attribute.

MatchingCriteriaResponse

Attribute string
The name of a CloudEvents attribute. Currently, only a subset of attributes can be specified. All triggers MUST provide a matching criteria for the ‘type’ attribute.
Value string
The value for the attribute.
Attribute string
The name of a CloudEvents attribute. Currently, only a subset of attributes can be specified. All triggers MUST provide a matching criteria for the ‘type’ attribute.
Value string
The value for the attribute.
attribute string
The name of a CloudEvents attribute. Currently, only a subset of attributes can be specified. All triggers MUST provide a matching criteria for the ‘type’ attribute.
value string
The value for the attribute.
attribute str
The name of a CloudEvents attribute. Currently, only a subset of attributes can be specified. All triggers MUST provide a matching criteria for the ‘type’ attribute.
value str
The value for the attribute.

PubsubResponse

Subscription string
The name of the Pub/Sub subscription created and managed by Eventarc system as a transport for the event delivery. Format: projects/{PROJECT_ID}/subscriptions/{SUBSCRIPTION_NAME}.
Topic string
Optional. The name of the Pub/Sub topic created and managed by Eventarc system as a transport for the event delivery. Format: projects/{PROJECT_ID}/topics/{TOPIC_NAME}. You may set an existing topic for triggers of the type google.cloud.pubsub.topic.v1.messagePublished only. The topic you provide here will not be deleted by Eventarc at trigger deletion.
Subscription string
The name of the Pub/Sub subscription created and managed by Eventarc system as a transport for the event delivery. Format: projects/{PROJECT_ID}/subscriptions/{SUBSCRIPTION_NAME}.
Topic string
Optional. The name of the Pub/Sub topic created and managed by Eventarc system as a transport for the event delivery. Format: projects/{PROJECT_ID}/topics/{TOPIC_NAME}. You may set an existing topic for triggers of the type google.cloud.pubsub.topic.v1.messagePublished only. The topic you provide here will not be deleted by Eventarc at trigger deletion.
subscription string
The name of the Pub/Sub subscription created and managed by Eventarc system as a transport for the event delivery. Format: projects/{PROJECT_ID}/subscriptions/{SUBSCRIPTION_NAME}.
topic string
Optional. The name of the Pub/Sub topic created and managed by Eventarc system as a transport for the event delivery. Format: projects/{PROJECT_ID}/topics/{TOPIC_NAME}. You may set an existing topic for triggers of the type google.cloud.pubsub.topic.v1.messagePublished only. The topic you provide here will not be deleted by Eventarc at trigger deletion.
subscription str
The name of the Pub/Sub subscription created and managed by Eventarc system as a transport for the event delivery. Format: projects/{PROJECT_ID}/subscriptions/{SUBSCRIPTION_NAME}.
topic str
Optional. The name of the Pub/Sub topic created and managed by Eventarc system as a transport for the event delivery. Format: projects/{PROJECT_ID}/topics/{TOPIC_NAME}. You may set an existing topic for triggers of the type google.cloud.pubsub.topic.v1.messagePublished only. The topic you provide here will not be deleted by Eventarc at trigger deletion.

TransportResponse

Pubsub Pulumi.GoogleNative.Eventarc.V1Beta1.Inputs.PubsubResponse
The Pub/Sub topic and subscription used by Eventarc as delivery intermediary.
Pubsub PubsubResponse
The Pub/Sub topic and subscription used by Eventarc as delivery intermediary.
pubsub PubsubResponse
The Pub/Sub topic and subscription used by Eventarc as delivery intermediary.
pubsub PubsubResponse
The Pub/Sub topic and subscription used by Eventarc as delivery intermediary.

Package Details

Repository
https://github.com/pulumi/pulumi-google-native
License
Apache-2.0