Google Cloud Native v0.28.0, Feb 2 23

google-native.eventarc/v1.Channel

Create a new channel in a particular project and location.

Create Channel Resource

new Channel(name: string, args: ChannelArgs, opts?: CustomResourceOptions);

@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,
            validate_only: Optional[bool] = None)
@overload
def Channel(resource_name: str,
            args: ChannelArgs,
            opts: Optional[ResourceOptions] = 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.

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.

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

The Channel resource accepts the following input properties:

ChannelId string: Required. The user-provided ID to be assigned to the channel.
ValidateOnly bool: Required. If set, validate the request and preview the review, but do not post it.
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/*.
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}.

ChannelId string: Required. The user-provided ID to be assigned to the channel.
ValidateOnly bool: Required. If set, validate the request and preview the review, but do not post it.
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/*.
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}.

channelId String: Required. The user-provided ID to be assigned to the channel.
validateOnly Boolean: Required. If set, validate the request and preview the review, but do not post it.
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/*.
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}.

channelId string: Required. The user-provided ID to be assigned to the channel.
validateOnly boolean: Required. If set, validate the request and preview the review, but do not post it.
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/*.
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.
validate_only bool: Required. If set, validate the request and preview the review, but do not post it.
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/*.
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}.

channelId String: Required. The user-provided ID to be assigned to the channel.
validateOnly Boolean: Required. If set, validate the request and preview the review, but do not post it.
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/*.
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:

ActivationToken string: The activation token for the channel. The token must be used by the provider to register the channel for publishing.
CreateTime string: The creation time.
Id string: The provider-assigned unique ID for this managed resource.
PubsubTopic 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.
UpdateTime string: The last-modified time.

ActivationToken string: The activation token for the channel. The token must be used by the provider to register the channel for publishing.
CreateTime string: The creation time.
Id string: The provider-assigned unique ID for this managed resource.
PubsubTopic 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.
UpdateTime string: The last-modified time.

activationToken String: The activation token for the channel. The token must be used by the provider to register the channel for publishing.
createTime String: The creation time.
id String: The provider-assigned unique ID for this managed resource.
pubsubTopic 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.
updateTime String: The last-modified time.

activationToken string: The activation token for the channel. The token must be used by the provider to register the channel for publishing.
createTime string: The creation time.
id string: The provider-assigned unique ID for this managed resource.
pubsubTopic 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.
updateTime 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.

activationToken String: The activation token for the channel. The token must be used by the provider to register the channel for publishing.
createTime String: The creation time.
id String: The provider-assigned unique ID for this managed resource.
pubsubTopic 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.
updateTime String: The last-modified time.

Package Details

Repository: Google Cloud Native pulumi/pulumi-google-native
License: Apache-2.0