1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. eventarc
  5. GoogleChannelConfig
Google Cloud Classic v7.23.0 published on Wednesday, May 15, 2024 by Pulumi

gcp.eventarc.GoogleChannelConfig

Explore with Pulumi AI

gcp logo
Google Cloud Classic v7.23.0 published on Wednesday, May 15, 2024 by Pulumi

    The Eventarc GoogleChannelConfig resource

    Example Usage

    Basic

    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-west1",
    });
    const key = testKeyRing.then(testKeyRing => gcp.kms.getKMSCryptoKey({
        name: "key",
        keyRing: testKeyRing.id,
    }));
    const key1Member = new gcp.kms.CryptoKeyIAMMember("key1_member", {
        cryptoKeyId: key1.id,
        role: "roles/cloudkms.cryptoKeyEncrypterDecrypter",
        member: testProject.then(testProject => `serviceAccount:service-${testProject.number}@gcp-sa-eventarc.iam.gserviceaccount.com`),
    });
    const primary = new gcp.eventarc.GoogleChannelConfig("primary", {
        location: "us-west1",
        name: "channel",
        project: testProject.then(testProject => testProject.projectId),
        cryptoKeyName: key1.id,
    });
    
    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-west1")
    key = gcp.kms.get_kms_crypto_key(name="key",
        key_ring=test_key_ring.id)
    key1_member = gcp.kms.CryptoKeyIAMMember("key1_member",
        crypto_key_id=key1["id"],
        role="roles/cloudkms.cryptoKeyEncrypterDecrypter",
        member=f"serviceAccount:service-{test_project.number}@gcp-sa-eventarc.iam.gserviceaccount.com")
    primary = gcp.eventarc.GoogleChannelConfig("primary",
        location="us-west1",
        name="channel",
        project=test_project.project_id,
        crypto_key_name=key1["id"])
    
    package main
    
    import (
    	"fmt"
    
    	"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/eventarc"
    	"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/kms"
    	"github.com/pulumi/pulumi-gcp/sdk/v7/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-west1",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		_, err = kms.GetKMSCryptoKey(ctx, &kms.GetKMSCryptoKeyArgs{
    			Name:    "key",
    			KeyRing: testKeyRing.Id,
    		}, nil)
    		if err != nil {
    			return err
    		}
    		_, err = kms.NewCryptoKeyIAMMember(ctx, "key1_member", &kms.CryptoKeyIAMMemberArgs{
    			CryptoKeyId: pulumi.Any(key1.Id),
    			Role:        pulumi.String("roles/cloudkms.cryptoKeyEncrypterDecrypter"),
    			Member:      pulumi.String(fmt.Sprintf("serviceAccount:service-%v@gcp-sa-eventarc.iam.gserviceaccount.com", testProject.Number)),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = eventarc.NewGoogleChannelConfig(ctx, "primary", &eventarc.GoogleChannelConfigArgs{
    			Location:      pulumi.String("us-west1"),
    			Name:          pulumi.String("channel"),
    			Project:       pulumi.String(testProject.ProjectId),
    			CryptoKeyName: pulumi.Any(key1.Id),
    		})
    		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-west1",
        });
    
        var key = Gcp.Kms.GetKMSCryptoKey.Invoke(new()
        {
            Name = "key",
            KeyRing = testKeyRing.Apply(getKMSKeyRingResult => getKMSKeyRingResult.Id),
        });
    
        var key1Member = new Gcp.Kms.CryptoKeyIAMMember("key1_member", new()
        {
            CryptoKeyId = key1.Id,
            Role = "roles/cloudkms.cryptoKeyEncrypterDecrypter",
            Member = $"serviceAccount:service-{testProject.Apply(getProjectResult => getProjectResult.Number)}@gcp-sa-eventarc.iam.gserviceaccount.com",
        });
    
        var primary = new Gcp.Eventarc.GoogleChannelConfig("primary", new()
        {
            Location = "us-west1",
            Name = "channel",
            Project = testProject.Apply(getProjectResult => getProjectResult.ProjectId),
            CryptoKeyName = key1.Id,
        });
    
    });
    
    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.GoogleChannelConfig;
    import com.pulumi.gcp.eventarc.GoogleChannelConfigArgs;
    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-west1")
                .build());
    
            final var key = KmsFunctions.getKMSCryptoKey(GetKMSCryptoKeyArgs.builder()
                .name("key")
                .keyRing(testKeyRing.applyValue(getKMSKeyRingResult -> getKMSKeyRingResult.id()))
                .build());
    
            var key1Member = new CryptoKeyIAMMember("key1Member", CryptoKeyIAMMemberArgs.builder()        
                .cryptoKeyId(key1.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 GoogleChannelConfig("primary", GoogleChannelConfigArgs.builder()        
                .location("us-west1")
                .name("channel")
                .project(testProject.applyValue(getProjectResult -> getProjectResult.projectId()))
                .cryptoKeyName(key1.id())
                .build());
    
        }
    }
    
    resources:
      key1Member:
        type: gcp:kms:CryptoKeyIAMMember
        name: key1_member
        properties:
          cryptoKeyId: ${key1.id}
          role: roles/cloudkms.cryptoKeyEncrypterDecrypter
          member: serviceAccount:service-${testProject.number}@gcp-sa-eventarc.iam.gserviceaccount.com
      primary:
        type: gcp:eventarc:GoogleChannelConfig
        properties:
          location: us-west1
          name: channel
          project: ${testProject.projectId}
          cryptoKeyName: ${key1.id}
    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-west1
      key:
        fn::invoke:
          Function: gcp:kms:getKMSCryptoKey
          Arguments:
            name: key
            keyRing: ${testKeyRing.id}
    

    Create GoogleChannelConfig Resource

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

    Constructor syntax

    new GoogleChannelConfig(name: string, args: GoogleChannelConfigArgs, opts?: CustomResourceOptions);
    @overload
    def GoogleChannelConfig(resource_name: str,
                            args: GoogleChannelConfigArgs,
                            opts: Optional[ResourceOptions] = None)
    
    @overload
    def GoogleChannelConfig(resource_name: str,
                            opts: Optional[ResourceOptions] = None,
                            location: Optional[str] = None,
                            crypto_key_name: Optional[str] = None,
                            name: Optional[str] = None,
                            project: Optional[str] = None)
    func NewGoogleChannelConfig(ctx *Context, name string, args GoogleChannelConfigArgs, opts ...ResourceOption) (*GoogleChannelConfig, error)
    public GoogleChannelConfig(string name, GoogleChannelConfigArgs args, CustomResourceOptions? opts = null)
    public GoogleChannelConfig(String name, GoogleChannelConfigArgs args)
    public GoogleChannelConfig(String name, GoogleChannelConfigArgs args, CustomResourceOptions options)
    
    type: gcp:eventarc:GoogleChannelConfig
    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 GoogleChannelConfigArgs
    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 GoogleChannelConfigArgs
    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 GoogleChannelConfigArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args GoogleChannelConfigArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args GoogleChannelConfigArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var googleChannelConfigResource = new Gcp.Eventarc.GoogleChannelConfig("googleChannelConfigResource", new()
    {
        Location = "string",
        CryptoKeyName = "string",
        Name = "string",
        Project = "string",
    });
    
    example, err := eventarc.NewGoogleChannelConfig(ctx, "googleChannelConfigResource", &eventarc.GoogleChannelConfigArgs{
    	Location:      pulumi.String("string"),
    	CryptoKeyName: pulumi.String("string"),
    	Name:          pulumi.String("string"),
    	Project:       pulumi.String("string"),
    })
    
    var googleChannelConfigResource = new GoogleChannelConfig("googleChannelConfigResource", GoogleChannelConfigArgs.builder()        
        .location("string")
        .cryptoKeyName("string")
        .name("string")
        .project("string")
        .build());
    
    google_channel_config_resource = gcp.eventarc.GoogleChannelConfig("googleChannelConfigResource",
        location="string",
        crypto_key_name="string",
        name="string",
        project="string")
    
    const googleChannelConfigResource = new gcp.eventarc.GoogleChannelConfig("googleChannelConfigResource", {
        location: "string",
        cryptoKeyName: "string",
        name: "string",
        project: "string",
    });
    
    type: gcp:eventarc:GoogleChannelConfig
    properties:
        cryptoKeyName: string
        location: string
        name: string
        project: string
    

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

    Location string
    The location for 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/*.
    Name string
    Required. The resource name of the config. Must be in the format of, projects/{project}/locations/{location}/googleChannelConfig.


    Project string
    The project for the resource
    Location string
    The location for 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/*.
    Name string
    Required. The resource name of the config. Must be in the format of, projects/{project}/locations/{location}/googleChannelConfig.


    Project string
    The project for the resource
    location String
    The location for 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/*.
    name String
    Required. The resource name of the config. Must be in the format of, projects/{project}/locations/{location}/googleChannelConfig.


    project String
    The project for the resource
    location string
    The location for 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/*.
    name string
    Required. The resource name of the config. Must be in the format of, projects/{project}/locations/{location}/googleChannelConfig.


    project string
    The project for the resource
    location str
    The location for 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/*.
    name str
    Required. The resource name of the config. Must be in the format of, projects/{project}/locations/{location}/googleChannelConfig.


    project str
    The project for the resource
    location String
    The location for 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/*.
    name String
    Required. The resource name of the config. Must be in the format of, projects/{project}/locations/{location}/googleChannelConfig.


    project String
    The project for the resource

    Outputs

    All input properties are implicitly available as output properties. Additionally, the GoogleChannelConfig resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    UpdateTime string
    Output only. The last-modified time.
    Id string
    The provider-assigned unique ID for this managed resource.
    UpdateTime string
    Output only. The last-modified time.
    id String
    The provider-assigned unique ID for this managed resource.
    updateTime String
    Output only. The last-modified time.
    id string
    The provider-assigned unique ID for this managed resource.
    updateTime string
    Output only. The last-modified time.
    id str
    The provider-assigned unique ID for this managed resource.
    update_time str
    Output only. The last-modified time.
    id String
    The provider-assigned unique ID for this managed resource.
    updateTime String
    Output only. The last-modified time.

    Look up Existing GoogleChannelConfig Resource

    Get an existing GoogleChannelConfig 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?: GoogleChannelConfigState, opts?: CustomResourceOptions): GoogleChannelConfig
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            crypto_key_name: Optional[str] = None,
            location: Optional[str] = None,
            name: Optional[str] = None,
            project: Optional[str] = None,
            update_time: Optional[str] = None) -> GoogleChannelConfig
    func GetGoogleChannelConfig(ctx *Context, name string, id IDInput, state *GoogleChannelConfigState, opts ...ResourceOption) (*GoogleChannelConfig, error)
    public static GoogleChannelConfig Get(string name, Input<string> id, GoogleChannelConfigState? state, CustomResourceOptions? opts = null)
    public static GoogleChannelConfig get(String name, Output<String> id, GoogleChannelConfigState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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:
    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
    The location for the resource
    Name string
    Required. The resource name of the config. Must be in the format of, projects/{project}/locations/{location}/googleChannelConfig.


    Project string
    The project for the resource
    UpdateTime string
    Output only. The last-modified 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/*.
    Location string
    The location for the resource
    Name string
    Required. The resource name of the config. Must be in the format of, projects/{project}/locations/{location}/googleChannelConfig.


    Project string
    The project for the resource
    UpdateTime string
    Output only. The last-modified 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/*.
    location String
    The location for the resource
    name String
    Required. The resource name of the config. Must be in the format of, projects/{project}/locations/{location}/googleChannelConfig.


    project String
    The project for the resource
    updateTime String
    Output only. The last-modified 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/*.
    location string
    The location for the resource
    name string
    Required. The resource name of the config. Must be in the format of, projects/{project}/locations/{location}/googleChannelConfig.


    project string
    The project for the resource
    updateTime string
    Output only. The last-modified 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/*.
    location str
    The location for the resource
    name str
    Required. The resource name of the config. Must be in the format of, projects/{project}/locations/{location}/googleChannelConfig.


    project str
    The project for the resource
    update_time str
    Output only. The last-modified 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/*.
    location String
    The location for the resource
    name String
    Required. The resource name of the config. Must be in the format of, projects/{project}/locations/{location}/googleChannelConfig.


    project String
    The project for the resource
    updateTime String
    Output only. The last-modified time.

    Import

    GoogleChannelConfig can be imported using any of these accepted formats:

    • projects/{{project}}/locations/{{location}}/googleChannelConfig

    • {{project}}/{{location}}

    • {{location}}

    When using the pulumi import command, GoogleChannelConfig can be imported using one of the formats above. For example:

    $ pulumi import gcp:eventarc/googleChannelConfig:GoogleChannelConfig default projects/{{project}}/locations/{{location}}/googleChannelConfig
    
    $ pulumi import gcp:eventarc/googleChannelConfig:GoogleChannelConfig default {{project}}/{{location}}
    
    $ pulumi import gcp:eventarc/googleChannelConfig:GoogleChannelConfig default {{location}}
    

    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 Classic v7.23.0 published on Wednesday, May 15, 2024 by Pulumi