1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. applicationintegration
  5. Client
Google Cloud v8.26.0 published on Thursday, Apr 10, 2025 by Pulumi

gcp.applicationintegration.Client

Explore with Pulumi AI

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"});
Copy
import pulumi
import pulumi_gcp as gcp

example = gcp.applicationintegration.Client("example", location="us-central1")
Copy
package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v8/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
	})
}
Copy
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",
    });

});
Copy
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());

    }
}
Copy
resources:
  example:
    type: gcp:applicationintegration:Client
    properties:
      location: us-central1
Copy

Integrations Client Full

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
import * as std from "@pulumi/std";

const _default = gcp.organizations.getProject({});
const keyring = gcp.kms.getKMSKeyRing({
    name: "my-keyring",
    location: "us-east1",
});
const cryptokey = keyring.then(keyring => gcp.kms.getKMSCryptoKey({
    name: "my-crypto-key",
    keyRing: keyring.id,
}));
const testKey = cryptokey.then(cryptokey => gcp.kms.getKMSCryptoKeyVersion({
    cryptoKey: cryptokey.id,
}));
const serviceAccount = new gcp.serviceaccount.Account("service_account", {
    accountId: "service-acc",
    displayName: "Service Account",
});
const example = new gcp.applicationintegration.Client("example", {
    location: "us-east1",
    createSampleIntegrations: true,
    runAsServiceAccount: serviceAccount.email,
    cloudKmsConfig: {
        kmsLocation: "us-east1",
        kmsRing: keyring.then(keyring => std.basename({
            input: keyring.id,
        })).then(invoke => invoke.result),
        key: cryptokey.then(cryptokey => std.basename({
            input: cryptokey.id,
        })).then(invoke => invoke.result),
        keyVersion: testKey.then(testKey => std.basename({
            input: testKey.id,
        })).then(invoke => invoke.result),
        kmsProjectId: _default.then(_default => _default.projectId),
    },
});
Copy
import pulumi
import pulumi_gcp as gcp
import pulumi_std as std

default = gcp.organizations.get_project()
keyring = gcp.kms.get_kms_key_ring(name="my-keyring",
    location="us-east1")
cryptokey = gcp.kms.get_kms_crypto_key(name="my-crypto-key",
    key_ring=keyring.id)
test_key = gcp.kms.get_kms_crypto_key_version(crypto_key=cryptokey.id)
service_account = gcp.serviceaccount.Account("service_account",
    account_id="service-acc",
    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={
        "kms_location": "us-east1",
        "kms_ring": std.basename(input=keyring.id).result,
        "key": std.basename(input=cryptokey.id).result,
        "key_version": std.basename(input=test_key.id).result,
        "kms_project_id": default.project_id,
    })
Copy
package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/applicationintegration"
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/kms"
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/organizations"
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/serviceaccount"
	"github.com/pulumi/pulumi-std/sdk/go/std"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_default, err := organizations.LookupProject(ctx, &organizations.LookupProjectArgs{}, nil)
		if err != nil {
			return err
		}
		keyring, err := kms.GetKMSKeyRing(ctx, &kms.GetKMSKeyRingArgs{
			Name:     "my-keyring",
			Location: "us-east1",
		}, nil)
		if err != nil {
			return err
		}
		cryptokey, err := kms.GetKMSCryptoKey(ctx, &kms.GetKMSCryptoKeyArgs{
			Name:    "my-crypto-key",
			KeyRing: keyring.Id,
		}, nil)
		if err != nil {
			return err
		}
		testKey, err := kms.GetKMSCryptoKeyVersion(ctx, &kms.GetKMSCryptoKeyVersionArgs{
			CryptoKey: cryptokey.Id,
		}, nil)
		if err != nil {
			return err
		}
		serviceAccount, err := serviceaccount.NewAccount(ctx, "service_account", &serviceaccount.AccountArgs{
			AccountId:   pulumi.String("service-acc"),
			DisplayName: pulumi.String("Service Account"),
		})
		if err != nil {
			return err
		}
		invokeBasename, err := std.Basename(ctx, &std.BasenameArgs{
			Input: keyring.Id,
		}, nil)
		if err != nil {
			return err
		}
		invokeBasename1, err := std.Basename(ctx, &std.BasenameArgs{
			Input: cryptokey.Id,
		}, nil)
		if err != nil {
			return err
		}
		invokeBasename2, err := std.Basename(ctx, &std.BasenameArgs{
			Input: testKey.Id,
		}, nil)
		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:      pulumi.String(invokeBasename.Result),
				Key:          pulumi.String(invokeBasename1.Result),
				KeyVersion:   pulumi.String(invokeBasename2.Result),
				KmsProjectId: pulumi.String(_default.ProjectId),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;
using Std = Pulumi.Std;

return await Deployment.RunAsync(() => 
{
    var @default = Gcp.Organizations.GetProject.Invoke();

    var keyring = Gcp.Kms.GetKMSKeyRing.Invoke(new()
    {
        Name = "my-keyring",
        Location = "us-east1",
    });

    var cryptokey = Gcp.Kms.GetKMSCryptoKey.Invoke(new()
    {
        Name = "my-crypto-key",
        KeyRing = keyring.Apply(getKMSKeyRingResult => getKMSKeyRingResult.Id),
    });

    var testKey = Gcp.Kms.GetKMSCryptoKeyVersion.Invoke(new()
    {
        CryptoKey = cryptokey.Apply(getKMSCryptoKeyResult => getKMSCryptoKeyResult.Id),
    });

    var serviceAccount = new Gcp.ServiceAccount.Account("service_account", new()
    {
        AccountId = "service-acc",
        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 = Std.Basename.Invoke(new()
            {
                Input = keyring.Apply(getKMSKeyRingResult => getKMSKeyRingResult.Id),
            }).Apply(invoke => invoke.Result),
            Key = Std.Basename.Invoke(new()
            {
                Input = cryptokey.Apply(getKMSCryptoKeyResult => getKMSCryptoKeyResult.Id),
            }).Apply(invoke => invoke.Result),
            KeyVersion = Std.Basename.Invoke(new()
            {
                Input = testKey.Apply(getKMSCryptoKeyVersionResult => getKMSCryptoKeyVersionResult.Id),
            }).Apply(invoke => invoke.Result),
            KmsProjectId = @default.Apply(@default => @default.Apply(getProjectResult => getProjectResult.ProjectId)),
        },
    });

});
Copy
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.inputs.GetKMSCryptoKeyVersionArgs;
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 com.pulumi.std.StdFunctions;
import com.pulumi.std.inputs.BasenameArgs;
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 default = OrganizationsFunctions.getProject(GetProjectArgs.builder()
            .build());

        final var keyring = KmsFunctions.getKMSKeyRing(GetKMSKeyRingArgs.builder()
            .name("my-keyring")
            .location("us-east1")
            .build());

        final var cryptokey = KmsFunctions.getKMSCryptoKey(GetKMSCryptoKeyArgs.builder()
            .name("my-crypto-key")
            .keyRing(keyring.id())
            .build());

        final var testKey = KmsFunctions.getKMSCryptoKeyVersion(GetKMSCryptoKeyVersionArgs.builder()
            .cryptoKey(cryptokey.id())
            .build());

        var serviceAccount = new Account("serviceAccount", AccountArgs.builder()
            .accountId("service-acc")
            .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(StdFunctions.basename(BasenameArgs.builder()
                    .input(keyring.id())
                    .build()).result())
                .key(StdFunctions.basename(BasenameArgs.builder()
                    .input(cryptokey.id())
                    .build()).result())
                .keyVersion(StdFunctions.basename(BasenameArgs.builder()
                    .input(testKey.id())
                    .build()).result())
                .kmsProjectId(default_.projectId())
                .build())
            .build());

    }
}
Copy
resources:
  serviceAccount:
    type: gcp:serviceaccount:Account
    name: service_account
    properties:
      accountId: service-acc
      displayName: Service Account
  example:
    type: gcp:applicationintegration:Client
    properties:
      location: us-east1
      createSampleIntegrations: true
      runAsServiceAccount: ${serviceAccount.email}
      cloudKmsConfig:
        kmsLocation: us-east1
        kmsRing:
          fn::invoke:
            function: std:basename
            arguments:
              input: ${keyring.id}
            return: result
        key:
          fn::invoke:
            function: std:basename
            arguments:
              input: ${cryptokey.id}
            return: result
        keyVersion:
          fn::invoke:
            function: std:basename
            arguments:
              input: ${testKey.id}
            return: result
        kmsProjectId: ${default.projectId}
variables:
  default:
    fn::invoke:
      function: gcp:organizations:getProject
      arguments: {}
  keyring:
    fn::invoke:
      function: gcp:kms:getKMSKeyRing
      arguments:
        name: my-keyring
        location: us-east1
  cryptokey:
    fn::invoke:
      function: gcp:kms:getKMSCryptoKey
      arguments:
        name: my-crypto-key
        keyRing: ${keyring.id}
  testKey:
    fn::invoke:
      function: gcp:kms:getKMSCryptoKeyVersion
      arguments:
        cryptoKey: ${cryptokey.id}
Copy

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,
           project: Optional[str] = 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 This property is required. string
The unique name of the resource.
args This property is required. ClientArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. 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 This property is required. string
The unique name of the resource.
args This property is required. ClientArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. ClientArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. ClientArgs
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 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",
});
Copy
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"),
})
Copy
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());
Copy
client_resource = gcp.applicationintegration.Client("clientResource",
    location="string",
    cloud_kms_config={
        "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")
Copy
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",
});
Copy
type: gcp:applicationintegration:Client
properties:
    cloudKmsConfig:
        key: string
        keyVersion: string
        kmsLocation: string
        kmsProjectId: string
        kmsRing: string
    createSampleIntegrations: false
    location: string
    project: string
    runAsServiceAccount: string
Copy

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

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Client resource accepts the following input properties:

Location
This property is required.
Changes to this property will trigger replacement.
string
Location in which client needs to be provisioned.


CloudKmsConfig Changes to this property will trigger replacement. ClientCloudKmsConfig
Cloud KMS config for AuthModule to encrypt/decrypt credentials. Structure is documented below.
CreateSampleIntegrations Changes to this property will trigger replacement. bool
Indicates if sample integrations should be created along with provisioning.
Project Changes to this property will trigger replacement. string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
RunAsServiceAccount Changes to this property will trigger replacement. string
User input run-as service account, if empty, will bring up a new default service account.
Location
This property is required.
Changes to this property will trigger replacement.
string
Location in which client needs to be provisioned.


CloudKmsConfig Changes to this property will trigger replacement. ClientCloudKmsConfigArgs
Cloud KMS config for AuthModule to encrypt/decrypt credentials. Structure is documented below.
CreateSampleIntegrations Changes to this property will trigger replacement. bool
Indicates if sample integrations should be created along with provisioning.
Project Changes to this property will trigger replacement. string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
RunAsServiceAccount Changes to this property will trigger replacement. string
User input run-as service account, if empty, will bring up a new default service account.
location
This property is required.
Changes to this property will trigger replacement.
String
Location in which client needs to be provisioned.


cloudKmsConfig Changes to this property will trigger replacement. ClientCloudKmsConfig
Cloud KMS config for AuthModule to encrypt/decrypt credentials. Structure is documented below.
createSampleIntegrations Changes to this property will trigger replacement. Boolean
Indicates if sample integrations should be created along with provisioning.
project Changes to this property will trigger replacement. String
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
runAsServiceAccount Changes to this property will trigger replacement. String
User input run-as service account, if empty, will bring up a new default service account.
location
This property is required.
Changes to this property will trigger replacement.
string
Location in which client needs to be provisioned.


cloudKmsConfig Changes to this property will trigger replacement. ClientCloudKmsConfig
Cloud KMS config for AuthModule to encrypt/decrypt credentials. Structure is documented below.
createSampleIntegrations Changes to this property will trigger replacement. boolean
Indicates if sample integrations should be created along with provisioning.
project Changes to this property will trigger replacement. string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
runAsServiceAccount Changes to this property will trigger replacement. string
User input run-as service account, if empty, will bring up a new default service account.
location
This property is required.
Changes to this property will trigger replacement.
str
Location in which client needs to be provisioned.


cloud_kms_config Changes to this property will trigger replacement. ClientCloudKmsConfigArgs
Cloud KMS config for AuthModule to encrypt/decrypt credentials. Structure is documented below.
create_sample_integrations Changes to this property will trigger replacement. bool
Indicates if sample integrations should be created along with provisioning.
project Changes to this property will trigger replacement. str
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
run_as_service_account Changes to this property will trigger replacement. str
User input run-as service account, if empty, will bring up a new default service account.
location
This property is required.
Changes to this property will trigger replacement.
String
Location in which client needs to be provisioned.


cloudKmsConfig Changes to this property will trigger replacement. Property Map
Cloud KMS config for AuthModule to encrypt/decrypt credentials. Structure is documented below.
createSampleIntegrations Changes to this property will trigger replacement. Boolean
Indicates if sample integrations should be created along with provisioning.
project Changes to this property will trigger replacement. String
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
runAsServiceAccount Changes to this property will trigger replacement. 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,
        location: Optional[str] = None,
        project: Optional[str] = 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)
resources:  _:    type: gcp:applicationintegration:Client    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 Changes to this property will trigger replacement. ClientCloudKmsConfig
Cloud KMS config for AuthModule to encrypt/decrypt credentials. Structure is documented below.
CreateSampleIntegrations Changes to this property will trigger replacement. bool
Indicates if sample integrations should be created along with provisioning.
Location Changes to this property will trigger replacement. string
Location in which client needs to be provisioned.


Project Changes to this property will trigger replacement. string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
RunAsServiceAccount Changes to this property will trigger replacement. string
User input run-as service account, if empty, will bring up a new default service account.
CloudKmsConfig Changes to this property will trigger replacement. ClientCloudKmsConfigArgs
Cloud KMS config for AuthModule to encrypt/decrypt credentials. Structure is documented below.
CreateSampleIntegrations Changes to this property will trigger replacement. bool
Indicates if sample integrations should be created along with provisioning.
Location Changes to this property will trigger replacement. string
Location in which client needs to be provisioned.


Project Changes to this property will trigger replacement. string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
RunAsServiceAccount Changes to this property will trigger replacement. string
User input run-as service account, if empty, will bring up a new default service account.
cloudKmsConfig Changes to this property will trigger replacement. ClientCloudKmsConfig
Cloud KMS config for AuthModule to encrypt/decrypt credentials. Structure is documented below.
createSampleIntegrations Changes to this property will trigger replacement. Boolean
Indicates if sample integrations should be created along with provisioning.
location Changes to this property will trigger replacement. String
Location in which client needs to be provisioned.


project Changes to this property will trigger replacement. String
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
runAsServiceAccount Changes to this property will trigger replacement. String
User input run-as service account, if empty, will bring up a new default service account.
cloudKmsConfig Changes to this property will trigger replacement. ClientCloudKmsConfig
Cloud KMS config for AuthModule to encrypt/decrypt credentials. Structure is documented below.
createSampleIntegrations Changes to this property will trigger replacement. boolean
Indicates if sample integrations should be created along with provisioning.
location Changes to this property will trigger replacement. string
Location in which client needs to be provisioned.


project Changes to this property will trigger replacement. string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
runAsServiceAccount Changes to this property will trigger replacement. string
User input run-as service account, if empty, will bring up a new default service account.
cloud_kms_config Changes to this property will trigger replacement. ClientCloudKmsConfigArgs
Cloud KMS config for AuthModule to encrypt/decrypt credentials. Structure is documented below.
create_sample_integrations Changes to this property will trigger replacement. bool
Indicates if sample integrations should be created along with provisioning.
location Changes to this property will trigger replacement. str
Location in which client needs to be provisioned.


project Changes to this property will trigger replacement. str
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
run_as_service_account Changes to this property will trigger replacement. str
User input run-as service account, if empty, will bring up a new default service account.
cloudKmsConfig Changes to this property will trigger replacement. Property Map
Cloud KMS config for AuthModule to encrypt/decrypt credentials. Structure is documented below.
createSampleIntegrations Changes to this property will trigger replacement. Boolean
Indicates if sample integrations should be created along with provisioning.
location Changes to this property will trigger replacement. String
Location in which client needs to be provisioned.


project Changes to this property will trigger replacement. String
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
runAsServiceAccount Changes to this property will trigger replacement. String
User input run-as service account, if empty, will bring up a new default service account.

Supporting Types

ClientCloudKmsConfig
, ClientCloudKmsConfigArgs

Key
This property is required.
Changes to this property will trigger replacement.
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
This property is required.
Changes to this property will trigger replacement.
string
Location name of the key ring, e.g. "us-west1".
KmsRing
This property is required.
Changes to this property will trigger replacement.
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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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
This property is required.
Changes to this property will trigger replacement.
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
This property is required.
Changes to this property will trigger replacement.
string
Location name of the key ring, e.g. "us-west1".
KmsRing
This property is required.
Changes to this property will trigger replacement.
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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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
This property is required.
Changes to this property will trigger replacement.
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
This property is required.
Changes to this property will trigger replacement.
String
Location name of the key ring, e.g. "us-west1".
kmsRing
This property is required.
Changes to this property will trigger replacement.
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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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
This property is required.
Changes to this property will trigger replacement.
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
This property is required.
Changes to this property will trigger replacement.
string
Location name of the key ring, e.g. "us-west1".
kmsRing
This property is required.
Changes to this property will trigger replacement.
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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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
This property is required.
Changes to this property will trigger replacement.
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
This property is required.
Changes to this property will trigger replacement.
str
Location name of the key ring, e.g. "us-west1".
kms_ring
This property is required.
Changes to this property will trigger replacement.
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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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
This property is required.
Changes to this property will trigger replacement.
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
This property is required.
Changes to this property will trigger replacement.
String
Location name of the key ring, e.g. "us-west1".
kmsRing
This property is required.
Changes to this property will trigger replacement.
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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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
Copy
$ pulumi import gcp:applicationintegration/client:Client default {{project}}/{{location}}
Copy
$ pulumi import gcp:applicationintegration/client:Client default {{location}}
Copy

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.