Skip to main content

target_https_proxies

Creates, updates, deletes, gets or lists a target_https_proxies resource.

Overview​

Nametarget_https_proxies
TypeResource
Idgoogle.compute.target_https_proxies

Fields​

The following fields are returned by SELECT queries:

NameDatatypeDescription
idstring (uint64)[Output Only] The unique identifier for the resource. This identifier is defined by the server.
namestringName of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply withRFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. (pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?)
authorizationPolicystringOptional. A URL referring to a networksecurity.AuthorizationPolicy resource that describes how the proxy should authorize inbound traffic. If left blank, access will not be restricted by an authorization policy. Refer to the AuthorizationPolicy resource for additional details. authorizationPolicy only applies to a globalTargetHttpsProxy attached toglobalForwardingRules with theloadBalancingScheme set to INTERNAL_SELF_MANAGED. Note: This field currently has no impact.
certificateMapstringURL of a certificate map that identifies a certificate map associated with the given target proxy. This field can only be set for Global external Application Load Balancer or Classic Application Load Balancer. For other products use Certificate Manager Certificates instead. If set, sslCertificates will be ignored. Accepted format is//certificatemanager.googleapis.com/projects/{project}/locations/{location}/certificateMaps/{resourceName}.
creationTimestampstringOutput only. [Output Only] Creation timestamp inRFC3339 text format.
descriptionstringAn optional description of this resource. Provide this property when you create the resource.
fingerprintstring (byte)Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a TargetHttpsProxy. An up-to-date fingerprint must be provided in order to patch the TargetHttpsProxy; otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the TargetHttpsProxy.
httpKeepAliveTimeoutSecinteger (int32)Specifies how long to keep a connection open, after completing a response, while there is no matching traffic (in seconds). If an HTTP keep-alive is not specified, a default value (610 seconds) will be used. For global external Application Load Balancers, the minimum allowed value is 5 seconds and the maximum allowed value is 1200 seconds. For classic Application Load Balancers, this option is not supported.
kindstringOutput only. [Output Only] Type of resource. Alwayscompute#targetHttpsProxy for target HTTPS proxies. (default: compute#targetHttpsProxy)
proxyBindbooleanThis field only applies when the forwarding rule that references this target proxy has a loadBalancingScheme set toINTERNAL_SELF_MANAGED. When this field is set to true, Envoy proxies set up inbound traffic interception and bind to the IP address and port specified in the forwarding rule. This is generally useful when using Traffic Director to configure Envoy as a gateway or middle proxy (in other words, not a sidecar proxy). The Envoy proxy listens for inbound requests and handles requests when it receives them. The default is false.
quicOverridestringSpecifies the QUIC override policy for this TargetHttpsProxy resource. This setting determines whether the load balancer attempts to negotiate QUIC with clients. You can specify NONE, ENABLE, orDISABLE. - When quic-override is set to NONE, Google manages whether QUIC is used. - When quic-override is set to ENABLE, the load balancer uses QUIC when possible. - When quic-override is set to DISABLE, the load balancer doesn't use QUIC. - If the quic-override flag is not specified,NONE is implied. (DISABLE, ENABLE, NONE)
regionstringOutput only. [Output Only] URL of the region where the regional TargetHttpsProxy resides. This field is not applicable to global TargetHttpsProxies.
selfLinkstring[Output Only] Server-defined URL for the resource.
serverTlsPolicystringOptional. A URL referring to a networksecurity.ServerTlsPolicy resource that describes how the proxy should authenticate inbound traffic. serverTlsPolicy only applies to a globalTargetHttpsProxy attached toglobalForwardingRules with theloadBalancingScheme set to INTERNAL_SELF_MANAGED or EXTERNAL orEXTERNAL_MANAGED or INTERNAL_MANAGED. It also applies to a regional TargetHttpsProxy attached to regional forwardingRules with theloadBalancingScheme set to EXTERNAL_MANAGED orINTERNAL_MANAGED. For details whichServerTlsPolicy resources are accepted withINTERNAL_SELF_MANAGED and which with EXTERNAL,INTERNAL_MANAGED, EXTERNAL_MANAGEDloadBalancingScheme consult ServerTlsPolicy documentation. If left blank, communications are not encrypted.
sslCertificatesarrayURLs to SslCertificate resources that are used to authenticate connections between users and the load balancer. At least one SSL certificate must be specified. SslCertificates do not apply when the load balancing scheme is set to INTERNAL_SELF_MANAGED. The URLs should refer to a SSL Certificate resource or Certificate Manager Certificate resource. Mixing Classic Certificates and Certificate Manager Certificates is not allowed. Certificate Manager Certificates must include the certificatemanager API namespace. Using Certificate Manager Certificates in this field is not supported by Global external Application Load Balancer or Classic Application Load Balancer, use certificate_map instead. Currently, you may specify up to 15 Classic SSL Certificates or up to 100 Certificate Manager Certificates. Certificate Manager Certificates accepted formats are: - //certificatemanager.googleapis.com/projects/{project}/locations/{location}/certificates/{resourceName}. - https://certificatemanager.googleapis.com/v1alpha1/projects/{project}/locations/{location}/certificates/{resourceName}.
sslPolicystringURL of SslPolicy resource that will be associated with the TargetHttpsProxy resource. If not set, the TargetHttpsProxy resource has no SSL policy configured.
tlsEarlyDatastringSpecifies whether TLS 1.3 0-RTT Data ("Early Data") should be accepted for this service. Early Data allows a TLS resumption handshake to include the initial application payload (a HTTP request) alongside the handshake, reducing the effective round trips to "zero". This applies to TLS 1.3 connections over TCP (HTTP/2) as well as over UDP (QUIC/h3). This can improve application performance, especially on networks where interruptions may be common, such as on mobile. Requests with Early Data will have the "Early-Data" HTTP header set on the request, with a value of "1", to allow the backend to determine whether Early Data was included. Note: TLS Early Data may allow requests to be replayed, as the data is sent to the backend before the handshake has fully completed. Applications that allow idempotent HTTP methods to make non-idempotent changes, such as a GET request updating a database, should not accept Early Data on those requests, and reject requests with the "Early-Data: 1" HTTP header by returning a HTTP 425 (Too Early) status code, in order to remain RFC compliant. The default value is DISABLED. (DISABLED, PERMISSIVE, STRICT, UNRESTRICTED)
urlMapstringA fully-qualified or valid partial URL to the UrlMap resource that defines the mapping from URL to the BackendService. For example, the following are all valid URLs for specifying a URL map: - https://www.googleapis.compute/v1/projects/project/global/urlMaps/url-map - projects/project/global/urlMaps/url-map - global/urlMaps/url-map

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectproject, region, targetHttpsProxyReturns the specified TargetHttpsProxy resource in the specified region.
listselectproject, regionreturnPartialSuccess, filter, maxResults, pageToken, orderByRetrieves the list of TargetHttpsProxy resources available
to the specified project in the specified region.
aggregated_listselectprojectreturnPartialSuccess, includeAllScopes, orderBy, maxResults, pageToken, filter, serviceProjectNumberRetrieves the list of all TargetHttpsProxy resources, regional and global,
available to the specified project.

To prevent failure, Google recommends that you set the
returnPartialSuccess parameter to true.
insertinsertproject, regionrequestIdCreates a TargetHttpsProxy resource in the specified project and region
using the data included in the request.
patchupdateproject, region, targetHttpsProxyrequestIdPatches the specified regional TargetHttpsProxy resource with the data
included in the request. This method supports PATCH
semantics and usesJSON merge
patch format and processing rules.
deletedeleteproject, region, targetHttpsProxyrequestIdDeletes the specified TargetHttpsProxy resource.
set_ssl_certificatesexecproject, region, targetHttpsProxyrequestIdReplaces SslCertificates for TargetHttpsProxy.
set_ssl_policyexecproject, targetHttpsProxyrequestIdSets the SSL policy for TargetHttpsProxy. The SSL policy specifies the
server-side support for SSL features. This affects connections between
clients and the HTTPS proxy load balancer. They do not affect the
connection between the load balancer and the backends.
set_quic_overrideexecproject, targetHttpsProxyrequestIdSets the QUIC override policy for TargetHttpsProxy.
set_certificate_mapexecproject, targetHttpsProxyrequestIdChanges the Certificate Map for TargetHttpsProxy.
set_url_mapexecproject, region, targetHttpsProxyrequestIdChanges the URL map for TargetHttpsProxy.

Parameters​

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
projectstring
regionstring
targetHttpsProxystring
filterstring
includeAllScopesboolean
maxResultsinteger (uint32)
orderBystring
pageTokenstring
requestIdstring
returnPartialSuccessboolean
serviceProjectNumberstring (int64)

SELECT examples​

Returns the specified TargetHttpsProxy resource in the specified region.

SELECT
id,
name,
authorizationPolicy,
certificateMap,
creationTimestamp,
description,
fingerprint,
httpKeepAliveTimeoutSec,
kind,
proxyBind,
quicOverride,
region,
selfLink,
serverTlsPolicy,
sslCertificates,
sslPolicy,
tlsEarlyData,
urlMap
FROM google.compute.target_https_proxies
WHERE project = '{{ project }}' -- required
AND region = '{{ region }}' -- required
AND targetHttpsProxy = '{{ targetHttpsProxy }}' -- required
;

INSERT examples​

Creates a TargetHttpsProxy resource in the specified project and region
using the data included in the request.

INSERT INTO google.compute.target_https_proxies (
data__urlMap,
data__fingerprint,
data__tlsEarlyData,
data__sslCertificates,
data__id,
data__selfLink,
data__description,
data__quicOverride,
data__authorizationPolicy,
data__certificateMap,
data__httpKeepAliveTimeoutSec,
data__serverTlsPolicy,
data__name,
data__sslPolicy,
data__proxyBind,
project,
region,
requestId
)
SELECT 
'{{ urlMap }}',
'{{ fingerprint }}',
'{{ tlsEarlyData }}',
'{{ sslCertificates }}',
'{{ id }}',
'{{ selfLink }}',
'{{ description }}',
'{{ quicOverride }}',
'{{ authorizationPolicy }}',
'{{ certificateMap }}',
{{ httpKeepAliveTimeoutSec }},
'{{ serverTlsPolicy }}',
'{{ name }}',
'{{ sslPolicy }}',
{{ proxyBind }},
'{{ project }}',
'{{ region }}',
'{{ requestId }}'
RETURNING
id,
name,
clientOperationId,
creationTimestamp,
description,
endTime,
error,
getVersionOperationMetadata,
httpErrorMessage,
httpErrorStatusCode,
insertTime,
instancesBulkInsertOperationMetadata,
kind,
operationGroupId,
operationType,
progress,
region,
selfLink,
setCommonInstanceMetadataOperationMetadata,
startTime,
status,
statusMessage,
targetId,
targetLink,
user,
warnings,
zone
;

UPDATE examples​

Patches the specified regional TargetHttpsProxy resource with the data
included in the request. This method supports PATCH
semantics and usesJSON merge
patch format and processing rules.

UPDATE google.compute.target_https_proxies
SET 
data__urlMap = '{{ urlMap }}',
data__fingerprint = '{{ fingerprint }}',
data__tlsEarlyData = '{{ tlsEarlyData }}',
data__sslCertificates = '{{ sslCertificates }}',
data__id = '{{ id }}',
data__selfLink = '{{ selfLink }}',
data__description = '{{ description }}',
data__quicOverride = '{{ quicOverride }}',
data__authorizationPolicy = '{{ authorizationPolicy }}',
data__certificateMap = '{{ certificateMap }}',
data__httpKeepAliveTimeoutSec = {{ httpKeepAliveTimeoutSec }},
data__serverTlsPolicy = '{{ serverTlsPolicy }}',
data__name = '{{ name }}',
data__sslPolicy = '{{ sslPolicy }}',
data__proxyBind = {{ proxyBind }}
WHERE 
project = '{{ project }}' --required
AND region = '{{ region }}' --required
AND targetHttpsProxy = '{{ targetHttpsProxy }}' --required
AND requestId = '{{ requestId}}'
RETURNING
id,
name,
clientOperationId,
creationTimestamp,
description,
endTime,
error,
getVersionOperationMetadata,
httpErrorMessage,
httpErrorStatusCode,
insertTime,
instancesBulkInsertOperationMetadata,
kind,
operationGroupId,
operationType,
progress,
region,
selfLink,
setCommonInstanceMetadataOperationMetadata,
startTime,
status,
statusMessage,
targetId,
targetLink,
user,
warnings,
zone;

DELETE examples​

Deletes the specified TargetHttpsProxy resource.

DELETE FROM google.compute.target_https_proxies
WHERE project = '{{ project }}' --required
AND region = '{{ region }}' --required
AND targetHttpsProxy = '{{ targetHttpsProxy }}' --required
AND requestId = '{{ requestId }}'
;

Lifecycle Methods​

Replaces SslCertificates for TargetHttpsProxy.

EXEC google.compute.target_https_proxies.set_ssl_certificates 
@project='{{ project }}' --required, 
@region='{{ region }}' --required, 
@targetHttpsProxy='{{ targetHttpsProxy }}' --required, 
@requestId='{{ requestId }}' 
@@json=
'{
"sslCertificates": "{{ sslCertificates }}"
}'
;