amazonka-s3-2.0: Amazon Simple Storage Service SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.S3.Types.Encryption

Description

 
Synopsis

Documentation

data Encryption Source #

Contains the type of server-side encryption used.

See: newEncryption smart constructor.

Constructors

Encryption' 

Fields

  • kmsContext :: Maybe Text

    If the encryption type is aws:kms, this optional value can be used to specify the encryption context for the restore results.

  • kmsKeyId :: Maybe (Sensitive Text)

    If the encryption type is aws:kms, this optional value specifies the ID of the symmetric customer managed key to use for encryption of job results. Amazon S3 only supports symmetric keys. For more information, see Using symmetric and asymmetric keys in the Amazon Web Services Key Management Service Developer Guide.

  • encryptionType :: ServerSideEncryption

    The server-side encryption algorithm used when storing job results in Amazon S3 (for example, AES256, aws:kms).

Instances

Instances details
ToXML Encryption Source # 
Instance details

Defined in Amazonka.S3.Types.Encryption

Methods

toXML :: Encryption -> XML #

Generic Encryption Source # 
Instance details

Defined in Amazonka.S3.Types.Encryption

Associated Types

type Rep Encryption :: Type -> Type #

Show Encryption Source # 
Instance details

Defined in Amazonka.S3.Types.Encryption

NFData Encryption Source # 
Instance details

Defined in Amazonka.S3.Types.Encryption

Methods

rnf :: Encryption -> () #

Eq Encryption Source # 
Instance details

Defined in Amazonka.S3.Types.Encryption

Hashable Encryption Source # 
Instance details

Defined in Amazonka.S3.Types.Encryption

type Rep Encryption Source # 
Instance details

Defined in Amazonka.S3.Types.Encryption

type Rep Encryption = D1 ('MetaData "Encryption" "Amazonka.S3.Types.Encryption" "amazonka-s3-2.0-CNZtv1UmVzj28JXsFvwNoj" 'False) (C1 ('MetaCons "Encryption'" 'PrefixI 'True) (S1 ('MetaSel ('Just "kmsContext") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "kmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :*: S1 ('MetaSel ('Just "encryptionType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ServerSideEncryption))))

newEncryption Source #

Create a value of Encryption 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:kmsContext:Encryption', encryption_kmsContext - If the encryption type is aws:kms, this optional value can be used to specify the encryption context for the restore results.

$sel:kmsKeyId:Encryption', encryption_kmsKeyId - If the encryption type is aws:kms, this optional value specifies the ID of the symmetric customer managed key to use for encryption of job results. Amazon S3 only supports symmetric keys. For more information, see Using symmetric and asymmetric keys in the Amazon Web Services Key Management Service Developer Guide.

$sel:encryptionType:Encryption', encryption_encryptionType - The server-side encryption algorithm used when storing job results in Amazon S3 (for example, AES256, aws:kms).

encryption_kmsContext :: Lens' Encryption (Maybe Text) Source #

If the encryption type is aws:kms, this optional value can be used to specify the encryption context for the restore results.

encryption_kmsKeyId :: Lens' Encryption (Maybe Text) Source #

If the encryption type is aws:kms, this optional value specifies the ID of the symmetric customer managed key to use for encryption of job results. Amazon S3 only supports symmetric keys. For more information, see Using symmetric and asymmetric keys in the Amazon Web Services Key Management Service Developer Guide.

encryption_encryptionType :: Lens' Encryption ServerSideEncryption Source #

The server-side encryption algorithm used when storing job results in Amazon S3 (for example, AES256, aws:kms).