This package is deprecated. Active development has stopped. We recommend using the Google Cloud package instead.
published on Wednesday, Nov 29, 2023 by Pulumi
This package is deprecated. Active development has stopped. We recommend using the Google Cloud package instead.
published on Wednesday, Nov 29, 2023 by Pulumi
Create a new channel in a particular project and location.
Create Channel Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Channel(name: string, args: ChannelArgs, opts?: CustomResourceOptions);@overload
def Channel(resource_name: str,
args: ChannelArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Channel(resource_name: str,
opts: Optional[ResourceOptions] = None,
channel_id: Optional[str] = None,
crypto_key_name: Optional[str] = None,
location: Optional[str] = None,
name: Optional[str] = None,
project: Optional[str] = None,
provider: Optional[str] = None)func NewChannel(ctx *Context, name string, args ChannelArgs, opts ...ResourceOption) (*Channel, error)public Channel(string name, ChannelArgs args, CustomResourceOptions? opts = null)
public Channel(String name, ChannelArgs args)
public Channel(String name, ChannelArgs args, CustomResourceOptions options)
type: google-native:eventarc/v1:Channel
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "google-native_eventarc_v1_channel" "name" {
# resource properties
}Parameters
- name string
- The unique name of the resource.
- args ChannelArgs
- 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 ChannelArgs
- 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 ChannelArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ChannelArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ChannelArgs
- 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 channelResource = new GoogleNative.Eventarc.V1.Channel("channelResource", new()
{
ChannelId = "string",
CryptoKeyName = "string",
Location = "string",
Name = "string",
Project = "string",
Provider = "string",
});
example, err := eventarc.NewChannel(ctx, "channelResource", &eventarc.ChannelArgs{
ChannelId: pulumi.String("string"),
CryptoKeyName: pulumi.String("string"),
Location: pulumi.String("string"),
Name: pulumi.String("string"),
Project: pulumi.String("string"),
Provider: pulumi.String("string"),
})
resource "google-native_eventarc_v1_channel" "channelResource" {
lifecycle {
create_before_destroy = true
}
channel_id = "string"
crypto_key_name = "string"
location = "string"
name = "string"
project = "string"
_ {
provider = "string"
}
}
var channelResource = new com.pulumi.googlenative.eventarc_v1.Channel("channelResource", com.pulumi.googlenative.eventarc_v1.ChannelArgs.builder()
.channelId("string")
.cryptoKeyName("string")
.location("string")
.name("string")
.project("string")
.provider("string")
.build());
channel_resource = google_native.eventarc.v1.Channel("channelResource",
channel_id="string",
crypto_key_name="string",
location="string",
name="string",
project="string",
provider="string")
const channelResource = new google_native.eventarc.v1.Channel("channelResource", {
channelId: "string",
cryptoKeyName: "string",
location: "string",
name: "string",
project: "string",
provider: "string",
});
type: google-native:eventarc/v1:Channel
properties:
channelId: string
cryptoKeyName: string
location: string
name: string
project: string
provider: string
Channel 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 Channel resource accepts the following input properties:
- Channel
Id string - Required. The user-provided ID to be assigned to the channel.
- Crypto
Key stringName - 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/*. - Location string
- Name string
- The resource name of the channel. Must be unique within the location on the project and must be in
projects/{project}/locations/{location}/channels/{channel_id}format. - Project string
- Provider 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}.
- Channel
Id string - Required. The user-provided ID to be assigned to the channel.
- Crypto
Key stringName - 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/*. - Location string
- Name string
- The resource name of the channel. Must be unique within the location on the project and must be in
projects/{project}/locations/{location}/channels/{channel_id}format. - Project string
- Provider 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}.
- channel_
id string - Required. The user-provided ID to be assigned to the channel.
- crypto_
key_ stringname - 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/*. - location string
- name string
- The resource name of the channel. Must be unique within the location on the project and must be in
projects/{project}/locations/{location}/channels/{channel_id}format. - project string
- provider 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}.
- channel
Id String - Required. The user-provided ID to be assigned to the channel.
- crypto
Key StringName - 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/*. - location String
- name String
- The resource name of the channel. Must be unique within the location on the project and must be in
projects/{project}/locations/{location}/channels/{channel_id}format. - project String
- provider 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}.
- channel
Id string - Required. The user-provided ID to be assigned to the channel.
- crypto
Key stringName - 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/*. - location string
- name string
- The resource name of the channel. Must be unique within the location on the project and must be in
projects/{project}/locations/{location}/channels/{channel_id}format. - project string
- provider 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}.
- channel_
id str - Required. The user-provided ID to be assigned to the channel.
- crypto_
key_ strname - 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/*. - location str
- name str
- The resource name of the channel. Must be unique within the location on the project and must be in
projects/{project}/locations/{location}/channels/{channel_id}format. - project str
- provider str
- 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}.
- channel
Id String - Required. The user-provided ID to be assigned to the channel.
- crypto
Key StringName - 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/*. - location String
- name String
- The resource name of the channel. Must be unique within the location on the project and must be in
projects/{project}/locations/{location}/channels/{channel_id}format. - project String
- provider 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}.
Outputs
All input properties are implicitly available as output properties. Additionally, the Channel resource produces the following output properties:
- Activation
Token string - The activation token for the channel. The token must be used by the provider to register the channel for publishing.
- Create
Time string - The creation time.
- Id string
- The provider-assigned unique ID for this managed resource.
- Pubsub
Topic 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}. - State string
- The state of a Channel.
- Uid string
- 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 string - The last-modified time.
- Activation
Token string - The activation token for the channel. The token must be used by the provider to register the channel for publishing.
- Create
Time string - The creation time.
- Id string
- The provider-assigned unique ID for this managed resource.
- Pubsub
Topic 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}. - State string
- The state of a Channel.
- Uid string
- 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 string - The last-modified time.
- activation_
token string - The activation token for the channel. The token must be used by the provider to register the channel for publishing.
- create_
time string - The creation time.
- id string
- The provider-assigned unique ID for this managed resource.
- pubsub_
topic 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}. - state string
- The state of a Channel.
- uid string
- 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 string - The last-modified time.
- activation
Token String - The activation token for the channel. The token must be used by the provider to register the channel for publishing.
- create
Time String - The creation time.
- id String
- The provider-assigned unique ID for this managed resource.
- pubsub
Topic 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}. - state String
- The state of a Channel.
- uid String
- 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 String - The last-modified time.
- activation
Token string - The activation token for the channel. The token must be used by the provider to register the channel for publishing.
- create
Time string - The creation time.
- id string
- The provider-assigned unique ID for this managed resource.
- pubsub
Topic 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}. - state string
- The state of a Channel.
- uid string
- 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 string - The last-modified time.
- activation_
token str - The activation token for the channel. The token must be used by the provider to register the channel for publishing.
- create_
time str - The creation time.
- id str
- The provider-assigned unique ID for this managed resource.
- pubsub_
topic str - 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}. - state str
- The state of a Channel.
- uid str
- 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 - The last-modified time.
- activation
Token String - The activation token for the channel. The token must be used by the provider to register the channel for publishing.
- create
Time String - The creation time.
- id String
- The provider-assigned unique ID for this managed resource.
- pubsub
Topic 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}. - state String
- The state of a Channel.
- uid String
- 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 String - The last-modified time.
Look up Existing Channel Resource
Get an existing Channel 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>, opts?: CustomResourceOptions): Channel@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None) -> Channelfunc GetChannel(ctx *Context, name string, id IDInput, state *ChannelState, opts ...ResourceOption) (*Channel, error)public static Channel Get(string name, Input<string> id, CustomResourceOptions? opts = null)public static Channel get(String name, Output<String> id, CustomResourceOptions options)resources: existingChannel: type: google-native:eventarc/v1:Channel get: id: ${id}import {
to = google-native_eventarc_v1_channel.example
id = "${id}"
}
- name string
- The unique name of the resulting resource.
- id Input<ID>
- The unique provider ID of the resource to look up.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resulting resource.
- id str
- The unique provider ID of the resource to look up.
- 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 resulting resource.
- id IDInput
- The unique provider ID of the resource to look up.
- state ChannelState
- Pass nil. This resource has no state arguments.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resulting resource.
- id Input<string>
- The unique provider ID of the resource to look up.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resulting resource.
- id Output<String>
- The unique provider ID of the resource to look up.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Package Details
- Repository
- Google Cloud Native pulumi/pulumi-google-native
- License
- Apache-2.0
This package is deprecated. Active development has stopped. We recommend using the Google Cloud package instead.
published on Wednesday, Nov 29, 2023 by Pulumi