service_attachments

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

Overview

Name	service_attachments
Type	Resource
Id	google.compute.service_attachments

Fields

Name	Datatype	Description
id	string	[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 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.
description	string	An optional description of this resource. Provide this property when you create the resource.
connectedEndpoints	array	[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.
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.
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] Creation timestamp in RFC3339 text format.
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	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] Type of the resource. Always compute#serviceAttachment for service attachments.
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.
pscServiceAttachmentId	object
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] 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] Server-defined URL for the resource.
targetService	string	The URL of a service serving the endpoint identified by this service attachment.

Methods

Name	Accessible by	Required Params	Description
aggregated_list	SELECT	project	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.
get	SELECT	project, region, serviceAttachment	Returns the specified ServiceAttachment resource in the given scope.
list	SELECT	project, region	Lists the ServiceAttachments for a project in the given scope.
insert	INSERT	project, region	Creates a ServiceAttachment in the specified project in the given scope using the parameters that are included in the request.
delete	DELETE	project, region, serviceAttachment	Deletes the specified ServiceAttachment in the given scope
patch	UPDATE	project, region, serviceAttachment	Patches the specified ServiceAttachment resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.

SELECT examples

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,
description,
connectedEndpoints,
connectionPreference,
consumerAcceptLists,
consumerRejectLists,
creationTimestamp,
domainNames,
enableProxyProtocol,
fingerprint,
kind,
natSubnets,
producerForwardingRule,
pscServiceAttachmentId,
reconcileConnections,
region,
selfLink,
targetService
FROM google.compute.service_attachments
WHERE project = '{{ project }}';

INSERT example

Use the following StackQL query and manifest file to create a new service_attachments resource.

All Properties

/*+ create */
INSERT INTO google.compute.service_attachments (
project,
region,
name,
description,
region,
producerForwardingRule,
targetService,
connectionPreference,
connectedEndpoints,
natSubnets,
enableProxyProtocol,
consumerRejectLists,
consumerAcceptLists,
pscServiceAttachmentId,
fingerprint,
domainNames,
reconcileConnections
)
SELECT 
'{{ project }}',
'{{ region }}',
'{{ name }}',
'{{ description }}',
'{{ region }}',
'{{ producerForwardingRule }}',
'{{ targetService }}',
'{{ connectionPreference }}',
'{{ connectedEndpoints }}',
'{{ natSubnets }}',
{{ enableProxyProtocol }},
'{{ consumerRejectLists }}',
'{{ consumerAcceptLists }}',
'{{ pscServiceAttachmentId }}',
'{{ fingerprint }}',
'{{ domainNames }}',
{{ reconcileConnections }}
;

Manifest

- name: your_resource_model_name
  props:
    - name: kind
      value: string
    - name: id
      value: string
    - name: creationTimestamp
      value: string
    - name: name
      value: string
    - name: description
      value: string
    - name: selfLink
      value: string
    - name: region
      value: string
    - name: producerForwardingRule
      value: string
    - name: targetService
      value: string
    - name: connectionPreference
      value: string
    - name: connectedEndpoints
      value:
        - - name: status
            value: string
          - name: pscConnectionId
            value: string
          - name: endpoint
            value: string
          - name: consumerNetwork
            value: string
    - name: natSubnets
      value:
        - string
    - name: enableProxyProtocol
      value: boolean
    - name: consumerRejectLists
      value:
        - string
    - name: consumerAcceptLists
      value:
        - - name: projectIdOrNum
            value: string
          - name: networkUrl
            value: string
          - name: connectionLimit
            value: integer
    - name: pscServiceAttachmentId
      value:
        - name: high
          value: string
        - name: low
          value: string
    - name: fingerprint
      value: string
    - name: domainNames
      value:
        - string
    - name: reconcileConnections
      value: boolean

UPDATE example

Updates a service_attachments resource.

/*+ update */
UPDATE google.compute.service_attachments
SET 
name = '{{ name }}',
description = '{{ description }}',
region = '{{ region }}',
producerForwardingRule = '{{ producerForwardingRule }}',
targetService = '{{ targetService }}',
connectionPreference = '{{ connectionPreference }}',
connectedEndpoints = '{{ connectedEndpoints }}',
natSubnets = '{{ natSubnets }}',
enableProxyProtocol = true|false,
consumerRejectLists = '{{ consumerRejectLists }}',
consumerAcceptLists = '{{ consumerAcceptLists }}',
pscServiceAttachmentId = '{{ pscServiceAttachmentId }}',
fingerprint = '{{ fingerprint }}',
domainNames = '{{ domainNames }}',
reconcileConnections = true|false
WHERE 
project = '{{ project }}'
AND region = '{{ region }}'
AND serviceAttachment = '{{ serviceAttachment }}';

DELETE example

Deletes the specified service_attachments resource.

/*+ delete */
DELETE FROM google.compute.service_attachments
WHERE project = '{{ project }}'
AND region = '{{ region }}'
AND serviceAttachment = '{{ serviceAttachment }}';