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

gcp.applicationintegration.Client

Explore with Pulumi AI

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

    Application Integration Client.

    To get more information about Client, see:

    Example Usage

    Integrations Client Basic

    import * as pulumi from "@pulumi/pulumi";
    import * as gcp from "@pulumi/gcp";
    
    const example = new gcp.applicationintegration.Client("example", {location: "us-central1"});
    
    import pulumi
    import pulumi_gcp as gcp
    
    example = gcp.applicationintegration.Client("example", location="us-central1")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/applicationintegration"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := applicationintegration.NewClient(ctx, "example", &applicationintegration.ClientArgs{
    			Location: pulumi.String("us-central1"),
    		})
    		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 example = new Gcp.ApplicationIntegration.Client("example", new()
        {
            Location = "us-central1",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.gcp.applicationintegration.Client;
    import com.pulumi.gcp.applicationintegration.ClientArgs;
    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) {
            var example = new Client("example", ClientArgs.builder()        
                .location("us-central1")
                .build());
    
        }
    }
    
    resources:
      example:
        type: gcp:applicationintegration:Client
        properties:
          location: us-central1
    

    Integrations Client Full

    import * as pulumi from "@pulumi/pulumi";
    import * as gcp from "@pulumi/gcp";
    
    const testProject = gcp.organizations.getProject({});
    const keyring = new gcp.kms.KeyRing("keyring", {
        name: "my-keyring",
        location: "us-east1",
    });
    const cryptokey = new gcp.kms.CryptoKey("cryptokey", {
        name: "crypto-key-example",
        keyRing: keyring.id,
        rotationPeriod: "7776000s",
    });
    const testKey = new gcp.kms.CryptoKeyVersion("test_key", {cryptoKey: cryptokey.id});
    const serviceAccount = new gcp.serviceaccount.Account("service_account", {
        accountId: "service-account-id",
        displayName: "Service Account",
    });
    const example = new gcp.applicationintegration.Client("example", {
        location: "us-east1",
        createSampleIntegrations: true,
        runAsServiceAccount: serviceAccount.email,
        cloudKmsConfig: {
            kmsLocation: "us-east1",
            kmsRing: keyring.id,
            key: cryptokey.id,
            keyVersion: testKey.id,
            kmsProjectId: testProject.then(testProject => testProject.projectId),
        },
    });
    
    import pulumi
    import pulumi_gcp as gcp
    
    test_project = gcp.organizations.get_project()
    keyring = gcp.kms.KeyRing("keyring",
        name="my-keyring",
        location="us-east1")
    cryptokey = gcp.kms.CryptoKey("cryptokey",
        name="crypto-key-example",
        key_ring=keyring.id,
        rotation_period="7776000s")
    test_key = gcp.kms.CryptoKeyVersion("test_key", crypto_key=cryptokey.id)
    service_account = gcp.serviceaccount.Account("service_account",
        account_id="service-account-id",
        display_name="Service Account")
    example = gcp.applicationintegration.Client("example",
        location="us-east1",
        create_sample_integrations=True,
        run_as_service_account=service_account.email,
        cloud_kms_config=gcp.applicationintegration.ClientCloudKmsConfigArgs(
            kms_location="us-east1",
            kms_ring=keyring.id,
            key=cryptokey.id,
            key_version=test_key.id,
            kms_project_id=test_project.project_id,
        ))
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/applicationintegration"
    	"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/kms"
    	"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/organizations"
    	"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/serviceaccount"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		testProject, err := organizations.LookupProject(ctx, nil, nil)
    		if err != nil {
    			return err
    		}
    		keyring, err := kms.NewKeyRing(ctx, "keyring", &kms.KeyRingArgs{
    			Name:     pulumi.String("my-keyring"),
    			Location: pulumi.String("us-east1"),
    		})
    		if err != nil {
    			return err
    		}
    		cryptokey, err := kms.NewCryptoKey(ctx, "cryptokey", &kms.CryptoKeyArgs{
    			Name:           pulumi.String("crypto-key-example"),
    			KeyRing:        keyring.ID(),
    			RotationPeriod: pulumi.String("7776000s"),
    		})
    		if err != nil {
    			return err
    		}
    		testKey, err := kms.NewCryptoKeyVersion(ctx, "test_key", &kms.CryptoKeyVersionArgs{
    			CryptoKey: cryptokey.ID(),
    		})
    		if err != nil {
    			return err
    		}
    		serviceAccount, err := serviceaccount.NewAccount(ctx, "service_account", &serviceaccount.AccountArgs{
    			AccountId:   pulumi.String("service-account-id"),
    			DisplayName: pulumi.String("Service Account"),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = applicationintegration.NewClient(ctx, "example", &applicationintegration.ClientArgs{
    			Location:                 pulumi.String("us-east1"),
    			CreateSampleIntegrations: pulumi.Bool(true),
    			RunAsServiceAccount:      serviceAccount.Email,
    			CloudKmsConfig: &applicationintegration.ClientCloudKmsConfigArgs{
    				KmsLocation:  pulumi.String("us-east1"),
    				KmsRing:      keyring.ID(),
    				Key:          cryptokey.ID(),
    				KeyVersion:   testKey.ID(),
    				KmsProjectId: pulumi.String(testProject.ProjectId),
    			},
    		})
    		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();
    
        var keyring = new Gcp.Kms.KeyRing("keyring", new()
        {
            Name = "my-keyring",
            Location = "us-east1",
        });
    
        var cryptokey = new Gcp.Kms.CryptoKey("cryptokey", new()
        {
            Name = "crypto-key-example",
            KeyRing = keyring.Id,
            RotationPeriod = "7776000s",
        });
    
        var testKey = new Gcp.Kms.CryptoKeyVersion("test_key", new()
        {
            CryptoKey = cryptokey.Id,
        });
    
        var serviceAccount = new Gcp.ServiceAccount.Account("service_account", new()
        {
            AccountId = "service-account-id",
            DisplayName = "Service Account",
        });
    
        var example = new Gcp.ApplicationIntegration.Client("example", new()
        {
            Location = "us-east1",
            CreateSampleIntegrations = true,
            RunAsServiceAccount = serviceAccount.Email,
            CloudKmsConfig = new Gcp.ApplicationIntegration.Inputs.ClientCloudKmsConfigArgs
            {
                KmsLocation = "us-east1",
                KmsRing = keyring.Id,
                Key = cryptokey.Id,
                KeyVersion = testKey.Id,
                KmsProjectId = testProject.Apply(getProjectResult => getProjectResult.ProjectId),
            },
        });
    
    });
    
    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.KeyRing;
    import com.pulumi.gcp.kms.KeyRingArgs;
    import com.pulumi.gcp.kms.CryptoKey;
    import com.pulumi.gcp.kms.CryptoKeyArgs;
    import com.pulumi.gcp.kms.CryptoKeyVersion;
    import com.pulumi.gcp.kms.CryptoKeyVersionArgs;
    import com.pulumi.gcp.serviceaccount.Account;
    import com.pulumi.gcp.serviceaccount.AccountArgs;
    import com.pulumi.gcp.applicationintegration.Client;
    import com.pulumi.gcp.applicationintegration.ClientArgs;
    import com.pulumi.gcp.applicationintegration.inputs.ClientCloudKmsConfigArgs;
    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();
    
            var keyring = new KeyRing("keyring", KeyRingArgs.builder()        
                .name("my-keyring")
                .location("us-east1")
                .build());
    
            var cryptokey = new CryptoKey("cryptokey", CryptoKeyArgs.builder()        
                .name("crypto-key-example")
                .keyRing(keyring.id())
                .rotationPeriod("7776000s")
                .build());
    
            var testKey = new CryptoKeyVersion("testKey", CryptoKeyVersionArgs.builder()        
                .cryptoKey(cryptokey.id())
                .build());
    
            var serviceAccount = new Account("serviceAccount", AccountArgs.builder()        
                .accountId("service-account-id")
                .displayName("Service Account")
                .build());
    
            var example = new Client("example", ClientArgs.builder()        
                .location("us-east1")
                .createSampleIntegrations(true)
                .runAsServiceAccount(serviceAccount.email())
                .cloudKmsConfig(ClientCloudKmsConfigArgs.builder()
                    .kmsLocation("us-east1")
                    .kmsRing(keyring.id())
                    .key(cryptokey.id())
                    .keyVersion(testKey.id())
                    .kmsProjectId(testProject.applyValue(getProjectResult -> getProjectResult.projectId()))
                    .build())
                .build());
    
        }
    }
    
    resources:
      keyring:
        type: gcp:kms:KeyRing
        properties:
          name: my-keyring
          location: us-east1
      cryptokey:
        type: gcp:kms:CryptoKey
        properties:
          name: crypto-key-example
          keyRing: ${keyring.id}
          rotationPeriod: 7776000s
      testKey:
        type: gcp:kms:CryptoKeyVersion
        name: test_key
        properties:
          cryptoKey: ${cryptokey.id}
      serviceAccount:
        type: gcp:serviceaccount:Account
        name: service_account
        properties:
          accountId: service-account-id
          displayName: Service Account
      example:
        type: gcp:applicationintegration:Client
        properties:
          location: us-east1
          createSampleIntegrations: true
          runAsServiceAccount: ${serviceAccount.email}
          cloudKmsConfig:
            kmsLocation: us-east1
            kmsRing: ${keyring.id}
            key: ${cryptokey.id}
            keyVersion: ${testKey.id}
            kmsProjectId: ${testProject.projectId}
    variables:
      testProject:
        fn::invoke:
          Function: gcp:organizations:getProject
          Arguments: {}
    

    Create Client Resource

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

    Constructor syntax

    new Client(name: string, args: ClientArgs, opts?: CustomResourceOptions);
    @overload
    def Client(resource_name: str,
               args: ClientArgs,
               opts: Optional[ResourceOptions] = None)
    
    @overload
    def Client(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               location: Optional[str] = None,
               cloud_kms_config: Optional[ClientCloudKmsConfigArgs] = None,
               create_sample_integrations: Optional[bool] = None,
               create_sample_workflows: Optional[bool] = None,
               project: Optional[str] = None,
               provision_gmek: Optional[bool] = None,
               run_as_service_account: Optional[str] = None)
    func NewClient(ctx *Context, name string, args ClientArgs, opts ...ResourceOption) (*Client, error)
    public Client(string name, ClientArgs args, CustomResourceOptions? opts = null)
    public Client(String name, ClientArgs args)
    public Client(String name, ClientArgs args, CustomResourceOptions options)
    
    type: gcp:applicationintegration:Client
    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 ClientArgs
    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 ClientArgs
    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 ClientArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ClientArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ClientArgs
    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 clientResource = new Gcp.ApplicationIntegration.Client("clientResource", new()
    {
        Location = "string",
        CloudKmsConfig = new Gcp.ApplicationIntegration.Inputs.ClientCloudKmsConfigArgs
        {
            Key = "string",
            KmsLocation = "string",
            KmsRing = "string",
            KeyVersion = "string",
            KmsProjectId = "string",
        },
        CreateSampleIntegrations = false,
        Project = "string",
        RunAsServiceAccount = "string",
    });
    
    example, err := applicationintegration.NewClient(ctx, "clientResource", &applicationintegration.ClientArgs{
    	Location: pulumi.String("string"),
    	CloudKmsConfig: &applicationintegration.ClientCloudKmsConfigArgs{
    		Key:          pulumi.String("string"),
    		KmsLocation:  pulumi.String("string"),
    		KmsRing:      pulumi.String("string"),
    		KeyVersion:   pulumi.String("string"),
    		KmsProjectId: pulumi.String("string"),
    	},
    	CreateSampleIntegrations: pulumi.Bool(false),
    	Project:                  pulumi.String("string"),
    	RunAsServiceAccount:      pulumi.String("string"),
    })
    
    var clientResource = new Client("clientResource", ClientArgs.builder()        
        .location("string")
        .cloudKmsConfig(ClientCloudKmsConfigArgs.builder()
            .key("string")
            .kmsLocation("string")
            .kmsRing("string")
            .keyVersion("string")
            .kmsProjectId("string")
            .build())
        .createSampleIntegrations(false)
        .project("string")
        .runAsServiceAccount("string")
        .build());
    
    client_resource = gcp.applicationintegration.Client("clientResource",
        location="string",
        cloud_kms_config=gcp.applicationintegration.ClientCloudKmsConfigArgs(
            key="string",
            kms_location="string",
            kms_ring="string",
            key_version="string",
            kms_project_id="string",
        ),
        create_sample_integrations=False,
        project="string",
        run_as_service_account="string")
    
    const clientResource = new gcp.applicationintegration.Client("clientResource", {
        location: "string",
        cloudKmsConfig: {
            key: "string",
            kmsLocation: "string",
            kmsRing: "string",
            keyVersion: "string",
            kmsProjectId: "string",
        },
        createSampleIntegrations: false,
        project: "string",
        runAsServiceAccount: "string",
    });
    
    type: gcp:applicationintegration:Client
    properties:
        cloudKmsConfig:
            key: string
            keyVersion: string
            kmsLocation: string
            kmsProjectId: string
            kmsRing: string
        createSampleIntegrations: false
        location: string
        project: string
        runAsServiceAccount: string
    

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

    Location string
    Location in which client needs to be provisioned.


    CloudKmsConfig ClientCloudKmsConfig
    Cloud KMS config for AuthModule to encrypt/decrypt credentials. Structure is documented below.
    CreateSampleIntegrations bool
    Indicates if sample integrations should be created along with provisioning.
    CreateSampleWorkflows bool

    (Optional, Deprecated) Indicates if sample workflow should be created along with provisioning.

    Warning: create_sample_workflows is deprecated and will be removed in a future major release. Use create_sample_integrations instead.

    Deprecated: create_sample_workflows is deprecated and will be removed in a future major release. Use create_sample_integrations instead.

    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    ProvisionGmek bool

    (Optional, Deprecated) Indicates provision with GMEK or CMEK.

    Warning: provision_gmek is deprecated and will be removed in a future major release. Client would be provisioned as gmek if cloud_kms_config is not given.

    Deprecated: provision_gmek is deprecated and will be removed in a future major release. Client would be provisioned as gmek if cloud_kms_config is not given.

    RunAsServiceAccount string
    User input run-as service account, if empty, will bring up a new default service account.
    Location string
    Location in which client needs to be provisioned.


    CloudKmsConfig ClientCloudKmsConfigArgs
    Cloud KMS config for AuthModule to encrypt/decrypt credentials. Structure is documented below.
    CreateSampleIntegrations bool
    Indicates if sample integrations should be created along with provisioning.
    CreateSampleWorkflows bool

    (Optional, Deprecated) Indicates if sample workflow should be created along with provisioning.

    Warning: create_sample_workflows is deprecated and will be removed in a future major release. Use create_sample_integrations instead.

    Deprecated: create_sample_workflows is deprecated and will be removed in a future major release. Use create_sample_integrations instead.

    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    ProvisionGmek bool

    (Optional, Deprecated) Indicates provision with GMEK or CMEK.

    Warning: provision_gmek is deprecated and will be removed in a future major release. Client would be provisioned as gmek if cloud_kms_config is not given.

    Deprecated: provision_gmek is deprecated and will be removed in a future major release. Client would be provisioned as gmek if cloud_kms_config is not given.

    RunAsServiceAccount string
    User input run-as service account, if empty, will bring up a new default service account.
    location String
    Location in which client needs to be provisioned.


    cloudKmsConfig ClientCloudKmsConfig
    Cloud KMS config for AuthModule to encrypt/decrypt credentials. Structure is documented below.
    createSampleIntegrations Boolean
    Indicates if sample integrations should be created along with provisioning.
    createSampleWorkflows Boolean

    (Optional, Deprecated) Indicates if sample workflow should be created along with provisioning.

    Warning: create_sample_workflows is deprecated and will be removed in a future major release. Use create_sample_integrations instead.

    Deprecated: create_sample_workflows is deprecated and will be removed in a future major release. Use create_sample_integrations instead.

    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    provisionGmek Boolean

    (Optional, Deprecated) Indicates provision with GMEK or CMEK.

    Warning: provision_gmek is deprecated and will be removed in a future major release. Client would be provisioned as gmek if cloud_kms_config is not given.

    Deprecated: provision_gmek is deprecated and will be removed in a future major release. Client would be provisioned as gmek if cloud_kms_config is not given.

    runAsServiceAccount String
    User input run-as service account, if empty, will bring up a new default service account.
    location string
    Location in which client needs to be provisioned.


    cloudKmsConfig ClientCloudKmsConfig
    Cloud KMS config for AuthModule to encrypt/decrypt credentials. Structure is documented below.
    createSampleIntegrations boolean
    Indicates if sample integrations should be created along with provisioning.
    createSampleWorkflows boolean

    (Optional, Deprecated) Indicates if sample workflow should be created along with provisioning.

    Warning: create_sample_workflows is deprecated and will be removed in a future major release. Use create_sample_integrations instead.

    Deprecated: create_sample_workflows is deprecated and will be removed in a future major release. Use create_sample_integrations instead.

    project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    provisionGmek boolean

    (Optional, Deprecated) Indicates provision with GMEK or CMEK.

    Warning: provision_gmek is deprecated and will be removed in a future major release. Client would be provisioned as gmek if cloud_kms_config is not given.

    Deprecated: provision_gmek is deprecated and will be removed in a future major release. Client would be provisioned as gmek if cloud_kms_config is not given.

    runAsServiceAccount string
    User input run-as service account, if empty, will bring up a new default service account.
    location str
    Location in which client needs to be provisioned.


    cloud_kms_config ClientCloudKmsConfigArgs
    Cloud KMS config for AuthModule to encrypt/decrypt credentials. Structure is documented below.
    create_sample_integrations bool
    Indicates if sample integrations should be created along with provisioning.
    create_sample_workflows bool

    (Optional, Deprecated) Indicates if sample workflow should be created along with provisioning.

    Warning: create_sample_workflows is deprecated and will be removed in a future major release. Use create_sample_integrations instead.

    Deprecated: create_sample_workflows is deprecated and will be removed in a future major release. Use create_sample_integrations instead.

    project str
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    provision_gmek bool

    (Optional, Deprecated) Indicates provision with GMEK or CMEK.

    Warning: provision_gmek is deprecated and will be removed in a future major release. Client would be provisioned as gmek if cloud_kms_config is not given.

    Deprecated: provision_gmek is deprecated and will be removed in a future major release. Client would be provisioned as gmek if cloud_kms_config is not given.

    run_as_service_account str
    User input run-as service account, if empty, will bring up a new default service account.
    location String
    Location in which client needs to be provisioned.


    cloudKmsConfig Property Map
    Cloud KMS config for AuthModule to encrypt/decrypt credentials. Structure is documented below.
    createSampleIntegrations Boolean
    Indicates if sample integrations should be created along with provisioning.
    createSampleWorkflows Boolean

    (Optional, Deprecated) Indicates if sample workflow should be created along with provisioning.

    Warning: create_sample_workflows is deprecated and will be removed in a future major release. Use create_sample_integrations instead.

    Deprecated: create_sample_workflows is deprecated and will be removed in a future major release. Use create_sample_integrations instead.

    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    provisionGmek Boolean

    (Optional, Deprecated) Indicates provision with GMEK or CMEK.

    Warning: provision_gmek is deprecated and will be removed in a future major release. Client would be provisioned as gmek if cloud_kms_config is not given.

    Deprecated: provision_gmek is deprecated and will be removed in a future major release. Client would be provisioned as gmek if cloud_kms_config is not given.

    runAsServiceAccount String
    User input run-as service account, if empty, will bring up a new default service account.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing Client Resource

    Get an existing Client 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?: ClientState, opts?: CustomResourceOptions): Client
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            cloud_kms_config: Optional[ClientCloudKmsConfigArgs] = None,
            create_sample_integrations: Optional[bool] = None,
            create_sample_workflows: Optional[bool] = None,
            location: Optional[str] = None,
            project: Optional[str] = None,
            provision_gmek: Optional[bool] = None,
            run_as_service_account: Optional[str] = None) -> Client
    func GetClient(ctx *Context, name string, id IDInput, state *ClientState, opts ...ResourceOption) (*Client, error)
    public static Client Get(string name, Input<string> id, ClientState? state, CustomResourceOptions? opts = null)
    public static Client get(String name, Output<String> id, ClientState 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:
    CloudKmsConfig ClientCloudKmsConfig
    Cloud KMS config for AuthModule to encrypt/decrypt credentials. Structure is documented below.
    CreateSampleIntegrations bool
    Indicates if sample integrations should be created along with provisioning.
    CreateSampleWorkflows bool

    (Optional, Deprecated) Indicates if sample workflow should be created along with provisioning.

    Warning: create_sample_workflows is deprecated and will be removed in a future major release. Use create_sample_integrations instead.

    Deprecated: create_sample_workflows is deprecated and will be removed in a future major release. Use create_sample_integrations instead.

    Location string
    Location in which client needs to be provisioned.


    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    ProvisionGmek bool

    (Optional, Deprecated) Indicates provision with GMEK or CMEK.

    Warning: provision_gmek is deprecated and will be removed in a future major release. Client would be provisioned as gmek if cloud_kms_config is not given.

    Deprecated: provision_gmek is deprecated and will be removed in a future major release. Client would be provisioned as gmek if cloud_kms_config is not given.

    RunAsServiceAccount string
    User input run-as service account, if empty, will bring up a new default service account.
    CloudKmsConfig ClientCloudKmsConfigArgs
    Cloud KMS config for AuthModule to encrypt/decrypt credentials. Structure is documented below.
    CreateSampleIntegrations bool
    Indicates if sample integrations should be created along with provisioning.
    CreateSampleWorkflows bool

    (Optional, Deprecated) Indicates if sample workflow should be created along with provisioning.

    Warning: create_sample_workflows is deprecated and will be removed in a future major release. Use create_sample_integrations instead.

    Deprecated: create_sample_workflows is deprecated and will be removed in a future major release. Use create_sample_integrations instead.

    Location string
    Location in which client needs to be provisioned.


    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    ProvisionGmek bool

    (Optional, Deprecated) Indicates provision with GMEK or CMEK.

    Warning: provision_gmek is deprecated and will be removed in a future major release. Client would be provisioned as gmek if cloud_kms_config is not given.

    Deprecated: provision_gmek is deprecated and will be removed in a future major release. Client would be provisioned as gmek if cloud_kms_config is not given.

    RunAsServiceAccount string
    User input run-as service account, if empty, will bring up a new default service account.
    cloudKmsConfig ClientCloudKmsConfig
    Cloud KMS config for AuthModule to encrypt/decrypt credentials. Structure is documented below.
    createSampleIntegrations Boolean
    Indicates if sample integrations should be created along with provisioning.
    createSampleWorkflows Boolean

    (Optional, Deprecated) Indicates if sample workflow should be created along with provisioning.

    Warning: create_sample_workflows is deprecated and will be removed in a future major release. Use create_sample_integrations instead.

    Deprecated: create_sample_workflows is deprecated and will be removed in a future major release. Use create_sample_integrations instead.

    location String
    Location in which client needs to be provisioned.


    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    provisionGmek Boolean

    (Optional, Deprecated) Indicates provision with GMEK or CMEK.

    Warning: provision_gmek is deprecated and will be removed in a future major release. Client would be provisioned as gmek if cloud_kms_config is not given.

    Deprecated: provision_gmek is deprecated and will be removed in a future major release. Client would be provisioned as gmek if cloud_kms_config is not given.

    runAsServiceAccount String
    User input run-as service account, if empty, will bring up a new default service account.
    cloudKmsConfig ClientCloudKmsConfig
    Cloud KMS config for AuthModule to encrypt/decrypt credentials. Structure is documented below.
    createSampleIntegrations boolean
    Indicates if sample integrations should be created along with provisioning.
    createSampleWorkflows boolean

    (Optional, Deprecated) Indicates if sample workflow should be created along with provisioning.

    Warning: create_sample_workflows is deprecated and will be removed in a future major release. Use create_sample_integrations instead.

    Deprecated: create_sample_workflows is deprecated and will be removed in a future major release. Use create_sample_integrations instead.

    location string
    Location in which client needs to be provisioned.


    project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    provisionGmek boolean

    (Optional, Deprecated) Indicates provision with GMEK or CMEK.

    Warning: provision_gmek is deprecated and will be removed in a future major release. Client would be provisioned as gmek if cloud_kms_config is not given.

    Deprecated: provision_gmek is deprecated and will be removed in a future major release. Client would be provisioned as gmek if cloud_kms_config is not given.

    runAsServiceAccount string
    User input run-as service account, if empty, will bring up a new default service account.
    cloud_kms_config ClientCloudKmsConfigArgs
    Cloud KMS config for AuthModule to encrypt/decrypt credentials. Structure is documented below.
    create_sample_integrations bool
    Indicates if sample integrations should be created along with provisioning.
    create_sample_workflows bool

    (Optional, Deprecated) Indicates if sample workflow should be created along with provisioning.

    Warning: create_sample_workflows is deprecated and will be removed in a future major release. Use create_sample_integrations instead.

    Deprecated: create_sample_workflows is deprecated and will be removed in a future major release. Use create_sample_integrations instead.

    location str
    Location in which client needs to be provisioned.


    project str
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    provision_gmek bool

    (Optional, Deprecated) Indicates provision with GMEK or CMEK.

    Warning: provision_gmek is deprecated and will be removed in a future major release. Client would be provisioned as gmek if cloud_kms_config is not given.

    Deprecated: provision_gmek is deprecated and will be removed in a future major release. Client would be provisioned as gmek if cloud_kms_config is not given.

    run_as_service_account str
    User input run-as service account, if empty, will bring up a new default service account.
    cloudKmsConfig Property Map
    Cloud KMS config for AuthModule to encrypt/decrypt credentials. Structure is documented below.
    createSampleIntegrations Boolean
    Indicates if sample integrations should be created along with provisioning.
    createSampleWorkflows Boolean

    (Optional, Deprecated) Indicates if sample workflow should be created along with provisioning.

    Warning: create_sample_workflows is deprecated and will be removed in a future major release. Use create_sample_integrations instead.

    Deprecated: create_sample_workflows is deprecated and will be removed in a future major release. Use create_sample_integrations instead.

    location String
    Location in which client needs to be provisioned.


    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    provisionGmek Boolean

    (Optional, Deprecated) Indicates provision with GMEK or CMEK.

    Warning: provision_gmek is deprecated and will be removed in a future major release. Client would be provisioned as gmek if cloud_kms_config is not given.

    Deprecated: provision_gmek is deprecated and will be removed in a future major release. Client would be provisioned as gmek if cloud_kms_config is not given.

    runAsServiceAccount String
    User input run-as service account, if empty, will bring up a new default service account.

    Supporting Types

    ClientCloudKmsConfig, ClientCloudKmsConfigArgs

    Key string
    A Cloud KMS key is a named object containing one or more key versions, along with metadata for the key. A key exists on exactly one key ring tied to a specific location.
    KmsLocation string
    Location name of the key ring, e.g. "us-west1".
    KmsRing string
    A key ring organizes keys in a specific Google Cloud location and allows you to manage access control on groups of keys. A key ring's name does not need to be unique across a Google Cloud project, but must be unique within a given location.
    KeyVersion string
    Each version of a key contains key material used for encryption or signing. A key's version is represented by an integer, starting at 1. To decrypt data or verify a signature, you must use the same key version that was used to encrypt or sign the data.
    KmsProjectId string
    The Google Cloud project id of the project where the kms key stored. If empty, the kms key is stored at the same project as customer's project and ecrypted with CMEK, otherwise, the kms key is stored in the tenant project and encrypted with GMEK.
    Key string
    A Cloud KMS key is a named object containing one or more key versions, along with metadata for the key. A key exists on exactly one key ring tied to a specific location.
    KmsLocation string
    Location name of the key ring, e.g. "us-west1".
    KmsRing string
    A key ring organizes keys in a specific Google Cloud location and allows you to manage access control on groups of keys. A key ring's name does not need to be unique across a Google Cloud project, but must be unique within a given location.
    KeyVersion string
    Each version of a key contains key material used for encryption or signing. A key's version is represented by an integer, starting at 1. To decrypt data or verify a signature, you must use the same key version that was used to encrypt or sign the data.
    KmsProjectId string
    The Google Cloud project id of the project where the kms key stored. If empty, the kms key is stored at the same project as customer's project and ecrypted with CMEK, otherwise, the kms key is stored in the tenant project and encrypted with GMEK.
    key String
    A Cloud KMS key is a named object containing one or more key versions, along with metadata for the key. A key exists on exactly one key ring tied to a specific location.
    kmsLocation String
    Location name of the key ring, e.g. "us-west1".
    kmsRing String
    A key ring organizes keys in a specific Google Cloud location and allows you to manage access control on groups of keys. A key ring's name does not need to be unique across a Google Cloud project, but must be unique within a given location.
    keyVersion String
    Each version of a key contains key material used for encryption or signing. A key's version is represented by an integer, starting at 1. To decrypt data or verify a signature, you must use the same key version that was used to encrypt or sign the data.
    kmsProjectId String
    The Google Cloud project id of the project where the kms key stored. If empty, the kms key is stored at the same project as customer's project and ecrypted with CMEK, otherwise, the kms key is stored in the tenant project and encrypted with GMEK.
    key string
    A Cloud KMS key is a named object containing one or more key versions, along with metadata for the key. A key exists on exactly one key ring tied to a specific location.
    kmsLocation string
    Location name of the key ring, e.g. "us-west1".
    kmsRing string
    A key ring organizes keys in a specific Google Cloud location and allows you to manage access control on groups of keys. A key ring's name does not need to be unique across a Google Cloud project, but must be unique within a given location.
    keyVersion string
    Each version of a key contains key material used for encryption or signing. A key's version is represented by an integer, starting at 1. To decrypt data or verify a signature, you must use the same key version that was used to encrypt or sign the data.
    kmsProjectId string
    The Google Cloud project id of the project where the kms key stored. If empty, the kms key is stored at the same project as customer's project and ecrypted with CMEK, otherwise, the kms key is stored in the tenant project and encrypted with GMEK.
    key str
    A Cloud KMS key is a named object containing one or more key versions, along with metadata for the key. A key exists on exactly one key ring tied to a specific location.
    kms_location str
    Location name of the key ring, e.g. "us-west1".
    kms_ring str
    A key ring organizes keys in a specific Google Cloud location and allows you to manage access control on groups of keys. A key ring's name does not need to be unique across a Google Cloud project, but must be unique within a given location.
    key_version str
    Each version of a key contains key material used for encryption or signing. A key's version is represented by an integer, starting at 1. To decrypt data or verify a signature, you must use the same key version that was used to encrypt or sign the data.
    kms_project_id str
    The Google Cloud project id of the project where the kms key stored. If empty, the kms key is stored at the same project as customer's project and ecrypted with CMEK, otherwise, the kms key is stored in the tenant project and encrypted with GMEK.
    key String
    A Cloud KMS key is a named object containing one or more key versions, along with metadata for the key. A key exists on exactly one key ring tied to a specific location.
    kmsLocation String
    Location name of the key ring, e.g. "us-west1".
    kmsRing String
    A key ring organizes keys in a specific Google Cloud location and allows you to manage access control on groups of keys. A key ring's name does not need to be unique across a Google Cloud project, but must be unique within a given location.
    keyVersion String
    Each version of a key contains key material used for encryption or signing. A key's version is represented by an integer, starting at 1. To decrypt data or verify a signature, you must use the same key version that was used to encrypt or sign the data.
    kmsProjectId String
    The Google Cloud project id of the project where the kms key stored. If empty, the kms key is stored at the same project as customer's project and ecrypted with CMEK, otherwise, the kms key is stored in the tenant project and encrypted with GMEK.

    Import

    Client can be imported using any of these accepted formats:

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

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

    • {{location}}

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

    $ pulumi import gcp:applicationintegration/client:Client default projects/{{project}}/locations/{{location}}/clients
    
    $ pulumi import gcp:applicationintegration/client:Client default {{project}}/{{location}}
    
    $ pulumi import gcp:applicationintegration/client:Client 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