AWSS3ServerSideEncryptionByDefault

Objective-C

@interface AWSS3ServerSideEncryptionByDefault

Swift

class AWSS3ServerSideEncryptionByDefault

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 Simple Storage Service API Reference.

Required parameters: [SSEAlgorithm]

  • AWS Key Management Service (KMS) customer master 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 CMK. However, if you are using encryption with cross-account operations, you must use a fully qualified CMK 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 CMKs and not asymmetric CMKs. For more information, see Using Symmetric and Asymmetric Keys in the AWS Key Management Service Developer Guide.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable KMSMasterKeyID;

    Swift

    var kmsMasterKeyID: String? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic) AWSS3ServerSideEncryption SSEAlgorithm;

    Swift

    var sseAlgorithm: AWSS3ServerSideEncryption { get set }