applicationintegration

package
v7.20.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 24, 2024 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Client

type Client struct {
	pulumi.CustomResourceState

	// Cloud KMS config for AuthModule to encrypt/decrypt credentials.
	// Structure is documented below.
	CloudKmsConfig ClientCloudKmsConfigPtrOutput `pulumi:"cloudKmsConfig"`
	// Indicates if sample workflow should be created along with provisioning.
	CreateSampleWorkflows pulumi.BoolPtrOutput `pulumi:"createSampleWorkflows"`
	// Location in which client needs to be provisioned.
	//
	// ***
	Location pulumi.StringOutput `pulumi:"location"`
	// The ID of the project in which the resource belongs.
	// If it is not provided, the provider project is used.
	Project pulumi.StringOutput `pulumi:"project"`
	// Indicates provision with GMEK or CMEK.
	ProvisionGmek pulumi.BoolPtrOutput `pulumi:"provisionGmek"`
	// User input run-as service account, if empty, will bring up a new default service account.
	RunAsServiceAccount pulumi.StringPtrOutput `pulumi:"runAsServiceAccount"`
}

Application Integration Client.

To get more information about Client, see:

* [API documentation](https://cloud.google.com/application-integration/docs/reference/rest/v1/projects.locations.clients) * How-to Guides

## Example Usage

### Integrations Client Basic

```go 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"),
			ProvisionGmek: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

``` ### Integrations Client Advance

```go 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"),
			CreateSampleWorkflows: 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
	})
}

```

## 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:

```sh $ pulumi import gcp:applicationintegration/client:Client default projects/{{project}}/locations/{{location}}/clients ```

```sh $ pulumi import gcp:applicationintegration/client:Client default {{project}}/{{location}} ```

```sh $ pulumi import gcp:applicationintegration/client:Client default {{location}} ```

func GetClient

func GetClient(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *ClientState, opts ...pulumi.ResourceOption) (*Client, error)

GetClient gets an existing Client resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewClient

func NewClient(ctx *pulumi.Context,
	name string, args *ClientArgs, opts ...pulumi.ResourceOption) (*Client, error)

NewClient registers a new resource with the given unique name, arguments, and options.

func (*Client) ElementType

func (*Client) ElementType() reflect.Type

func (*Client) ToClientOutput

func (i *Client) ToClientOutput() ClientOutput

func (*Client) ToClientOutputWithContext

func (i *Client) ToClientOutputWithContext(ctx context.Context) ClientOutput

type ClientArgs

type ClientArgs struct {
	// Cloud KMS config for AuthModule to encrypt/decrypt credentials.
	// Structure is documented below.
	CloudKmsConfig ClientCloudKmsConfigPtrInput
	// Indicates if sample workflow should be created along with provisioning.
	CreateSampleWorkflows pulumi.BoolPtrInput
	// Location in which client needs to be provisioned.
	//
	// ***
	Location pulumi.StringInput
	// The ID of the project in which the resource belongs.
	// If it is not provided, the provider project is used.
	Project pulumi.StringPtrInput
	// Indicates provision with GMEK or CMEK.
	ProvisionGmek pulumi.BoolPtrInput
	// User input run-as service account, if empty, will bring up a new default service account.
	RunAsServiceAccount pulumi.StringPtrInput
}

The set of arguments for constructing a Client resource.

func (ClientArgs) ElementType

func (ClientArgs) ElementType() reflect.Type

type ClientArray

type ClientArray []ClientInput

func (ClientArray) ElementType

func (ClientArray) ElementType() reflect.Type

func (ClientArray) ToClientArrayOutput

func (i ClientArray) ToClientArrayOutput() ClientArrayOutput

func (ClientArray) ToClientArrayOutputWithContext

func (i ClientArray) ToClientArrayOutputWithContext(ctx context.Context) ClientArrayOutput

type ClientArrayInput

type ClientArrayInput interface {
	pulumi.Input

	ToClientArrayOutput() ClientArrayOutput
	ToClientArrayOutputWithContext(context.Context) ClientArrayOutput
}

ClientArrayInput is an input type that accepts ClientArray and ClientArrayOutput values. You can construct a concrete instance of `ClientArrayInput` via:

ClientArray{ ClientArgs{...} }

type ClientArrayOutput

type ClientArrayOutput struct{ *pulumi.OutputState }

func (ClientArrayOutput) ElementType

func (ClientArrayOutput) ElementType() reflect.Type

func (ClientArrayOutput) Index

func (ClientArrayOutput) ToClientArrayOutput

func (o ClientArrayOutput) ToClientArrayOutput() ClientArrayOutput

func (ClientArrayOutput) ToClientArrayOutputWithContext

func (o ClientArrayOutput) ToClientArrayOutputWithContext(ctx context.Context) ClientArrayOutput

type ClientCloudKmsConfig

type ClientCloudKmsConfig struct {
	// 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.
	Key string `pulumi:"key"`
	// 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.
	KeyVersion *string `pulumi:"keyVersion"`
	// Location name of the key ring, e.g. "us-west1".
	KmsLocation string `pulumi:"kmsLocation"`
	// 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.
	KmsProjectId *string `pulumi:"kmsProjectId"`
	// 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.
	KmsRing string `pulumi:"kmsRing"`
}

type ClientCloudKmsConfigArgs

type ClientCloudKmsConfigArgs struct {
	// 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.
	Key pulumi.StringInput `pulumi:"key"`
	// 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.
	KeyVersion pulumi.StringPtrInput `pulumi:"keyVersion"`
	// Location name of the key ring, e.g. "us-west1".
	KmsLocation pulumi.StringInput `pulumi:"kmsLocation"`
	// 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.
	KmsProjectId pulumi.StringPtrInput `pulumi:"kmsProjectId"`
	// 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.
	KmsRing pulumi.StringInput `pulumi:"kmsRing"`
}

func (ClientCloudKmsConfigArgs) ElementType

func (ClientCloudKmsConfigArgs) ElementType() reflect.Type

func (ClientCloudKmsConfigArgs) ToClientCloudKmsConfigOutput

func (i ClientCloudKmsConfigArgs) ToClientCloudKmsConfigOutput() ClientCloudKmsConfigOutput

func (ClientCloudKmsConfigArgs) ToClientCloudKmsConfigOutputWithContext

func (i ClientCloudKmsConfigArgs) ToClientCloudKmsConfigOutputWithContext(ctx context.Context) ClientCloudKmsConfigOutput

func (ClientCloudKmsConfigArgs) ToClientCloudKmsConfigPtrOutput

func (i ClientCloudKmsConfigArgs) ToClientCloudKmsConfigPtrOutput() ClientCloudKmsConfigPtrOutput

func (ClientCloudKmsConfigArgs) ToClientCloudKmsConfigPtrOutputWithContext

func (i ClientCloudKmsConfigArgs) ToClientCloudKmsConfigPtrOutputWithContext(ctx context.Context) ClientCloudKmsConfigPtrOutput

type ClientCloudKmsConfigInput

type ClientCloudKmsConfigInput interface {
	pulumi.Input

	ToClientCloudKmsConfigOutput() ClientCloudKmsConfigOutput
	ToClientCloudKmsConfigOutputWithContext(context.Context) ClientCloudKmsConfigOutput
}

ClientCloudKmsConfigInput is an input type that accepts ClientCloudKmsConfigArgs and ClientCloudKmsConfigOutput values. You can construct a concrete instance of `ClientCloudKmsConfigInput` via:

ClientCloudKmsConfigArgs{...}

type ClientCloudKmsConfigOutput

type ClientCloudKmsConfigOutput struct{ *pulumi.OutputState }

func (ClientCloudKmsConfigOutput) ElementType

func (ClientCloudKmsConfigOutput) ElementType() reflect.Type

func (ClientCloudKmsConfigOutput) Key

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.

func (ClientCloudKmsConfigOutput) KeyVersion

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.

func (ClientCloudKmsConfigOutput) KmsLocation

Location name of the key ring, e.g. "us-west1".

func (ClientCloudKmsConfigOutput) KmsProjectId

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.

func (ClientCloudKmsConfigOutput) KmsRing

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.

func (ClientCloudKmsConfigOutput) ToClientCloudKmsConfigOutput

func (o ClientCloudKmsConfigOutput) ToClientCloudKmsConfigOutput() ClientCloudKmsConfigOutput

func (ClientCloudKmsConfigOutput) ToClientCloudKmsConfigOutputWithContext

func (o ClientCloudKmsConfigOutput) ToClientCloudKmsConfigOutputWithContext(ctx context.Context) ClientCloudKmsConfigOutput

func (ClientCloudKmsConfigOutput) ToClientCloudKmsConfigPtrOutput

func (o ClientCloudKmsConfigOutput) ToClientCloudKmsConfigPtrOutput() ClientCloudKmsConfigPtrOutput

func (ClientCloudKmsConfigOutput) ToClientCloudKmsConfigPtrOutputWithContext

func (o ClientCloudKmsConfigOutput) ToClientCloudKmsConfigPtrOutputWithContext(ctx context.Context) ClientCloudKmsConfigPtrOutput

type ClientCloudKmsConfigPtrInput

type ClientCloudKmsConfigPtrInput interface {
	pulumi.Input

	ToClientCloudKmsConfigPtrOutput() ClientCloudKmsConfigPtrOutput
	ToClientCloudKmsConfigPtrOutputWithContext(context.Context) ClientCloudKmsConfigPtrOutput
}

ClientCloudKmsConfigPtrInput is an input type that accepts ClientCloudKmsConfigArgs, ClientCloudKmsConfigPtr and ClientCloudKmsConfigPtrOutput values. You can construct a concrete instance of `ClientCloudKmsConfigPtrInput` via:

        ClientCloudKmsConfigArgs{...}

or:

        nil

type ClientCloudKmsConfigPtrOutput

type ClientCloudKmsConfigPtrOutput struct{ *pulumi.OutputState }

func (ClientCloudKmsConfigPtrOutput) Elem

func (ClientCloudKmsConfigPtrOutput) ElementType

func (ClientCloudKmsConfigPtrOutput) Key

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.

func (ClientCloudKmsConfigPtrOutput) KeyVersion

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.

func (ClientCloudKmsConfigPtrOutput) KmsLocation

Location name of the key ring, e.g. "us-west1".

func (ClientCloudKmsConfigPtrOutput) KmsProjectId

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.

func (ClientCloudKmsConfigPtrOutput) KmsRing

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.

func (ClientCloudKmsConfigPtrOutput) ToClientCloudKmsConfigPtrOutput

func (o ClientCloudKmsConfigPtrOutput) ToClientCloudKmsConfigPtrOutput() ClientCloudKmsConfigPtrOutput

func (ClientCloudKmsConfigPtrOutput) ToClientCloudKmsConfigPtrOutputWithContext

func (o ClientCloudKmsConfigPtrOutput) ToClientCloudKmsConfigPtrOutputWithContext(ctx context.Context) ClientCloudKmsConfigPtrOutput

type ClientInput

type ClientInput interface {
	pulumi.Input

	ToClientOutput() ClientOutput
	ToClientOutputWithContext(ctx context.Context) ClientOutput
}

type ClientMap

type ClientMap map[string]ClientInput

func (ClientMap) ElementType

func (ClientMap) ElementType() reflect.Type

func (ClientMap) ToClientMapOutput

func (i ClientMap) ToClientMapOutput() ClientMapOutput

func (ClientMap) ToClientMapOutputWithContext

func (i ClientMap) ToClientMapOutputWithContext(ctx context.Context) ClientMapOutput

type ClientMapInput

type ClientMapInput interface {
	pulumi.Input

	ToClientMapOutput() ClientMapOutput
	ToClientMapOutputWithContext(context.Context) ClientMapOutput
}

ClientMapInput is an input type that accepts ClientMap and ClientMapOutput values. You can construct a concrete instance of `ClientMapInput` via:

ClientMap{ "key": ClientArgs{...} }

type ClientMapOutput

type ClientMapOutput struct{ *pulumi.OutputState }

func (ClientMapOutput) ElementType

func (ClientMapOutput) ElementType() reflect.Type

func (ClientMapOutput) MapIndex

func (ClientMapOutput) ToClientMapOutput

func (o ClientMapOutput) ToClientMapOutput() ClientMapOutput

func (ClientMapOutput) ToClientMapOutputWithContext

func (o ClientMapOutput) ToClientMapOutputWithContext(ctx context.Context) ClientMapOutput

type ClientOutput

type ClientOutput struct{ *pulumi.OutputState }

func (ClientOutput) CloudKmsConfig

func (o ClientOutput) CloudKmsConfig() ClientCloudKmsConfigPtrOutput

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

func (ClientOutput) CreateSampleWorkflows

func (o ClientOutput) CreateSampleWorkflows() pulumi.BoolPtrOutput

Indicates if sample workflow should be created along with provisioning.

func (ClientOutput) ElementType

func (ClientOutput) ElementType() reflect.Type

func (ClientOutput) Location

func (o ClientOutput) Location() pulumi.StringOutput

Location in which client needs to be provisioned.

***

func (ClientOutput) Project

func (o ClientOutput) Project() pulumi.StringOutput

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

func (ClientOutput) ProvisionGmek

func (o ClientOutput) ProvisionGmek() pulumi.BoolPtrOutput

Indicates provision with GMEK or CMEK.

func (ClientOutput) RunAsServiceAccount

func (o ClientOutput) RunAsServiceAccount() pulumi.StringPtrOutput

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

func (ClientOutput) ToClientOutput

func (o ClientOutput) ToClientOutput() ClientOutput

func (ClientOutput) ToClientOutputWithContext

func (o ClientOutput) ToClientOutputWithContext(ctx context.Context) ClientOutput

type ClientState

type ClientState struct {
	// Cloud KMS config for AuthModule to encrypt/decrypt credentials.
	// Structure is documented below.
	CloudKmsConfig ClientCloudKmsConfigPtrInput
	// Indicates if sample workflow should be created along with provisioning.
	CreateSampleWorkflows pulumi.BoolPtrInput
	// Location in which client needs to be provisioned.
	//
	// ***
	Location pulumi.StringPtrInput
	// The ID of the project in which the resource belongs.
	// If it is not provided, the provider project is used.
	Project pulumi.StringPtrInput
	// Indicates provision with GMEK or CMEK.
	ProvisionGmek pulumi.BoolPtrInput
	// User input run-as service account, if empty, will bring up a new default service account.
	RunAsServiceAccount pulumi.StringPtrInput
}

func (ClientState) ElementType

func (ClientState) ElementType() reflect.Type

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL