Class: Aws::CognitoIdentityProvider::Types::KeyConfigurationType

Inherits:

Struct

• Object
• Struct
• Aws::CognitoIdentityProvider::Types::KeyConfigurationType

Includes:

Structure

Defined in:

lib/aws-sdk-cognitoidentityprovider/types.rb

Overview

Specifies the key configuration for a user pool. Contains settings for encryption keys used to secure user pool data.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #key_type ⇒ String

  The type of encryption key used for the user pool.

• #kms_key_arn ⇒ String

  The Amazon Resource Name (ARN) of the KMS key used for encryption.

Instance Attribute Details

#key_type ⇒ String

The type of encryption key used for the user pool.

AWS_OWNED_KEY

: A key owned by Amazon Web Services in Key Management Service.

CUSTOMER_MANAGED_KEY

: A key managed by the customer in Key Management Service. You must

use a multi-region key to enable multi-region replication for a
user pool.

Returns:

• (String)

# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 7893

class KeyConfigurationType < Struct.new(
  :key_type,
  :kms_key_arn)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_arn ⇒ String

The Amazon Resource Name (ARN) of the KMS key used for encryption. If not specified, Amazon Web Services managed keys are used.

Returns:

• (String)

# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 7893

class KeyConfigurationType < Struct.new(
  :key_type,
  :kms_key_arn)
  SENSITIVE = []
  include Aws::Structure
end