Amazonka.Athena.Types.EncryptionConfiguration

Documentation

data EncryptionConfiguration

If query results are encrypted in Amazon S3, indicates the encryption option used (for example, SSE_KMS or CSE_KMS) and key information.

See: newEncryptionConfiguration smart constructor.

Constructors

EncryptionConfiguration'

Fields

• kmsKey :: Maybe Text

  For SSE_KMS and CSE_KMS, this is the KMS key ARN or ID.

• encryptionOption :: EncryptionOption

  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.

Instances

FromJSON EncryptionConfiguration

Defined in Amazonka.Athena.Types.EncryptionConfiguration

Methods

parseJSON :: Value -> Parser EncryptionConfiguration

parseJSONList :: Value -> Parser [EncryptionConfiguration]

ToJSON EncryptionConfiguration

Defined in Amazonka.Athena.Types.EncryptionConfiguration

Methods

toJSON :: EncryptionConfiguration -> Value

toEncoding :: EncryptionConfiguration -> Encoding

toJSONList :: [EncryptionConfiguration] -> Value

toEncodingList :: [EncryptionConfiguration] -> Encoding

Generic EncryptionConfiguration

Defined in Amazonka.Athena.Types.EncryptionConfiguration

Associated Types

type Rep EncryptionConfiguration :: Type -> Type

Methods

from :: EncryptionConfiguration -> Rep EncryptionConfiguration x

to :: Rep EncryptionConfiguration x -> EncryptionConfiguration

Read EncryptionConfiguration

Defined in Amazonka.Athena.Types.EncryptionConfiguration

Methods

readsPrec :: Int -> ReadS EncryptionConfiguration

readList :: ReadS [EncryptionConfiguration]

readPrec :: ReadPrec EncryptionConfiguration

readListPrec :: ReadPrec [EncryptionConfiguration]

Show EncryptionConfiguration

Defined in Amazonka.Athena.Types.EncryptionConfiguration

Methods

showsPrec :: Int -> EncryptionConfiguration -> ShowS

show :: EncryptionConfiguration -> String

showList :: [EncryptionConfiguration] -> ShowS

NFData EncryptionConfiguration

Defined in Amazonka.Athena.Types.EncryptionConfiguration

Methods

rnf :: EncryptionConfiguration -> ()

Eq EncryptionConfiguration

Defined in Amazonka.Athena.Types.EncryptionConfiguration

Methods

(==) :: EncryptionConfiguration -> EncryptionConfiguration -> Bool

(/=) :: EncryptionConfiguration -> EncryptionConfiguration -> Bool

Hashable EncryptionConfiguration

Defined in Amazonka.Athena.Types.EncryptionConfiguration

Methods

hashWithSalt :: Int -> EncryptionConfiguration -> Int

hash :: EncryptionConfiguration -> Int

type Rep EncryptionConfiguration

Defined in Amazonka.Athena.Types.EncryptionConfiguration

type Rep EncryptionConfiguration = D1 ('MetaData "EncryptionConfiguration" "Amazonka.Athena.Types.EncryptionConfiguration" "amazonka-athena-2.0-1BJA3HTvHJNEzwQRaEw59w" 'False) (C1 ('MetaCons "EncryptionConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "kmsKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "encryptionOption") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 EncryptionOption)))

newEncryptionConfiguration

Arguments

:: EncryptionOption

$sel:encryptionOption:EncryptionConfiguration'

-> EncryptionConfiguration

Create a value of EncryptionConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:kmsKey:EncryptionConfiguration', encryptionConfiguration_kmsKey - For SSE_KMS and CSE_KMS, this is the KMS key ARN or ID.

$sel:encryptionOption:EncryptionConfiguration', encryptionConfiguration_encryptionOption - 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.

encryptionConfiguration_kmsKey :: Lens' EncryptionConfiguration (Maybe Text)

For SSE_KMS and CSE_KMS, this is the KMS key ARN or ID.

encryptionConfiguration_encryptionOption :: Lens' EncryptionConfiguration EncryptionOption

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.