Google Native

Pulumi Official
Package maintained by Pulumi
v0.22.0 published on Friday, Jul 29, 2022 by Pulumi

Gateway

Creates a new Gateway in a given project and location.

Create a Gateway Resource

new Gateway(name: string, args: GatewayArgs, opts?: CustomResourceOptions);
@overload
def Gateway(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            description: Optional[str] = None,
            gateway_id: Optional[str] = None,
            labels: Optional[Mapping[str, str]] = None,
            location: Optional[str] = None,
            name: Optional[str] = None,
            ports: Optional[Sequence[int]] = None,
            project: Optional[str] = None,
            scope: Optional[str] = None,
            server_tls_policy: Optional[str] = None,
            type: Optional[GatewayType] = None)
@overload
def Gateway(resource_name: str,
            args: GatewayArgs,
            opts: Optional[ResourceOptions] = None)
func NewGateway(ctx *Context, name string, args GatewayArgs, opts ...ResourceOption) (*Gateway, error)
public Gateway(string name, GatewayArgs args, CustomResourceOptions? opts = null)
public Gateway(String name, GatewayArgs args)
public Gateway(String name, GatewayArgs args, CustomResourceOptions options)
type: google-native:networkservices/v1beta1:Gateway
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args GatewayArgs
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 GatewayArgs
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 GatewayArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args GatewayArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args GatewayArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Gateway 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 Gateway resource accepts the following input properties:

GatewayId string

Required. Short name of the Gateway resource to be created.

Ports List<int>

One or more port numbers (1-65535), on which the Gateway will receive traffic. The proxy binds to the specified ports. Gateways of type 'SECURE_WEB_GATEWAY' are limited to 1 port. Gateways of type 'OPEN_MESH' listen on 0.0.0.0 and support multiple ports.

Scope string

Immutable. Scope determines how configuration across multiple Gateway instances are merged. The configuration for multiple Gateway instances with the same scope will be merged as presented as a single coniguration to the proxy/load balancer. Max length 64 characters. Scope should start with a letter and can only have letters, numbers, hyphens.

Description string

Optional. A free-text description of the resource. Max length 1024 characters.

Labels Dictionary<string, string>

Optional. Set of label tags associated with the Gateway resource.

Location string
Name string

Name of the Gateway resource. It matches pattern projects/*/locations/*/gateways/.

Project string
ServerTlsPolicy string

Optional. A fully-qualified ServerTLSPolicy URL reference. Specifies how TLS traffic is terminated. If empty, TLS termination is disabled.

Type Pulumi.GoogleNative.NetworkServices.V1Beta1.GatewayType

Immutable. The type of the customer managed gateway. This field is required. If unspecified, an error is returned.

GatewayId string

Required. Short name of the Gateway resource to be created.

Ports []int

One or more port numbers (1-65535), on which the Gateway will receive traffic. The proxy binds to the specified ports. Gateways of type 'SECURE_WEB_GATEWAY' are limited to 1 port. Gateways of type 'OPEN_MESH' listen on 0.0.0.0 and support multiple ports.

Scope string

Immutable. Scope determines how configuration across multiple Gateway instances are merged. The configuration for multiple Gateway instances with the same scope will be merged as presented as a single coniguration to the proxy/load balancer. Max length 64 characters. Scope should start with a letter and can only have letters, numbers, hyphens.

Description string

Optional. A free-text description of the resource. Max length 1024 characters.

Labels map[string]string

Optional. Set of label tags associated with the Gateway resource.

Location string
Name string

Name of the Gateway resource. It matches pattern projects/*/locations/*/gateways/.

Project string
ServerTlsPolicy string

Optional. A fully-qualified ServerTLSPolicy URL reference. Specifies how TLS traffic is terminated. If empty, TLS termination is disabled.

Type GatewayType

Immutable. The type of the customer managed gateway. This field is required. If unspecified, an error is returned.

gatewayId String

Required. Short name of the Gateway resource to be created.

ports List<Integer>

One or more port numbers (1-65535), on which the Gateway will receive traffic. The proxy binds to the specified ports. Gateways of type 'SECURE_WEB_GATEWAY' are limited to 1 port. Gateways of type 'OPEN_MESH' listen on 0.0.0.0 and support multiple ports.

scope String

Immutable. Scope determines how configuration across multiple Gateway instances are merged. The configuration for multiple Gateway instances with the same scope will be merged as presented as a single coniguration to the proxy/load balancer. Max length 64 characters. Scope should start with a letter and can only have letters, numbers, hyphens.

description String

Optional. A free-text description of the resource. Max length 1024 characters.

labels Map<String,String>

Optional. Set of label tags associated with the Gateway resource.

location String
name String

Name of the Gateway resource. It matches pattern projects/*/locations/*/gateways/.

project String
serverTlsPolicy String

Optional. A fully-qualified ServerTLSPolicy URL reference. Specifies how TLS traffic is terminated. If empty, TLS termination is disabled.

type GatewayType

Immutable. The type of the customer managed gateway. This field is required. If unspecified, an error is returned.

gatewayId string

Required. Short name of the Gateway resource to be created.

ports number[]

One or more port numbers (1-65535), on which the Gateway will receive traffic. The proxy binds to the specified ports. Gateways of type 'SECURE_WEB_GATEWAY' are limited to 1 port. Gateways of type 'OPEN_MESH' listen on 0.0.0.0 and support multiple ports.

scope string

Immutable. Scope determines how configuration across multiple Gateway instances are merged. The configuration for multiple Gateway instances with the same scope will be merged as presented as a single coniguration to the proxy/load balancer. Max length 64 characters. Scope should start with a letter and can only have letters, numbers, hyphens.

description string

Optional. A free-text description of the resource. Max length 1024 characters.

labels {[key: string]: string}

Optional. Set of label tags associated with the Gateway resource.

location string
name string

Name of the Gateway resource. It matches pattern projects/*/locations/*/gateways/.

project string
serverTlsPolicy string

Optional. A fully-qualified ServerTLSPolicy URL reference. Specifies how TLS traffic is terminated. If empty, TLS termination is disabled.

type GatewayType

Immutable. The type of the customer managed gateway. This field is required. If unspecified, an error is returned.

gateway_id str

Required. Short name of the Gateway resource to be created.

ports Sequence[int]

One or more port numbers (1-65535), on which the Gateway will receive traffic. The proxy binds to the specified ports. Gateways of type 'SECURE_WEB_GATEWAY' are limited to 1 port. Gateways of type 'OPEN_MESH' listen on 0.0.0.0 and support multiple ports.

scope str

Immutable. Scope determines how configuration across multiple Gateway instances are merged. The configuration for multiple Gateway instances with the same scope will be merged as presented as a single coniguration to the proxy/load balancer. Max length 64 characters. Scope should start with a letter and can only have letters, numbers, hyphens.

description str

Optional. A free-text description of the resource. Max length 1024 characters.

labels Mapping[str, str]

Optional. Set of label tags associated with the Gateway resource.

location str
name str

Name of the Gateway resource. It matches pattern projects/*/locations/*/gateways/.

project str
server_tls_policy str

Optional. A fully-qualified ServerTLSPolicy URL reference. Specifies how TLS traffic is terminated. If empty, TLS termination is disabled.

type GatewayType

Immutable. The type of the customer managed gateway. This field is required. If unspecified, an error is returned.

gatewayId String

Required. Short name of the Gateway resource to be created.

ports List<Number>

One or more port numbers (1-65535), on which the Gateway will receive traffic. The proxy binds to the specified ports. Gateways of type 'SECURE_WEB_GATEWAY' are limited to 1 port. Gateways of type 'OPEN_MESH' listen on 0.0.0.0 and support multiple ports.

scope String

Immutable. Scope determines how configuration across multiple Gateway instances are merged. The configuration for multiple Gateway instances with the same scope will be merged as presented as a single coniguration to the proxy/load balancer. Max length 64 characters. Scope should start with a letter and can only have letters, numbers, hyphens.

description String

Optional. A free-text description of the resource. Max length 1024 characters.

labels Map<String>

Optional. Set of label tags associated with the Gateway resource.

location String
name String

Name of the Gateway resource. It matches pattern projects/*/locations/*/gateways/.

project String
serverTlsPolicy String

Optional. A fully-qualified ServerTLSPolicy URL reference. Specifies how TLS traffic is terminated. If empty, TLS termination is disabled.

type "TYPE_UNSPECIFIED" | "OPEN_MESH" | "SECURE_WEB_GATEWAY"

Immutable. The type of the customer managed gateway. This field is required. If unspecified, an error is returned.

Outputs

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

CreateTime string

The timestamp when the resource was created.

Id string

The provider-assigned unique ID for this managed resource.

SelfLink string

Server-defined URL of this resource

UpdateTime string

The timestamp when the resource was updated.

CreateTime string

The timestamp when the resource was created.

Id string

The provider-assigned unique ID for this managed resource.

SelfLink string

Server-defined URL of this resource

UpdateTime string

The timestamp when the resource was updated.

createTime String

The timestamp when the resource was created.

id String

The provider-assigned unique ID for this managed resource.

selfLink String

Server-defined URL of this resource

updateTime String

The timestamp when the resource was updated.

createTime string

The timestamp when the resource was created.

id string

The provider-assigned unique ID for this managed resource.

selfLink string

Server-defined URL of this resource

updateTime string

The timestamp when the resource was updated.

create_time str

The timestamp when the resource was created.

id str

The provider-assigned unique ID for this managed resource.

self_link str

Server-defined URL of this resource

update_time str

The timestamp when the resource was updated.

createTime String

The timestamp when the resource was created.

id String

The provider-assigned unique ID for this managed resource.

selfLink String

Server-defined URL of this resource

updateTime String

The timestamp when the resource was updated.

Supporting Types

GatewayType

TypeUnspecified
TYPE_UNSPECIFIED

The type of the customer managed gateway is unspecified.

OpenMesh
OPEN_MESH

The type of the customer managed gateway is TrafficDirector Open Mesh.

SecureWebGateway
SECURE_WEB_GATEWAY

The type of the customer managed gateway is SecureWebGateway (SWG).

GatewayTypeTypeUnspecified
TYPE_UNSPECIFIED

The type of the customer managed gateway is unspecified.

GatewayTypeOpenMesh
OPEN_MESH

The type of the customer managed gateway is TrafficDirector Open Mesh.

GatewayTypeSecureWebGateway
SECURE_WEB_GATEWAY

The type of the customer managed gateway is SecureWebGateway (SWG).

TypeUnspecified
TYPE_UNSPECIFIED

The type of the customer managed gateway is unspecified.

OpenMesh
OPEN_MESH

The type of the customer managed gateway is TrafficDirector Open Mesh.

SecureWebGateway
SECURE_WEB_GATEWAY

The type of the customer managed gateway is SecureWebGateway (SWG).

TypeUnspecified
TYPE_UNSPECIFIED

The type of the customer managed gateway is unspecified.

OpenMesh
OPEN_MESH

The type of the customer managed gateway is TrafficDirector Open Mesh.

SecureWebGateway
SECURE_WEB_GATEWAY

The type of the customer managed gateway is SecureWebGateway (SWG).

TYPE_UNSPECIFIED
TYPE_UNSPECIFIED

The type of the customer managed gateway is unspecified.

OPEN_MESH
OPEN_MESH

The type of the customer managed gateway is TrafficDirector Open Mesh.

SECURE_WEB_GATEWAY
SECURE_WEB_GATEWAY

The type of the customer managed gateway is SecureWebGateway (SWG).

"TYPE_UNSPECIFIED"
TYPE_UNSPECIFIED

The type of the customer managed gateway is unspecified.

"OPEN_MESH"
OPEN_MESH

The type of the customer managed gateway is TrafficDirector Open Mesh.

"SECURE_WEB_GATEWAY"
SECURE_WEB_GATEWAY

The type of the customer managed gateway is SecureWebGateway (SWG).

Package Details

Repository
https://github.com/pulumi/pulumi-google-native
License
Apache-2.0