kms_encryption_keys
Creates, updates, deletes, gets or lists a kms_encryption_keys resource.
Overview
| Name | kms_encryption_keys |
| Type | Resource |
| Id | aws.frauddetector.kms_encryption_keys |
Fields
The following fields are returned by SELECT queries:
- get_kms_encryption_key
| Name | Datatype | Description |
|---|---|---|
kms_encryption_key_arn | string | The encryption key ARN. (pattern: <code>^DEFAULT|arn:[a-zA-Z0-9-]+:kms:[a-zA-Z0-9-]+:\d{12}:key/\w{8}-\w{4}-\w{4}-\w{4}-\w{12}$</code>) |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_kms_encryption_key | select | region | Gets the encryption key if a KMS key has been specified to be used to encrypt content in Amazon Fraud Detector. | |
put_kms_encryption_key | replace | region, kmsEncryptionKeyArn | Specifies the KMS key to be used to encrypt content in Amazon Fraud Detector. |
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 |
|---|---|---|
region | string | AWS region (default: us-east-1) |
SELECT examples
- get_kms_encryption_key
Gets the encryption key if a KMS key has been specified to be used to encrypt content in Amazon Fraud Detector.
SELECT
kms_encryption_key_arn
FROM aws.frauddetector.kms_encryption_keys
WHERE region = '{{ region }}' -- required
;
REPLACE examples
- put_kms_encryption_key
Specifies the KMS key to be used to encrypt content in Amazon Fraud Detector.
REPLACE aws.frauddetector.kms_encryption_keys
SET
kmsEncryptionKeyArn = '{{ kmsEncryptionKeyArn }}'
WHERE
region = '{{ region }}' --required
AND kmsEncryptionKeyArn = '{{ kmsEncryptionKeyArn }}' --required;