Added docs for kms

This commit is contained in:
Philip Witty 2015-10-26 14:47:35 +00:00 committed by Radek Simko
parent 5e18031367
commit fd4be284da
3 changed files with 88 additions and 0 deletions

View File

@ -0,0 +1,38 @@
---
layout: "aws"
page_title: "AWS: aws_kms_alias"
sidebar_current: "docs-aws-resource-kms-alias"
description: |-
Provides a display name for a customer master key.
---
# aws\_kms\_alias
Provides an alias for a KMS customer master key. AWS Console enforces 1-to-1 mapping between aliases & keys,
but API (hence Terraform too) allows you to create as many aliases as
the [account limits](http://docs.aws.amazon.com/kms/latest/developerguide/limits.html) allow you.
## Example Usage
```
resource "aws_kms_key" "a" {
}
resource "aws_kms_alias" "a" {
name = "alias/my-key-alias"
target_key_id = "${aws_kms_key.a.key_id}"
}
```
## Argument Reference
The following arguments are supported:
* `name` - (Required) The display name of the alias. The name must start with the word "alias" followed by a forward slash (alias/)
* `target_key_id` - (Required) Identifier for the key for which the alias is for, can be either an ARN or key_id.
## Attributes Reference
The following attributes are exported:
* `arn` - The Amazon Resource Name (ARN) of the key alias.

View File

@ -0,0 +1,36 @@
---
layout: "aws"
page_title: "AWS: aws_kms_key"
sidebar_current: "docs-aws-resource-kms-key"
description: |-
Provides a KMS customer master key.
---
# aws\_kms\_key
Provides a KMS customer master key.
## Example Usage
```
resource "aws_kms_key" "a" {
description = "KMS key 1"
deletion_window = 10
}
```
## Argument Reference
The following arguments are supported:
* `description` - (Optional) The description of the key as viewed in AWS console.
* `key_usage` - (Optional) Specifies the intended use of the key. Currently this defaults to ENCRYPT/DECRYPT, and only symmetric encryption and decryption are supported.
* `policy` - (Optional) A valid policy JSON document.
* `deletion_window` - (Optional) Duration in days after which the key is deleted after destruction of the resource, must be between 7 and 30 days.
## Attributes Reference
The following attributes are exported:
* `arn` - The Amazon Resource Name (ARN) of the key.
* `key_id` - The globally unique identifier for the key.

View File

@ -405,6 +405,20 @@
</ul>
</li>
<li<%= sidebar_current(/^docs-aws-resource-kms/) %>>
<a href="#">KMS Resources</a>
<ul class="nav nav-visible">
<li<%= sidebar_current("docs-aws-resource-kms-key") %>>
<a href="/docs/providers/aws/r/kms_key.html">aws_kms_key</a>
</li>
<li<%= sidebar_current("docs-aws-resource-kms-alias") %>>
<a href="/docs/providers/aws/r/kms_alias.html">aws_kms_alias</a>
</li>
</ul>
</li>
<li<%= sidebar_current(/^docs-aws-resource-lambda/) %>>
<a href="#">Lambda Resources</a>
<ul class="nav nav-visible">