« blib/lib/Paws/AccessAnalyzer/KmsGrantConfiguration.pm
↑ Summary
blib/lib/Paws/AccessAnalyzer/KmsKeyConfiguration.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::AccessAnalyzer::KmsGrantConstraints; | ||
| 3 | use Moose; | ||
| 4 | has EncryptionContextEquals => (is => 'ro', isa => 'Paws::AccessAnalyzer::KmsConstraintsMap', request_name => 'encryptionContextEquals', traits => ['NameInRequest']); | ||
| 5 | has EncryptionContextSubset => (is => 'ro', isa => 'Paws::AccessAnalyzer::KmsConstraintsMap', request_name => 'encryptionContextSubset', traits => ['NameInRequest']); | ||
| 6 | |||
| 7 | 1; | ||
| 8 | |||
| 9 | ### main pod documentation begin ### | ||
| 10 | |||
| 11 | =head1 NAME | ||
| 12 | |||
| 13 | Paws::AccessAnalyzer::KmsGrantConstraints | ||
| 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::AccessAnalyzer::KmsGrantConstraints object: | ||
| 25 | |||
| 26 | $service_obj->Method(Att1 => { EncryptionContextEquals => $value, ..., EncryptionContextSubset => $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::AccessAnalyzer::KmsGrantConstraints object: | ||
| 31 | |||
| 32 | $result = $service_obj->Method(...); | ||
| 33 | $result->Att1->EncryptionContextEquals | ||
| 34 | |||
| 35 | =head1 DESCRIPTION | ||
| 36 | |||
| 37 | Use this structure to propose allowing cryptographic operations | ||
| 38 | (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations) | ||
| 39 | in the grant only when the operation request includes the specified | ||
| 40 | encryption context | ||
| 41 | (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context). | ||
| 42 | You can specify only one type of encryption context. An empty map is | ||
| 43 | treated as not specified. For more information, see GrantConstraints | ||
| 44 | (https://docs.aws.amazon.com/kms/latest/APIReference/API_GrantConstraints.html). | ||
| 45 | |||
| 46 | =head1 ATTRIBUTES | ||
| 47 | |||
| 48 | |||
| 49 | =head2 EncryptionContextEquals => L<Paws::AccessAnalyzer::KmsConstraintsMap> | ||
| 50 | |||
| 51 | A list of key-value pairs that must match the encryption context in the | ||
| 52 | cryptographic operation | ||
| 53 | (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations) | ||
| 54 | request. The grant allows the operation only when the encryption | ||
| 55 | context in the request is the same as the encryption context specified | ||
| 56 | in this constraint. | ||
| 57 | |||
| 58 | |||
| 59 | =head2 EncryptionContextSubset => L<Paws::AccessAnalyzer::KmsConstraintsMap> | ||
| 60 | |||
| 61 | A list of key-value pairs that must be included in the encryption | ||
| 62 | context of the cryptographic operation | ||
| 63 | (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations) | ||
| 64 | request. The grant allows the cryptographic operation only when the | ||
| 65 | encryption context in the request includes the key-value pairs | ||
| 66 | specified in this constraint, although it can include additional | ||
| 67 | key-value pairs. | ||
| 68 | |||
| 69 | |||
| 70 | |||
| 71 | =head1 SEE ALSO | ||
| 72 | |||
| 73 | This class forms part of L<Paws>, describing an object used in L<Paws::AccessAnalyzer> | ||
| 74 | |||
| 75 | =head1 BUGS and CONTRIBUTIONS | ||
| 76 | |||
| 77 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 78 | |||
| 79 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 80 | |||
| 81 | =cut | ||
| 82 |