@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
326 lines (325 loc) • 12.4 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* The Eventarc MessageBus resource
*
* To get more information about MessageBus, see:
*
* * [API documentation](https://cloud.google.com/eventarc/docs/reference/rest/v1/projects.locations.messageBuses)
* * How-to Guides
* * [Official Documentation](https://cloud.google.com/eventarc/advanced/docs/publish-events/create-bus)
*
* ## Example Usage
*
* ### Eventarc Message Bus With Cmek
*
* ```typescript
* 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
*
* 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:
*
* ```sh
* $ pulumi import gcp:eventarc/messageBus:MessageBus default projects/{{project}}/locations/{{location}}/messageBuses/{{message_bus_id}}
* ```
*
* ```sh
* $ pulumi import gcp:eventarc/messageBus:MessageBus default {{project}}/{{location}}/{{message_bus_id}}
* ```
*
* ```sh
* $ pulumi import gcp:eventarc/messageBus:MessageBus default {{location}}/{{message_bus_id}}
* ```
*/
export declare class MessageBus extends pulumi.CustomResource {
/**
* Get an existing MessageBus resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: MessageBusState, opts?: pulumi.CustomResourceOptions): MessageBus;
/**
* Returns true if the given object is an instance of MessageBus. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is MessageBus;
/**
* 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.
*/
readonly annotations: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* Output only. The creation time.
*/
readonly createTime: pulumi.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/*`.
*/
readonly cryptoKeyName: pulumi.Output<string | undefined>;
/**
* Optional. Resource display name.
*/
readonly displayName: pulumi.Output<string | undefined>;
readonly effectiveAnnotations: pulumi.Output<{
[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.
*/
readonly effectiveLabels: pulumi.Output<{
[key: string]: 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.
*/
readonly etag: pulumi.Output<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.
*/
readonly labels: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
*/
readonly location: pulumi.Output<string>;
/**
* The configuration for Platform Telemetry logging for Eventarc Advanced
* resources.
* Structure is documented below.
*/
readonly loggingConfig: pulumi.Output<outputs.eventarc.MessageBusLoggingConfig>;
/**
* Required. The user-provided ID to be assigned to the MessageBus. It should match the
* format `^a-z?$`.
*/
readonly messageBusId: pulumi.Output<string>;
/**
* Identifier. Resource name of the form
* projects/{project}/locations/{location}/messageBuses/{message_bus}
*/
readonly name: pulumi.Output<string>;
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
readonly project: pulumi.Output<string>;
/**
* The combination of labels configured directly on the resource
* and default labels configured on the provider.
*/
readonly pulumiLabels: pulumi.Output<{
[key: string]: 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.
*/
readonly uid: pulumi.Output<string>;
/**
* Output only. The last-modified time.
*/
readonly updateTime: pulumi.Output<string>;
/**
* Create a MessageBus resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: MessageBusArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering MessageBus resources.
*/
export interface MessageBusState {
/**
* 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.
*/
annotations?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* Output only. The creation time.
*/
createTime?: pulumi.Input<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/*`.
*/
cryptoKeyName?: pulumi.Input<string>;
/**
* Optional. Resource display name.
*/
displayName?: pulumi.Input<string>;
effectiveAnnotations?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
*/
effectiveLabels?: pulumi.Input<{
[key: string]: pulumi.Input<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.
*/
etag?: pulumi.Input<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.
*/
labels?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
*/
location?: pulumi.Input<string>;
/**
* The configuration for Platform Telemetry logging for Eventarc Advanced
* resources.
* Structure is documented below.
*/
loggingConfig?: pulumi.Input<inputs.eventarc.MessageBusLoggingConfig>;
/**
* Required. The user-provided ID to be assigned to the MessageBus. It should match the
* format `^a-z?$`.
*/
messageBusId?: pulumi.Input<string>;
/**
* Identifier. Resource name of the form
* projects/{project}/locations/{location}/messageBuses/{message_bus}
*/
name?: pulumi.Input<string>;
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
project?: pulumi.Input<string>;
/**
* The combination of labels configured directly on the resource
* and default labels configured on the provider.
*/
pulumiLabels?: pulumi.Input<{
[key: string]: pulumi.Input<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.
*/
uid?: pulumi.Input<string>;
/**
* Output only. The last-modified time.
*/
updateTime?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a MessageBus resource.
*/
export interface MessageBusArgs {
/**
* 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.
*/
annotations?: pulumi.Input<{
[key: string]: pulumi.Input<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/*`.
*/
cryptoKeyName?: pulumi.Input<string>;
/**
* Optional. Resource display name.
*/
displayName?: pulumi.Input<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.
*/
labels?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
*/
location: pulumi.Input<string>;
/**
* The configuration for Platform Telemetry logging for Eventarc Advanced
* resources.
* Structure is documented below.
*/
loggingConfig?: pulumi.Input<inputs.eventarc.MessageBusLoggingConfig>;
/**
* Required. The user-provided ID to be assigned to the MessageBus. It should match the
* format `^a-z?$`.
*/
messageBusId: pulumi.Input<string>;
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
project?: pulumi.Input<string>;
}