« blib/lib/Paws/KMS/ConnectCustomKeyStoreResponse.pm
↑ Summary
blib/lib/Paws/KMS/CreateCustomKeyStore.pm »
| 1 | |||
| 2 | package Paws::KMS::CreateAlias; | ||
| 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 => 'CreateAlias'); | ||
| 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::CreateAlias - Arguments for method CreateAlias on L<Paws::KMS> | ||
| 19 | |||
| 20 | =head1 DESCRIPTION | ||
| 21 | |||
| 22 | This class represents the parameters used for calling the method CreateAlias on the | ||
| 23 | L<AWS Key Management Service|Paws::KMS> service. Use the attributes of this class | ||
| 24 | as arguments to method CreateAlias. | ||
| 25 | |||
| 26 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateAlias. | ||
| 27 | |||
| 28 | =head1 SYNOPSIS | ||
| 29 | |||
| 30 | my $kms = Paws->service('KMS'); | ||
| 31 | # To create an alias | ||
| 32 | # The following example creates an alias for the specified customer master key | ||
| 33 | # (CMK). | ||
| 34 | $kms->CreateAlias( | ||
| 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/CreateAlias> | ||
| 42 | |||
| 43 | =head1 ATTRIBUTES | ||
| 44 | |||
| 45 | |||
| 46 | =head2 B<REQUIRED> AliasName => Str | ||
| 47 | |||
| 48 | Specifies the alias name. This value must begin with C<alias/> followed | ||
| 49 | by a name, such as C<alias/ExampleAlias>. | ||
| 50 | |||
| 51 | The C<AliasName> value must be string of 1-256 characters. It can | ||
| 52 | contain only alphanumeric characters, forward slashes (/), underscores | ||
| 53 | (_), and dashes (-). The alias name cannot begin with C<alias/aws/>. | ||
| 54 | The C<alias/aws/> prefix is reserved for AWS managed CMKs | ||
| 55 | (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk). | ||
| 56 | |||
| 57 | |||
| 58 | |||
| 59 | =head2 B<REQUIRED> TargetKeyId => Str | ||
| 60 | |||
| 61 | Associates the alias with the specified customer managed CMK | ||
| 62 | (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk). | ||
| 63 | The CMK must be in the same AWS Region. | ||
| 64 | |||
| 65 | A valid CMK ID is required. If you supply a null or empty string value, | ||
| 66 | this operation returns an error. | ||
| 67 | |||
| 68 | For help finding the key ID and ARN, see Finding the Key ID and ARN | ||
| 69 | (https://docs.aws.amazon.com/kms/latest/developerguide/viewing-keys.html#find-cmk-id-arn) | ||
| 70 | in the I<AWS Key Management Service Developer Guide>. | ||
| 71 | |||
| 72 | Specify the key ID or key ARN of the CMK. | ||
| 73 | |||
| 74 | For example: | ||
| 75 | |||
| 76 | =over | ||
| 77 | |||
| 78 | =item * | ||
| 79 | |||
| 80 | Key ID: C<1234abcd-12ab-34cd-56ef-1234567890ab> | ||
| 81 | |||
| 82 | =item * | ||
| 83 | |||
| 84 | Key ARN: | ||
| 85 | C<arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab> | ||
| 86 | |||
| 87 | =back | ||
| 88 | |||
| 89 | To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. | ||
| 90 | |||
| 91 | |||
| 92 | |||
| 93 | |||
| 94 | =head1 SEE ALSO | ||
| 95 | |||
| 96 | This class forms part of L<Paws>, documenting arguments for method CreateAlias in L<Paws::KMS> | ||
| 97 | |||
| 98 | =head1 BUGS and CONTRIBUTIONS | ||
| 99 | |||
| 100 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 101 | |||
| 102 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 103 | |||
| 104 | =cut | ||
| 105 |