| 1 | |||
| 2 | package Paws::KMS::TagResource; | ||
| 3 | use Moose; | ||
| 4 | has KeyId => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has Tags => (is => 'ro', isa => 'ArrayRef[Paws::KMS::Tag]', required => 1); | ||
| 6 | |||
| 7 | use MooseX::ClassAttribute; | ||
| 8 | |||
| 9 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'TagResource'); | ||
| 10 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::API::Response'); | ||
| 11 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 12 | 1; | ||
| 13 | |||
| 14 | ### main pod documentation begin ### | ||
| 15 | |||
| 16 | =head1 NAME | ||
| 17 | |||
| 18 | Paws::KMS::TagResource - Arguments for method TagResource on L<Paws::KMS> | ||
| 19 | |||
| 20 | =head1 DESCRIPTION | ||
| 21 | |||
| 22 | This class represents the parameters used for calling the method TagResource on the | ||
| 23 | L<AWS Key Management Service|Paws::KMS> service. Use the attributes of this class | ||
| 24 | as arguments to method TagResource. | ||
| 25 | |||
| 26 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to TagResource. | ||
| 27 | |||
| 28 | =head1 SYNOPSIS | ||
| 29 | |||
| 30 | my $kms = Paws->service('KMS'); | ||
| 31 | # To tag a customer master key (CMK) | ||
| 32 | # The following example tags a CMK. | ||
| 33 | $kms->TagResource( | ||
| 34 | 'KeyId' => '1234abcd-12ab-34cd-56ef-1234567890ab', | ||
| 35 | 'Tags' => [ | ||
| 36 | |||
| 37 | { | ||
| 38 | 'TagKey' => 'Purpose', | ||
| 39 | 'TagValue' => 'Test' | ||
| 40 | } | ||
| 41 | ] | ||
| 42 | ); | ||
| 43 | |||
| 44 | |||
| 45 | Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. | ||
| 46 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/kms/TagResource> | ||
| 47 | |||
| 48 | =head1 ATTRIBUTES | ||
| 49 | |||
| 50 | |||
| 51 | =head2 B<REQUIRED> KeyId => Str | ||
| 52 | |||
| 53 | Identifies a customer managed CMK in the account and Region. | ||
| 54 | |||
| 55 | Specify the key ID or key ARN of the CMK. | ||
| 56 | |||
| 57 | For example: | ||
| 58 | |||
| 59 | =over | ||
| 60 | |||
| 61 | =item * | ||
| 62 | |||
| 63 | Key ID: C<1234abcd-12ab-34cd-56ef-1234567890ab> | ||
| 64 | |||
| 65 | =item * | ||
| 66 | |||
| 67 | Key ARN: | ||
| 68 | C<arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab> | ||
| 69 | |||
| 70 | =back | ||
| 71 | |||
| 72 | To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. | ||
| 73 | |||
| 74 | |||
| 75 | |||
| 76 | =head2 B<REQUIRED> Tags => ArrayRef[L<Paws::KMS::Tag>] | ||
| 77 | |||
| 78 | One or more tags. | ||
| 79 | |||
| 80 | Each tag consists of a tag key and a tag value. The tag value can be an | ||
| 81 | empty (null) string. | ||
| 82 | |||
| 83 | You cannot have more than one tag on a CMK with the same tag key. If | ||
| 84 | you specify an existing tag key with a different tag value, AWS KMS | ||
| 85 | replaces the current tag value with the specified one. | ||
| 86 | |||
| 87 | |||
| 88 | |||
| 89 | |||
| 90 | =head1 SEE ALSO | ||
| 91 | |||
| 92 | This class forms part of L<Paws>, documenting arguments for method TagResource in L<Paws::KMS> | ||
| 93 | |||
| 94 | =head1 BUGS and CONTRIBUTIONS | ||
| 95 | |||
| 96 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 97 | |||
| 98 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 99 | |||
| 100 | =cut | ||
| 101 |