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

gcp.eventarc.MessageBus

Explore with Pulumi AI

gcp logo
Google Cloud v8.23.0 published on Monday, Mar 24, 2025 by Pulumi
pulumi/pulumi-gcp

    The Eventarc MessageBus resource

    To get more information about MessageBus, see:

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

    package main

import (
	"fmt"

	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/eventarc"
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/kms"
	"github.com/pulumi/pulumi-gcp/sdk/v8/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:service-%v@gcp-sa-eventarc.iam.gserviceaccount.com", 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
	})
}

    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 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.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-central1")
            .build());

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

        var keyMember = new CryptoKeyIAMMember("keyMember", CryptoKeyIAMMemberArgs.builder()
            .cryptoKeyId(key.applyValue(getKMSCryptoKeyResult -> getKMSCryptoKeyResult.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 MessageBus("primary", MessageBusArgs.builder()
            .location("us-central1")
            .messageBusId("some-message-bus")
            .cryptoKeyName(key.applyValue(getKMSCryptoKeyResult -> getKMSCryptoKeyResult.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}

    Create MessageBus Resource

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

    Constructor syntax

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

@overload
def MessageBus(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               location: Optional[str] = None,
               message_bus_id: Optional[str] = None,
               annotations: Optional[Mapping[str, str]] = None,
               crypto_key_name: Optional[str] = None,
               display_name: Optional[str] = None,
               labels: Optional[Mapping[str, str]] = None,
               logging_config: Optional[MessageBusLoggingConfigArgs] = None,
               project: Optional[str] = None)
    func NewMessageBus(ctx *Context, name string, args MessageBusArgs, opts ...ResourceOption) (*MessageBus, error)
    public MessageBus(string name, MessageBusArgs args, CustomResourceOptions? opts = null)
    public MessageBus(String name, MessageBusArgs args)
public MessageBus(String name, MessageBusArgs args, CustomResourceOptions options)

    type: gcp:eventarc:MessageBus
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 MessageBusArgs
    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 MessageBusArgs
    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 MessageBusArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args MessageBusArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args MessageBusArgs
    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 messageBusResource = new Gcp.Eventarc.MessageBus("messageBusResource", new()
{
    Location = "string",
    MessageBusId = "string",
    Annotations = 
    {
        { "string", "string" },
    },
    CryptoKeyName = "string",
    DisplayName = "string",
    Labels = 
    {
        { "string", "string" },
    },
    LoggingConfig = new Gcp.Eventarc.Inputs.MessageBusLoggingConfigArgs
    {
        LogSeverity = "string",
    },
    Project = "string",
});

    example, err := eventarc.NewMessageBus(ctx, "messageBusResource", &eventarc.MessageBusArgs{
	Location:     pulumi.String("string"),
	MessageBusId: pulumi.String("string"),
	Annotations: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	CryptoKeyName: pulumi.String("string"),
	DisplayName:   pulumi.String("string"),
	Labels: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	LoggingConfig: &eventarc.MessageBusLoggingConfigArgs{
		LogSeverity: pulumi.String("string"),
	},
	Project: pulumi.String("string"),
})

    var messageBusResource = new MessageBus("messageBusResource", MessageBusArgs.builder()
    .location("string")
    .messageBusId("string")
    .annotations(Map.of("string", "string"))
    .cryptoKeyName("string")
    .displayName("string")
    .labels(Map.of("string", "string"))
    .loggingConfig(MessageBusLoggingConfigArgs.builder()
        .logSeverity("string")
        .build())
    .project("string")
    .build());

    message_bus_resource = gcp.eventarc.MessageBus("messageBusResource",
    location="string",
    message_bus_id="string",
    annotations={
        "string": "string",
    },
    crypto_key_name="string",
    display_name="string",
    labels={
        "string": "string",
    },
    logging_config={
        "log_severity": "string",
    },
    project="string")

    const messageBusResource = new gcp.eventarc.MessageBus("messageBusResource", {
    location: "string",
    messageBusId: "string",
    annotations: {
        string: "string",
    },
    cryptoKeyName: "string",
    displayName: "string",
    labels: {
        string: "string",
    },
    loggingConfig: {
        logSeverity: "string",
    },
    project: "string",
});

    type: gcp:eventarc:MessageBus
properties:
    annotations:
        string: string
    cryptoKeyName: string
    displayName: string
    labels:
        string: string
    location: string
    loggingConfig:
        logSeverity: string
    messageBusId: string
    project: string

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

    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.
    MessageBusId string
    Required. The user-provided ID to be assigned to the MessageBus. It should match the format ^a-z?$.

    Annotations Dictionary<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 effective_annotations for all of the annotations present on the resource.
    CryptoKeyName 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/*.
    DisplayName string
    Optional. Resource display name.
    Labels Dictionary<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 effective_labels for all of the labels present on the resource.
    LoggingConfig MessageBusLoggingConfig
    The configuration for Platform Telemetry logging for Eventarc Advanced resources. Structure is documented below.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    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.
    MessageBusId string
    Required. The user-provided ID to be assigned to the MessageBus. It should match the format ^a-z?$.

    Annotations 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 effective_annotations for all of the annotations present on the resource.
    CryptoKeyName 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/*.
    DisplayName string
    Optional. Resource display name.
    Labels 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 effective_labels for all of the labels present on the resource.
    LoggingConfig MessageBusLoggingConfigArgs
    The configuration for Platform Telemetry logging for Eventarc Advanced resources. Structure is documented below.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    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.
    messageBusId String
    Required. The user-provided ID to be assigned to the MessageBus. It should match the format ^a-z?$.

    annotations 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 effective_annotations for all of the annotations present on the resource.
    cryptoKeyName 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/*.
    displayName String
    Optional. Resource display name.
    labels 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 effective_labels for all of the labels present on the resource.
    loggingConfig MessageBusLoggingConfig
    The configuration for Platform Telemetry logging for Eventarc Advanced resources. Structure is documented below.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    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.
    messageBusId string
    Required. The user-provided ID to be assigned to the MessageBus. It should match the format ^a-z?$.

    annotations {[key: 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 effective_annotations for all of the annotations present on the resource.
    cryptoKeyName 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/*.
    displayName string
    Optional. Resource display name.
    labels {[key: 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 effective_labels for all of the labels present on the resource.
    loggingConfig MessageBusLoggingConfig
    The configuration for Platform Telemetry logging for Eventarc Advanced resources. Structure is documented below.
    project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    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_id str
    Required. The user-provided ID to be assigned to the MessageBus. It should match the format ^a-z?$.

    annotations Mapping[str, str]
    Optional. 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.
    crypto_key_name str
    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/*.
    display_name str
    Optional. Resource display name.
    labels Mapping[str, str]
    Optional. 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.
    logging_config MessageBusLoggingConfigArgs
    The configuration for Platform Telemetry logging for Eventarc Advanced resources. Structure is documented below.
    project str
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    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.
    messageBusId String
    Required. The user-provided ID to be assigned to the MessageBus. It should match the format ^a-z?$.

    annotations Map<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 effective_annotations for all of the annotations present on the resource.
    cryptoKeyName 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/*.
    displayName String
    Optional. Resource display name.
    labels Map<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 effective_labels for all of the labels present on the resource.
    loggingConfig Property Map
    The configuration for Platform Telemetry logging for Eventarc Advanced resources. Structure is documented below.
    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 MessageBus resource produces the following output properties:

    CreateTime string
    Output only. 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
    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.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    Identifier. Resource name of the form projects/{project}/locations/{location}/messageBuses/{message_bus}
    PulumiLabels Dictionary<string, string>
    The combination of labels configured directly on the resource and default labels configured on the provider.
    Uid 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 string
    Output only. The last-modified time.
    CreateTime string
    Output only. 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
    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.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    Identifier. Resource name of the form projects/{project}/locations/{location}/messageBuses/{message_bus}
    PulumiLabels map[string]string
    The combination of labels configured directly on the resource and default labels configured on the provider.
    Uid 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 string
    Output only. The last-modified time.
    createTime String
    Output only. 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
    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.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    Identifier. Resource name of the form projects/{project}/locations/{location}/messageBuses/{message_bus}
    pulumiLabels Map<String,String>
    The combination of labels configured directly on the resource and default labels configured on the provider.
    uid 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 String
    Output only. The last-modified time.
    createTime string
    Output only. 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
    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.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    Identifier. Resource name of the form projects/{project}/locations/{location}/messageBuses/{message_bus}
    pulumiLabels {[key: string]: string}
    The combination of labels configured directly on the resource and default labels configured on the provider.
    uid 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 string
    Output only. The last-modified time.
    create_time str
    Output only. 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
    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.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    Identifier. Resource name of the form projects/{project}/locations/{location}/messageBuses/{message_bus}
    pulumi_labels Mapping[str, str]
    The combination of labels configured directly on the resource and default labels configured on the provider.
    uid str
    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.
    update_time str
    Output only. The last-modified time.
    createTime String
    Output only. 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
    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.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    Identifier. Resource name of the form projects/{project}/locations/{location}/messageBuses/{message_bus}
    pulumiLabels Map<String>
    The combination of labels configured directly on the resource and default labels configured on the provider.
    uid 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 String
    Output only. The last-modified time.

    Look up Existing MessageBus Resource

    Get an existing MessageBus 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?: MessageBusState, opts?: CustomResourceOptions): MessageBus
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        annotations: Optional[Mapping[str, str]] = None,
        create_time: Optional[str] = None,
        crypto_key_name: Optional[str] = None,
        display_name: Optional[str] = None,
        effective_annotations: Optional[Mapping[str, str]] = None,
        effective_labels: Optional[Mapping[str, str]] = None,
        etag: Optional[str] = None,
        labels: Optional[Mapping[str, str]] = None,
        location: Optional[str] = None,
        logging_config: Optional[MessageBusLoggingConfigArgs] = None,
        message_bus_id: 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) -> MessageBus
    func GetMessageBus(ctx *Context, name string, id IDInput, state *MessageBusState, opts ...ResourceOption) (*MessageBus, error)
    public static MessageBus Get(string name, Input<string> id, MessageBusState? state, CustomResourceOptions? opts = null)
    public static MessageBus get(String name, Output<String> id, MessageBusState state, CustomResourceOptions options)
    resources:  _:    type: gcp:eventarc:MessageBus    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>
    Optional. 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.
    CreateTime string
    Output only. The creation time.
    CryptoKeyName 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/*.
    DisplayName string
    Optional. 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.
    Etag 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.
    Labels Dictionary<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 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.
    LoggingConfig MessageBusLoggingConfig
    The configuration for Platform Telemetry logging for Eventarc Advanced resources. Structure is documented below.
    MessageBusId string
    Required. The user-provided ID to be assigned to the MessageBus. It should match the format ^a-z?$.

    Name string
    Identifier. Resource name of the form projects/{project}/locations/{location}/messageBuses/{message_bus}
    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
    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 string
    Output only. The last-modified time.
    Annotations 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 effective_annotations for all of the annotations present on the resource.
    CreateTime string
    Output only. The creation time.
    CryptoKeyName 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/*.
    DisplayName string
    Optional. 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.
    Etag 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.
    Labels 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 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.
    LoggingConfig MessageBusLoggingConfigArgs
    The configuration for Platform Telemetry logging for Eventarc Advanced resources. Structure is documented below.
    MessageBusId string
    Required. The user-provided ID to be assigned to the MessageBus. It should match the format ^a-z?$.

    Name string
    Identifier. Resource name of the form projects/{project}/locations/{location}/messageBuses/{message_bus}
    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
    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 string
    Output only. The last-modified time.
    annotations 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 effective_annotations for all of the annotations present on the resource.
    createTime String
    Output only. The creation time.
    cryptoKeyName 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/*.
    displayName String
    Optional. 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.
    etag 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.
    labels 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 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.
    loggingConfig MessageBusLoggingConfig
    The configuration for Platform Telemetry logging for Eventarc Advanced resources. Structure is documented below.
    messageBusId String
    Required. The user-provided ID to be assigned to the MessageBus. It should match the format ^a-z?$.

    name String
    Identifier. Resource name of the form projects/{project}/locations/{location}/messageBuses/{message_bus}
    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
    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 String
    Output only. The last-modified time.
    annotations {[key: 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 effective_annotations for all of the annotations present on the resource.
    createTime string
    Output only. The creation time.
    cryptoKeyName 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/*.
    displayName string
    Optional. 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.
    etag 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.
    labels {[key: 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 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.
    loggingConfig MessageBusLoggingConfig
    The configuration for Platform Telemetry logging for Eventarc Advanced resources. Structure is documented below.
    messageBusId string
    Required. The user-provided ID to be assigned to the MessageBus. It should match the format ^a-z?$.

    name string
    Identifier. Resource name of the form projects/{project}/locations/{location}/messageBuses/{message_bus}
    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
    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 string
    Output only. The last-modified time.
    annotations Mapping[str, str]
    Optional. 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.
    create_time str
    Output only. The creation time.
    crypto_key_name str
    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/*.
    display_name str
    Optional. 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.
    etag str
    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.
    labels Mapping[str, str]
    Optional. 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.
    logging_config MessageBusLoggingConfigArgs
    The configuration for Platform Telemetry logging for Eventarc Advanced resources. Structure is documented below.
    message_bus_id str
    Required. The user-provided ID to be assigned to the MessageBus. It should match the format ^a-z?$.

    name str
    Identifier. Resource name of the form projects/{project}/locations/{location}/messageBuses/{message_bus}
    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
    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.
    update_time str
    Output only. The last-modified time.
    annotations Map<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 effective_annotations for all of the annotations present on the resource.
    createTime String
    Output only. The creation time.
    cryptoKeyName 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/*.
    displayName String
    Optional. 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.
    etag 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.
    labels Map<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 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.
    loggingConfig Property Map
    The configuration for Platform Telemetry logging for Eventarc Advanced resources. Structure is documented below.
    messageBusId String
    Required. The user-provided ID to be assigned to the MessageBus. It should match the format ^a-z?$.

    name String
    Identifier. Resource name of the form projects/{project}/locations/{location}/messageBuses/{message_bus}
    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
    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 String
    Output only. The last-modified time.

    Supporting Types

    MessageBusLoggingConfig, MessageBusLoggingConfigArgs

    LogSeverity string
    Optional. The minimum severity of logs that will be sent to Stackdriver/Platform Telemetry. Logs at severitiy ≥ this value will be sent, unless it is NONE. Possible values are: NONE, DEBUG, INFO, NOTICE, WARNING, ERROR, CRITICAL, ALERT, EMERGENCY.
    LogSeverity string
    Optional. The minimum severity of logs that will be sent to Stackdriver/Platform Telemetry. Logs at severitiy ≥ this value will be sent, unless it is NONE. Possible values are: NONE, DEBUG, INFO, NOTICE, WARNING, ERROR, CRITICAL, ALERT, EMERGENCY.
    logSeverity String
    Optional. The minimum severity of logs that will be sent to Stackdriver/Platform Telemetry. Logs at severitiy ≥ this value will be sent, unless it is NONE. Possible values are: NONE, DEBUG, INFO, NOTICE, WARNING, ERROR, CRITICAL, ALERT, EMERGENCY.
    logSeverity string
    Optional. The minimum severity of logs that will be sent to Stackdriver/Platform Telemetry. Logs at severitiy ≥ this value will be sent, unless it is NONE. Possible values are: NONE, DEBUG, INFO, NOTICE, WARNING, ERROR, CRITICAL, ALERT, EMERGENCY.
    log_severity str
    Optional. The minimum severity of logs that will be sent to Stackdriver/Platform Telemetry. Logs at severitiy ≥ this value will be sent, unless it is NONE. Possible values are: NONE, DEBUG, INFO, NOTICE, WARNING, ERROR, CRITICAL, ALERT, EMERGENCY.
    logSeverity String
    Optional. The minimum severity of logs that will be sent to Stackdriver/Platform Telemetry. Logs at severitiy ≥ this value will be sent, unless it is NONE. Possible values are: NONE, DEBUG, INFO, NOTICE, WARNING, ERROR, CRITICAL, ALERT, EMERGENCY.

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

    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.23.0 published on Monday, Mar 24, 2025 by Pulumi
    pulumi/pulumi-gcp