Channel class

The Eventarc Channel resource

To get more information about Channel, see:

• API documentation
• How-to Guides
• Official Documentation

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")

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 main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v9/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
	})
}

pulumi {
  required_providers {
    gcp = {
      source = "pulumi/gcp"
    }
  }
}

resource "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 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.ArrayList;
import java.util.Arrays;
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

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}}

Constructors

Channel(String name, {ChannelArgs? args, CustomResourceOptions? options})

Creates a new Channel. name The Pulumi resource name. args Arguments used to configure this Channel. The set of arguments for Channel. options Resource options controlling this resource's behavior.

Channel.reference(String urn)

Creates a typed reference to an existing Channel resource.

Properties

activationToken ↔ Output<String>

The activation token for the channel. The token must be used by the provider to register the channel for publishing.

late, final

childResources → Set<Resource>

final, inherited

completionSources ↔ Map<String, IOutputCompletionSource>

late, final, inherited

createTime ↔ Output<String>

The creation time.

late, final

cryptoKeyName ↔ Output<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/*.

late, final

deletionPolicy ↔ Output<String>

Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.

late, final

effectiveLabels ↔ Output<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.

late, final

hashCode → int

The hash code for this object.

no setter, inherited

id ↔ Output<String>

getter/setter pair, inherited

isCustom → bool

Returns whether this resource is provider-managed.

no setter, inherited

isProtected → bool

Returns whether this resource is protected from deletion.

no setter, inherited

isRemote → bool

Whether this resource is registered as remote.

no setter, inherited

isResourceReference → bool

Whether this instance represents a resource value returned over RPC.

final, inherited

labels ↔ Output<Map<String, String>?>

User-defined labels for the channel. Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effectiveLabels for all of the labels present on the resource.

late, final

location ↔ Output<String>

The location for the resource

late, final

name ↔ Output<String>

The resource name of the channel. Must be unique within the location on the project.

late, final

project ↔ Output<String>

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

late, final

pubsubTopic ↔ Output<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}.

late, final

pulumiLabels ↔ Output<Map<String, String>>

The combination of labels configured directly on the resource and default labels configured on the provider.

late, final

resourceTransforms → List<ResourceTransform>

Inherited/explicit async transforms.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

state ↔ Output<String>

The state of a Channel.

late, final

thirdPartyProvider ↔ Output<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}.

late, final

transformations → List<ResourceTransformation>

Inherited/explicit legacy transformations.

no setter, inherited

uid ↔ Output<String>

Server assigned unique identifier for the channel. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted.

late, final

updateTime ↔ Output<String>

The last-modified time.

late, final

urn ↔ Output<String>

late, final, inherited

Methods

failId(Object error) → void

Completes this resource ID with an error when registration fails.

inherited

failOutputs(Object error) → void

Completes all output properties with error.

inherited

failUrn(Object error) → void

Completes this resource URN with an error when registration fails.

inherited

getProvider(String moduleMember) → ProviderResource?

Returns provider for moduleMember's package, if configured.

inherited

getResourceName() → String

Returns this resource's logical name.

inherited

getResourceType() → String

Returns this resource's Pulumi type token.

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>

Registers a dynamic output property for this resource.

inherited

resolveId(String? value, {required bool isKnown}) → void

Resolves the provider-assigned ID for this resource.

inherited

resolveOutputs(Struct outputs) → void

Resolves all output properties from a monitor response payload.

inherited

resolveUrn(String value) → void

Resolves this resource's URN once assigned by the engine.

inherited

serializeProperties(Map<String, dynamic> properties) → Future<Struct>

Serializes resource properties for RPC transmission.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Static Methods

get(String name, Input<String> id, {ChannelState? state, CustomResourceOptions? options}) → Channel

Gets an existing Channel resource's state with the given name and id.