Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. eventarc
  5. Enrollment
Google Cloud v8.29.0 published on Thursday, May 1, 2025 by Pulumi
pulumi/pulumi-gcp

gcp.eventarc.Enrollment

Explore with Pulumi AI

gcp logo
Google Cloud v8.29.0 published on Thursday, May 1, 2025 by Pulumi
pulumi/pulumi-gcp

    The Eventarc Enrollment resource

    To get more information about Enrollment, see:

    Example Usage

    Eventarc Enrollment With Pipeline Destination

    import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const pipeline = new gcp.eventarc.Pipeline("pipeline", {
    location: "us-central1",
    pipelineId: "some-pipeline",
    destinations: [{
        httpEndpoint: {
            uri: "https://10.77.0.0:80/route",
        },
        networkConfig: {
            networkAttachment: "projects/my-project-name/regions/us-central1/networkAttachments/some-network-attachment",
        },
    }],
});
const primary = new gcp.eventarc.Enrollment("primary", {
    location: "us-central1",
    enrollmentId: "some-enrollment",
    messageBus: primaryGoogleEventarcMessageBus.id,
    destination: pipeline.id,
    celMatch: "message.type == 'google.cloud.dataflow.job.v1beta3.statusChanged'",
});
const messageBus = new gcp.eventarc.MessageBus("message_bus", {
    location: "us-central1",
    messageBusId: "some-message-bus",
});

    import pulumi
import pulumi_gcp as gcp

pipeline = gcp.eventarc.Pipeline("pipeline",
    location="us-central1",
    pipeline_id="some-pipeline",
    destinations=[{
        "http_endpoint": {
            "uri": "https://10.77.0.0:80/route",
        },
        "network_config": {
            "network_attachment": "projects/my-project-name/regions/us-central1/networkAttachments/some-network-attachment",
        },
    }])
primary = gcp.eventarc.Enrollment("primary",
    location="us-central1",
    enrollment_id="some-enrollment",
    message_bus=primary_google_eventarc_message_bus["id"],
    destination=pipeline.id,
    cel_match="message.type == 'google.cloud.dataflow.job.v1beta3.statusChanged'")
message_bus = gcp.eventarc.MessageBus("message_bus",
    location="us-central1",
    message_bus_id="some-message-bus")

    package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/eventarc"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		pipeline, err := eventarc.NewPipeline(ctx, "pipeline", &eventarc.PipelineArgs{
			Location:   pulumi.String("us-central1"),
			PipelineId: pulumi.String("some-pipeline"),
			Destinations: eventarc.PipelineDestinationArray{
				&eventarc.PipelineDestinationArgs{
					HttpEndpoint: &eventarc.PipelineDestinationHttpEndpointArgs{
						Uri: pulumi.String("https://10.77.0.0:80/route"),
					},
					NetworkConfig: &eventarc.PipelineDestinationNetworkConfigArgs{
						NetworkAttachment: pulumi.String("projects/my-project-name/regions/us-central1/networkAttachments/some-network-attachment"),
					},
				},
			},
		})
		if err != nil {
			return err
		}
		_, err = eventarc.NewEnrollment(ctx, "primary", &eventarc.EnrollmentArgs{
			Location:     pulumi.String("us-central1"),
			EnrollmentId: pulumi.String("some-enrollment"),
			MessageBus:   pulumi.Any(primaryGoogleEventarcMessageBus.Id),
			Destination:  pipeline.ID(),
			CelMatch:     pulumi.String("message.type == 'google.cloud.dataflow.job.v1beta3.statusChanged'"),
		})
		if err != nil {
			return err
		}
		_, err = eventarc.NewMessageBus(ctx, "message_bus", &eventarc.MessageBusArgs{
			Location:     pulumi.String("us-central1"),
			MessageBusId: pulumi.String("some-message-bus"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() => 
{
    var pipeline = new Gcp.Eventarc.Pipeline("pipeline", new()
    {
        Location = "us-central1",
        PipelineId = "some-pipeline",
        Destinations = new[]
        {
            new Gcp.Eventarc.Inputs.PipelineDestinationArgs
            {
                HttpEndpoint = new Gcp.Eventarc.Inputs.PipelineDestinationHttpEndpointArgs
                {
                    Uri = "https://10.77.0.0:80/route",
                },
                NetworkConfig = new Gcp.Eventarc.Inputs.PipelineDestinationNetworkConfigArgs
                {
                    NetworkAttachment = "projects/my-project-name/regions/us-central1/networkAttachments/some-network-attachment",
                },
            },
        },
    });

    var primary = new Gcp.Eventarc.Enrollment("primary", new()
    {
        Location = "us-central1",
        EnrollmentId = "some-enrollment",
        MessageBus = primaryGoogleEventarcMessageBus.Id,
        Destination = pipeline.Id,
        CelMatch = "message.type == 'google.cloud.dataflow.job.v1beta3.statusChanged'",
    });

    var messageBus = new Gcp.Eventarc.MessageBus("message_bus", new()
    {
        Location = "us-central1",
        MessageBusId = "some-message-bus",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.eventarc.Pipeline;
import com.pulumi.gcp.eventarc.PipelineArgs;
import com.pulumi.gcp.eventarc.inputs.PipelineDestinationArgs;
import com.pulumi.gcp.eventarc.inputs.PipelineDestinationHttpEndpointArgs;
import com.pulumi.gcp.eventarc.inputs.PipelineDestinationNetworkConfigArgs;
import com.pulumi.gcp.eventarc.Enrollment;
import com.pulumi.gcp.eventarc.EnrollmentArgs;
import com.pulumi.gcp.eventarc.MessageBus;
import com.pulumi.gcp.eventarc.MessageBusArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var pipeline = new Pipeline("pipeline", PipelineArgs.builder()
            .location("us-central1")
            .pipelineId("some-pipeline")
            .destinations(PipelineDestinationArgs.builder()
                .httpEndpoint(PipelineDestinationHttpEndpointArgs.builder()
                    .uri("https://10.77.0.0:80/route")
                    .build())
                .networkConfig(PipelineDestinationNetworkConfigArgs.builder()
                    .networkAttachment("projects/my-project-name/regions/us-central1/networkAttachments/some-network-attachment")
                    .build())
                .build())
            .build());

        var primary = new Enrollment("primary", EnrollmentArgs.builder()
            .location("us-central1")
            .enrollmentId("some-enrollment")
            .messageBus(primaryGoogleEventarcMessageBus.id())
            .destination(pipeline.id())
            .celMatch("message.type == 'google.cloud.dataflow.job.v1beta3.statusChanged'")
            .build());

        var messageBus = new MessageBus("messageBus", MessageBusArgs.builder()
            .location("us-central1")
            .messageBusId("some-message-bus")
            .build());

    }
}

    resources:
  primary:
    type: gcp:eventarc:Enrollment
    properties:
      location: us-central1
      enrollmentId: some-enrollment
      messageBus: ${primaryGoogleEventarcMessageBus.id}
      destination: ${pipeline.id}
      celMatch: message.type == 'google.cloud.dataflow.job.v1beta3.statusChanged'
  pipeline:
    type: gcp:eventarc:Pipeline
    properties:
      location: us-central1
      pipelineId: some-pipeline
      destinations:
        - httpEndpoint:
            uri: https://10.77.0.0:80/route
          networkConfig:
            networkAttachment: projects/my-project-name/regions/us-central1/networkAttachments/some-network-attachment
  messageBus:
    type: gcp:eventarc:MessageBus
    name: message_bus
    properties:
      location: us-central1
      messageBusId: some-message-bus

    Create Enrollment Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Enrollment(name: string, args: EnrollmentArgs, opts?: CustomResourceOptions);
    @overload
def Enrollment(resource_name: str,
               args: EnrollmentArgs,
               opts: Optional[ResourceOptions] = None)

@overload
def Enrollment(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               cel_match: Optional[str] = None,
               destination: Optional[str] = None,
               enrollment_id: Optional[str] = None,
               location: Optional[str] = None,
               message_bus: Optional[str] = None,
               annotations: Optional[Mapping[str, str]] = None,
               display_name: Optional[str] = None,
               labels: Optional[Mapping[str, str]] = None,
               project: Optional[str] = None)
    func NewEnrollment(ctx *Context, name string, args EnrollmentArgs, opts ...ResourceOption) (*Enrollment, error)
    public Enrollment(string name, EnrollmentArgs args, CustomResourceOptions? opts = null)
    public Enrollment(String name, EnrollmentArgs args)
public Enrollment(String name, EnrollmentArgs args, CustomResourceOptions options)

    type: gcp:eventarc:Enrollment
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args EnrollmentArgs
    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 EnrollmentArgs
    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 EnrollmentArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args EnrollmentArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args EnrollmentArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var enrollmentResource = new Gcp.Eventarc.Enrollment("enrollmentResource", new()
{
    CelMatch = "string",
    Destination = "string",
    EnrollmentId = "string",
    Location = "string",
    MessageBus = "string",
    Annotations = 
    {
        { "string", "string" },
    },
    DisplayName = "string",
    Labels = 
    {
        { "string", "string" },
    },
    Project = "string",
});

    example, err := eventarc.NewEnrollment(ctx, "enrollmentResource", &eventarc.EnrollmentArgs{
	CelMatch:     pulumi.String("string"),
	Destination:  pulumi.String("string"),
	EnrollmentId: pulumi.String("string"),
	Location:     pulumi.String("string"),
	MessageBus:   pulumi.String("string"),
	Annotations: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	DisplayName: pulumi.String("string"),
	Labels: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Project: pulumi.String("string"),
})

    var enrollmentResource = new Enrollment("enrollmentResource", EnrollmentArgs.builder()
    .celMatch("string")
    .destination("string")
    .enrollmentId("string")
    .location("string")
    .messageBus("string")
    .annotations(Map.of("string", "string"))
    .displayName("string")
    .labels(Map.of("string", "string"))
    .project("string")
    .build());

    enrollment_resource = gcp.eventarc.Enrollment("enrollmentResource",
    cel_match="string",
    destination="string",
    enrollment_id="string",
    location="string",
    message_bus="string",
    annotations={
        "string": "string",
    },
    display_name="string",
    labels={
        "string": "string",
    },
    project="string")

    const enrollmentResource = new gcp.eventarc.Enrollment("enrollmentResource", {
    celMatch: "string",
    destination: "string",
    enrollmentId: "string",
    location: "string",
    messageBus: "string",
    annotations: {
        string: "string",
    },
    displayName: "string",
    labels: {
        string: "string",
    },
    project: "string",
});

    type: gcp:eventarc:Enrollment
properties:
    annotations:
        string: string
    celMatch: string
    destination: string
    displayName: string
    enrollmentId: string
    labels:
        string: string
    location: string
    messageBus: string
    project: string

    Enrollment Resource Properties

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

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Enrollment resource accepts the following input properties:

    CelMatch string
    A CEL expression identifying which messages this enrollment applies to.
    Destination string
    Destination is the Pipeline that the Enrollment is delivering to. It must point to the full resource name of a Pipeline. Format: "projects/{PROJECT_ID}/locations/{region}/pipelines/{PIPELINE_ID)"
    EnrollmentId string
    The user-provided ID to be assigned to the Enrollment. It should match the format ^a-z?$.

    Location string
    Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
    MessageBus string
    Resource name of the message bus identifying the source of the messages. It matches the form projects/{project}/locations/{location}/messageBuses/{messageBus}.
    Annotations Dictionary<string, string>
    Resource annotations. Note: This field is non-authoritative, and will only manage the annotations present in your configuration. Please refer to the field effective_annotations for all of the annotations present on the resource.
    DisplayName string
    Resource display name.
    Labels Dictionary<string, string>
    Resource labels. Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    CelMatch string
    A CEL expression identifying which messages this enrollment applies to.
    Destination string
    Destination is the Pipeline that the Enrollment is delivering to. It must point to the full resource name of a Pipeline. Format: "projects/{PROJECT_ID}/locations/{region}/pipelines/{PIPELINE_ID)"
    EnrollmentId string
    The user-provided ID to be assigned to the Enrollment. It should match the format ^a-z?$.

    Location string
    Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
    MessageBus string
    Resource name of the message bus identifying the source of the messages. It matches the form projects/{project}/locations/{location}/messageBuses/{messageBus}.
    Annotations map[string]string
    Resource annotations. Note: This field is non-authoritative, and will only manage the annotations present in your configuration. Please refer to the field effective_annotations for all of the annotations present on the resource.
    DisplayName string
    Resource display name.
    Labels map[string]string
    Resource labels. Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    celMatch String
    A CEL expression identifying which messages this enrollment applies to.
    destination String
    Destination is the Pipeline that the Enrollment is delivering to. It must point to the full resource name of a Pipeline. Format: "projects/{PROJECT_ID}/locations/{region}/pipelines/{PIPELINE_ID)"
    enrollmentId String
    The user-provided ID to be assigned to the Enrollment. It should match the format ^a-z?$.

    location String
    Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
    messageBus String
    Resource name of the message bus identifying the source of the messages. It matches the form projects/{project}/locations/{location}/messageBuses/{messageBus}.
    annotations Map<String,String>
    Resource annotations. Note: This field is non-authoritative, and will only manage the annotations present in your configuration. Please refer to the field effective_annotations for all of the annotations present on the resource.
    displayName String
    Resource display name.
    labels Map<String,String>
    Resource labels. Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    celMatch string
    A CEL expression identifying which messages this enrollment applies to.
    destination string
    Destination is the Pipeline that the Enrollment is delivering to. It must point to the full resource name of a Pipeline. Format: "projects/{PROJECT_ID}/locations/{region}/pipelines/{PIPELINE_ID)"
    enrollmentId string
    The user-provided ID to be assigned to the Enrollment. It should match the format ^a-z?$.

    location string
    Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
    messageBus string
    Resource name of the message bus identifying the source of the messages. It matches the form projects/{project}/locations/{location}/messageBuses/{messageBus}.
    annotations {[key: string]: string}
    Resource annotations. Note: This field is non-authoritative, and will only manage the annotations present in your configuration. Please refer to the field effective_annotations for all of the annotations present on the resource.
    displayName string
    Resource display name.
    labels {[key: string]: string}
    Resource labels. Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.
    project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    cel_match str
    A CEL expression identifying which messages this enrollment applies to.
    destination str
    Destination is the Pipeline that the Enrollment is delivering to. It must point to the full resource name of a Pipeline. Format: "projects/{PROJECT_ID}/locations/{region}/pipelines/{PIPELINE_ID)"
    enrollment_id str
    The user-provided ID to be assigned to the Enrollment. It should match the format ^a-z?$.

    location str
    Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
    message_bus str
    Resource name of the message bus identifying the source of the messages. It matches the form projects/{project}/locations/{location}/messageBuses/{messageBus}.
    annotations Mapping[str, str]
    Resource annotations. Note: This field is non-authoritative, and will only manage the annotations present in your configuration. Please refer to the field effective_annotations for all of the annotations present on the resource.
    display_name str
    Resource display name.
    labels Mapping[str, str]
    Resource labels. Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.
    project str
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    celMatch String
    A CEL expression identifying which messages this enrollment applies to.
    destination String
    Destination is the Pipeline that the Enrollment is delivering to. It must point to the full resource name of a Pipeline. Format: "projects/{PROJECT_ID}/locations/{region}/pipelines/{PIPELINE_ID)"
    enrollmentId String
    The user-provided ID to be assigned to the Enrollment. It should match the format ^a-z?$.

    location String
    Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
    messageBus String
    Resource name of the message bus identifying the source of the messages. It matches the form projects/{project}/locations/{location}/messageBuses/{messageBus}.
    annotations Map<String>
    Resource annotations. Note: This field is non-authoritative, and will only manage the annotations present in your configuration. Please refer to the field effective_annotations for all of the annotations present on the resource.
    displayName String
    Resource display name.
    labels Map<String>
    Resource labels. Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

    Outputs

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

    CreateTime string
    The creation time.
    EffectiveAnnotations Dictionary<string, string>
    EffectiveLabels Dictionary<string, string>
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    Etag string
    This checksum is computed by the server based on the value of other fields, and might be sent only on update and delete requests to ensure that the client has an up-to-date value before proceeding.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    Resource name of the form projects/{project}/locations/{location}/enrollments/{enrollment}
    PulumiLabels Dictionary<string, string>
    The combination of labels configured directly on the resource and default labels configured on the provider.
    Uid string
    Server assigned unique identifier for the channel. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted.
    UpdateTime string
    The last-modified time.
    CreateTime string
    The creation time.
    EffectiveAnnotations map[string]string
    EffectiveLabels map[string]string
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    Etag string
    This checksum is computed by the server based on the value of other fields, and might be sent only on update and delete requests to ensure that the client has an up-to-date value before proceeding.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    Resource name of the form projects/{project}/locations/{location}/enrollments/{enrollment}
    PulumiLabels map[string]string
    The combination of labels configured directly on the resource and default labels configured on the provider.
    Uid string
    Server assigned unique identifier for the channel. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted.
    UpdateTime string
    The last-modified time.
    createTime String
    The creation time.
    effectiveAnnotations Map<String,String>
    effectiveLabels Map<String,String>
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    etag String
    This checksum is computed by the server based on the value of other fields, and might be sent only on update and delete requests to ensure that the client has an up-to-date value before proceeding.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    Resource name of the form projects/{project}/locations/{location}/enrollments/{enrollment}
    pulumiLabels Map<String,String>
    The combination of labels configured directly on the resource and default labels configured on the provider.
    uid String
    Server assigned unique identifier for the channel. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted.
    updateTime String
    The last-modified time.
    createTime string
    The creation time.
    effectiveAnnotations {[key: string]: string}
    effectiveLabels {[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.
    etag string
    This checksum is computed by the server based on the value of other fields, and might be sent only on update and delete requests to ensure that the client has an up-to-date value before proceeding.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    Resource name of the form projects/{project}/locations/{location}/enrollments/{enrollment}
    pulumiLabels {[key: string]: string}
    The combination of labels configured directly on the resource and default labels configured on the provider.
    uid string
    Server assigned unique identifier for the channel. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted.
    updateTime string
    The last-modified time.
    create_time str
    The creation time.
    effective_annotations Mapping[str, str]
    effective_labels Mapping[str, str]
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    etag str
    This checksum is computed by the server based on the value of other fields, and might be sent only on update and delete requests to ensure that the client has an up-to-date value before proceeding.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    Resource name of the form projects/{project}/locations/{location}/enrollments/{enrollment}
    pulumi_labels Mapping[str, str]
    The combination of labels configured directly on the resource and default labels configured on the provider.
    uid str
    Server assigned unique identifier for the channel. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted.
    update_time str
    The last-modified time.
    createTime String
    The creation time.
    effectiveAnnotations Map<String>
    effectiveLabels Map<String>
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    etag String
    This checksum is computed by the server based on the value of other fields, and might be sent only on update and delete requests to ensure that the client has an up-to-date value before proceeding.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    Resource name of the form projects/{project}/locations/{location}/enrollments/{enrollment}
    pulumiLabels Map<String>
    The combination of labels configured directly on the resource and default labels configured on the provider.
    uid String
    Server assigned unique identifier for the channel. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted.
    updateTime String
    The last-modified time.

    Look up Existing Enrollment Resource

    Get an existing Enrollment 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?: EnrollmentState, opts?: CustomResourceOptions): Enrollment
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        annotations: Optional[Mapping[str, str]] = None,
        cel_match: Optional[str] = None,
        create_time: Optional[str] = None,
        destination: Optional[str] = None,
        display_name: Optional[str] = None,
        effective_annotations: Optional[Mapping[str, str]] = None,
        effective_labels: Optional[Mapping[str, str]] = None,
        enrollment_id: Optional[str] = None,
        etag: Optional[str] = None,
        labels: Optional[Mapping[str, str]] = None,
        location: Optional[str] = None,
        message_bus: Optional[str] = None,
        name: Optional[str] = None,
        project: Optional[str] = None,
        pulumi_labels: Optional[Mapping[str, str]] = None,
        uid: Optional[str] = None,
        update_time: Optional[str] = None) -> Enrollment
    func GetEnrollment(ctx *Context, name string, id IDInput, state *EnrollmentState, opts ...ResourceOption) (*Enrollment, error)
    public static Enrollment Get(string name, Input<string> id, EnrollmentState? state, CustomResourceOptions? opts = null)
    public static Enrollment get(String name, Output<String> id, EnrollmentState state, CustomResourceOptions options)
    resources:  _:    type: gcp:eventarc:Enrollment    get:      id: ${id}
    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.
    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:
    Annotations Dictionary<string, string>
    Resource annotations. Note: This field is non-authoritative, and will only manage the annotations present in your configuration. Please refer to the field effective_annotations for all of the annotations present on the resource.
    CelMatch string
    A CEL expression identifying which messages this enrollment applies to.
    CreateTime string
    The creation time.
    Destination string
    Destination is the Pipeline that the Enrollment is delivering to. It must point to the full resource name of a Pipeline. Format: "projects/{PROJECT_ID}/locations/{region}/pipelines/{PIPELINE_ID)"
    DisplayName string
    Resource display name.
    EffectiveAnnotations Dictionary<string, string>
    EffectiveLabels Dictionary<string, string>
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    EnrollmentId string
    The user-provided ID to be assigned to the Enrollment. It should match the format ^a-z?$.

    Etag string
    This checksum is computed by the server based on the value of other fields, and might be sent only on update and delete requests to ensure that the client has an up-to-date value before proceeding.
    Labels Dictionary<string, string>
    Resource labels. Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.
    Location string
    Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
    MessageBus string
    Resource name of the message bus identifying the source of the messages. It matches the form projects/{project}/locations/{location}/messageBuses/{messageBus}.
    Name string
    Resource name of the form projects/{project}/locations/{location}/enrollments/{enrollment}
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    PulumiLabels Dictionary<string, string>
    The combination of labels configured directly on the resource and default labels configured on the provider.
    Uid string
    Server assigned unique identifier for the channel. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted.
    UpdateTime string
    The last-modified time.
    Annotations map[string]string
    Resource annotations. Note: This field is non-authoritative, and will only manage the annotations present in your configuration. Please refer to the field effective_annotations for all of the annotations present on the resource.
    CelMatch string
    A CEL expression identifying which messages this enrollment applies to.
    CreateTime string
    The creation time.
    Destination string
    Destination is the Pipeline that the Enrollment is delivering to. It must point to the full resource name of a Pipeline. Format: "projects/{PROJECT_ID}/locations/{region}/pipelines/{PIPELINE_ID)"
    DisplayName string
    Resource display name.
    EffectiveAnnotations map[string]string
    EffectiveLabels map[string]string
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    EnrollmentId string
    The user-provided ID to be assigned to the Enrollment. It should match the format ^a-z?$.

    Etag string
    This checksum is computed by the server based on the value of other fields, and might be sent only on update and delete requests to ensure that the client has an up-to-date value before proceeding.
    Labels map[string]string
    Resource labels. Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.
    Location string
    Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
    MessageBus string
    Resource name of the message bus identifying the source of the messages. It matches the form projects/{project}/locations/{location}/messageBuses/{messageBus}.
    Name string
    Resource name of the form projects/{project}/locations/{location}/enrollments/{enrollment}
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    PulumiLabels map[string]string
    The combination of labels configured directly on the resource and default labels configured on the provider.
    Uid string
    Server assigned unique identifier for the channel. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted.
    UpdateTime string
    The last-modified time.
    annotations Map<String,String>
    Resource annotations. Note: This field is non-authoritative, and will only manage the annotations present in your configuration. Please refer to the field effective_annotations for all of the annotations present on the resource.
    celMatch String
    A CEL expression identifying which messages this enrollment applies to.
    createTime String
    The creation time.
    destination String
    Destination is the Pipeline that the Enrollment is delivering to. It must point to the full resource name of a Pipeline. Format: "projects/{PROJECT_ID}/locations/{region}/pipelines/{PIPELINE_ID)"
    displayName String
    Resource display name.
    effectiveAnnotations Map<String,String>
    effectiveLabels Map<String,String>
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    enrollmentId String
    The user-provided ID to be assigned to the Enrollment. It should match the format ^a-z?$.

    etag String
    This checksum is computed by the server based on the value of other fields, and might be sent only on update and delete requests to ensure that the client has an up-to-date value before proceeding.
    labels Map<String,String>
    Resource labels. Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.
    location String
    Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
    messageBus String
    Resource name of the message bus identifying the source of the messages. It matches the form projects/{project}/locations/{location}/messageBuses/{messageBus}.
    name String
    Resource name of the form projects/{project}/locations/{location}/enrollments/{enrollment}
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    pulumiLabels Map<String,String>
    The combination of labels configured directly on the resource and default labels configured on the provider.
    uid String
    Server assigned unique identifier for the channel. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted.
    updateTime String
    The last-modified time.
    annotations {[key: string]: string}
    Resource annotations. Note: This field is non-authoritative, and will only manage the annotations present in your configuration. Please refer to the field effective_annotations for all of the annotations present on the resource.
    celMatch string
    A CEL expression identifying which messages this enrollment applies to.
    createTime string
    The creation time.
    destination string
    Destination is the Pipeline that the Enrollment is delivering to. It must point to the full resource name of a Pipeline. Format: "projects/{PROJECT_ID}/locations/{region}/pipelines/{PIPELINE_ID)"
    displayName string
    Resource display name.
    effectiveAnnotations {[key: string]: string}
    effectiveLabels {[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.
    enrollmentId string
    The user-provided ID to be assigned to the Enrollment. It should match the format ^a-z?$.

    etag string
    This checksum is computed by the server based on the value of other fields, and might be sent only on update and delete requests to ensure that the client has an up-to-date value before proceeding.
    labels {[key: string]: string}
    Resource labels. Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.
    location string
    Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
    messageBus string
    Resource name of the message bus identifying the source of the messages. It matches the form projects/{project}/locations/{location}/messageBuses/{messageBus}.
    name string
    Resource name of the form projects/{project}/locations/{location}/enrollments/{enrollment}
    project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    pulumiLabels {[key: string]: string}
    The combination of labels configured directly on the resource and default labels configured on the provider.
    uid string
    Server assigned unique identifier for the channel. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted.
    updateTime string
    The last-modified time.
    annotations Mapping[str, str]
    Resource annotations. Note: This field is non-authoritative, and will only manage the annotations present in your configuration. Please refer to the field effective_annotations for all of the annotations present on the resource.
    cel_match str
    A CEL expression identifying which messages this enrollment applies to.
    create_time str
    The creation time.
    destination str
    Destination is the Pipeline that the Enrollment is delivering to. It must point to the full resource name of a Pipeline. Format: "projects/{PROJECT_ID}/locations/{region}/pipelines/{PIPELINE_ID)"
    display_name str
    Resource display name.
    effective_annotations Mapping[str, str]
    effective_labels Mapping[str, str]
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    enrollment_id str
    The user-provided ID to be assigned to the Enrollment. It should match the format ^a-z?$.

    etag str
    This checksum is computed by the server based on the value of other fields, and might be sent only on update and delete requests to ensure that the client has an up-to-date value before proceeding.
    labels Mapping[str, str]
    Resource labels. Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.
    location str
    Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
    message_bus str
    Resource name of the message bus identifying the source of the messages. It matches the form projects/{project}/locations/{location}/messageBuses/{messageBus}.
    name str
    Resource name of the form projects/{project}/locations/{location}/enrollments/{enrollment}
    project str
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    pulumi_labels Mapping[str, str]
    The combination of labels configured directly on the resource and default labels configured on the provider.
    uid str
    Server assigned unique identifier for the channel. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted.
    update_time str
    The last-modified time.
    annotations Map<String>
    Resource annotations. Note: This field is non-authoritative, and will only manage the annotations present in your configuration. Please refer to the field effective_annotations for all of the annotations present on the resource.
    celMatch String
    A CEL expression identifying which messages this enrollment applies to.
    createTime String
    The creation time.
    destination String
    Destination is the Pipeline that the Enrollment is delivering to. It must point to the full resource name of a Pipeline. Format: "projects/{PROJECT_ID}/locations/{region}/pipelines/{PIPELINE_ID)"
    displayName String
    Resource display name.
    effectiveAnnotations Map<String>
    effectiveLabels Map<String>
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    enrollmentId String
    The user-provided ID to be assigned to the Enrollment. It should match the format ^a-z?$.

    etag String
    This checksum is computed by the server based on the value of other fields, and might be sent only on update and delete requests to ensure that the client has an up-to-date value before proceeding.
    labels Map<String>
    Resource labels. Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.
    location String
    Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
    messageBus String
    Resource name of the message bus identifying the source of the messages. It matches the form projects/{project}/locations/{location}/messageBuses/{messageBus}.
    name String
    Resource name of the form projects/{project}/locations/{location}/enrollments/{enrollment}
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    pulumiLabels Map<String>
    The combination of labels configured directly on the resource and default labels configured on the provider.
    uid String
    Server assigned unique identifier for the channel. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted.
    updateTime String
    The last-modified time.

    Import

    Enrollment can be imported using any of these accepted formats:

    • projects/{{project}}/locations/{{location}}/enrollments/{{enrollment_id}}

    • {{project}}/{{location}}/{{enrollment_id}}

    • {{location}}/{{enrollment_id}}

    When using the pulumi import command, Enrollment can be imported using one of the formats above. For example:

    $ pulumi import gcp:eventarc/enrollment:Enrollment default projects/{{project}}/locations/{{location}}/enrollments/{{enrollment_id}}

    $ pulumi import gcp:eventarc/enrollment:Enrollment default {{project}}/{{location}}/{{enrollment_id}}

    $ pulumi import gcp:eventarc/enrollment:Enrollment default {{location}}/{{enrollment_id}}

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Google Cloud (GCP) Classic pulumi/pulumi-gcp
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the google-beta Terraform Provider.
    gcp logo
    Google Cloud v8.29.0 published on Thursday, May 1, 2025 by Pulumi
    pulumi/pulumi-gcp