Client class

Application Integration Client.

To get more information about Client, see:

• API documentation
• How-to Guides
• Official Documentation
• Set up Application Integration

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")

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 main

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

pulumi {
  required_providers {
    gcp = {
      source = "pulumi/gcp"
    }
  }
}

resource "gcp_applicationintegration_client" "example" {
  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.ArrayList;
import java.util.Arrays;
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";
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 example = new gcp.applicationintegration.Client("example", {
    location: "us-east1",
    createSampleIntegrations: true,
    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),
    },
});

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)
example = gcp.applicationintegration.Client("example",
    location="us-east1",
    create_sample_integrations=True,
    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,
    })

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 example = new Gcp.ApplicationIntegration.Client("example", new()
    {
        Location = "us-east1",
        CreateSampleIntegrations = true,
        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)),
        },
    });

});

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/applicationintegration"
	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/kms"
	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/organizations"
	"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
		}
		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),
			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
	})
}

pulumi {
  required_providers {
    gcp = {
      source = "pulumi/gcp"
    }
    std = {
      source = "pulumi/std"
    }
  }
}

data "gcp_organizations_getproject" "default" {
}
data "gcp_kms_getkmskeyring" "keyring" {
  name     = "my-keyring"
  location = "us-east1"
}
data "gcp_kms_getkmscryptokey" "cryptokey" {
  name     = "my-crypto-key"
  key_ring = data.gcp_kms_getkmskeyring.keyring.id
}
data "gcp_kms_getkmscryptokeyversion" "testKey" {
  crypto_key = data.gcp_kms_getkmscryptokey.cryptokey.id
}

resource "gcp_applicationintegration_client" "example" {
  location                   = "us-east1"
  create_sample_integrations = true
  cloud_kms_config = {
    kms_location   = "us-east1"
    kms_ring       = basename(data.gcp_kms_getkmskeyring.keyring.id)
    key            = basename(data.gcp_kms_getkmscryptokey.cryptokey.id)
    key_version    = basename(data.gcp_kms_getkmscryptokeyversion.testKey.id)
    kms_project_id = data.gcp_organizations_getproject.default.project_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.inputs.GetKMSCryptoKeyVersionArgs;
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.ArrayList;
import java.util.Arrays;
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 example = new Client("example", ClientArgs.builder()
            .location("us-east1")
            .createSampleIntegrations(true)
            .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());

    }
}

resources:
  example:
    type: gcp:applicationintegration:Client
    properties:
      location: us-east1
      createSampleIntegrations: true
      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}

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}}

Constructors

Client(String name, {ClientArgs? args, CustomResourceOptions? options})

Creates a new Client. name The Pulumi resource name. args Arguments used to configure this Client. The set of arguments for Client. options Resource options controlling this resource's behavior.

Client.reference(String urn)

Creates a typed reference to an existing Client resource.

Properties

childResources → Set<Resource>

final, inherited

cloudKmsConfig ↔ Output<ClientCloudKmsConfig?>

Cloud KMS config for AuthModule to encrypt/decrypt credentials. Structure is documented below.

late, final

completionSources ↔ Map<String, IOutputCompletionSource>

late, final, inherited

createSampleIntegrations ↔ Output<bool?>

Indicates if sample integrations should be created along with provisioning.

late, final

deletionPolicy ↔ Output<String>

Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.

late, final

hashCode → int

The hash code for this object.

no setter, inherited

id ↔ Output<String>

getter/setter pair, inherited

isCustom → bool

Returns whether this resource is provider-managed.

no setter, inherited

isProtected → bool

Returns whether this resource is protected from deletion.

no setter, inherited

isRemote → bool

Whether this resource is registered as remote.

no setter, inherited

isResourceReference → bool

Whether this instance represents a resource value returned over RPC.

final, inherited

location ↔ Output<String>

Location in which client needs to be provisioned.

late, final

project ↔ Output<String>

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

late, final

resourceTransforms → List<ResourceTransform>

Inherited/explicit async transforms.

no setter, inherited

runAsServiceAccount ↔ Output<String?>

(Optional, Deprecated) User input run-as service account, if empty, will bring up a new default service account.

late, final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

transformations → List<ResourceTransformation>

Inherited/explicit legacy transformations.

no setter, inherited

urn ↔ Output<String>

late, final, inherited

Methods

failId(Object error) → void

Completes this resource ID with an error when registration fails.

inherited

failOutputs(Object error) → void

Completes all output properties with error.

inherited

failUrn(Object error) → void

Completes this resource URN with an error when registration fails.

inherited

getProvider(String moduleMember) → ProviderResource?

Returns provider for moduleMember's package, if configured.

inherited

getResourceName() → String

Returns this resource's logical name.

inherited

getResourceType() → String

Returns this resource's Pulumi type token.

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>

Registers a dynamic output property for this resource.

inherited

resolveId(String? value, {required bool isKnown}) → void

Resolves the provider-assigned ID for this resource.

inherited

resolveOutputs(Struct outputs) → void

Resolves all output properties from a monitor response payload.

inherited

resolveUrn(String value) → void

Resolves this resource's URN once assigned by the engine.

inherited

serializeProperties(Map<String, dynamic> properties) → Future<Struct>

Serializes resource properties for RPC transmission.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Static Methods

get(String name, Input<String> id, {ClientState? state, CustomResourceOptions? options}) → Client

Gets an existing Client resource's state with the given name and id.