Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.S3.Types.ServerSideEncryptionByDefault

Description

Documentation

data ServerSideEncryptionByDefault Source #

Describes the default server-side encryption to apply to new objects in the bucket. If a PUT Object request doesn't specify any server-side encryption, this default encryption will be applied. For more information, see PUT Bucket encryption in the Amazon S3 API Reference.

See: newServerSideEncryptionByDefault smart constructor.

Constructors

ServerSideEncryptionByDefault'

Fields

kmsMasterKeyID :: Maybe (Sensitive Text)
Amazon Web Services Key Management Service (KMS) customer Amazon Web Services KMS key ID to use for the default encryption. This parameter is allowed if and only if SSEAlgorithm is set to aws:kms.
You can specify the key ID or the Amazon Resource Name (ARN) of the KMS key. However, if you are using encryption with cross-account operations, you must use a fully qualified KMS key ARN. For more information, see Using encryption for cross-account operations.
For example:
- Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
- Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
Amazon S3 only supports symmetric KMS keys and not asymmetric KMS keys. For more information, see Using symmetric and asymmetric keys in the Amazon Web Services Key Management Service Developer Guide.
sSEAlgorithm :: ServerSideEncryption
Server-side encryption algorithm to use for the default encryption.

Instances

Instances details

Eq ServerSideEncryptionByDefault Source #
Instance details Defined in Amazonka.S3.Types.ServerSideEncryptionByDefault Methods (==) :: ServerSideEncryptionByDefault -> ServerSideEncryptionByDefault -> Bool # (/=) :: ServerSideEncryptionByDefault -> ServerSideEncryptionByDefault -> Bool #
Show ServerSideEncryptionByDefault Source #
Instance details Defined in Amazonka.S3.Types.ServerSideEncryptionByDefault Methods showsPrec :: Int -> ServerSideEncryptionByDefault -> ShowS # show :: ServerSideEncryptionByDefault -> String # showList :: [ServerSideEncryptionByDefault] -> ShowS #
Generic ServerSideEncryptionByDefault Source #
Instance details Defined in Amazonka.S3.Types.ServerSideEncryptionByDefault Associated Types type Rep ServerSideEncryptionByDefault :: Type -> Type # Methods from :: ServerSideEncryptionByDefault -> Rep ServerSideEncryptionByDefault x # to :: Rep ServerSideEncryptionByDefault x -> ServerSideEncryptionByDefault #
NFData ServerSideEncryptionByDefault Source #
Instance details Defined in Amazonka.S3.Types.ServerSideEncryptionByDefault Methods rnf :: ServerSideEncryptionByDefault -> () #
Hashable ServerSideEncryptionByDefault Source #
Instance details Defined in Amazonka.S3.Types.ServerSideEncryptionByDefault Methods hashWithSalt :: Int -> ServerSideEncryptionByDefault -> Int # hash :: ServerSideEncryptionByDefault -> Int #
FromXML ServerSideEncryptionByDefault Source #
Instance details Defined in Amazonka.S3.Types.ServerSideEncryptionByDefault Methods parseXML :: [Node] -> Either String ServerSideEncryptionByDefault #
ToXML ServerSideEncryptionByDefault Source #
Instance details Defined in Amazonka.S3.Types.ServerSideEncryptionByDefault Methods toXML :: ServerSideEncryptionByDefault -> XML #
type Rep ServerSideEncryptionByDefault Source #
Instance details Defined in Amazonka.S3.Types.ServerSideEncryptionByDefault type Rep ServerSideEncryptionByDefault = D1 ('MetaData "ServerSideEncryptionByDefault" "Amazonka.S3.Types.ServerSideEncryptionByDefault" "libZSservicesZSamazonka-s3ZSamazonka-s3" 'False) (C1 ('MetaCons "ServerSideEncryptionByDefault'" 'PrefixI 'True) (S1 ('MetaSel ('Just "kmsMasterKeyID") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :*: S1 ('MetaSel ('Just "sSEAlgorithm") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ServerSideEncryption)))

newServerSideEncryptionByDefault Source #

Arguments

:: ServerSideEncryption	`$sel:sSEAlgorithm:ServerSideEncryptionByDefault'`
-> ServerSideEncryptionByDefault

Create a value of ServerSideEncryptionByDefault 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:kmsMasterKeyID:ServerSideEncryptionByDefault', serverSideEncryptionByDefault_kmsMasterKeyID - Amazon Web Services Key Management Service (KMS) customer Amazon Web Services KMS key ID to use for the default encryption. This parameter is allowed if and only if SSEAlgorithm is set to aws:kms.

You can specify the key ID or the Amazon Resource Name (ARN) of the KMS key. However, if you are using encryption with cross-account operations, you must use a fully qualified KMS key ARN. For more information, see Using encryption for cross-account operations.

For example:

Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

Amazon S3 only supports symmetric KMS keys and not asymmetric KMS keys. For more information, see Using symmetric and asymmetric keys in the Amazon Web Services Key Management Service Developer Guide.

$sel:sSEAlgorithm:ServerSideEncryptionByDefault', serverSideEncryptionByDefault_sSEAlgorithm - Server-side encryption algorithm to use for the default encryption.

serverSideEncryptionByDefault_kmsMasterKeyID :: Lens' ServerSideEncryptionByDefault (Maybe Text) Source #

Amazon Web Services Key Management Service (KMS) customer Amazon Web Services KMS key ID to use for the default encryption. This parameter is allowed if and only if SSEAlgorithm is set to aws:kms.

You can specify the key ID or the Amazon Resource Name (ARN) of the KMS key. However, if you are using encryption with cross-account operations, you must use a fully qualified KMS key ARN. For more information, see Using encryption for cross-account operations.

For example:

Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

Amazon S3 only supports symmetric KMS keys and not asymmetric KMS keys. For more information, see Using symmetric and asymmetric keys in the Amazon Web Services Key Management Service Developer Guide.

serverSideEncryptionByDefault_sSEAlgorithm :: Lens' ServerSideEncryptionByDefault ServerSideEncryption Source #

Server-side encryption algorithm to use for the default encryption.