AppGateway class

> Warning: gcp.beyondcorp.AppGateway is deprecated. App Connector is being deprecated and creation of new App Connectors is no longer permitted. Use gcp.beyondcorp.SecurityGateway instead.

A BeyondCorp AppGateway resource represents a BeyondCorp protected AppGateway to a remote application. It creates all the necessary GCP components needed for creating a BeyondCorp protected AppGateway. Multiple connectors can be authorised for a single AppGateway.

To get more information about AppGateway, see:

• API documentation
• How-to Guides
• Official Documentation

Example Usage

Beyondcorp App Gateway Basic

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

const appGateway = new gcp.beyondcorp.AppGateway("app_gateway", {
    name: "my-app-gateway",
    type: "TCP_PROXY",
    region: "us-central1",
    hostType: "GCP_REGIONAL_MIG",
});

import pulumi
import pulumi_gcp as gcp

app_gateway = gcp.beyondcorp.AppGateway("app_gateway",
    name="my-app-gateway",
    type="TCP_PROXY",
    region="us-central1",
    host_type="GCP_REGIONAL_MIG")

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

return await Deployment.RunAsync(() =>
{
    var appGateway = new Gcp.Beyondcorp.AppGateway("app_gateway", new()
    {
        Name = "my-app-gateway",
        Type = "TCP_PROXY",
        Region = "us-central1",
        HostType = "GCP_REGIONAL_MIG",
    });

});

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/beyondcorp"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := beyondcorp.NewAppGateway(ctx, "app_gateway", &beyondcorp.AppGatewayArgs{
			Name:     pulumi.String("my-app-gateway"),
			Type:     pulumi.String("TCP_PROXY"),
			Region:   pulumi.String("us-central1"),
			HostType: pulumi.String("GCP_REGIONAL_MIG"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

resource "gcp_beyondcorp_appgateway" "app_gateway" {
  name      = "my-app-gateway"
  type      = "TCP_PROXY"
  region    = "us-central1"
  host_type = "GCP_REGIONAL_MIG"
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.beyondcorp.AppGateway;
import com.pulumi.gcp.beyondcorp.AppGatewayArgs;
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 appGateway = new AppGateway("appGateway", AppGatewayArgs.builder()
            .name("my-app-gateway")
            .type("TCP_PROXY")
            .region("us-central1")
            .hostType("GCP_REGIONAL_MIG")
            .build());

    }
}

resources:
  appGateway:
    type: gcp:beyondcorp:AppGateway
    name: app_gateway
    properties:
      name: my-app-gateway
      type: TCP_PROXY
      region: us-central1
      hostType: GCP_REGIONAL_MIG

Beyondcorp App Gateway Full

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

const appGateway = new gcp.beyondcorp.AppGateway("app_gateway", {
    name: "my-app-gateway",
    type: "TCP_PROXY",
    region: "us-central1",
    displayName: "some display name",
    labels: {
        foo: "bar",
        bar: "baz",
    },
    hostType: "GCP_REGIONAL_MIG",
});

import pulumi
import pulumi_gcp as gcp

app_gateway = gcp.beyondcorp.AppGateway("app_gateway",
    name="my-app-gateway",
    type="TCP_PROXY",
    region="us-central1",
    display_name="some display name",
    labels={
        "foo": "bar",
        "bar": "baz",
    },
    host_type="GCP_REGIONAL_MIG")

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

return await Deployment.RunAsync(() =>
{
    var appGateway = new Gcp.Beyondcorp.AppGateway("app_gateway", new()
    {
        Name = "my-app-gateway",
        Type = "TCP_PROXY",
        Region = "us-central1",
        DisplayName = "some display name",
        Labels =
        {
            { "foo", "bar" },
            { "bar", "baz" },
        },
        HostType = "GCP_REGIONAL_MIG",
    });

});

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/beyondcorp"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := beyondcorp.NewAppGateway(ctx, "app_gateway", &beyondcorp.AppGatewayArgs{
			Name:        pulumi.String("my-app-gateway"),
			Type:        pulumi.String("TCP_PROXY"),
			Region:      pulumi.String("us-central1"),
			DisplayName: pulumi.String("some display name"),
			Labels: pulumi.StringMap{
				"foo": pulumi.String("bar"),
				"bar": pulumi.String("baz"),
			},
			HostType: pulumi.String("GCP_REGIONAL_MIG"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

resource "gcp_beyondcorp_appgateway" "app_gateway" {
  name         = "my-app-gateway"
  type         = "TCP_PROXY"
  region       = "us-central1"
  display_name = "some display name"
  labels = {
    "foo" = "bar"
    "bar" = "baz"
  }
  host_type = "GCP_REGIONAL_MIG"
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.beyondcorp.AppGateway;
import com.pulumi.gcp.beyondcorp.AppGatewayArgs;
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 appGateway = new AppGateway("appGateway", AppGatewayArgs.builder()
            .name("my-app-gateway")
            .type("TCP_PROXY")
            .region("us-central1")
            .displayName("some display name")
            .labels(Map.ofEntries(
                Map.entry("foo", "bar"),
                Map.entry("bar", "baz")
            ))
            .hostType("GCP_REGIONAL_MIG")
            .build());

    }
}

resources:
  appGateway:
    type: gcp:beyondcorp:AppGateway
    name: app_gateway
    properties:
      name: my-app-gateway
      type: TCP_PROXY
      region: us-central1
      displayName: some display name
      labels:
        foo: bar
        bar: baz
      hostType: GCP_REGIONAL_MIG

Import

AppGateway can be imported using any of these accepted formats:

• projects/{{project}}/locations/{{region}}/appGateways/{{name}}
• {{project}}/{{region}}/{{name}}
• {{region}}/{{name}}
• {{name}}

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

$ pulumi import gcp:beyondcorp/appGateway:AppGateway default projects/{{project}}/locations/{{region}}/appGateways/{{name}}
$ pulumi import gcp:beyondcorp/appGateway:AppGateway default {{project}}/{{region}}/{{name}}
$ pulumi import gcp:beyondcorp/appGateway:AppGateway default {{region}}/{{name}}
$ pulumi import gcp:beyondcorp/appGateway:AppGateway default {{name}}

Constructors

AppGateway(String name, {AppGatewayArgs? args, CustomResourceOptions? options})

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

AppGateway.reference(String urn)

Creates a typed reference to an existing AppGateway resource.

Properties

allocatedConnections ↔ Output<List<AppGatewayAllocatedConnection>>

A list of connections allocated for the Gateway. Structure is documented below.

late, final

childResources → Set<Resource>

final, inherited

completionSources ↔ Map<String, IOutputCompletionSource>

late, final, inherited

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

displayName ↔ Output<String?>

An arbitrary user-provided name for the AppGateway.

late, final

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.

late, final

hashCode → int

The hash code for this object.

no setter, inherited

hostType ↔ Output<String?>

The type of hosting used by the AppGateway. Default value is HOST_TYPE_UNSPECIFIED. Possible values are: HOST_TYPE_UNSPECIFIED, GCP_REGIONAL_MIG.

late, final

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

labels ↔ Output<Map<String, String>?>

Resource labels to represent user provided metadata.

late, final

name ↔ Output<String>

ID of the AppGateway.

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

pulumiLabels ↔ Output<Map<String, String>>

The combination of labels configured directly on the resource and default labels configured on the provider.

late, final

region ↔ Output<String?>

The region of the AppGateway.

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>

Represents the different states of a AppGateway.

late, final

transformations → List<ResourceTransformation>

Inherited/explicit legacy transformations.

no setter, inherited

type ↔ Output<String?>

The type of network connectivity used by the AppGateway. Default value is TYPE_UNSPECIFIED. Possible values are: TYPE_UNSPECIFIED, TCP_PROXY.

late, final

uri ↔ Output<String>

Server-defined URI for this resource.

late, final

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

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