instances

Creates, updates, deletes, gets or lists an instances resource.

Overview

Name	instances
Type	Resource
Id	google.securesourcemanager.instances

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
name	string	Optional. A unique identifier for an instance. The name should be of the format: projects/{project_number}/locations/{location_id}/instances/{instance_id} project_number: Maps to a unique int64 id assigned to each project. location_id: Refers to the region where the instance will be deployed. Since Secure Source Manager is a regional service, it must be one of the valid GCP regions. instance_id: User provided name for the instance, must be unique for a project_number and location_id combination.
createTime	string (google-datetime)	Output only. Create timestamp.
hostConfig	object	Output only. A list of hostnames for this instance. (id: HostConfig)
kmsKey	string	Optional. Immutable. Customer-managed encryption key name, in the format projects//locations//keyRings//cryptoKeys/.
labels	object	Optional. Labels as key value pairs.
privateConfig	object	Optional. Private settings for private instance. (id: PrivateConfig)
state	string	Output only. Current state of the instance.
stateNote	string	Output only. An optional field providing information about the current instance state.
updateTime	string (google-datetime)	Output only. Update timestamp.
workforceIdentityFederationConfig	object	Optional. Configuration for Workforce Identity Federation to support third party identity provider. If unset, defaults to the Google OIDC IdP. (id: WorkforceIdentityFederationConfig)

list

Successful response

Name	Datatype	Description
name	string	Optional. A unique identifier for an instance. The name should be of the format: projects/{project_number}/locations/{location_id}/instances/{instance_id} project_number: Maps to a unique int64 id assigned to each project. location_id: Refers to the region where the instance will be deployed. Since Secure Source Manager is a regional service, it must be one of the valid GCP regions. instance_id: User provided name for the instance, must be unique for a project_number and location_id combination.
createTime	string (google-datetime)	Output only. Create timestamp.
hostConfig	object	Output only. A list of hostnames for this instance. (id: HostConfig)
kmsKey	string	Optional. Immutable. Customer-managed encryption key name, in the format projects//locations//keyRings//cryptoKeys/.
labels	object	Optional. Labels as key value pairs.
privateConfig	object	Optional. Private settings for private instance. (id: PrivateConfig)
state	string	Output only. Current state of the instance.
stateNote	string	Output only. An optional field providing information about the current instance state.
updateTime	string (google-datetime)	Output only. Update timestamp.
workforceIdentityFederationConfig	object	Optional. Configuration for Workforce Identity Federation to support third party identity provider. If unset, defaults to the Google OIDC IdP. (id: WorkforceIdentityFederationConfig)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, instancesId		Gets details of a single instance.
list	select	projectsId, locationsId	pageSize, pageToken, filter, orderBy	Lists Instances in a given project and location.
create	insert	projectsId, locationsId	instanceId, requestId	Creates a new instance in a given project and location.
delete	delete	projectsId, locationsId, instancesId	requestId	Deletes a single instance.

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
instancesId	string
locationsId	string
projectsId	string
filter	string
instanceId	string
orderBy	string
pageSize	integer (int32)
pageToken	string
requestId	string

SELECT examples

get

Gets details of a single instance.

SELECT
name,
createTime,
hostConfig,
kmsKey,
labels,
privateConfig,
state,
stateNote,
updateTime,
workforceIdentityFederationConfig
FROM google.securesourcemanager.instances
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND instancesId = '{{ instancesId }}' -- required;

list

Lists Instances in a given project and location.

SELECT
name,
createTime,
hostConfig,
kmsKey,
labels,
privateConfig,
state,
stateNote,
updateTime,
workforceIdentityFederationConfig
FROM google.securesourcemanager.instances
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}'
AND orderBy = '{{ orderBy }}';

INSERT examples

create

Creates a new instance in a given project and location.

INSERT INTO google.securesourcemanager.instances (
data__name,
data__labels,
data__privateConfig,
data__kmsKey,
data__workforceIdentityFederationConfig,
projectsId,
locationsId,
instanceId,
requestId
)
SELECT 
'{{ name }}',
'{{ labels }}',
'{{ privateConfig }}',
'{{ kmsKey }}',
'{{ workforceIdentityFederationConfig }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ instanceId }}',
'{{ requestId }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: instances
  props:
    - name: projectsId
      value: string
      description: Required parameter for the instances resource.
    - name: locationsId
      value: string
      description: Required parameter for the instances resource.
    - name: name
      value: string
      description: >
        Optional. A unique identifier for an instance. The name should be of the format: `projects/{project_number}/locations/{location_id}/instances/{instance_id}` `project_number`: Maps to a unique int64 id assigned to each project. `location_id`: Refers to the region where the instance will be deployed. Since Secure Source Manager is a regional service, it must be one of the valid GCP regions. `instance_id`: User provided name for the instance, must be unique for a project_number and location_id combination.
        
    - name: labels
      value: object
      description: >
        Optional. Labels as key value pairs.
        
    - name: privateConfig
      value: object
      description: >
        Optional. Private settings for private instance.
        
    - name: kmsKey
      value: string
      description: >
        Optional. Immutable. Customer-managed encryption key name, in the format projects/*/locations/*/keyRings/*/cryptoKeys/*.
        
    - name: workforceIdentityFederationConfig
      value: object
      description: >
        Optional. Configuration for Workforce Identity Federation to support third party identity provider. If unset, defaults to the Google OIDC IdP.
        
    - name: instanceId
      value: string
    - name: requestId
      value: string

DELETE examples

delete

Deletes a single instance.

DELETE FROM google.securesourcemanager.instances
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND instancesId = '{{ instancesId }}' --required
AND requestId = '{{ requestId }}';