« blib/lib/Paws/AccessAnalyzer/KmsGrantConstraints.pm
↑ Summary
blib/lib/Paws/AccessAnalyzer/KmsKeyPoliciesMap.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::AccessAnalyzer::KmsKeyConfiguration; | ||
| 3 | use Moose; | ||
| 4 | has Grants => (is => 'ro', isa => 'ArrayRef[Paws::AccessAnalyzer::KmsGrantConfiguration]', request_name => 'grants', traits => ['NameInRequest']); | ||
| 5 | has KeyPolicies => (is => 'ro', isa => 'Paws::AccessAnalyzer::KmsKeyPoliciesMap', request_name => 'keyPolicies', traits => ['NameInRequest']); | ||
| 6 | |||
| 7 | 1; | ||
| 8 | |||
| 9 | ### main pod documentation begin ### | ||
| 10 | |||
| 11 | =head1 NAME | ||
| 12 | |||
| 13 | Paws::AccessAnalyzer::KmsKeyConfiguration | ||
| 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::KmsKeyConfiguration object: | ||
| 25 | |||
| 26 | $service_obj->Method(Att1 => { Grants => $value, ..., KeyPolicies => $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::KmsKeyConfiguration object: | ||
| 31 | |||
| 32 | $result = $service_obj->Method(...); | ||
| 33 | $result->Att1->Grants | ||
| 34 | |||
| 35 | =head1 DESCRIPTION | ||
| 36 | |||
| 37 | Proposed access control configuration for a KMS key. You can propose a | ||
| 38 | configuration for a new KMS key or an existing KMS key that you own by | ||
| 39 | specifying the key policy and KMS grant configuration. If the | ||
| 40 | configuration is for an existing key and you do not specify the key | ||
| 41 | policy, the access preview uses the existing policy for the key. If the | ||
| 42 | access preview is for a new resource and you do not specify the key | ||
| 43 | policy, then the access preview uses the default key policy. The | ||
| 44 | proposed key policy cannot be an empty string. For more information, | ||
| 45 | see Default key policy | ||
| 46 | (https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default). | ||
| 47 | For more information about key policy limits, see Resource quotas | ||
| 48 | (https://docs.aws.amazon.com/kms/latest/developerguide/resource-limits.html). | ||
| 49 | |||
| 50 | =head1 ATTRIBUTES | ||
| 51 | |||
| 52 | |||
| 53 | =head2 Grants => ArrayRef[L<Paws::AccessAnalyzer::KmsGrantConfiguration>] | ||
| 54 | |||
| 55 | A list of proposed grant configurations for the KMS key. If the | ||
| 56 | proposed grant configuration is for an existing key, the access preview | ||
| 57 | uses the proposed list of grant configurations in place of the existing | ||
| 58 | grants. Otherwise, the access preview uses the existing grants for the | ||
| 59 | key. | ||
| 60 | |||
| 61 | |||
| 62 | =head2 KeyPolicies => L<Paws::AccessAnalyzer::KmsKeyPoliciesMap> | ||
| 63 | |||
| 64 | Resource policy configuration for the KMS key. The only valid value for | ||
| 65 | the name of the key policy is C<default>. For more information, see | ||
| 66 | Default key policy | ||
| 67 | (https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default). | ||
| 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 |