You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-athena/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.

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)


372
373
374
375
376
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/types.rb', line 372

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

#kms_keyString

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

Returns:

  • (String)


372
373
374
375
376
# File 'gems/aws-sdk-athena/lib/aws-sdk-athena/types.rb', line 372

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