user_workloads_secrets

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

Overview

Name	user_workloads_secrets
Type	Resource
Id	google.composer.user_workloads_secrets

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
name	string	Identifier. The resource name of the Secret, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}/userWorkloadsSecrets/{userWorkloadsSecretId}"
data	object	Optional. The "data" field of Kubernetes Secret, organized in key-value pairs, which can contain sensitive values such as a password, a token, or a key. The values for all keys have to be base64-encoded strings. For details see: https://kubernetes.io/docs/concepts/configuration/secret/ Example: { "example": "ZXhhbXBsZV92YWx1ZQ==", "another-example": "YW5vdGhlcl9leGFtcGxlX3ZhbHVl" }

list

Successful response

Name	Datatype	Description
name	string	Identifier. The resource name of the Secret, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}/userWorkloadsSecrets/{userWorkloadsSecretId}"
data	object	Optional. The "data" field of Kubernetes Secret, organized in key-value pairs, which can contain sensitive values such as a password, a token, or a key. The values for all keys have to be base64-encoded strings. For details see: https://kubernetes.io/docs/concepts/configuration/secret/ Example: { "example": "ZXhhbXBsZV92YWx1ZQ==", "another-example": "YW5vdGhlcl9leGFtcGxlX3ZhbHVl" }

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, environmentsId, userWorkloadsSecretsId		Gets an existing user workloads Secret. Values of the "data" field in the response are cleared. This method is supported for Cloud Composer environments in versions composer-3-airflow-..-build. and newer.
list	select	projectsId, locationsId, environmentsId	pageSize, pageToken	Lists user workloads Secrets. This method is supported for Cloud Composer environments in versions composer-3-airflow-..-build. and newer.
create	insert	projectsId, locationsId, environmentsId		Creates a user workloads Secret. This method is supported for Cloud Composer environments in versions composer-3-airflow-..-build. and newer.
update	replace	projectsId, locationsId, environmentsId, userWorkloadsSecretsId		Updates a user workloads Secret. This method is supported for Cloud Composer environments in versions composer-3-airflow-..-build. and newer.
delete	delete	projectsId, locationsId, environmentsId, userWorkloadsSecretsId		Deletes a user workloads Secret. This method is supported for Cloud Composer environments in versions composer-3-airflow-..-build. and newer.

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
environmentsId	string
locationsId	string
projectsId	string
userWorkloadsSecretsId	string
pageSize	integer (int32)
pageToken	string

SELECT examples

get

Gets an existing user workloads Secret. Values of the "data" field in the response are cleared. This method is supported for Cloud Composer environments in versions composer-3-airflow-..-build. and newer.

SELECT
name,
data
FROM google.composer.user_workloads_secrets
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND environmentsId = '{{ environmentsId }}' -- required
AND userWorkloadsSecretsId = '{{ userWorkloadsSecretsId }}' -- required;

list

Lists user workloads Secrets. This method is supported for Cloud Composer environments in versions composer-3-airflow-..-build. and newer.

SELECT
name,
data
FROM google.composer.user_workloads_secrets
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND environmentsId = '{{ environmentsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}';

INSERT examples

create

Creates a user workloads Secret. This method is supported for Cloud Composer environments in versions composer-3-airflow-..-build. and newer.

INSERT INTO google.composer.user_workloads_secrets (
data__name,
data__data,
projectsId,
locationsId,
environmentsId
)
SELECT 
'{{ name }}',
'{{ data }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ environmentsId }}'
RETURNING
name,
data
;

Manifest

# Description fields are for documentation purposes
- name: user_workloads_secrets
  props:
    - name: projectsId
      value: string
      description: Required parameter for the user_workloads_secrets resource.
    - name: locationsId
      value: string
      description: Required parameter for the user_workloads_secrets resource.
    - name: environmentsId
      value: string
      description: Required parameter for the user_workloads_secrets resource.
    - name: name
      value: string
      description: >
        Identifier. The resource name of the Secret, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}/userWorkloadsSecrets/{userWorkloadsSecretId}"
        
    - name: data
      value: object
      description: >
        Optional. The "data" field of Kubernetes Secret, organized in key-value pairs, which can contain sensitive values such as a password, a token, or a key. The values for all keys have to be base64-encoded strings. For details see: https://kubernetes.io/docs/concepts/configuration/secret/ Example: { "example": "ZXhhbXBsZV92YWx1ZQ==", "another-example": "YW5vdGhlcl9leGFtcGxlX3ZhbHVl" }
        

REPLACE examples

update

Updates a user workloads Secret. This method is supported for Cloud Composer environments in versions composer-3-airflow-..-build. and newer.

REPLACE google.composer.user_workloads_secrets
SET 
data__name = '{{ name }}',
data__data = '{{ data }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND environmentsId = '{{ environmentsId }}' --required
AND userWorkloadsSecretsId = '{{ userWorkloadsSecretsId }}' --required
RETURNING
name,
data;

DELETE examples

delete

Deletes a user workloads Secret. This method is supported for Cloud Composer environments in versions composer-3-airflow-..-build. and newer.

DELETE FROM google.composer.user_workloads_secrets
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND environmentsId = '{{ environmentsId }}' --required
AND userWorkloadsSecretsId = '{{ userWorkloadsSecretsId }}' --required;