pulumi-gcp-kotlin/com.pulumi.gcp.eventarc.kotlin/Channel

Channel

class Channel : KotlinCustomResource

The Eventarc Channel resource

Example Usage

Basic

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const testProject = gcp.organizations.getProject({
    projectId: "my-project-name",
});
const testKeyRing = gcp.kms.getKMSKeyRing({
    name: "keyring",
    location: "us-west1",
});
const key = testKeyRing.then(testKeyRing => gcp.kms.getKMSCryptoKey({
    name: "key",
    keyRing: testKeyRing.id,
}));
const key1Member = new gcp.kms.CryptoKeyIAMMember("key1_member", {
    cryptoKeyId: key1.id,
    role: "roles/cloudkms.cryptoKeyEncrypterDecrypter",
    member: testProject.then(testProject => `serviceAccount:service-${testProject.number}@gcp-sa-eventarc.iam.gserviceaccount.com`),
});
const primary = new gcp.eventarc.Channel("primary", {
    location: "us-west1",
    name: "channel",
    project: testProject.then(testProject => testProject.projectId),
    cryptoKeyName: key1.id,
    thirdPartyProvider: testProject.then(testProject => `projects/${testProject.projectId}/locations/us-west1/providers/datadog`),
}, {
    dependsOn: [key1Member],
});

import pulumi
import pulumi_gcp as gcp
test_project = gcp.organizations.get_project(project_id="my-project-name")
test_key_ring = gcp.kms.get_kms_key_ring(name="keyring",
    location="us-west1")
key = gcp.kms.get_kms_crypto_key(name="key",
    key_ring=test_key_ring.id)
key1_member = gcp.kms.CryptoKeyIAMMember("key1_member",
    crypto_key_id=key1["id"],
    role="roles/cloudkms.cryptoKeyEncrypterDecrypter",
    member=f"serviceAccount:service-{test_project.number}@gcp-sa-eventarc.iam.gserviceaccount.com")
primary = gcp.eventarc.Channel("primary",
    location="us-west1",
    name="channel",
    project=test_project.project_id,
    crypto_key_name=key1["id"],
    third_party_provider=f"projects/{test_project.project_id}/locations/us-west1/providers/datadog",
    opts = pulumi.ResourceOptions(depends_on=[key1_member]))

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;
return await Deployment.RunAsync(() =>
{
    var testProject = Gcp.Organizations.GetProject.Invoke(new()
    {
        ProjectId = "my-project-name",
    });
    var testKeyRing = Gcp.Kms.GetKMSKeyRing.Invoke(new()
    {
        Name = "keyring",
        Location = "us-west1",
    });
    var key = Gcp.Kms.GetKMSCryptoKey.Invoke(new()
    {
        Name = "key",
        KeyRing = testKeyRing.Apply(getKMSKeyRingResult => getKMSKeyRingResult.Id),
    });
    var key1Member = new Gcp.Kms.CryptoKeyIAMMember("key1_member", new()
    {
        CryptoKeyId = key1.Id,
        Role = "roles/cloudkms.cryptoKeyEncrypterDecrypter",
        Member = $"serviceAccount:service-{testProject.Apply(getProjectResult => getProjectResult.Number)}@gcp-sa-eventarc.iam.gserviceaccount.com",
    });
    var primary = new Gcp.Eventarc.Channel("primary", new()
    {
        Location = "us-west1",
        Name = "channel",
        Project = testProject.Apply(getProjectResult => getProjectResult.ProjectId),
        CryptoKeyName = key1.Id,
        ThirdPartyProvider = $"projects/{testProject.Apply(getProjectResult => getProjectResult.ProjectId)}/locations/us-west1/providers/datadog",
    }, new CustomResourceOptions
    {
        DependsOn =
        {
            key1Member,
        },
    });
});

package main
import (
	"fmt"
	"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/eventarc"
	"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/kms"
	"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/organizations"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		testProject, err := organizations.LookupProject(ctx, &organizations.LookupProjectArgs{
			ProjectId: pulumi.StringRef("my-project-name"),
		}, nil)
		if err != nil {
			return err
		}
		testKeyRing, err := kms.GetKMSKeyRing(ctx, &kms.GetKMSKeyRingArgs{
			Name:     "keyring",
			Location: "us-west1",
		}, nil)
		if err != nil {
			return err
		}
		_, err = kms.GetKMSCryptoKey(ctx, &kms.GetKMSCryptoKeyArgs{
			Name:    "key",
			KeyRing: testKeyRing.Id,
		}, nil)
		if err != nil {
			return err
		}
		key1Member, err := kms.NewCryptoKeyIAMMember(ctx, "key1_member", &kms.CryptoKeyIAMMemberArgs{
			CryptoKeyId: pulumi.Any(key1.Id),
			Role:        pulumi.String("roles/cloudkms.cryptoKeyEncrypterDecrypter"),
			Member:      pulumi.Sprintf("serviceAccount:service-%v@gcp-sa-eventarc.iam.gserviceaccount.com", testProject.Number),
		})
		if err != nil {
			return err
		}
		_, err = eventarc.NewChannel(ctx, "primary", &eventarc.ChannelArgs{
			Location:           pulumi.String("us-west1"),
			Name:               pulumi.String("channel"),
			Project:            pulumi.String(testProject.ProjectId),
			CryptoKeyName:      pulumi.Any(key1.Id),
			ThirdPartyProvider: pulumi.Sprintf("projects/%v/locations/us-west1/providers/datadog", testProject.ProjectId),
		}, pulumi.DependsOn([]pulumi.Resource{
			key1Member,
		}))
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.organizations.OrganizationsFunctions;
import com.pulumi.gcp.organizations.inputs.GetProjectArgs;
import com.pulumi.gcp.kms.KmsFunctions;
import com.pulumi.gcp.kms.inputs.GetKMSKeyRingArgs;
import com.pulumi.gcp.kms.inputs.GetKMSCryptoKeyArgs;
import com.pulumi.gcp.kms.CryptoKeyIAMMember;
import com.pulumi.gcp.kms.CryptoKeyIAMMemberArgs;
import com.pulumi.gcp.eventarc.Channel;
import com.pulumi.gcp.eventarc.ChannelArgs;
import com.pulumi.resources.CustomResourceOptions;
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) {
        final var testProject = OrganizationsFunctions.getProject(GetProjectArgs.builder()
            .projectId("my-project-name")
            .build());
        final var testKeyRing = KmsFunctions.getKMSKeyRing(GetKMSKeyRingArgs.builder()
            .name("keyring")
            .location("us-west1")
            .build());
        final var key = KmsFunctions.getKMSCryptoKey(GetKMSCryptoKeyArgs.builder()
            .name("key")
            .keyRing(testKeyRing.applyValue(getKMSKeyRingResult -> getKMSKeyRingResult.id()))
            .build());
        var key1Member = new CryptoKeyIAMMember("key1Member", CryptoKeyIAMMemberArgs.builder()
            .cryptoKeyId(key1.id())
            .role("roles/cloudkms.cryptoKeyEncrypterDecrypter")
            .member(String.format("serviceAccount:service-%s@gcp-sa-eventarc.iam.gserviceaccount.com", testProject.applyValue(getProjectResult -> getProjectResult.number())))
            .build());
        var primary = new Channel("primary", ChannelArgs.builder()
            .location("us-west1")
            .name("channel")
            .project(testProject.applyValue(getProjectResult -> getProjectResult.projectId()))
            .cryptoKeyName(key1.id())
            .thirdPartyProvider(String.format("projects/%s/locations/us-west1/providers/datadog", testProject.applyValue(getProjectResult -> getProjectResult.projectId())))
            .build(), CustomResourceOptions.builder()
                .dependsOn(key1Member)
                .build());
    }
}

resources:
  key1Member:
    type: gcp:kms:CryptoKeyIAMMember
    name: key1_member
    properties:
      cryptoKeyId: ${key1.id}
      role: roles/cloudkms.cryptoKeyEncrypterDecrypter
      member: serviceAccount:service-${testProject.number}@gcp-sa-eventarc.iam.gserviceaccount.com
  primary:
    type: gcp:eventarc:Channel
    properties:
      location: us-west1
      name: channel
      project: ${testProject.projectId}
      cryptoKeyName: ${key1.id}
      thirdPartyProvider: projects/${testProject.projectId}/locations/us-west1/providers/datadog
    options:
      dependson:
        - ${key1Member}
variables:
  testProject:
    fn::invoke:
      Function: gcp:organizations:getProject
      Arguments:
        projectId: my-project-name
  testKeyRing:
    fn::invoke:
      Function: gcp:kms:getKMSKeyRing
      Arguments:
        name: keyring
        location: us-west1
  key:
    fn::invoke:
      Function: gcp:kms:getKMSCryptoKey
      Arguments:
        name: key
        keyRing: ${testKeyRing.id}

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

Properties

activationToken

val activationToken: Output<String>

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

createTime

val createTime: Output<String>

Output only. The creation time.

cryptoKeyName

val cryptoKeyName: Output<String>?

Optional. 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/*. ////

val id: Output<String>

location

val location: Output<String>

The location for the resource

name

val name: Output<String>

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

project

val project: Output<String>

The project for the resource

pubsubTopic

val pubsubTopic: Output<String>

Output only. 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}.

pulumiChildResources

val pulumiChildResources: Set<KotlinResource>

pulumiResourceName

val pulumiResourceName: String

pulumiResourceType

val pulumiResourceType: String

state

val state: Output<String>

Output only. The state of a Channel. Possible values: STATE_UNSPECIFIED, PENDING, ACTIVE, INACTIVE

thirdPartyProvider

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

uid

val uid: Output<String>

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

updateTime

val updateTime: Output<String>

Output only. The last-modified time.

urn

val urn: Output<String>