target_ssl_proxies

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

Overview

Name	target_ssl_proxies
Type	Resource
Id	google.compute.target_ssl_proxies

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
id	string (uint64)	[Output Only] The unique identifier for the resource. This identifier is defined by the server.
name	string	Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. 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?)
certificateMap	string	URL of a certificate map that identifies a certificate map associated with the given target proxy. This field can only be set for global target proxies. If set, sslCertificates will be ignored. Accepted format is //certificatemanager.googleapis.com/projects/{project }/locations/{location}/certificateMaps/{resourceName}.
creationTimestamp	string	[Output Only] Creation timestamp in RFC3339 text format.
description	string	An optional description of this resource. Provide this property when you create the resource.
kind	string	[Output Only] Type of the resource. Always compute#targetSslProxy for target SSL proxies. (default: compute#targetSslProxy)
proxyHeader	string	Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
selfLink	string	[Output Only] Server-defined URL for the resource.
service	string	URL to the BackendService resource.
sslCertificates	array	URLs to SslCertificate resources that are used to authenticate connections to Backends. At least one SSL certificate must be specified. Currently, you may specify up to 15 SSL certificates. sslCertificates do not apply when the load balancing scheme is set to INTERNAL_SELF_MANAGED.
sslPolicy	string	URL of SslPolicy resource that will be associated with the TargetSslProxy resource. If not set, the TargetSslProxy resource will not have any SSL policy configured.

list

Successful response

Name	Datatype	Description
id	string	[Output Only] Unique identifier for the resource; defined by the server.
items	array	A list of TargetSslProxy resources.
kind	string	Type of resource. (default: compute#targetSslProxyList)
nextPageToken	string	[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
selfLink	string	[Output Only] Server-defined URL for this resource.
warning	object	[Output Only] Informational warning message.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	project, targetSslProxy		Returns the specified TargetSslProxy resource.
list	select	project	filter, maxResults, orderBy, pageToken, returnPartialSuccess	Retrieves the list of TargetSslProxy resources available to the specified project.
insert	insert	project	requestId	Creates a TargetSslProxy resource in the specified project using the data included in the request.
delete	delete	project, targetSslProxy	requestId	Deletes the specified TargetSslProxy resource.
set_backend_service	exec	project, targetSslProxy	requestId	Changes the BackendService for TargetSslProxy.
set_ssl_certificates	exec	project, targetSslProxy	requestId	Changes SslCertificates for TargetSslProxy.
set_certificate_map	exec	project, targetSslProxy	requestId	Changes the Certificate Map for TargetSslProxy.
set_proxy_header	exec	project, targetSslProxy	requestId	Changes the ProxyHeaderType for TargetSslProxy.
set_ssl_policy	exec	project, targetSslProxy	requestId	Sets the SSL policy for TargetSslProxy. The SSL policy specifies the server-side support for SSL features. This affects connections between clients and the load balancer. They do not affect the connection between the load balancer and the backends.

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.

Name	Datatype	Description
project	string
targetSslProxy	string
filter	string
maxResults	integer (uint32)
orderBy	string
pageToken	string
requestId	string
returnPartialSuccess	boolean

SELECT examples

get

Returns the specified TargetSslProxy resource.

SELECT
id,
name,
certificateMap,
creationTimestamp,
description,
kind,
proxyHeader,
selfLink,
service,
sslCertificates,
sslPolicy
FROM google.compute.target_ssl_proxies
WHERE project = '{{ project }}' -- required
AND targetSslProxy = '{{ targetSslProxy }}' -- required;

list

Retrieves the list of TargetSslProxy resources available to the specified project.

SELECT
id,
items,
kind,
nextPageToken,
selfLink,
warning
FROM google.compute.target_ssl_proxies
WHERE project = '{{ project }}' -- required
AND filter = '{{ filter }}'
AND maxResults = '{{ maxResults }}'
AND orderBy = '{{ orderBy }}'
AND pageToken = '{{ pageToken }}'
AND returnPartialSuccess = '{{ returnPartialSuccess }}';

INSERT examples

insert

Creates a TargetSslProxy resource in the specified project using the data included in the request.

INSERT INTO google.compute.target_ssl_proxies (
data__kind,
data__id,
data__creationTimestamp,
data__name,
data__description,
data__selfLink,
data__service,
data__sslCertificates,
data__certificateMap,
data__proxyHeader,
data__sslPolicy,
project,
requestId
)
SELECT 
'{{ kind }}',
'{{ id }}',
'{{ creationTimestamp }}',
'{{ name }}',
'{{ description }}',
'{{ selfLink }}',
'{{ service }}',
'{{ sslCertificates }}',
'{{ certificateMap }}',
'{{ proxyHeader }}',
'{{ sslPolicy }}',
'{{ project }}',
'{{ requestId }}'
RETURNING
id,
name,
clientOperationId,
creationTimestamp,
description,
endTime,
error,
httpErrorMessage,
httpErrorStatusCode,
insertTime,
instancesBulkInsertOperationMetadata,
kind,
operationGroupId,
operationType,
progress,
region,
selfLink,
setCommonInstanceMetadataOperationMetadata,
startTime,
status,
statusMessage,
targetId,
targetLink,
user,
warnings,
zone
;

Manifest

# Description fields are for documentation purposes
- name: target_ssl_proxies
  props:
    - name: project
      value: string
      description: Required parameter for the target_ssl_proxies resource.
    - name: kind
      value: string
      description: >
        [Output Only] Type of the resource. Always compute#targetSslProxy for target SSL proxies.
        
      default: compute#targetSslProxy
    - name: id
      value: string
      description: >
        [Output Only] The unique identifier for the resource. This identifier is defined by the server.
        
    - name: creationTimestamp
      value: string
      description: >
        [Output Only] Creation timestamp in RFC3339 text format.
        
    - name: name
      value: string
      description: >
        Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. 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.
        
    - name: description
      value: string
      description: >
        An optional description of this resource. Provide this property when you create the resource.
        
    - name: selfLink
      value: string
      description: >
        [Output Only] Server-defined URL for the resource.
        
    - name: service
      value: string
      description: >
        URL to the BackendService resource.
        
    - name: sslCertificates
      value: array
      description: >
        URLs to SslCertificate resources that are used to authenticate connections to Backends. At least one SSL certificate must be specified. Currently, you may specify up to 15 SSL certificates. sslCertificates do not apply when the load balancing scheme is set to INTERNAL_SELF_MANAGED.
        
    - name: certificateMap
      value: string
      description: >
        URL of a certificate map that identifies a certificate map associated with the given target proxy. This field can only be set for global target proxies. If set, sslCertificates will be ignored. Accepted format is //certificatemanager.googleapis.com/projects/{project }/locations/{location}/certificateMaps/{resourceName}.
        
    - name: proxyHeader
      value: string
      description: >
        Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
        
      valid_values: ['NONE', 'PROXY_V1']
    - name: sslPolicy
      value: string
      description: >
        URL of SslPolicy resource that will be associated with the TargetSslProxy resource. If not set, the TargetSslProxy resource will not have any SSL policy configured.
        
    - name: requestId
      value: string

DELETE examples

delete

Deletes the specified TargetSslProxy resource.

DELETE FROM google.compute.target_ssl_proxies
WHERE project = '{{ project }}' --required
AND targetSslProxy = '{{ targetSslProxy }}' --required
AND requestId = '{{ requestId }}';

Lifecycle Methods

set_backend_service

Changes the BackendService for TargetSslProxy.

EXEC google.compute.target_ssl_proxies.set_backend_service 
@project='{{ project }}' --required, 
@targetSslProxy='{{ targetSslProxy }}' --required, 
@requestId='{{ requestId }}' 
@@json=
'{
"service": "{{ service }}"
}';

set_ssl_certificates

Changes SslCertificates for TargetSslProxy.

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

set_certificate_map

Changes the Certificate Map for TargetSslProxy.

EXEC google.compute.target_ssl_proxies.set_certificate_map 
@project='{{ project }}' --required, 
@targetSslProxy='{{ targetSslProxy }}' --required, 
@requestId='{{ requestId }}' 
@@json=
'{
"certificateMap": "{{ certificateMap }}"
}';

set_proxy_header

Changes the ProxyHeaderType for TargetSslProxy.

EXEC google.compute.target_ssl_proxies.set_proxy_header 
@project='{{ project }}' --required, 
@targetSslProxy='{{ targetSslProxy }}' --required, 
@requestId='{{ requestId }}' 
@@json=
'{
"proxyHeader": "{{ proxyHeader }}"
}';

set_ssl_policy

Sets the SSL policy for TargetSslProxy. The SSL policy specifies the server-side support for SSL features. This affects connections between clients and the load balancer. They do not affect the connection between the load balancer and the backends.

EXEC google.compute.target_ssl_proxies.set_ssl_policy 
@project='{{ project }}' --required, 
@targetSslProxy='{{ targetSslProxy }}' --required, 
@requestId='{{ requestId }}' 
@@json=
'{
"sslPolicy": "{{ sslPolicy }}"
}';