| 1 | |||
| 2 | package Paws::KMS::UpdateAlias; | ||
| 3 | use Moose; | ||
| 4 | has AliasName => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has TargetKeyId => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | |||
| 7 | use MooseX::ClassAttribute; | ||
| 8 | |||
| 9 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'UpdateAlias'); | ||
| 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::UpdateAlias - Arguments for method UpdateAlias on L<Paws::KMS> | ||
| 19 | |||
| 20 | =head1 DESCRIPTION | ||
| 21 | |||
| 22 | This class represents the parameters used for calling the method UpdateAlias on the | ||
| 23 | L<AWS Key Management Service|Paws::KMS> service. Use the attributes of this class | ||
| 24 | as arguments to method UpdateAlias. | ||
| 25 | |||
| 26 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to UpdateAlias. | ||
| 27 | |||
| 28 | =head1 SYNOPSIS | ||
| 29 | |||
| 30 | my $kms = Paws->service('KMS'); | ||
| 31 | # To update an alias | ||
| 32 | # The following example updates the specified alias to refer to the specified | ||
| 33 | # customer master key (CMK). | ||
| 34 | $kms->UpdateAlias( | ||
| 35 | 'AliasName' => 'alias/ExampleAlias', | ||
| 36 | 'TargetKeyId' => '1234abcd-12ab-34cd-56ef-1234567890ab' | ||
| 37 | ); | ||
| 38 | |||
| 39 | |||
| 40 | 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. | ||
| 41 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/kms/UpdateAlias> | ||
| 42 | |||
| 43 | =head1 ATTRIBUTES | ||
| 44 | |||
| 45 | |||
| 46 | =head2 B<REQUIRED> AliasName => Str | ||
| 47 | |||
| 48 | Identifies the alias that is changing its CMK. This value must begin | ||
| 49 | with C<alias/> followed by the alias name, such as | ||
| 50 | C<alias/ExampleAlias>. You cannot use UpdateAlias to change the alias | ||
| 51 | name. | ||
| 52 | |||
| 53 | |||
| 54 | |||
| 55 | =head2 B<REQUIRED> TargetKeyId => Str | ||
| 56 | |||
| 57 | Identifies the customer managed CMK | ||
| 58 | (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk) | ||
| 59 | to associate with the alias. You don't have permission to associate an | ||
| 60 | alias with an AWS managed CMK | ||
| 61 | (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk). | ||
| 62 | |||
| 63 | The CMK must be in the same AWS account and Region as the alias. Also, | ||
| 64 | the new target CMK must be the same type as the current target CMK | ||
| 65 | (both symmetric or both asymmetric) and they must have the same key | ||
| 66 | usage. | ||
| 67 | |||
| 68 | Specify the key ID or key ARN of the CMK. | ||
| 69 | |||
| 70 | For example: | ||
| 71 | |||
| 72 | =over | ||
| 73 | |||
| 74 | =item * | ||
| 75 | |||
| 76 | Key ID: C<1234abcd-12ab-34cd-56ef-1234567890ab> | ||
| 77 | |||
| 78 | =item * | ||
| 79 | |||
| 80 | Key ARN: | ||
| 81 | C<arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab> | ||
| 82 | |||
| 83 | =back | ||
| 84 | |||
| 85 | To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. | ||
| 86 | |||
| 87 | To verify that the alias is mapped to the correct CMK, use ListAliases. | ||
| 88 | |||
| 89 | |||
| 90 | |||
| 91 | |||
| 92 | =head1 SEE ALSO | ||
| 93 | |||
| 94 | This class forms part of L<Paws>, documenting arguments for method UpdateAlias in L<Paws::KMS> | ||
| 95 | |||
| 96 | =head1 BUGS and CONTRIBUTIONS | ||
| 97 | |||
| 98 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 99 | |||
| 100 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 101 | |||
| 102 | =cut | ||
| 103 |