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

gcp.eventarc.Channel

Explore with Pulumi AI

gcp logo
Google Cloud v8.22.0 published on Thursday, Mar 13, 2025 by Pulumi
pulumi/pulumi-gcp

    The Eventarc Channel resource

    To get more information about Channel, see:

    Example Usage

    Eventarc Channel With Cmek

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

const primary = new gcp.eventarc.Channel("primary", {
    location: "us-central1",
    name: "some-channel",
    cryptoKeyName: "some-key",
    thirdPartyProvider: "projects/my-project-name/locations/us-central1/providers/datadog",
});

    import pulumi
import pulumi_gcp as gcp

primary = gcp.eventarc.Channel("primary",
    location="us-central1",
    name="some-channel",
    crypto_key_name="some-key",
    third_party_provider="projects/my-project-name/locations/us-central1/providers/datadog")

    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 {
		_, err := eventarc.NewChannel(ctx, "primary", &eventarc.ChannelArgs{
			Location:           pulumi.String("us-central1"),
			Name:               pulumi.String("some-channel"),
			CryptoKeyName:      pulumi.String("some-key"),
			ThirdPartyProvider: pulumi.String("projects/my-project-name/locations/us-central1/providers/datadog"),
		})
		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 primary = new Gcp.Eventarc.Channel("primary", new()
    {
        Location = "us-central1",
        Name = "some-channel",
        CryptoKeyName = "some-key",
        ThirdPartyProvider = "projects/my-project-name/locations/us-central1/providers/datadog",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.eventarc.Channel;
import com.pulumi.gcp.eventarc.ChannelArgs;
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 primary = new Channel("primary", ChannelArgs.builder()
            .location("us-central1")
            .name("some-channel")
            .cryptoKeyName("some-key")
            .thirdPartyProvider("projects/my-project-name/locations/us-central1/providers/datadog")
            .build());

    }
}

    resources:
  primary:
    type: gcp:eventarc:Channel
    properties:
      location: us-central1
      name: some-channel
      cryptoKeyName: some-key
      thirdPartyProvider: projects/my-project-name/locations/us-central1/providers/datadog

    Create Channel Resource

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

    Constructor syntax

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

@overload
def Channel(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            location: Optional[str] = None,
            crypto_key_name: Optional[str] = None,
            name: Optional[str] = None,
            project: Optional[str] = None,
            third_party_provider: Optional[str] = None)
    func NewChannel(ctx *Context, name string, args ChannelArgs, opts ...ResourceOption) (*Channel, error)
    public Channel(string name, ChannelArgs args, CustomResourceOptions? opts = null)
    public Channel(String name, ChannelArgs args)
public Channel(String name, ChannelArgs args, CustomResourceOptions options)

    type: gcp:eventarc:Channel
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 ChannelArgs
    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 ChannelArgs
    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 ChannelArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ChannelArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ChannelArgs
    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 channelResource = new Gcp.Eventarc.Channel("channelResource", new()
{
    Location = "string",
    CryptoKeyName = "string",
    Name = "string",
    Project = "string",
    ThirdPartyProvider = "string",
});

    example, err := eventarc.NewChannel(ctx, "channelResource", &eventarc.ChannelArgs{
	Location:           pulumi.String("string"),
	CryptoKeyName:      pulumi.String("string"),
	Name:               pulumi.String("string"),
	Project:            pulumi.String("string"),
	ThirdPartyProvider: pulumi.String("string"),
})

    var channelResource = new Channel("channelResource", ChannelArgs.builder()
    .location("string")
    .cryptoKeyName("string")
    .name("string")
    .project("string")
    .thirdPartyProvider("string")
    .build());

    channel_resource = gcp.eventarc.Channel("channelResource",
    location="string",
    crypto_key_name="string",
    name="string",
    project="string",
    third_party_provider="string")

    const channelResource = new gcp.eventarc.Channel("channelResource", {
    location: "string",
    cryptoKeyName: "string",
    name: "string",
    project: "string",
    thirdPartyProvider: "string",
});

    type: gcp:eventarc:Channel
properties:
    cryptoKeyName: string
    location: string
    name: string
    project: string
    thirdPartyProvider: string

    Channel 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 Channel resource accepts the following input properties:

    Location string
    The location for the resource

    CryptoKeyName string
    Resource name of a KMS crypto key (managed by the user) used to encrypt/decrypt their event data. It must match the pattern projects/*/locations/*/keyRings/*/cryptoKeys/*.
    Name string
    The resource name of the channel. Must be unique within the location on the project.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    ThirdPartyProvider string
    The name of the event provider (e.g. Eventarc SaaS partner) associated with the channel. This provider will be granted permissions to publish events to the channel. Format: projects/{project}/locations/{location}/providers/{provider_id}.
    Location string
    The location for the resource

    CryptoKeyName string
    Resource name of a KMS crypto key (managed by the user) used to encrypt/decrypt their event data. It must match the pattern projects/*/locations/*/keyRings/*/cryptoKeys/*.
    Name string
    The resource name of the channel. Must be unique within the location on the project.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    ThirdPartyProvider string
    The name of the event provider (e.g. Eventarc SaaS partner) associated with the channel. This provider will be granted permissions to publish events to the channel. Format: projects/{project}/locations/{location}/providers/{provider_id}.
    location String
    The location for the resource

    cryptoKeyName String
    Resource name of a KMS crypto key (managed by the user) used to encrypt/decrypt their event data. It must match the pattern projects/*/locations/*/keyRings/*/cryptoKeys/*.
    name String
    The resource name of the channel. Must be unique within the location on the project.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    thirdPartyProvider String
    The name of the event provider (e.g. Eventarc SaaS partner) associated with the channel. This provider will be granted permissions to publish events to the channel. Format: projects/{project}/locations/{location}/providers/{provider_id}.
    location string
    The location for the resource

    cryptoKeyName string
    Resource name of a KMS crypto key (managed by the user) used to encrypt/decrypt their event data. It must match the pattern projects/*/locations/*/keyRings/*/cryptoKeys/*.
    name string
    The resource name of the channel. Must be unique within the location on the project.
    project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    thirdPartyProvider string
    The name of the event provider (e.g. Eventarc SaaS partner) associated with the channel. This provider will be granted permissions to publish events to the channel. Format: projects/{project}/locations/{location}/providers/{provider_id}.
    location str
    The location for the resource

    crypto_key_name str
    Resource name of a KMS crypto key (managed by the user) used to encrypt/decrypt their event data. It must match the pattern projects/*/locations/*/keyRings/*/cryptoKeys/*.
    name str
    The resource name of the channel. Must be unique within the location on the project.
    project str
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    third_party_provider str
    The name of the event provider (e.g. Eventarc SaaS partner) associated with the channel. This provider will be granted permissions to publish events to the channel. Format: projects/{project}/locations/{location}/providers/{provider_id}.
    location String
    The location for the resource

    cryptoKeyName String
    Resource name of a KMS crypto key (managed by the user) used to encrypt/decrypt their event data. It must match the pattern projects/*/locations/*/keyRings/*/cryptoKeys/*.
    name String
    The resource name of the channel. Must be unique within the location on the project.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    thirdPartyProvider String
    The name of the event provider (e.g. Eventarc SaaS partner) associated with the channel. This provider will be granted permissions to publish events to the channel. Format: projects/{project}/locations/{location}/providers/{provider_id}.

    Outputs

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

    ActivationToken string
    The activation token for the channel. The token must be used by the provider to register the channel for publishing.
    CreateTime string
    The creation time.
    Id string
    The provider-assigned unique ID for this managed resource.
    PubsubTopic string
    The name of the Pub/Sub topic created and managed by Eventarc system as a transport for the event delivery. Format: projects/{project}/topics/{topic_id}.
    State string
    The state of a Channel.
    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.
    ActivationToken string
    The activation token for the channel. The token must be used by the provider to register the channel for publishing.
    CreateTime string
    The creation time.
    Id string
    The provider-assigned unique ID for this managed resource.
    PubsubTopic string
    The name of the Pub/Sub topic created and managed by Eventarc system as a transport for the event delivery. Format: projects/{project}/topics/{topic_id}.
    State string
    The state of a Channel.
    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.
    activationToken String
    The activation token for the channel. The token must be used by the provider to register the channel for publishing.
    createTime String
    The creation time.
    id String
    The provider-assigned unique ID for this managed resource.
    pubsubTopic String
    The name of the Pub/Sub topic created and managed by Eventarc system as a transport for the event delivery. Format: projects/{project}/topics/{topic_id}.
    state String
    The state of a Channel.
    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.
    activationToken string
    The activation token for the channel. The token must be used by the provider to register the channel for publishing.
    createTime string
    The creation time.
    id string
    The provider-assigned unique ID for this managed resource.
    pubsubTopic string
    The name of the Pub/Sub topic created and managed by Eventarc system as a transport for the event delivery. Format: projects/{project}/topics/{topic_id}.
    state string
    The state of a Channel.
    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.
    activation_token str
    The activation token for the channel. The token must be used by the provider to register the channel for publishing.
    create_time str
    The creation time.
    id str
    The provider-assigned unique ID for this managed resource.
    pubsub_topic str
    The name of the Pub/Sub topic created and managed by Eventarc system as a transport for the event delivery. Format: projects/{project}/topics/{topic_id}.
    state str
    The state of a Channel.
    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.
    activationToken String
    The activation token for the channel. The token must be used by the provider to register the channel for publishing.
    createTime String
    The creation time.
    id String
    The provider-assigned unique ID for this managed resource.
    pubsubTopic String
    The name of the Pub/Sub topic created and managed by Eventarc system as a transport for the event delivery. Format: projects/{project}/topics/{topic_id}.
    state String
    The state of a Channel.
    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 Channel Resource

    Get an existing Channel 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?: ChannelState, opts?: CustomResourceOptions): Channel
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        activation_token: Optional[str] = None,
        create_time: Optional[str] = None,
        crypto_key_name: Optional[str] = None,
        location: Optional[str] = None,
        name: Optional[str] = None,
        project: Optional[str] = None,
        pubsub_topic: Optional[str] = None,
        state: Optional[str] = None,
        third_party_provider: Optional[str] = None,
        uid: Optional[str] = None,
        update_time: Optional[str] = None) -> Channel
    func GetChannel(ctx *Context, name string, id IDInput, state *ChannelState, opts ...ResourceOption) (*Channel, error)
    public static Channel Get(string name, Input<string> id, ChannelState? state, CustomResourceOptions? opts = null)
    public static Channel get(String name, Output<String> id, ChannelState state, CustomResourceOptions options)
    resources:  _:    type: gcp:eventarc:Channel    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:
    ActivationToken string
    The activation token for the channel. The token must be used by the provider to register the channel for publishing.
    CreateTime string
    The creation time.
    CryptoKeyName string
    Resource name of a KMS crypto key (managed by the user) used to encrypt/decrypt their event data. It must match the pattern projects/*/locations/*/keyRings/*/cryptoKeys/*.
    Location string
    The location for the resource

    Name string
    The resource name of the channel. Must be unique within the location on the project.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    PubsubTopic string
    The name of the Pub/Sub topic created and managed by Eventarc system as a transport for the event delivery. Format: projects/{project}/topics/{topic_id}.
    State string
    The state of a Channel.
    ThirdPartyProvider string
    The name of the event provider (e.g. Eventarc SaaS partner) associated with the channel. This provider will be granted permissions to publish events to the channel. Format: projects/{project}/locations/{location}/providers/{provider_id}.
    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.
    ActivationToken string
    The activation token for the channel. The token must be used by the provider to register the channel for publishing.
    CreateTime string
    The creation time.
    CryptoKeyName string
    Resource name of a KMS crypto key (managed by the user) used to encrypt/decrypt their event data. It must match the pattern projects/*/locations/*/keyRings/*/cryptoKeys/*.
    Location string
    The location for the resource

    Name string
    The resource name of the channel. Must be unique within the location on the project.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    PubsubTopic string
    The name of the Pub/Sub topic created and managed by Eventarc system as a transport for the event delivery. Format: projects/{project}/topics/{topic_id}.
    State string
    The state of a Channel.
    ThirdPartyProvider string
    The name of the event provider (e.g. Eventarc SaaS partner) associated with the channel. This provider will be granted permissions to publish events to the channel. Format: projects/{project}/locations/{location}/providers/{provider_id}.
    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.
    activationToken String
    The activation token for the channel. The token must be used by the provider to register the channel for publishing.
    createTime String
    The creation time.
    cryptoKeyName String
    Resource name of a KMS crypto key (managed by the user) used to encrypt/decrypt their event data. It must match the pattern projects/*/locations/*/keyRings/*/cryptoKeys/*.
    location String
    The location for the resource

    name String
    The resource name of the channel. Must be unique within the location on the project.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    pubsubTopic String
    The name of the Pub/Sub topic created and managed by Eventarc system as a transport for the event delivery. Format: projects/{project}/topics/{topic_id}.
    state String
    The state of a Channel.
    thirdPartyProvider String
    The name of the event provider (e.g. Eventarc SaaS partner) associated with the channel. This provider will be granted permissions to publish events to the channel. Format: projects/{project}/locations/{location}/providers/{provider_id}.
    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.
    activationToken string
    The activation token for the channel. The token must be used by the provider to register the channel for publishing.
    createTime string
    The creation time.
    cryptoKeyName string
    Resource name of a KMS crypto key (managed by the user) used to encrypt/decrypt their event data. It must match the pattern projects/*/locations/*/keyRings/*/cryptoKeys/*.
    location string
    The location for the resource

    name string
    The resource name of the channel. Must be unique within the location on the project.
    project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    pubsubTopic string
    The name of the Pub/Sub topic created and managed by Eventarc system as a transport for the event delivery. Format: projects/{project}/topics/{topic_id}.
    state string
    The state of a Channel.
    thirdPartyProvider string
    The name of the event provider (e.g. Eventarc SaaS partner) associated with the channel. This provider will be granted permissions to publish events to the channel. Format: projects/{project}/locations/{location}/providers/{provider_id}.
    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.
    activation_token str
    The activation token for the channel. The token must be used by the provider to register the channel for publishing.
    create_time str
    The creation time.
    crypto_key_name str
    Resource name of a KMS crypto key (managed by the user) used to encrypt/decrypt their event data. It must match the pattern projects/*/locations/*/keyRings/*/cryptoKeys/*.
    location str
    The location for the resource

    name str
    The resource name of the channel. Must be unique within the location on the project.
    project str
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    pubsub_topic str
    The name of the Pub/Sub topic created and managed by Eventarc system as a transport for the event delivery. Format: projects/{project}/topics/{topic_id}.
    state str
    The state of a Channel.
    third_party_provider str
    The name of the event provider (e.g. Eventarc SaaS partner) associated with the channel. This provider will be granted permissions to publish events to the channel. Format: projects/{project}/locations/{location}/providers/{provider_id}.
    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.
    activationToken String
    The activation token for the channel. The token must be used by the provider to register the channel for publishing.
    createTime String
    The creation time.
    cryptoKeyName String
    Resource name of a KMS crypto key (managed by the user) used to encrypt/decrypt their event data. It must match the pattern projects/*/locations/*/keyRings/*/cryptoKeys/*.
    location String
    The location for the resource

    name String
    The resource name of the channel. Must be unique within the location on the project.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    pubsubTopic String
    The name of the Pub/Sub topic created and managed by Eventarc system as a transport for the event delivery. Format: projects/{project}/topics/{topic_id}.
    state String
    The state of a Channel.
    thirdPartyProvider String
    The name of the event provider (e.g. Eventarc SaaS partner) associated with the channel. This provider will be granted permissions to publish events to the channel. Format: projects/{project}/locations/{location}/providers/{provider_id}.
    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

    Channel can be imported using any of these accepted formats:

    • projects/{{project}}/locations/{{location}}/channels/{{name}}

    • {{project}}/{{location}}/{{name}}

    • {{location}}/{{name}}

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

    $ pulumi import gcp:eventarc/channel:Channel default projects/{{project}}/locations/{{location}}/channels/{{name}}

    $ pulumi import gcp:eventarc/channel:Channel default {{project}}/{{location}}/{{name}}

    $ pulumi import gcp:eventarc/channel:Channel default {{location}}/{{name}}

    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.22.0 published on Thursday, Mar 13, 2025 by Pulumi
    pulumi/pulumi-gcp