XksKeyConfigurationType - Amazon Key Management Service
ContentsSee Also
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

XksKeyConfigurationType

Information about the external key that is associated with a KMS key in an external key store.

This element appears in a CreateKey or DescribeKey response only for a KMS key in an external key store.

The external key is a symmetric encryption key that is hosted by an external key manager outside of Amazon. When you use the KMS key in an external key store in a cryptographic operation, the cryptographic operation is performed in the external key manager using the specified external key. For more information, see External key in the Amazon Key Management Service Developer Guide.

Contents

Note

In the following list, the required parameters are described first.

Id

The ID of the external key in its external key manager. This is the ID that the external key store proxy uses to identify the external key.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: ^[a-zA-Z0-9-_.]+$

Required: No

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: