« blib/lib/Paws/ECR/DescribeRepositoriesResponse.pm
↑ Summary
blib/lib/Paws/ECR/FindingSeverityCounts.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::ECR::EncryptionConfiguration; | ||
| 3 | use Moose; | ||
| 4 | has EncryptionType => (is => 'ro', isa => 'Str', request_name => 'encryptionType', traits => ['NameInRequest'], required => 1); | ||
| 5 | has KmsKey => (is => 'ro', isa => 'Str', request_name => 'kmsKey', traits => ['NameInRequest']); | ||
| 6 | |||
| 7 | 1; | ||
| 8 | |||
| 9 | ### main pod documentation begin ### | ||
| 10 | |||
| 11 | =head1 NAME | ||
| 12 | |||
| 13 | Paws::ECR::EncryptionConfiguration | ||
| 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::ECR::EncryptionConfiguration object: | ||
| 25 | |||
| 26 | $service_obj->Method(Att1 => { EncryptionType => $value, ..., KmsKey => $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::ECR::EncryptionConfiguration object: | ||
| 31 | |||
| 32 | $result = $service_obj->Method(...); | ||
| 33 | $result->Att1->EncryptionType | ||
| 34 | |||
| 35 | =head1 DESCRIPTION | ||
| 36 | |||
| 37 | The encryption configuration for the repository. This determines how | ||
| 38 | the contents of your repository are encrypted at rest. | ||
| 39 | |||
| 40 | By default, when no encryption configuration is set or the C<AES256> | ||
| 41 | encryption type is used, Amazon ECR uses server-side encryption with | ||
| 42 | Amazon S3-managed encryption keys which encrypts your data at rest | ||
| 43 | using an AES-256 encryption algorithm. This does not require any action | ||
| 44 | on your part. | ||
| 45 | |||
| 46 | For more control over the encryption of the contents of your | ||
| 47 | repository, you can use server-side encryption with customer master | ||
| 48 | keys (CMKs) stored in AWS Key Management Service (AWS KMS) to encrypt | ||
| 49 | your images. For more information, see Amazon ECR encryption at rest | ||
| 50 | (https://docs.aws.amazon.com/AmazonECR/latest/userguide/encryption-at-rest.html) | ||
| 51 | in the I<Amazon Elastic Container Registry User Guide>. | ||
| 52 | |||
| 53 | =head1 ATTRIBUTES | ||
| 54 | |||
| 55 | |||
| 56 | =head2 B<REQUIRED> EncryptionType => Str | ||
| 57 | |||
| 58 | The encryption type to use. | ||
| 59 | |||
| 60 | If you use the C<KMS> encryption type, the contents of the repository | ||
| 61 | will be encrypted using server-side encryption with customer master | ||
| 62 | keys (CMKs) stored in AWS KMS. When you use AWS KMS to encrypt your | ||
| 63 | data, you can either use the default AWS managed CMK for Amazon ECR, or | ||
| 64 | specify your own CMK, which you already created. For more information, | ||
| 65 | see Protecting Data Using Server-Side Encryption with CMKs Stored in | ||
| 66 | AWS Key Management Service (SSE-KMS) | ||
| 67 | (https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingKMSEncryption.html) | ||
| 68 | in the I<Amazon Simple Storage Service Console Developer Guide.>. | ||
| 69 | |||
| 70 | If you use the C<AES256> encryption type, Amazon ECR uses server-side | ||
| 71 | encryption with Amazon S3-managed encryption keys which encrypts the | ||
| 72 | images in the repository using an AES-256 encryption algorithm. For | ||
| 73 | more information, see Protecting Data Using Server-Side Encryption with | ||
| 74 | Amazon S3-Managed Encryption Keys (SSE-S3) | ||
| 75 | (https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingServerSideEncryption.html) | ||
| 76 | in the I<Amazon Simple Storage Service Console Developer Guide.>. | ||
| 77 | |||
| 78 | |||
| 79 | =head2 KmsKey => Str | ||
| 80 | |||
| 81 | If you use the C<KMS> encryption type, specify the CMK to use for | ||
| 82 | encryption. The alias, key ID, or full ARN of the CMK can be specified. | ||
| 83 | The key must exist in the same Region as the repository. If no key is | ||
| 84 | specified, the default AWS managed CMK for Amazon ECR will be used. | ||
| 85 | |||
| 86 | |||
| 87 | |||
| 88 | =head1 SEE ALSO | ||
| 89 | |||
| 90 | This class forms part of L<Paws>, describing an object used in L<Paws::ECR> | ||
| 91 | |||
| 92 | =head1 BUGS and CONTRIBUTIONS | ||
| 93 | |||
| 94 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 95 | |||
| 96 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 97 | |||
| 98 | =cut | ||
| 99 |