targetservers

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

Overview

Name	targetservers
Type	Resource
Id	google.apigee.targetservers

Fields

Name	Datatype	Description
name	string	Required. The resource id of this target server. Values must match the regular expression
description	string	Optional. A human-readable description of this TargetServer.
host	string	Required. The host name this target connects to. Value must be a valid hostname as described by RFC-1123.
isEnabled	boolean	Optional. Enabling/disabling a TargetServer is useful when TargetServers are used in load balancing configurations, and one or more TargetServers need to taken out of rotation periodically. Defaults to true.
port	integer	Required. The port number this target connects to on the given host. Value must be between 1 and 65535, inclusive.
protocol	string	Immutable. The protocol used by this TargetServer.
sSLInfo	object	TLS configuration information for virtual hosts and TargetServers.

Methods

Name	Accessible by	Required Params	Description
organizations_environments_targetservers_get	SELECT	environmentsId, organizationsId, targetserversId	Gets a TargetServer resource.
organizations_environments_targetservers_create	INSERT	environmentsId, organizationsId	Creates a TargetServer in the specified environment.
organizations_environments_targetservers_delete	DELETE	environmentsId, organizationsId, targetserversId	Deletes a TargetServer from an environment. Returns the deleted TargetServer resource.
organizations_environments_targetservers_update	REPLACE	environmentsId, organizationsId, targetserversId	Updates an existing TargetServer. Note that this operation has PUT semantics; it will replace the entirety of the existing TargetServer with the resource in the request body.

SELECT examples

Gets a TargetServer resource.

SELECT
name,
description,
host,
isEnabled,
port,
protocol,
sSLInfo
FROM google.apigee.targetservers
WHERE environmentsId = '{{ environmentsId }}'
AND organizationsId = '{{ organizationsId }}'
AND targetserversId = '{{ targetserversId }}';

INSERT example

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

All Properties

/*+ create */
INSERT INTO google.apigee.targetservers (
environmentsId,
organizationsId,
isEnabled,
port,
description,
sSLInfo,
host,
protocol,
name
)
SELECT 
'{{ environmentsId }}',
'{{ organizationsId }}',
{{ isEnabled }},
'{{ port }}',
'{{ description }}',
'{{ sSLInfo }}',
'{{ host }}',
'{{ protocol }}',
'{{ name }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: isEnabled
      value: boolean
    - name: port
      value: integer
    - name: description
      value: string
    - name: sSLInfo
      value:
        - name: trustStore
          value: string
        - name: commonName
          value:
            - name: value
              value: string
            - name: wildcardMatch
              value: boolean
        - name: keyAlias
          value: string
        - name: ignoreValidationErrors
          value: boolean
        - name: ciphers
          value:
            - string
        - name: protocols
          value:
            - string
        - name: enforce
          value: boolean
        - name: clientAuthEnabled
          value: boolean
        - name: enabled
          value: boolean
        - name: keyStore
          value: string
    - name: host
      value: string
    - name: protocol
      value: string
    - name: name
      value: string

REPLACE example

Replaces all fields in the specified targetservers resource.

/*+ update */
REPLACE google.apigee.targetservers
SET 
isEnabled = true|false,
port = '{{ port }}',
description = '{{ description }}',
sSLInfo = '{{ sSLInfo }}',
host = '{{ host }}',
protocol = '{{ protocol }}',
name = '{{ name }}'
WHERE 
environmentsId = '{{ environmentsId }}'
AND organizationsId = '{{ organizationsId }}'
AND targetserversId = '{{ targetserversId }}';

DELETE example

Deletes the specified targetservers resource.

/*+ delete */
DELETE FROM google.apigee.targetservers
WHERE environmentsId = '{{ environmentsId }}'
AND organizationsId = '{{ organizationsId }}'
AND targetserversId = '{{ targetserversId }}';