AuthConfig class

The AuthConfig resource use to hold channels and connection config data.

To get more information about AuthConfig, see:

• API documentation
• How-to Guides
• Manage authentication profiles
• Official Documentation

Example Usage

Integrations Auth Config Basic

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

const client = new gcp.applicationintegration.Client("client", {location: "us-west1"});
const basicExample = new gcp.applicationintegration.AuthConfig("basic_example", {
    location: "us-west1",
    displayName: "test-authconfig",
    description: "Test auth config created via terraform",
    decryptedCredential: {
        credentialType: "USERNAME_AND_PASSWORD",
        usernameAndPassword: {
            username: "test-username",
            password: "test-password",
        },
    },
}, {
    dependsOn: [client],
});

import pulumi
import pulumi_gcp as gcp

client = gcp.applicationintegration.Client("client", location="us-west1")
basic_example = gcp.applicationintegration.AuthConfig("basic_example",
    location="us-west1",
    display_name="test-authconfig",
    description="Test auth config created via terraform",
    decrypted_credential={
        "credential_type": "USERNAME_AND_PASSWORD",
        "username_and_password": {
            "username": "test-username",
            "password": "test-password",
        },
    },
    opts = pulumi.ResourceOptions(depends_on=[client]))

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() =>
{
    var client = new Gcp.ApplicationIntegration.Client("client", new()
    {
        Location = "us-west1",
    });

    var basicExample = new Gcp.ApplicationIntegration.AuthConfig("basic_example", new()
    {
        Location = "us-west1",
        DisplayName = "test-authconfig",
        Description = "Test auth config created via terraform",
        DecryptedCredential = new Gcp.ApplicationIntegration.Inputs.AuthConfigDecryptedCredentialArgs
        {
            CredentialType = "USERNAME_AND_PASSWORD",
            UsernameAndPassword = new Gcp.ApplicationIntegration.Inputs.AuthConfigDecryptedCredentialUsernameAndPasswordArgs
            {
                Username = "test-username",
                Password = "test-password",
            },
        },
    }, new CustomResourceOptions
    {
        DependsOn =
        {
            client,
        },
    });

});

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 {
		client, err := applicationintegration.NewClient(ctx, "client", &applicationintegration.ClientArgs{
			Location: pulumi.String("us-west1"),
		})
		if err != nil {
			return err
		}
		_, err = applicationintegration.NewAuthConfig(ctx, "basic_example", &applicationintegration.AuthConfigArgs{
			Location:    pulumi.String("us-west1"),
			DisplayName: pulumi.String("test-authconfig"),
			Description: pulumi.String("Test auth config created via terraform"),
			DecryptedCredential: &applicationintegration.AuthConfigDecryptedCredentialArgs{
				CredentialType: pulumi.String("USERNAME_AND_PASSWORD"),
				UsernameAndPassword: &applicationintegration.AuthConfigDecryptedCredentialUsernameAndPasswordArgs{
					Username: pulumi.String("test-username"),
					Password: pulumi.String("test-password"),
				},
			},
		}, pulumi.DependsOn([]pulumi.Resource{
			client,
		}))
		if err != nil {
			return err
		}
		return nil
	})
}

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

resource "gcp_applicationintegration_client" "client" {
  location = "us-west1"
}
resource "gcp_applicationintegration_authconfig" "basic_example" {
  depends_on   = [gcp_applicationintegration_client.client]
  location     = "us-west1"
  display_name = "test-authconfig"
  description  = "Test auth config created via terraform"
  decrypted_credential = {
    credential_type = "USERNAME_AND_PASSWORD"
    username_and_password = {
      username = "test-username"
      password = "test-password"
    }
  }
}

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 com.pulumi.gcp.applicationintegration.AuthConfig;
import com.pulumi.gcp.applicationintegration.AuthConfigArgs;
import com.pulumi.gcp.applicationintegration.inputs.AuthConfigDecryptedCredentialArgs;
import com.pulumi.gcp.applicationintegration.inputs.AuthConfigDecryptedCredentialUsernameAndPasswordArgs;
import com.pulumi.resources.CustomResourceOptions;
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 client = new Client("client", ClientArgs.builder()
            .location("us-west1")
            .build());

        var basicExample = new AuthConfig("basicExample", AuthConfigArgs.builder()
            .location("us-west1")
            .displayName("test-authconfig")
            .description("Test auth config created via terraform")
            .decryptedCredential(AuthConfigDecryptedCredentialArgs.builder()
                .credentialType("USERNAME_AND_PASSWORD")
                .usernameAndPassword(AuthConfigDecryptedCredentialUsernameAndPasswordArgs.builder()
                    .username("test-username")
                    .password("test-password")
                    .build())
                .build())
            .build(), CustomResourceOptions.builder()
                .dependsOn(client)
                .build());

    }
}

resources:
  client:
    type: gcp:applicationintegration:Client
    properties:
      location: us-west1
  basicExample:
    type: gcp:applicationintegration:AuthConfig
    name: basic_example
    properties:
      location: us-west1
      displayName: test-authconfig
      description: Test auth config created via terraform
      decryptedCredential:
        credentialType: USERNAME_AND_PASSWORD
        usernameAndPassword:
          username: test-username
          password: test-password
    options:
      dependsOn:
        - ${client}

Import

AuthConfig can be imported using any of these accepted formats:

• {{project}}/{{name}}
• {{project}} {{name}}
• {{name}}

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

$ pulumi import gcp:applicationintegration/authConfig:AuthConfig default {{project}}/{{name}}
$ terraform import google_integrations_auth_config.default "{{project}} {{name}}"
$ pulumi import gcp:applicationintegration/authConfig:AuthConfig default {{name}}

Constructors

AuthConfig(String name, {AuthConfigArgs? args, CustomResourceOptions? options})

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

AuthConfig.reference(String urn)

Creates a typed reference to an existing AuthConfig resource.

Properties

certificateId ↔ Output<String>

Certificate id for client certificate.

late, final

childResources → Set<Resource>

final, inherited

clientCertificate ↔ Output<AuthConfigClientCertificate?>

Raw client certificate Structure is documented below.

late, final

completionSources ↔ Map<String, IOutputCompletionSource>

late, final, inherited

createTime ↔ Output<String>

The timestamp when the auth config is created. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

late, final

creatorEmail ↔ Output<String>

The creator's email address. Generated based on the End User Credentials/LOAS role of the user making the call.

late, final

credentialType ↔ Output<String>

Credential type of the encrypted credential.

late, final

decryptedCredential ↔ Output<AuthConfigDecryptedCredential?>

Raw auth credentials. Structure is documented below.

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

description ↔ Output<String?>

A description of the auth config.

late, final

displayName ↔ Output<String>

The name of the auth config.

late, final

encryptedCredential ↔ Output<String>

Auth credential encrypted by Cloud KMS. Can be decrypted as Credential with proper KMS key. A base64-encoded string.

late, final

expiryNotificationDurations ↔ Output<List<String>?>

User can define the time to receive notification after which the auth config becomes invalid. Support up to 30 days. Support granularity in hours. A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".

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

lastModifierEmail ↔ Output<String>

The last modifier's email address. Generated based on the End User Credentials/LOAS role of the user making the call.

late, final

location ↔ Output<String>

Location in which client needs to be provisioned.

late, final

name ↔ Output<String>

Resource name of the auth config.

late, final

overrideValidTime ↔ Output<String?>

User provided expiry time to override. For the example of Salesforce, username/password credentials can be valid for 6 months depending on the instance settings. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

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

reason ↔ Output<String>

The reason / details of the current status.

late, final

resourceTransforms → List<ResourceTransform>

Inherited/explicit async transforms.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

state ↔ Output<String>

The status of the auth config.

late, final

transformations → List<ResourceTransformation>

Inherited/explicit legacy transformations.

no setter, inherited

updateTime ↔ Output<String>

The timestamp when the auth config is modified. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

late, final

urn ↔ Output<String>

late, final, inherited

validTime ↔ Output<String>

The time until the auth config is valid. Empty or max value is considered the auth config won't expire. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

late, final

visibility ↔ Output<String?>

The visibility of the auth config. Possible values are: PRIVATE, CLIENT_VISIBLE.

late, final

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, {AuthConfigState? state, CustomResourceOptions? options}) → AuthConfig

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