Google Cloud Native is in preview. Google Cloud Classic is fully supported.
google-native.networkservices/v1beta1.getGateway
Explore with Pulumi AI
Google Cloud Native is in preview. Google Cloud Classic is fully supported.
Gets details of a single Gateway.
Using getGateway
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getGateway(args: GetGatewayArgs, opts?: InvokeOptions): Promise<GetGatewayResult>
function getGatewayOutput(args: GetGatewayOutputArgs, opts?: InvokeOptions): Output<GetGatewayResult>
def get_gateway(gateway_id: Optional[str] = None,
location: Optional[str] = None,
project: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetGatewayResult
def get_gateway_output(gateway_id: Optional[pulumi.Input[str]] = None,
location: Optional[pulumi.Input[str]] = None,
project: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetGatewayResult]
func LookupGateway(ctx *Context, args *LookupGatewayArgs, opts ...InvokeOption) (*LookupGatewayResult, error)
func LookupGatewayOutput(ctx *Context, args *LookupGatewayOutputArgs, opts ...InvokeOption) LookupGatewayResultOutput
> Note: This function is named LookupGateway
in the Go SDK.
public static class GetGateway
{
public static Task<GetGatewayResult> InvokeAsync(GetGatewayArgs args, InvokeOptions? opts = null)
public static Output<GetGatewayResult> Invoke(GetGatewayInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetGatewayResult> getGateway(GetGatewayArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: google-native:networkservices/v1beta1:getGateway
arguments:
# arguments dictionary
The following arguments are supported:
- gateway_
id str - location str
- project str
getGateway Result
The following output properties are available:
- Addresses List<string>
Optional. Zero or one IPv4-address on which the Gateway will receive the traffic. When no address is provided, an IP from the subnetwork is allocated This field only applies to gateways of type 'SECURE_WEB_GATEWAY'. Gateways of type 'OPEN_MESH' listen on 0.0.0.0.
- Certificate
Urls List<string> Optional. A fully-qualified Certificates URL reference. The proxy presents a Certificate (selected based on SNI) when establishing a TLS connection. This feature only applies to gateways of type 'SECURE_WEB_GATEWAY'.
- Create
Time string The timestamp when the resource was created.
- Description string
Optional. A free-text description of the resource. Max length 1024 characters.
- Gateway
Security stringPolicy Optional. A fully-qualified GatewaySecurityPolicy URL reference. Defines how a server should apply security policy to inbound (VM to Proxy) initiated connections. For example:
projects/*/locations/*/gatewaySecurityPolicies/swg-policy
. This policy is specific to gateways of type 'SECURE_WEB_GATEWAY'.- Labels Dictionary<string, string>
Optional. Set of label tags associated with the Gateway resource.
- Name string
Name of the Gateway resource. It matches pattern
projects/*/locations/*/gateways/
.- Network string
Optional. The relative resource name identifying the VPC network that is using this configuration. For example:
projects/*/global/networks/network-1
. Currently, this field is specific to gateways of type 'SECURE_WEB_GATEWAY'.- 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
Optional. 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.
- Self
Link string Server-defined URL of this resource
- Server
Tls stringPolicy Optional. A fully-qualified ServerTLSPolicy URL reference. Specifies how TLS traffic is terminated. If empty, TLS termination is disabled.
- Subnetwork string
Optional. The relative resource name identifying the subnetwork in which this SWG is allocated. For example:
projects/*/regions/us-central1/subnetworks/network-1
Currently, this field is specific to gateways of type 'SECURE_WEB_GATEWAY".- Type string
Immutable. The type of the customer managed gateway. This field is required. If unspecified, an error is returned.
- Update
Time string The timestamp when the resource was updated.
- Addresses []string
Optional. Zero or one IPv4-address on which the Gateway will receive the traffic. When no address is provided, an IP from the subnetwork is allocated This field only applies to gateways of type 'SECURE_WEB_GATEWAY'. Gateways of type 'OPEN_MESH' listen on 0.0.0.0.
- Certificate
Urls []string Optional. A fully-qualified Certificates URL reference. The proxy presents a Certificate (selected based on SNI) when establishing a TLS connection. This feature only applies to gateways of type 'SECURE_WEB_GATEWAY'.
- Create
Time string The timestamp when the resource was created.
- Description string
Optional. A free-text description of the resource. Max length 1024 characters.
- Gateway
Security stringPolicy Optional. A fully-qualified GatewaySecurityPolicy URL reference. Defines how a server should apply security policy to inbound (VM to Proxy) initiated connections. For example:
projects/*/locations/*/gatewaySecurityPolicies/swg-policy
. This policy is specific to gateways of type 'SECURE_WEB_GATEWAY'.- Labels map[string]string
Optional. Set of label tags associated with the Gateway resource.
- Name string
Name of the Gateway resource. It matches pattern
projects/*/locations/*/gateways/
.- Network string
Optional. The relative resource name identifying the VPC network that is using this configuration. For example:
projects/*/global/networks/network-1
. Currently, this field is specific to gateways of type 'SECURE_WEB_GATEWAY'.- 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
Optional. 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.
- Self
Link string Server-defined URL of this resource
- Server
Tls stringPolicy Optional. A fully-qualified ServerTLSPolicy URL reference. Specifies how TLS traffic is terminated. If empty, TLS termination is disabled.
- Subnetwork string
Optional. The relative resource name identifying the subnetwork in which this SWG is allocated. For example:
projects/*/regions/us-central1/subnetworks/network-1
Currently, this field is specific to gateways of type 'SECURE_WEB_GATEWAY".- Type string
Immutable. The type of the customer managed gateway. This field is required. If unspecified, an error is returned.
- Update
Time string The timestamp when the resource was updated.
- addresses List<String>
Optional. Zero or one IPv4-address on which the Gateway will receive the traffic. When no address is provided, an IP from the subnetwork is allocated This field only applies to gateways of type 'SECURE_WEB_GATEWAY'. Gateways of type 'OPEN_MESH' listen on 0.0.0.0.
- certificate
Urls List<String> Optional. A fully-qualified Certificates URL reference. The proxy presents a Certificate (selected based on SNI) when establishing a TLS connection. This feature only applies to gateways of type 'SECURE_WEB_GATEWAY'.
- create
Time String The timestamp when the resource was created.
- description String
Optional. A free-text description of the resource. Max length 1024 characters.
- gateway
Security StringPolicy Optional. A fully-qualified GatewaySecurityPolicy URL reference. Defines how a server should apply security policy to inbound (VM to Proxy) initiated connections. For example:
projects/*/locations/*/gatewaySecurityPolicies/swg-policy
. This policy is specific to gateways of type 'SECURE_WEB_GATEWAY'.- labels Map<String,String>
Optional. Set of label tags associated with the Gateway resource.
- name String
Name of the Gateway resource. It matches pattern
projects/*/locations/*/gateways/
.- network String
Optional. The relative resource name identifying the VPC network that is using this configuration. For example:
projects/*/global/networks/network-1
. Currently, this field is specific to gateways of type 'SECURE_WEB_GATEWAY'.- 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
Optional. 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.
- self
Link String Server-defined URL of this resource
- server
Tls StringPolicy Optional. A fully-qualified ServerTLSPolicy URL reference. Specifies how TLS traffic is terminated. If empty, TLS termination is disabled.
- subnetwork String
Optional. The relative resource name identifying the subnetwork in which this SWG is allocated. For example:
projects/*/regions/us-central1/subnetworks/network-1
Currently, this field is specific to gateways of type 'SECURE_WEB_GATEWAY".- type String
Immutable. The type of the customer managed gateway. This field is required. If unspecified, an error is returned.
- update
Time String The timestamp when the resource was updated.
- addresses string[]
Optional. Zero or one IPv4-address on which the Gateway will receive the traffic. When no address is provided, an IP from the subnetwork is allocated This field only applies to gateways of type 'SECURE_WEB_GATEWAY'. Gateways of type 'OPEN_MESH' listen on 0.0.0.0.
- certificate
Urls string[] Optional. A fully-qualified Certificates URL reference. The proxy presents a Certificate (selected based on SNI) when establishing a TLS connection. This feature only applies to gateways of type 'SECURE_WEB_GATEWAY'.
- create
Time string The timestamp when the resource was created.
- description string
Optional. A free-text description of the resource. Max length 1024 characters.
- gateway
Security stringPolicy Optional. A fully-qualified GatewaySecurityPolicy URL reference. Defines how a server should apply security policy to inbound (VM to Proxy) initiated connections. For example:
projects/*/locations/*/gatewaySecurityPolicies/swg-policy
. This policy is specific to gateways of type 'SECURE_WEB_GATEWAY'.- labels {[key: string]: string}
Optional. Set of label tags associated with the Gateway resource.
- name string
Name of the Gateway resource. It matches pattern
projects/*/locations/*/gateways/
.- network string
Optional. The relative resource name identifying the VPC network that is using this configuration. For example:
projects/*/global/networks/network-1
. Currently, this field is specific to gateways of type 'SECURE_WEB_GATEWAY'.- 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
Optional. 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.
- self
Link string Server-defined URL of this resource
- server
Tls stringPolicy Optional. A fully-qualified ServerTLSPolicy URL reference. Specifies how TLS traffic is terminated. If empty, TLS termination is disabled.
- subnetwork string
Optional. The relative resource name identifying the subnetwork in which this SWG is allocated. For example:
projects/*/regions/us-central1/subnetworks/network-1
Currently, this field is specific to gateways of type 'SECURE_WEB_GATEWAY".- type string
Immutable. The type of the customer managed gateway. This field is required. If unspecified, an error is returned.
- update
Time string The timestamp when the resource was updated.
- addresses Sequence[str]
Optional. Zero or one IPv4-address on which the Gateway will receive the traffic. When no address is provided, an IP from the subnetwork is allocated This field only applies to gateways of type 'SECURE_WEB_GATEWAY'. Gateways of type 'OPEN_MESH' listen on 0.0.0.0.
- certificate_
urls Sequence[str] Optional. A fully-qualified Certificates URL reference. The proxy presents a Certificate (selected based on SNI) when establishing a TLS connection. This feature only applies to gateways of type 'SECURE_WEB_GATEWAY'.
- create_
time str The timestamp when the resource was created.
- description str
Optional. A free-text description of the resource. Max length 1024 characters.
- gateway_
security_ strpolicy Optional. A fully-qualified GatewaySecurityPolicy URL reference. Defines how a server should apply security policy to inbound (VM to Proxy) initiated connections. For example:
projects/*/locations/*/gatewaySecurityPolicies/swg-policy
. This policy is specific to gateways of type 'SECURE_WEB_GATEWAY'.- labels Mapping[str, str]
Optional. Set of label tags associated with the Gateway resource.
- name str
Name of the Gateway resource. It matches pattern
projects/*/locations/*/gateways/
.- network str
Optional. The relative resource name identifying the VPC network that is using this configuration. For example:
projects/*/global/networks/network-1
. Currently, this field is specific to gateways of type 'SECURE_WEB_GATEWAY'.- 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
Optional. 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.
- self_
link str Server-defined URL of this resource
- server_
tls_ strpolicy Optional. A fully-qualified ServerTLSPolicy URL reference. Specifies how TLS traffic is terminated. If empty, TLS termination is disabled.
- subnetwork str
Optional. The relative resource name identifying the subnetwork in which this SWG is allocated. For example:
projects/*/regions/us-central1/subnetworks/network-1
Currently, this field is specific to gateways of type 'SECURE_WEB_GATEWAY".- type str
Immutable. The type of the customer managed gateway. This field is required. If unspecified, an error is returned.
- update_
time str The timestamp when the resource was updated.
- addresses List<String>
Optional. Zero or one IPv4-address on which the Gateway will receive the traffic. When no address is provided, an IP from the subnetwork is allocated This field only applies to gateways of type 'SECURE_WEB_GATEWAY'. Gateways of type 'OPEN_MESH' listen on 0.0.0.0.
- certificate
Urls List<String> Optional. A fully-qualified Certificates URL reference. The proxy presents a Certificate (selected based on SNI) when establishing a TLS connection. This feature only applies to gateways of type 'SECURE_WEB_GATEWAY'.
- create
Time String The timestamp when the resource was created.
- description String
Optional. A free-text description of the resource. Max length 1024 characters.
- gateway
Security StringPolicy Optional. A fully-qualified GatewaySecurityPolicy URL reference. Defines how a server should apply security policy to inbound (VM to Proxy) initiated connections. For example:
projects/*/locations/*/gatewaySecurityPolicies/swg-policy
. This policy is specific to gateways of type 'SECURE_WEB_GATEWAY'.- labels Map<String>
Optional. Set of label tags associated with the Gateway resource.
- name String
Name of the Gateway resource. It matches pattern
projects/*/locations/*/gateways/
.- network String
Optional. The relative resource name identifying the VPC network that is using this configuration. For example:
projects/*/global/networks/network-1
. Currently, this field is specific to gateways of type 'SECURE_WEB_GATEWAY'.- 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
Optional. 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.
- self
Link String Server-defined URL of this resource
- server
Tls StringPolicy Optional. A fully-qualified ServerTLSPolicy URL reference. Specifies how TLS traffic is terminated. If empty, TLS termination is disabled.
- subnetwork String
Optional. The relative resource name identifying the subnetwork in which this SWG is allocated. For example:
projects/*/regions/us-central1/subnetworks/network-1
Currently, this field is specific to gateways of type 'SECURE_WEB_GATEWAY".- type String
Immutable. The type of the customer managed gateway. This field is required. If unspecified, an error is returned.
- update
Time String The timestamp when the resource was updated.
Package Details
- Repository
- Google Cloud Native pulumi/pulumi-google-native
- License
- Apache-2.0
Google Cloud Native is in preview. Google Cloud Classic is fully supported.