github.com/andresvia/terraform@v0.6.15-0.20160412045437-d51c75946785/website/source/docs/providers/aws/r/kms_alias.html.markdown (about)

     1  ---
     2  layout: "aws"
     3  page_title: "AWS: aws_kms_alias"
     4  sidebar_current: "docs-aws-resource-kms-alias"
     5  description: |-
     6    Provides a display name for a customer master key.
     7  ---
     8  
     9  # aws\_kms\_alias
    10  
    11  Provides an alias for a KMS customer master key. AWS Console enforces 1-to-1 mapping between aliases & keys,
    12  but API (hence Terraform too) allows you to create as many aliases as
    13  the [account limits](http://docs.aws.amazon.com/kms/latest/developerguide/limits.html) allow you.
    14  
    15  ## Example Usage
    16  
    17  ```
    18  resource "aws_kms_key" "a" {
    19  }
    20  
    21  resource "aws_kms_alias" "a" {
    22      name = "alias/my-key-alias"
    23      target_key_id = "${aws_kms_key.a.key_id}"
    24  }
    25  ```
    26  
    27  ## Argument Reference
    28  
    29  The following arguments are supported:
    30  
    31  
    32  * `name` - (Optional) The display name of the alias. The name must start with the word "alias" followed by a forward slash (alias/)
    33  * `name_prefix` - (Optional) Creates an unique alias beginning with the specified prefix.  
    34  The name must start with the word "alias" followed by a forward slash (alias/).  Conflicts with `name`.
    35  * `target_key_id` - (Required) Identifier for the key for which the alias is for, can be either an ARN or key_id.
    36  
    37  ## Attributes Reference
    38  
    39  The following attributes are exported:
    40  
    41  * `arn` - The Amazon Resource Name (ARN) of the key alias.