NAME

Paws::KMS::CreateAlias - Arguments for method CreateAlias on Paws::KMS

DESCRIPTION

This class represents the parameters used for calling the method CreateAlias on the AWS Key Management Service service. Use the attributes of this class as arguments to method CreateAlias.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateAlias.

SYNOPSIS

    my $kms = Paws->service('KMS');
  # To create an alias
  # The following example creates an alias for the specified customer master key
  # (CMK).
    $kms->CreateAlias(
      'AliasName'   => 'alias/ExampleAlias',
      'TargetKeyId' => '1234abcd-12ab-34cd-56ef-1234567890ab'
    );

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. For the AWS API documentation, see <https://docs.aws.amazon.com/goto/WebAPI/kms/CreateAlias>

ATTRIBUTES

REQUIRED AliasName => Str

Specifies the alias name. This value must begin with "alias/" followed by a name, such as "alias/ExampleAlias".

The "AliasName" value must be string of 1-256 characters. It can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). The alias name cannot begin with "alias/aws/". The "alias/aws/" prefix is reserved for AWS managed CMKs (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk).

REQUIRED TargetKeyId => Str

Associates the alias with the specified customer managed CMK (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk). The CMK must be in the same AWS Region.

A valid CMK ID is required. If you supply a null or empty string value, this operation returns an error.

For help finding the key ID and ARN, see Finding the Key ID and ARN (https://docs.aws.amazon.com/kms/latest/developerguide/viewing-keys.html#find-cmk-id-arn) in the AWS Key Management Service Developer Guide.

Specify the key ID or key ARN of the CMK.

For example:

Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
Key ARN: "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

BUGS and CONTRIBUTIONS

The source code is located here: <https://github.com/pplu/aws-sdk-perl>

Please report bugs to: <https://github.com/pplu/aws-sdk-perl/issues>