gcp logo
Google Cloud Classic v6.48.0, Jan 24 23

gcp.beyondcorp.AppGateway

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:

Example Usage

Beyondcorp App Gateway Basic

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

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

});
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := beyondcorp.NewAppGateway(ctx, "appGateway", &beyondcorp.AppGatewayArgs{
			HostType: pulumi.String("GCP_REGIONAL_MIG"),
			Region:   pulumi.String("us-central1"),
			Type:     pulumi.String("TCP_PROXY"),
		})
		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.beyondcorp.AppGateway;
import com.pulumi.gcp.beyondcorp.AppGatewayArgs;
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 appGateway = new AppGateway("appGateway", AppGatewayArgs.builder()        
            .hostType("GCP_REGIONAL_MIG")
            .region("us-central1")
            .type("TCP_PROXY")
            .build());

    }
}
import pulumi
import pulumi_gcp as gcp

app_gateway = gcp.beyondcorp.AppGateway("appGateway",
    host_type="GCP_REGIONAL_MIG",
    region="us-central1",
    type="TCP_PROXY")
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const appGateway = new gcp.beyondcorp.AppGateway("appGateway", {
    hostType: "GCP_REGIONAL_MIG",
    region: "us-central1",
    type: "TCP_PROXY",
});
resources:
  appGateway:
    type: gcp:beyondcorp:AppGateway
    properties:
      hostType: GCP_REGIONAL_MIG
      region: us-central1
      type: TCP_PROXY

Beyondcorp App Gateway Full

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

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

});
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := beyondcorp.NewAppGateway(ctx, "appGateway", &beyondcorp.AppGatewayArgs{
			DisplayName: pulumi.String("some display name"),
			HostType:    pulumi.String("GCP_REGIONAL_MIG"),
			Labels: pulumi.StringMap{
				"bar": pulumi.String("baz"),
				"foo": pulumi.String("bar"),
			},
			Region: pulumi.String("us-central1"),
			Type:   pulumi.String("TCP_PROXY"),
		})
		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.beyondcorp.AppGateway;
import com.pulumi.gcp.beyondcorp.AppGatewayArgs;
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 appGateway = new AppGateway("appGateway", AppGatewayArgs.builder()        
            .displayName("some display name")
            .hostType("GCP_REGIONAL_MIG")
            .labels(Map.ofEntries(
                Map.entry("bar", "baz"),
                Map.entry("foo", "bar")
            ))
            .region("us-central1")
            .type("TCP_PROXY")
            .build());

    }
}
import pulumi
import pulumi_gcp as gcp

app_gateway = gcp.beyondcorp.AppGateway("appGateway",
    display_name="some display name",
    host_type="GCP_REGIONAL_MIG",
    labels={
        "bar": "baz",
        "foo": "bar",
    },
    region="us-central1",
    type="TCP_PROXY")
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

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

Create AppGateway Resource

new AppGateway(name: string, args?: AppGatewayArgs, opts?: CustomResourceOptions);
@overload
def AppGateway(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               display_name: Optional[str] = None,
               host_type: Optional[str] = None,
               labels: Optional[Mapping[str, str]] = None,
               name: Optional[str] = None,
               project: Optional[str] = None,
               region: Optional[str] = None,
               type: Optional[str] = None)
@overload
def AppGateway(resource_name: str,
               args: Optional[AppGatewayArgs] = None,
               opts: Optional[ResourceOptions] = None)
func NewAppGateway(ctx *Context, name string, args *AppGatewayArgs, opts ...ResourceOption) (*AppGateway, error)
public AppGateway(string name, AppGatewayArgs? args = null, CustomResourceOptions? opts = null)
public AppGateway(String name, AppGatewayArgs args)
public AppGateway(String name, AppGatewayArgs args, CustomResourceOptions options)
type: gcp:beyondcorp:AppGateway
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args AppGatewayArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args AppGatewayArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args AppGatewayArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args AppGatewayArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args AppGatewayArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

AppGateway Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The AppGateway resource accepts the following input properties:

DisplayName string

An arbitrary user-provided name for the AppGateway.

HostType string

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

Labels Dictionary<string, string>

Resource labels to represent user provided metadata.

Name string

ID of the AppGateway.

Project string

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

Region string

The region of the AppGateway.

Type string

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

DisplayName string

An arbitrary user-provided name for the AppGateway.

HostType string

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

Labels map[string]string

Resource labels to represent user provided metadata.

Name string

ID of the AppGateway.

Project string

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

Region string

The region of the AppGateway.

Type string

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

displayName String

An arbitrary user-provided name for the AppGateway.

hostType String

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

labels Map<String,String>

Resource labels to represent user provided metadata.

name String

ID of the AppGateway.

project String

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

region String

The region of the AppGateway.

type String

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

displayName string

An arbitrary user-provided name for the AppGateway.

hostType string

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

labels {[key: string]: string}

Resource labels to represent user provided metadata.

name string

ID of the AppGateway.

project string

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

region string

The region of the AppGateway.

type string

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

display_name str

An arbitrary user-provided name for the AppGateway.

host_type str

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

labels Mapping[str, str]

Resource labels to represent user provided metadata.

name str

ID of the AppGateway.

project str

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

region str

The region of the AppGateway.

type str

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

displayName String

An arbitrary user-provided name for the AppGateway.

hostType String

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

labels Map<String>

Resource labels to represent user provided metadata.

name String

ID of the AppGateway.

project String

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

region String

The region of the AppGateway.

type String

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

Outputs

All input properties are implicitly available as output properties. Additionally, the AppGateway resource produces the following output properties:

AllocatedConnections List<AppGatewayAllocatedConnection>

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

Id string

The provider-assigned unique ID for this managed resource.

State string

Represents the different states of a AppGateway.

Uri string

Server-defined URI for this resource.

AllocatedConnections []AppGatewayAllocatedConnection

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

Id string

The provider-assigned unique ID for this managed resource.

State string

Represents the different states of a AppGateway.

Uri string

Server-defined URI for this resource.

allocatedConnections List<AppGatewayAllocatedConnection>

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

id String

The provider-assigned unique ID for this managed resource.

state String

Represents the different states of a AppGateway.

uri String

Server-defined URI for this resource.

allocatedConnections AppGatewayAllocatedConnection[]

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

id string

The provider-assigned unique ID for this managed resource.

state string

Represents the different states of a AppGateway.

uri string

Server-defined URI for this resource.

allocated_connections Sequence[AppGatewayAllocatedConnection]

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

id str

The provider-assigned unique ID for this managed resource.

state str

Represents the different states of a AppGateway.

uri str

Server-defined URI for this resource.

allocatedConnections List<Property Map>

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

id String

The provider-assigned unique ID for this managed resource.

state String

Represents the different states of a AppGateway.

uri String

Server-defined URI for this resource.

Look up Existing AppGateway Resource

Get an existing AppGateway resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: AppGatewayState, opts?: CustomResourceOptions): AppGateway
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        allocated_connections: Optional[Sequence[AppGatewayAllocatedConnectionArgs]] = None,
        display_name: Optional[str] = None,
        host_type: Optional[str] = None,
        labels: Optional[Mapping[str, str]] = None,
        name: Optional[str] = None,
        project: Optional[str] = None,
        region: Optional[str] = None,
        state: Optional[str] = None,
        type: Optional[str] = None,
        uri: Optional[str] = None) -> AppGateway
func GetAppGateway(ctx *Context, name string, id IDInput, state *AppGatewayState, opts ...ResourceOption) (*AppGateway, error)
public static AppGateway Get(string name, Input<string> id, AppGatewayState? state, CustomResourceOptions? opts = null)
public static AppGateway get(String name, Output<String> id, AppGatewayState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
AllocatedConnections List<AppGatewayAllocatedConnectionArgs>

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

DisplayName string

An arbitrary user-provided name for the AppGateway.

HostType string

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

Labels Dictionary<string, string>

Resource labels to represent user provided metadata.

Name string

ID of the AppGateway.

Project string

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

Region string

The region of the AppGateway.

State string

Represents the different states of a AppGateway.

Type string

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

Uri string

Server-defined URI for this resource.

AllocatedConnections []AppGatewayAllocatedConnectionArgs

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

DisplayName string

An arbitrary user-provided name for the AppGateway.

HostType string

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

Labels map[string]string

Resource labels to represent user provided metadata.

Name string

ID of the AppGateway.

Project string

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

Region string

The region of the AppGateway.

State string

Represents the different states of a AppGateway.

Type string

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

Uri string

Server-defined URI for this resource.

allocatedConnections List<AppGatewayAllocatedConnectionArgs>

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

displayName String

An arbitrary user-provided name for the AppGateway.

hostType String

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

labels Map<String,String>

Resource labels to represent user provided metadata.

name String

ID of the AppGateway.

project String

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

region String

The region of the AppGateway.

state String

Represents the different states of a AppGateway.

type String

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

uri String

Server-defined URI for this resource.

allocatedConnections AppGatewayAllocatedConnectionArgs[]

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

displayName string

An arbitrary user-provided name for the AppGateway.

hostType string

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

labels {[key: string]: string}

Resource labels to represent user provided metadata.

name string

ID of the AppGateway.

project string

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

region string

The region of the AppGateway.

state string

Represents the different states of a AppGateway.

type string

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

uri string

Server-defined URI for this resource.

allocated_connections Sequence[AppGatewayAllocatedConnectionArgs]

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

display_name str

An arbitrary user-provided name for the AppGateway.

host_type str

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

labels Mapping[str, str]

Resource labels to represent user provided metadata.

name str

ID of the AppGateway.

project str

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

region str

The region of the AppGateway.

state str

Represents the different states of a AppGateway.

type str

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

uri str

Server-defined URI for this resource.

allocatedConnections List<Property Map>

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

displayName String

An arbitrary user-provided name for the AppGateway.

hostType String

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

labels Map<String>

Resource labels to represent user provided metadata.

name String

ID of the AppGateway.

project String

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

region String

The region of the AppGateway.

state String

Represents the different states of a AppGateway.

type String

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

uri String

Server-defined URI for this resource.

Supporting Types

AppGatewayAllocatedConnection

IngressPort int

The ingress port of an allocated connection.

PscUri string

The PSC uri of an allocated connection.

IngressPort int

The ingress port of an allocated connection.

PscUri string

The PSC uri of an allocated connection.

ingressPort Integer

The ingress port of an allocated connection.

pscUri String

The PSC uri of an allocated connection.

ingressPort number

The ingress port of an allocated connection.

pscUri string

The PSC uri of an allocated connection.

ingress_port int

The ingress port of an allocated connection.

psc_uri str

The PSC uri of an allocated connection.

ingressPort Number

The ingress port of an allocated connection.

pscUri String

The PSC uri of an allocated connection.

Import

AppGateway can be imported using any of these accepted formats

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

Package Details

Repository
Google Cloud (GCP) Classic pulumi/pulumi-gcp
License
Apache-2.0
Notes

This Pulumi package is based on the google-beta Terraform Provider.