1. Packages
  2. Google Cloud Native
  3. API Docs
  4. eventarc
  5. eventarc/v1
  6. Channel

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi

google-native.eventarc/v1.Channel

Explore with Pulumi AI

google-native logo

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 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.
    
    

    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"),
    })
    
    var channelResource = new Channel("channelResource", 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:

    ChannelId string
    Required. The user-provided ID to be assigned to the channel.
    CryptoKeyName string
    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.
    CryptoKeyName string
    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.
    cryptoKeyName String
    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.
    cryptoKeyName string
    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_name str
    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.
    cryptoKeyName String
    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
    google-native logo

    Google Cloud Native is in preview. Google Cloud Classic is fully supported.

    Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi