| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::S3::ServerSideEncryptionByDefault; | ||
| 3 | use Moose; | ||
| 4 | has KMSMasterKeyID => (is => 'ro', isa => 'Str'); | ||
| 5 | has SSEAlgorithm => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | |||
| 7 | 1; | ||
| 8 | |||
| 9 | ### main pod documentation begin ### | ||
| 10 | |||
| 11 | =head1 NAME | ||
| 12 | |||
| 13 | Paws::S3::ServerSideEncryptionByDefault | ||
| 14 | |||
| 15 | =head1 USAGE | ||
| 16 | |||
| 17 | This class represents one of two things: | ||
| 18 | |||
| 19 | =head3 Arguments in a call to a service | ||
| 20 | |||
| 21 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 22 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 23 | |||
| 24 | As an example, if Att1 is expected to be a Paws::S3::ServerSideEncryptionByDefault object: | ||
| 25 | |||
| 26 | $service_obj->Method(Att1 => { KMSMasterKeyID => $value, ..., SSEAlgorithm => $value }); | ||
| 27 | |||
| 28 | =head3 Results returned from an API call | ||
| 29 | |||
| 30 | Use accessors for each attribute. If Att1 is expected to be an Paws::S3::ServerSideEncryptionByDefault object: | ||
| 31 | |||
| 32 | $result = $service_obj->Method(...); | ||
| 33 | $result->Att1->KMSMasterKeyID | ||
| 34 | |||
| 35 | =head1 DESCRIPTION | ||
| 36 | |||
| 37 | Describes the default server-side encryption to apply to new objects in | ||
| 38 | the bucket. If a PUT Object request doesn't specify any server-side | ||
| 39 | encryption, this default encryption will be applied. For more | ||
| 40 | information, see PUT Bucket encryption | ||
| 41 | (https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTencryption.html) | ||
| 42 | in the I<Amazon S3 API Reference>. | ||
| 43 | |||
| 44 | =head1 ATTRIBUTES | ||
| 45 | |||
| 46 | |||
| 47 | =head2 KMSMasterKeyID => Str | ||
| 48 | |||
| 49 | AWS Key Management Service (KMS) customer AWS KMS key ID to use for the | ||
| 50 | default encryption. This parameter is allowed if and only if | ||
| 51 | C<SSEAlgorithm> is set to C<aws:kms>. | ||
| 52 | |||
| 53 | You can specify the key ID or the Amazon Resource Name (ARN) of the KMS | ||
| 54 | key. However, if you are using encryption with cross-account | ||
| 55 | operations, you must use a fully qualified KMS key ARN. For more | ||
| 56 | information, see Using encryption for cross-account operations | ||
| 57 | (https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html#bucket-encryption-update-bucket-policy). | ||
| 58 | |||
| 59 | B<For example:> | ||
| 60 | |||
| 61 | =over | ||
| 62 | |||
| 63 | =item * | ||
| 64 | |||
| 65 | Key ID: C<1234abcd-12ab-34cd-56ef-1234567890ab> | ||
| 66 | |||
| 67 | =item * | ||
| 68 | |||
| 69 | Key ARN: | ||
| 70 | C<arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab> | ||
| 71 | |||
| 72 | =back | ||
| 73 | |||
| 74 | Amazon S3 only supports symmetric KMS keys and not asymmetric KMS keys. | ||
| 75 | For more information, see Using symmetric and asymmetric keys | ||
| 76 | (https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html) | ||
| 77 | in the I<AWS Key Management Service Developer Guide>. | ||
| 78 | |||
| 79 | |||
| 80 | =head2 B<REQUIRED> SSEAlgorithm => Str | ||
| 81 | |||
| 82 | Server-side encryption algorithm to use for the default encryption. | ||
| 83 | |||
| 84 | |||
| 85 | |||
| 86 | =head1 SEE ALSO | ||
| 87 | |||
| 88 | This class forms part of L<Paws>, describing an object used in L<Paws::S3> | ||
| 89 | |||
| 90 | =head1 BUGS and CONTRIBUTIONS | ||
| 91 | |||
| 92 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 93 | |||
| 94 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 95 | |||
| 96 | =cut | ||
| 97 |