Class: Aws::VerifiedPermissions::Types::KmsEncryptionSettings

Inherits:

Struct

Object
Struct
Aws::VerifiedPermissions::Types::KmsEncryptionSettings

show all

Defined in:: gems/aws-sdk-verifiedpermissions/lib/aws-sdk-verifiedpermissions/types.rb

Overview

A structure that contains the KMS encryption configuration for the policy store. The encryption settings determine what customer-managed KMS key will be used to encrypt all resources within the policy store, and any user-defined context key-value pairs to append during encryption processes.

This data type is used as a field that is part of the EncryptionSettings type.

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#encryption_context ⇒ Hash<String,String>
User-defined, additional context to be added to encryption processes.
#key ⇒ String
The customer-managed KMS key [Amazon Resource Name (ARN)][1], alias or ID to be used for encryption processes.

Instance Attribute Details

#encryption_context ⇒ `Hash<String,String>`

User-defined, additional context to be added to encryption processes.

Returns:

(Hash<String,String>)

# File 'gems/aws-sdk-verifiedpermissions/lib/aws-sdk-verifiedpermissions/types.rb', line 2781

class KmsEncryptionSettings < Struct.new(
  :key,
  :encryption_context)
  SENSITIVE = []
  include Aws::Structure
end

#key ⇒ `String`

The customer-managed KMS key Amazon Resource Name (ARN), alias or ID to be used for encryption processes.

Users can provide the full KMS key ARN, a KMS key alias, or a KMS key ID, but it will be mapped to the full KMS key ARN after policy store creation, and referenced when encrypting child resources.