Class: Aws::Athena::Types::EncryptionConfiguration

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-athena/types.rb

Overview

Note:

When making an API call, you may pass EncryptionConfiguration data as a hash:

{
  encryption_option: "SSE_S3", # required, accepts SSE_S3, SSE_KMS, CSE_KMS
  kms_key: "String",
}

If query results are encrypted in Amazon S3, indicates the encryption option used (for example, `SSE-KMS` or `CSE-KMS`) and key information.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#encryption_optionString

Indicates whether Amazon S3 server-side encryption with Amazon S3-managed keys (`SSE-S3`), server-side encryption with KMS-managed keys (`SSE-KMS`), or client-side encryption with KMS-managed keys (CSE-KMS) is used.

If a query runs in a workgroup and the workgroup overrides client-side settings, then the workgroup's setting for encryption is used. It specifies whether query results must be encrypted, for all queries that run in this workgroup.

Returns:

  • (String)

695
696
697
698
699
700
# File 'lib/aws-sdk-athena/types.rb', line 695

class EncryptionConfiguration < Struct.new(
  :encryption_option,
  :kms_key)
  SENSITIVE = []
  include Aws::Structure
end

#kms_keyString

For `SSE-KMS` and `CSE-KMS`, this is the KMS key ARN or ID.

Returns:

  • (String)

695
696
697
698
699
700
# File 'lib/aws-sdk-athena/types.rb', line 695

class EncryptionConfiguration < Struct.new(
  :encryption_option,
  :kms_key)
  SENSITIVE = []
  include Aws::Structure
end