replica_keys_list_only
Lists replica_keys
in a region or regions, for all properties use replica_keys
Overview
Name | replica_keys_list_only |
Type | Resource |
Description | The AWS::KMS::ReplicaKey resource specifies a multi-region replica AWS KMS key in AWS Key Management Service (AWS KMS). |
Id | aws.kms.replica_keys_list_only |
Fields
Name | Datatype | Description |
---|---|---|
description | string | A description of the AWS KMS key. Use a description that helps you to distinguish this AWS KMS key from others in the account, such as its intended use. |
pending_window_in_days | integer | Specifies the number of days in the waiting period before AWS KMS deletes an AWS KMS key that has been removed from a CloudFormation stack. Enter a value between 7 and 30 days. The default value is 30 days. |
key_policy | object | The key policy that authorizes use of the AWS KMS key. The key policy must observe the following rules. |
primary_key_arn | string | Identifies the primary AWS KMS key to create a replica of. Specify the Amazon Resource Name (ARN) of the AWS KMS key. You cannot specify an alias or key ID. For help finding the ARN, see Finding the Key ID and ARN in the AWS Key Management Service Developer Guide. |
enabled | boolean | Specifies whether the AWS KMS key is enabled. Disabled AWS KMS keys cannot be used in cryptographic operations. |
key_id | string | |
arn | string | |
tags | array | An array of key-value pairs to apply to this resource. |
region | string | AWS region. |
Methods
Name | Accessible by | Required Params |
---|---|---|
list_resources | SELECT | region |
SELECT
examples
Lists all replica_keys
in a region.
SELECT
region,
key_id
FROM aws.kms.replica_keys_list_only
WHERE region = 'us-east-1';
Permissions
For permissions required to operate on the replica_keys_list_only
resource, see replica_keys