| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Athena::EncryptionConfiguration; | ||
| 3 | use Moose; | ||
| 4 | has EncryptionOption => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has KmsKey => (is => 'ro', isa => 'Str'); | ||
| 6 | |||
| 7 | 1; | ||
| 8 | |||
| 9 | ### main pod documentation begin ### | ||
| 10 | |||
| 11 | =head1 NAME | ||
| 12 | |||
| 13 | Paws::Athena::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::Athena::EncryptionConfiguration object: | ||
| 25 | |||
| 26 | $service_obj->Method(Att1 => { EncryptionOption => $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::Athena::EncryptionConfiguration object: | ||
| 31 | |||
| 32 | $result = $service_obj->Method(...); | ||
| 33 | $result->Att1->EncryptionOption | ||
| 34 | |||
| 35 | =head1 DESCRIPTION | ||
| 36 | |||
| 37 | If query results are encrypted in Amazon S3, indicates the encryption | ||
| 38 | option used (for example, C<SSE-KMS> or C<CSE-KMS>) and key | ||
| 39 | information. | ||
| 40 | |||
| 41 | =head1 ATTRIBUTES | ||
| 42 | |||
| 43 | |||
| 44 | =head2 B<REQUIRED> EncryptionOption => Str | ||
| 45 | |||
| 46 | Indicates whether Amazon S3 server-side encryption with Amazon | ||
| 47 | S3-managed keys (C<SSE-S3>), server-side encryption with KMS-managed | ||
| 48 | keys (C<SSE-KMS>), or client-side encryption with KMS-managed keys | ||
| 49 | (CSE-KMS) is used. | ||
| 50 | |||
| 51 | If a query runs in a workgroup and the workgroup overrides client-side | ||
| 52 | settings, then the workgroup's setting for encryption is used. It | ||
| 53 | specifies whether query results must be encrypted, for all queries that | ||
| 54 | run in this workgroup. | ||
| 55 | |||
| 56 | |||
| 57 | =head2 KmsKey => Str | ||
| 58 | |||
| 59 | For C<SSE-KMS> and C<CSE-KMS>, this is the KMS key ARN or ID. | ||
| 60 | |||
| 61 | |||
| 62 | |||
| 63 | =head1 SEE ALSO | ||
| 64 | |||
| 65 | This class forms part of L<Paws>, describing an object used in L<Paws::Athena> | ||
| 66 | |||
| 67 | =head1 BUGS and CONTRIBUTIONS | ||
| 68 | |||
| 69 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 70 | |||
| 71 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 72 | |||
| 73 | =cut | ||
| 74 |