service_attachments

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

Overview

Name	service_attachments
Type	Resource
Id	google.compute.service_attachments

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string (uint64)	Output only. [Output Only] The unique identifier for the resource type. The server generates this identifier.
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 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])?)
connectedEndpoints	array	Output only. [Output Only] An array of connections for all the consumers connected to this service attachment.
connectionPreference	string	The connection preference of service attachment. The value can be set to ACCEPT_AUTOMATIC. An ACCEPT_AUTOMATIC service attachment is one that always accepts the connection from consumer forwarding rules. (ACCEPT_AUTOMATIC, ACCEPT_MANUAL, CONNECTION_PREFERENCE_UNSPECIFIED)
consumerAcceptLists	array	Specifies which consumer projects or networks are allowed to connect to the service attachment. Each project or network has a connection limit. A given service attachment can manage connections at either the project or network level. Therefore, both the accept and reject lists for a given service attachment must contain either only projects or only networks or only endpoints.
consumerRejectLists	array	Specifies a list of projects or networks that are not allowed to connect to this service attachment. The project can be specified using its project ID or project number and the network can be specified using its URL. A given service attachment can manage connections at either the project or network level. Therefore, both the reject and accept lists for a given service attachment must contain either only projects or only networks.
creationTimestamp	string	Output only. [Output Only] Creation timestamp inRFC3339 text format.
description	string	An optional description of this resource. Provide this property when you create the resource.
domainNames	array	If specified, the domain name will be used during the integration between the PSC connected endpoints and the Cloud DNS. For example, this is a valid domain name: "p.mycompany.com.". Current max number of domain names supported is 1.
enableProxyProtocol	boolean	If true, enable the proxy protocol which is for supplying client TCP/IP address data in TCP connections that traverse proxies on their way to destination servers.
fingerprint	string (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 ServiceAttachment. An up-to-date fingerprint must be provided in order to patch/update the ServiceAttachment; otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the ServiceAttachment.
kind	string	Output only. [Output Only] Type of the resource. Alwayscompute#serviceAttachment for service attachments. (default: compute#serviceAttachment)
metadata	object	Metadata of the service attachment.
natIpsPerEndpoint	integer (uint32)	The number of NAT IP addresses to be allocated per connected endpoint. If not specified, the default value is 1.
natSubnets	array	An array of URLs where each entry is the URL of a subnet provided by the service producer to use for NAT in this service attachment.
producerForwardingRule	string	The URL of a forwarding rule with loadBalancingScheme INTERNAL* that is serving the endpoint identified by this service attachment.
propagatedConnectionLimit	integer (uint32)	The number of consumer spokes that connected Private Service Connect endpoints can be propagated to through Network Connectivity Center. This limit lets the service producer limit how many propagated Private Service Connect connections can be established to this service attachment from a single consumer. If the connection preference of the service attachment is ACCEPT_MANUAL, the limit applies to each project or network that is listed in the consumer accept list. If the connection preference of the service attachment is ACCEPT_AUTOMATIC, the limit applies to each project that contains a connected endpoint. If unspecified, the default propagated connection limit is 250.
pscServiceAttachmentId	object	Output only. [Output Only] An 128-bit global unique ID of the PSC service attachment. (id: Uint128)
reconcileConnections	boolean	This flag determines whether a consumer accept/reject list change can reconcile the statuses of existing ACCEPTED or REJECTED PSC endpoints. - If false, connection policy update will only affect existing PENDING PSC endpoints. Existing ACCEPTED/REJECTED endpoints will remain untouched regardless how the connection policy is modified . - If true, update will affect both PENDING and ACCEPTED/REJECTED PSC endpoints. For example, an ACCEPTED PSC endpoint will be moved to REJECTED if its project is added to the reject list. For newly created service attachment, this boolean defaults to false.
region	string	Output only. [Output Only] URL of the region where the service attachment resides. This field applies only to the region resource. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
selfLink	string	Output only. [Output Only] Server-defined URL for the resource.
targetService	string	The URL of a service serving the endpoint identified by this service attachment.

list

Name	Datatype	Description
id	string	[Output Only] Unique identifier for the resource; defined by the server.
items	array	A list of ServiceAttachment resources.
kind	string	Output only. [Output Only] Type of the resource. Alwayscompute#serviceAttachment for service attachments. (default: compute#serviceAttachmentList)
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 thanmaxResults, 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.

aggregated_list

Name	Datatype	Description
id	string (uint64)	Output only. [Output Only] The unique identifier for the resource type. The server generates this identifier.
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 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])?)
connectedEndpoints	array	Output only. [Output Only] An array of connections for all the consumers connected to this service attachment.
connectionPreference	string	The connection preference of service attachment. The value can be set to ACCEPT_AUTOMATIC. An ACCEPT_AUTOMATIC service attachment is one that always accepts the connection from consumer forwarding rules. (ACCEPT_AUTOMATIC, ACCEPT_MANUAL, CONNECTION_PREFERENCE_UNSPECIFIED)
consumerAcceptLists	array	Specifies which consumer projects or networks are allowed to connect to the service attachment. Each project or network has a connection limit. A given service attachment can manage connections at either the project or network level. Therefore, both the accept and reject lists for a given service attachment must contain either only projects or only networks or only endpoints.
consumerRejectLists	array	Specifies a list of projects or networks that are not allowed to connect to this service attachment. The project can be specified using its project ID or project number and the network can be specified using its URL. A given service attachment can manage connections at either the project or network level. Therefore, both the reject and accept lists for a given service attachment must contain either only projects or only networks.
creationTimestamp	string	Output only. [Output Only] Creation timestamp inRFC3339 text format.
description	string	An optional description of this resource. Provide this property when you create the resource.
domainNames	array	If specified, the domain name will be used during the integration between the PSC connected endpoints and the Cloud DNS. For example, this is a valid domain name: "p.mycompany.com.". Current max number of domain names supported is 1.
enableProxyProtocol	boolean	If true, enable the proxy protocol which is for supplying client TCP/IP address data in TCP connections that traverse proxies on their way to destination servers.
fingerprint	string (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 ServiceAttachment. An up-to-date fingerprint must be provided in order to patch/update the ServiceAttachment; otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the ServiceAttachment.
kind	string	Output only. [Output Only] Type of the resource. Alwayscompute#serviceAttachment for service attachments. (default: compute#serviceAttachment)
metadata	object	Metadata of the service attachment.
natIpsPerEndpoint	integer (uint32)	The number of NAT IP addresses to be allocated per connected endpoint. If not specified, the default value is 1.
natSubnets	array	An array of URLs where each entry is the URL of a subnet provided by the service producer to use for NAT in this service attachment.
producerForwardingRule	string	The URL of a forwarding rule with loadBalancingScheme INTERNAL* that is serving the endpoint identified by this service attachment.
propagatedConnectionLimit	integer (uint32)	The number of consumer spokes that connected Private Service Connect endpoints can be propagated to through Network Connectivity Center. This limit lets the service producer limit how many propagated Private Service Connect connections can be established to this service attachment from a single consumer. If the connection preference of the service attachment is ACCEPT_MANUAL, the limit applies to each project or network that is listed in the consumer accept list. If the connection preference of the service attachment is ACCEPT_AUTOMATIC, the limit applies to each project that contains a connected endpoint. If unspecified, the default propagated connection limit is 250.
pscServiceAttachmentId	object	Output only. [Output Only] An 128-bit global unique ID of the PSC service attachment. (id: Uint128)
reconcileConnections	boolean	This flag determines whether a consumer accept/reject list change can reconcile the statuses of existing ACCEPTED or REJECTED PSC endpoints. - If false, connection policy update will only affect existing PENDING PSC endpoints. Existing ACCEPTED/REJECTED endpoints will remain untouched regardless how the connection policy is modified . - If true, update will affect both PENDING and ACCEPTED/REJECTED PSC endpoints. For example, an ACCEPTED PSC endpoint will be moved to REJECTED if its project is added to the reject list. For newly created service attachment, this boolean defaults to false.
region	string	Output only. [Output Only] URL of the region where the service attachment resides. This field applies only to the region resource. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
selfLink	string	Output only. [Output Only] Server-defined URL for the resource.
targetService	string	The URL of a service serving the endpoint identified by this service attachment.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	project, region, serviceAttachment	showNatIps	Returns the specified ServiceAttachment resource in the given scope.
list	select	project, region	returnPartialSuccess, maxResults, pageToken, filter, orderBy	Lists the ServiceAttachments for a project in the given scope.
aggregated_list	select	project	returnPartialSuccess, includeAllScopes, orderBy, maxResults, pageToken, filter, serviceProjectNumber	Retrieves the list of all ServiceAttachment resources, regional and global, available to the specified project. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.
insert	insert	project, region	requestId	Creates a ServiceAttachment in the specified project in the given scope using the parameters that are included in the request.
patch	update	project, region, serviceAttachment	requestId	Patches the specified ServiceAttachment resource with the data included in the request. This method supports PATCH semantics and usesJSON merge patch format and processing rules.
delete	delete	project, region, serviceAttachment	requestId	Deletes the specified ServiceAttachment in the given scope

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
region	string
serviceAttachment	string
filter	string
includeAllScopes	boolean
maxResults	integer (uint32)
orderBy	string
pageToken	string
requestId	string
returnPartialSuccess	boolean
serviceProjectNumber	string (int64)
showNatIps	boolean

SELECT examples

get

Returns the specified ServiceAttachment resource in the given scope.

SELECT
id,
name,
connectedEndpoints,
connectionPreference,
consumerAcceptLists,
consumerRejectLists,
creationTimestamp,
description,
domainNames,
enableProxyProtocol,
fingerprint,
kind,
metadata,
natIpsPerEndpoint,
natSubnets,
producerForwardingRule,
propagatedConnectionLimit,
pscServiceAttachmentId,
reconcileConnections,
region,
selfLink,
targetService
FROM google.compute.service_attachments
WHERE project = '{{ project }}' -- required
AND region = '{{ region }}' -- required
AND serviceAttachment = '{{ serviceAttachment }}' -- required
AND showNatIps = '{{ showNatIps }}'
;

list

Lists the ServiceAttachments for a project in the given scope.

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

aggregated_list

Retrieves the list of all ServiceAttachment resources,
regional and global, available to the specified project.

To prevent failure, Google recommends that you set the
returnPartialSuccess parameter to true.

SELECT
id,
name,
connectedEndpoints,
connectionPreference,
consumerAcceptLists,
consumerRejectLists,
creationTimestamp,
description,
domainNames,
enableProxyProtocol,
fingerprint,
kind,
metadata,
natIpsPerEndpoint,
natSubnets,
producerForwardingRule,
propagatedConnectionLimit,
pscServiceAttachmentId,
reconcileConnections,
region,
selfLink,
targetService
FROM google.compute.service_attachments
WHERE project = '{{ project }}' -- required
AND returnPartialSuccess = '{{ returnPartialSuccess }}'
AND includeAllScopes = '{{ includeAllScopes }}'
AND orderBy = '{{ orderBy }}'
AND maxResults = '{{ maxResults }}'
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}'
AND serviceProjectNumber = '{{ serviceProjectNumber }}'
;

INSERT examples

insert

Creates a ServiceAttachment in the specified project in the given scope
using the parameters that are included in the request.

INSERT INTO google.compute.service_attachments (
data__description,
data__domainNames,
data__consumerAcceptLists,
data__enableProxyProtocol,
data__name,
data__natIpsPerEndpoint,
data__consumerRejectLists,
data__connectionPreference,
data__targetService,
data__metadata,
data__producerForwardingRule,
data__natSubnets,
data__reconcileConnections,
data__propagatedConnectionLimit,
data__fingerprint,
project,
region,
requestId
)
SELECT 
'{{ description }}',
'{{ domainNames }}',
'{{ consumerAcceptLists }}',
{{ enableProxyProtocol }},
'{{ name }}',
{{ natIpsPerEndpoint }},
'{{ consumerRejectLists }}',
'{{ connectionPreference }}',
'{{ targetService }}',
'{{ metadata }}',
'{{ producerForwardingRule }}',
'{{ natSubnets }}',
{{ reconcileConnections }},
{{ propagatedConnectionLimit }},
'{{ fingerprint }}',
'{{ 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
;

Manifest

# Description fields are for documentation purposes
- name: service_attachments
props:
  - name: project
    value: "{{ project }}"
    description: Required parameter for the service_attachments resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the service_attachments resource.
  - name: description
    value: "{{ description }}"
    description: |
      An optional description of this resource. Provide this property when you
      create the resource.
  - name: domainNames
    value:
      - "{{ domainNames }}"
    description: |
      If specified, the domain name will be used during the integration between
      the PSC connected endpoints and the Cloud DNS. For example, this is a valid
      domain name: "p.mycompany.com.". Current max number of domain names
      supported is 1.
  - name: consumerAcceptLists
    description: |
      Specifies which consumer projects or networks are allowed to connect to the
      service attachment. Each project or network has a connection limit. A given
      service attachment can manage connections at either the project or network
      level. Therefore, both the accept and reject lists for a given service
      attachment must contain either only projects or only networks or only
      endpoints.
    value:
      - endpointUrl: "{{ endpointUrl }}"
        networkUrl: "{{ networkUrl }}"
        projectIdOrNum: "{{ projectIdOrNum }}"
        connectionLimit: {{ connectionLimit }}
  - name: enableProxyProtocol
    value: {{ enableProxyProtocol }}
    description: |
      If true, enable the proxy protocol which is for supplying client TCP/IP
      address data in TCP connections that traverse proxies on their way to
      destination servers.
  - name: name
    value: "{{ name }}"
    description: |
      Name 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.
  - name: natIpsPerEndpoint
    value: {{ natIpsPerEndpoint }}
    description: |
      The number of NAT IP addresses to be allocated per connected endpoint.
      If not specified, the default value is 1.
  - name: consumerRejectLists
    value:
      - "{{ consumerRejectLists }}"
    description: |
      Specifies a list of projects or networks that are not allowed to connect to
      this service attachment. The project can be specified using its project ID
      or project number and the network can be specified using its URL. A given
      service attachment can manage connections at either the project or network
      level. Therefore, both the reject and accept lists for a given service
      attachment must contain either only projects or only networks.
  - name: connectionPreference
    value: "{{ connectionPreference }}"
    description: |
      The connection preference of service attachment. The value can be set
      to ACCEPT_AUTOMATIC. An ACCEPT_AUTOMATIC
      service attachment is one that always accepts the connection from consumer
      forwarding rules.
    valid_values: ['ACCEPT_AUTOMATIC', 'ACCEPT_MANUAL', 'CONNECTION_PREFERENCE_UNSPECIFIED']
  - name: targetService
    value: "{{ targetService }}"
    description: |
      The URL of a service serving the endpoint identified by this service
      attachment.
  - name: metadata
    value: "{{ metadata }}"
    description: |
      Metadata of the service attachment.
  - name: producerForwardingRule
    value: "{{ producerForwardingRule }}"
    description: |
      The URL of a forwarding rule with loadBalancingScheme INTERNAL* that is
      serving the endpoint identified by this service attachment.
  - name: natSubnets
    value:
      - "{{ natSubnets }}"
    description: |
      An array of URLs where each entry is the URL of a subnet provided
      by the service producer to use for NAT in this service attachment.
  - name: reconcileConnections
    value: {{ reconcileConnections }}
    description: |
      This flag determines whether a consumer accept/reject list change can
      reconcile the statuses of existing ACCEPTED or REJECTED PSC endpoints.
      -  If false, connection policy update will only affect existing PENDING
      PSC endpoints. Existing ACCEPTED/REJECTED endpoints will remain untouched
      regardless how the connection policy is modified .
      -  If true,
      update will affect both PENDING and ACCEPTED/REJECTED PSC endpoints. For
      example, an ACCEPTED PSC endpoint will be moved to REJECTED if its project
      is added to the reject list.
      For newly created service attachment, this boolean defaults to false.
  - name: propagatedConnectionLimit
    value: {{ propagatedConnectionLimit }}
    description: |
      The number of consumer spokes that connected Private Service Connect
      endpoints can be propagated to through Network Connectivity Center. This
      limit lets the service producer limit how many propagated Private Service
      Connect connections can be established to this service attachment from a
      single consumer.
      If the connection preference of the service attachment is ACCEPT_MANUAL,
      the limit applies to each project or network that is listed in the consumer
      accept list. If the connection preference of the service attachment is
      ACCEPT_AUTOMATIC, the limit applies to each project that contains a
      connected endpoint.
      If unspecified, the default propagated connection limit is 250.
  - name: fingerprint
    value: "{{ fingerprint }}"
    description: |
      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 ServiceAttachment. An up-to-date fingerprint must
      be provided in order to patch/update the ServiceAttachment; otherwise, the
      request will fail with error 412 conditionNotMet. To see the
      latest fingerprint, make a get() request to retrieve the
      ServiceAttachment.
  - name: requestId
    value: "{{ requestId }}"

UPDATE examples

patch

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

UPDATE google.compute.service_attachments
SET 
data__description = '{{ description }}',
data__domainNames = '{{ domainNames }}',
data__consumerAcceptLists = '{{ consumerAcceptLists }}',
data__enableProxyProtocol = {{ enableProxyProtocol }},
data__name = '{{ name }}',
data__natIpsPerEndpoint = {{ natIpsPerEndpoint }},
data__consumerRejectLists = '{{ consumerRejectLists }}',
data__connectionPreference = '{{ connectionPreference }}',
data__targetService = '{{ targetService }}',
data__metadata = '{{ metadata }}',
data__producerForwardingRule = '{{ producerForwardingRule }}',
data__natSubnets = '{{ natSubnets }}',
data__reconcileConnections = {{ reconcileConnections }},
data__propagatedConnectionLimit = {{ propagatedConnectionLimit }},
data__fingerprint = '{{ fingerprint }}'
WHERE 
project = '{{ project }}' --required
AND region = '{{ region }}' --required
AND serviceAttachment = '{{ serviceAttachment }}' --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

delete

Deletes the specified ServiceAttachment in the given scope

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