encryption_spec
Creates, updates, deletes, gets or lists an encryption_spec
resource.
Overview
Name | encryption_spec |
Type | Resource |
Id | google.contactcenterinsights.encryption_spec |
Fields
The following fields are returned by SELECT
queries:
- get_encryption_spec
Successful response
Name | Datatype | Description |
---|---|---|
name | string | Immutable. The resource name of the encryption key specification resource. Format: projects/{project}/locations/{location}/encryptionSpec |
kmsKey | string | Required. The name of customer-managed encryption key that is used to secure a resource and its sub-resources. If empty, the resource is secured by our default encryption key. Only the key in the same location as this resource is allowed to be used for encryption. Format: projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{key} |
Methods
The following methods are available for this resource:
Name | Accessible by | Required Params | Optional Params | Description |
---|---|---|---|---|
get_encryption_spec | select | projectsId , locationsId | Gets location-level encryption key specification. | |
initialize | exec | projectsId , locationsId | Initializes a location-level encryption key specification. An error will result if the location has resources already created before the initialization. After the encryption specification is initialized at a location, it is immutable and all newly created resources under the location will be encrypted with the existing specification. |
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 |
---|---|---|
locationsId | string | |
projectsId | string |
SELECT
examples
- get_encryption_spec
Gets location-level encryption key specification.
SELECT
name,
kmsKey
FROM google.contactcenterinsights.encryption_spec
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required;
Lifecycle Methods
- initialize
Initializes a location-level encryption key specification. An error will result if the location has resources already created before the initialization. After the encryption specification is initialized at a location, it is immutable and all newly created resources under the location will be encrypted with the existing specification.
EXEC google.contactcenterinsights.encryption_spec.initialize
@projectsId='{{ projectsId }}' --required,
@locationsId='{{ locationsId }}' --required
@@json=
'{
"encryptionSpec": "{{ encryptionSpec }}"
}';