pulumi-gcp-kotlin/com.pulumi.gcp.beyondcorp.kotlin/AppConnector

AppConnector

class AppConnector : KotlinCustomResource

A BeyondCorp AppConnector resource represents an application facing component deployed proximal to and with direct access to the application instances. It is used to establish connectivity between the remote enterprise environment and GCP. It initiates connections to the applications and can proxy the data from users over the connection. To get more information about AppConnector, see:

API documentation
How-to Guides

Official Documentation

Example Usage

Beyondcorp App Connector Basic

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const serviceAccount = new gcp.serviceaccount.Account("service_account", {
    accountId: "my-account",
    displayName: "Test Service Account",
});
const appConnector = new gcp.beyondcorp.AppConnector("app_connector", {
    name: "my-app-connector",
    principalInfo: {
        serviceAccount: {
            email: serviceAccount.email,
        },
    },
});

import pulumi
import pulumi_gcp as gcp
service_account = gcp.serviceaccount.Account("service_account",
    account_id="my-account",
    display_name="Test Service Account")
app_connector = gcp.beyondcorp.AppConnector("app_connector",
    name="my-app-connector",
    principal_info={
        "service_account": {
            "email": service_account.email,
        },
    })

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;
return await Deployment.RunAsync(() =>
{
    var serviceAccount = new Gcp.ServiceAccount.Account("service_account", new()
    {
        AccountId = "my-account",
        DisplayName = "Test Service Account",
    });
    var appConnector = new Gcp.Beyondcorp.AppConnector("app_connector", new()
    {
        Name = "my-app-connector",
        PrincipalInfo = new Gcp.Beyondcorp.Inputs.AppConnectorPrincipalInfoArgs
        {
            ServiceAccount = new Gcp.Beyondcorp.Inputs.AppConnectorPrincipalInfoServiceAccountArgs
            {
                Email = serviceAccount.Email,
            },
        },
    });
});

package main
import (
	"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/beyondcorp"
	"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 {
		serviceAccount, err := serviceaccount.NewAccount(ctx, "service_account", &serviceaccount.AccountArgs{
			AccountId:   pulumi.String("my-account"),
			DisplayName: pulumi.String("Test Service Account"),
		})
		if err != nil {
			return err
		}
		_, err = beyondcorp.NewAppConnector(ctx, "app_connector", &beyondcorp.AppConnectorArgs{
			Name: pulumi.String("my-app-connector"),
			PrincipalInfo: &beyondcorp.AppConnectorPrincipalInfoArgs{
				ServiceAccount: &beyondcorp.AppConnectorPrincipalInfoServiceAccountArgs{
					Email: serviceAccount.Email,
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.serviceaccount.Account;
import com.pulumi.gcp.serviceaccount.AccountArgs;
import com.pulumi.gcp.beyondcorp.AppConnector;
import com.pulumi.gcp.beyondcorp.AppConnectorArgs;
import com.pulumi.gcp.beyondcorp.inputs.AppConnectorPrincipalInfoArgs;
import com.pulumi.gcp.beyondcorp.inputs.AppConnectorPrincipalInfoServiceAccountArgs;
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 serviceAccount = new Account("serviceAccount", AccountArgs.builder()
            .accountId("my-account")
            .displayName("Test Service Account")
            .build());
        var appConnector = new AppConnector("appConnector", AppConnectorArgs.builder()
            .name("my-app-connector")
            .principalInfo(AppConnectorPrincipalInfoArgs.builder()
                .serviceAccount(AppConnectorPrincipalInfoServiceAccountArgs.builder()
                    .email(serviceAccount.email())
                    .build())
                .build())
            .build());
    }
}

resources:
  serviceAccount:
    type: gcp:serviceaccount:Account
    name: service_account
    properties:
      accountId: my-account
      displayName: Test Service Account
  appConnector:
    type: gcp:beyondcorp:AppConnector
    name: app_connector
    properties:
      name: my-app-connector
      principalInfo:
        serviceAccount:
          email: ${serviceAccount.email}

Beyondcorp App Connector Full

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const serviceAccount = new gcp.serviceaccount.Account("service_account", {
    accountId: "my-account",
    displayName: "Test Service Account",
});
const appConnector = new gcp.beyondcorp.AppConnector("app_connector", {
    name: "my-app-connector",
    region: "us-central1",
    displayName: "some display name",
    principalInfo: {
        serviceAccount: {
            email: serviceAccount.email,
        },
    },
    labels: {
        foo: "bar",
        bar: "baz",
    },
});

import pulumi
import pulumi_gcp as gcp
service_account = gcp.serviceaccount.Account("service_account",
    account_id="my-account",
    display_name="Test Service Account")
app_connector = gcp.beyondcorp.AppConnector("app_connector",
    name="my-app-connector",
    region="us-central1",
    display_name="some display name",
    principal_info={
        "service_account": {
            "email": service_account.email,
        },
    },
    labels={
        "foo": "bar",
        "bar": "baz",
    })

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;
return await Deployment.RunAsync(() =>
{
    var serviceAccount = new Gcp.ServiceAccount.Account("service_account", new()
    {
        AccountId = "my-account",
        DisplayName = "Test Service Account",
    });
    var appConnector = new Gcp.Beyondcorp.AppConnector("app_connector", new()
    {
        Name = "my-app-connector",
        Region = "us-central1",
        DisplayName = "some display name",
        PrincipalInfo = new Gcp.Beyondcorp.Inputs.AppConnectorPrincipalInfoArgs
        {
            ServiceAccount = new Gcp.Beyondcorp.Inputs.AppConnectorPrincipalInfoServiceAccountArgs
            {
                Email = serviceAccount.Email,
            },
        },
        Labels =
        {
            { "foo", "bar" },
            { "bar", "baz" },
        },
    });
});

package main
import (
	"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/beyondcorp"
	"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 {
		serviceAccount, err := serviceaccount.NewAccount(ctx, "service_account", &serviceaccount.AccountArgs{
			AccountId:   pulumi.String("my-account"),
			DisplayName: pulumi.String("Test Service Account"),
		})
		if err != nil {
			return err
		}
		_, err = beyondcorp.NewAppConnector(ctx, "app_connector", &beyondcorp.AppConnectorArgs{
			Name:        pulumi.String("my-app-connector"),
			Region:      pulumi.String("us-central1"),
			DisplayName: pulumi.String("some display name"),
			PrincipalInfo: &beyondcorp.AppConnectorPrincipalInfoArgs{
				ServiceAccount: &beyondcorp.AppConnectorPrincipalInfoServiceAccountArgs{
					Email: serviceAccount.Email,
				},
			},
			Labels: pulumi.StringMap{
				"foo": pulumi.String("bar"),
				"bar": pulumi.String("baz"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.serviceaccount.Account;
import com.pulumi.gcp.serviceaccount.AccountArgs;
import com.pulumi.gcp.beyondcorp.AppConnector;
import com.pulumi.gcp.beyondcorp.AppConnectorArgs;
import com.pulumi.gcp.beyondcorp.inputs.AppConnectorPrincipalInfoArgs;
import com.pulumi.gcp.beyondcorp.inputs.AppConnectorPrincipalInfoServiceAccountArgs;
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 serviceAccount = new Account("serviceAccount", AccountArgs.builder()
            .accountId("my-account")
            .displayName("Test Service Account")
            .build());
        var appConnector = new AppConnector("appConnector", AppConnectorArgs.builder()
            .name("my-app-connector")
            .region("us-central1")
            .displayName("some display name")
            .principalInfo(AppConnectorPrincipalInfoArgs.builder()
                .serviceAccount(AppConnectorPrincipalInfoServiceAccountArgs.builder()
                    .email(serviceAccount.email())
                    .build())
                .build())
            .labels(Map.ofEntries(
                Map.entry("foo", "bar"),
                Map.entry("bar", "baz")
            ))
            .build());
    }
}

resources:
  serviceAccount:
    type: gcp:serviceaccount:Account
    name: service_account
    properties:
      accountId: my-account
      displayName: Test Service Account
  appConnector:
    type: gcp:beyondcorp:AppConnector
    name: app_connector
    properties:
      name: my-app-connector
      region: us-central1
      displayName: some display name
      principalInfo:
        serviceAccount:
          email: ${serviceAccount.email}
      labels:
        foo: bar
        bar: baz

Import

AppConnector can be imported using any of these accepted formats:

projects/{{project}}/locations/{{region}}/appConnectors/{{name}}
{{project}}/{{region}}/{{name}}
{{region}}/{{name}}
{{name}} When using the pulumi import command, AppConnector can be imported using one of the formats above. For example:

$ pulumi import gcp:beyondcorp/appConnector:AppConnector default projects/{{project}}/locations/{{region}}/appConnectors/{{name}}

$ pulumi import gcp:beyondcorp/appConnector:AppConnector default {{project}}/{{region}}/{{name}}

$ pulumi import gcp:beyondcorp/appConnector:AppConnector default {{region}}/{{name}}

$ pulumi import gcp:beyondcorp/appConnector:AppConnector default {{name}}

Properties

displayName

val displayName: Output<String>?

An arbitrary user-provided name for the AppConnector.

effectiveLabels

val effectiveLabels: Output<Map<String, String>>

All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.

val id: Output<String>

labels

val labels: Output<Map<String, String>>?

Resource labels to represent user provided metadata. Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field 'effective_labels' for all of the labels present on the resource.

name

val name: Output<String>

ID of the AppConnector.

principalInfo

val principalInfo: Output<AppConnectorPrincipalInfo>

Principal information about the Identity of the AppConnector. Structure is documented below.

project

val project: Output<String>

pulumiChildResources

val pulumiChildResources: Set<KotlinResource>

pulumiLabels