MessageBus class

The Eventarc MessageBus resource

To get more information about MessageBus, see:

• API documentation
• How-to Guides
• Official Documentation

Example Usage

Eventarc Message Bus With Cmek

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-central1",
});
const key = testKeyRing.then(testKeyRing => gcp.kms.getKMSCryptoKey({
    name: "key",
    keyRing: testKeyRing.id,
}));
const keyMember = new gcp.kms.CryptoKeyIAMMember("key_member", {
    cryptoKeyId: key.then(key => key.id),
    role: "roles/cloudkms.cryptoKeyEncrypterDecrypter",
    member: testProject.then(testProject => `serviceAccount:service-${testProject.number}@gcp-sa-eventarc.iam.gserviceaccount.com`),
});
const primary = new gcp.eventarc.MessageBus("primary", {
    location: "us-central1",
    messageBusId: "some-message-bus",
    cryptoKeyName: key.then(key => key.id),
}, {
    dependsOn: [keyMember],
});

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-central1")
key = gcp.kms.get_kms_crypto_key(name="key",
    key_ring=test_key_ring.id)
key_member = gcp.kms.CryptoKeyIAMMember("key_member",
    crypto_key_id=key.id,
    role="roles/cloudkms.cryptoKeyEncrypterDecrypter",
    member=f"serviceAccount:service-{test_project.number}@gcp-sa-eventarc.iam.gserviceaccount.com")
primary = gcp.eventarc.MessageBus("primary",
    location="us-central1",
    message_bus_id="some-message-bus",
    crypto_key_name=key.id,
    opts = pulumi.ResourceOptions(depends_on=[key_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-central1",
    });

    var key = Gcp.Kms.GetKMSCryptoKey.Invoke(new()
    {
        Name = "key",
        KeyRing = testKeyRing.Apply(getKMSKeyRingResult => getKMSKeyRingResult.Id),
    });

    var keyMember = new Gcp.Kms.CryptoKeyIAMMember("key_member", new()
    {
        CryptoKeyId = key.Apply(getKMSCryptoKeyResult => getKMSCryptoKeyResult.Id),
        Role = "roles/cloudkms.cryptoKeyEncrypterDecrypter",
        Member = $"serviceAccount:service-{testProject.Apply(getProjectResult => getProjectResult.Number)}@gcp-sa-eventarc.iam.gserviceaccount.com",
    });

    var primary = new Gcp.Eventarc.MessageBus("primary", new()
    {
        Location = "us-central1",
        MessageBusId = "some-message-bus",
        CryptoKeyName = key.Apply(getKMSCryptoKeyResult => getKMSCryptoKeyResult.Id),
    }, new CustomResourceOptions
    {
        DependsOn =
        {
            keyMember,
        },
    });

});

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/eventarc"
	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/kms"
	"github.com/pulumi/pulumi-gcp/sdk/v9/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-central1",
		}, nil)
		if err != nil {
			return err
		}
		key, err := kms.GetKMSCryptoKey(ctx, &kms.GetKMSCryptoKeyArgs{
			Name:    "key",
			KeyRing: testKeyRing.Id,
		}, nil)
		if err != nil {
			return err
		}
		keyMember, err := kms.NewCryptoKeyIAMMember(ctx, "key_member", &kms.CryptoKeyIAMMemberArgs{
			CryptoKeyId: pulumi.String(key.Id),
			Role:        pulumi.String("roles/cloudkms.cryptoKeyEncrypterDecrypter"),
			Member:      pulumi.Sprintf("serviceAccount:[e-mail]", testProject.Number),
		})
		if err != nil {
			return err
		}
		_, err = eventarc.NewMessageBus(ctx, "primary", &eventarc.MessageBusArgs{
			Location:      pulumi.String("us-central1"),
			MessageBusId:  pulumi.String("some-message-bus"),
			CryptoKeyName: pulumi.String(key.Id),
		}, pulumi.DependsOn([]pulumi.Resource{
			keyMember,
		}))
		if err != nil {
			return err
		}
		return nil
	})
}

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

data "gcp_organizations_getproject" "testProject" {
  project_id = "my-project-name"
}
data "gcp_kms_getkmskeyring" "testKeyRing" {
  name     = "keyring"
  location = "us-central1"
}
data "gcp_kms_getkmscryptokey" "key" {
  name     = "key"
  key_ring = data.gcp_kms_getkmskeyring.testKeyRing.id
}

resource "gcp_kms_cryptokeyiammember" "key_member" {
  crypto_key_id = data.gcp_kms_getkmscryptokey.key.id
  role          = "roles/cloudkms.cryptoKeyEncrypterDecrypter"
  member        ="serviceAccount:service-${data.gcp_organizations_getproject.testProject.number}@gcp-sa-eventarc.iam.gserviceaccount.com"
}
resource "gcp_eventarc_messagebus" "primary" {
  depends_on      = [gcp_kms_cryptokeyiammember.key_member]
  location        = "us-central1"
  message_bus_id  = "some-message-bus"
  crypto_key_name = data.gcp_kms_getkmscryptokey.key.id
}

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.MessageBus;
import com.pulumi.gcp.eventarc.MessageBusArgs;
import com.pulumi.resources.CustomResourceOptions;
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) {
        final var testProject = OrganizationsFunctions.getProject(GetProjectArgs.builder()
            .projectId("my-project-name")
            .build());

        final var testKeyRing = KmsFunctions.getKMSKeyRing(GetKMSKeyRingArgs.builder()
            .name("keyring")
            .location("us-central1")
            .build());

        final var key = KmsFunctions.getKMSCryptoKey(GetKMSCryptoKeyArgs.builder()
            .name("key")
            .keyRing(testKeyRing.id())
            .build());

        var keyMember = new CryptoKeyIAMMember("keyMember", CryptoKeyIAMMemberArgs.builder()
            .cryptoKeyId(key.id())
            .role("roles/cloudkms.cryptoKeyEncrypterDecrypter")
            .member(String.format("serviceAccount:[e-mail]", testProject.number()))
            .build());

        var primary = new MessageBus("primary", MessageBusArgs.builder()
            .location("us-central1")
            .messageBusId("some-message-bus")
            .cryptoKeyName(key.id())
            .build(), CustomResourceOptions.builder()
                .dependsOn(keyMember)
                .build());

    }
}

resources:
  keyMember:
    type: gcp:kms:CryptoKeyIAMMember
    name: key_member
    properties:
      cryptoKeyId: ${key.id}
      role: roles/cloudkms.cryptoKeyEncrypterDecrypter
      member: serviceAccount:service-${testProject.number}@gcp-sa-eventarc.iam.gserviceaccount.com
  primary:
    type: gcp:eventarc:MessageBus
    properties:
      location: us-central1
      messageBusId: some-message-bus
      cryptoKeyName: ${key.id}
    options:
      dependsOn:
        - ${keyMember}
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-central1
  key:
    fn::invoke:
      function: gcp:kms:getKMSCryptoKey
      arguments:
        name: key
        keyRing: ${testKeyRing.id}

Import

MessageBus can be imported using any of these accepted formats:

• projects/{{project}}/locations/{{location}}/messageBuses/{{message_bus_id}}
• {{project}}/{{location}}/{{message_bus_id}}
• {{location}}/{{message_bus_id}}

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

$ pulumi import gcp:eventarc/messageBus:MessageBus default projects/{{project}}/locations/{{location}}/messageBuses/{{message_bus_id}}
$ pulumi import gcp:eventarc/messageBus:MessageBus default {{project}}/{{location}}/{{message_bus_id}}
$ pulumi import gcp:eventarc/messageBus:MessageBus default {{location}}/{{message_bus_id}}

Constructors

MessageBus(String name, {MessageBusArgs? args, CustomResourceOptions? options})

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

MessageBus.reference(String urn)

Creates a typed reference to an existing MessageBus resource.

Properties

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

Optional. Resource annotations. Note: This field is non-authoritative, and will only manage the annotations present in your configuration. Please refer to the field effectiveAnnotations for all of the annotations present on the resource.

late, final

childResources → Set<Resource>

final, inherited

completionSources ↔ Map<String, IOutputCompletionSource>

late, final, inherited

createTime ↔ Output<String>

Output only. The creation time.

late, final

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

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

displayName ↔ Output<String?>

Optional. Resource display name.

late, final

effectiveAnnotations ↔ Output<Map<String, String>>

All of annotations (key/value pairs) present on the resource in GCP, including the annotations configured through Terraform, other clients and services.

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

etag ↔ Output<String>

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

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

Optional. Resource labels. 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>

Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.

late, final

loggingConfig ↔ Output<MessageBusLoggingConfig>

The configuration for Platform Telemetry logging for Eventarc Advanced resources. Structure is documented below.

late, final

messageBusId ↔ Output<String>

Required. The user-provided ID to be assigned to the MessageBus. It should match the format ^a-z?$.

late, final

name ↔ Output<String>

Identifier. Resource name of the form projects/{project}/locations/{location}/messageBuses/{message_bus}

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

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

transformations → List<ResourceTransformation>

Inherited/explicit legacy transformations.

no setter, inherited

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.

late, final

updateTime ↔ Output<String>

Output only. 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, {MessageBusState? state, CustomResourceOptions? options}) → MessageBus

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