Adding the the docs for the Glacier Vault resource

Updating the glacier docs to include a link to the AWS developer guide
This commit is contained in:
stack72 2015-09-15 23:32:54 +01:00
parent 5266db31e2
commit 95d35ad77f
2 changed files with 77 additions and 0 deletions

View File

@ -0,0 +1,68 @@
---
layout: "aws"
page_title: "AWS: aws_glacier_vault"
sidebar_current: "docs-aws-resource-glacier-vault"
description: |-
Provides a Glacier Vault.
---
# aws\_glacier\_vault
Provides a Glacier Vault Resource. You can refer to the [Glacier Developer Guide](http://docs.aws.amazon.com/amazonglacier/latest/dev/working-with-vaults.html) for a full explanation of the Glacier Vault functionality
## Example Usage
```
resource "aws_glacier_vault" "my_archive" {
name = "MyArchive"
notification {
sns_topic = "arn:aws:sns:us-west-2:432981146916:MyArchiveTopic"
events = ["ArchiveRetrievalCompleted","InventoryRetrievalCompleted"]
}
access_policy = <<EOF
{
"Version":"2012-10-17",
"Statement":[
{
"Sid": "add-read-only-perm",
"Principal": "*",
"Effect": "Allow",
"Action": [
"glacier:InitiateJob",
"glacier:GetJobOutput"
],
"Resource": [
"arn:aws:glacier:eu-west-1:432981146916:vaults/MyArchive"
]
}
]
}
EOF
tags {
Test="MyArchive"
}
}
```
## Argument Reference
The following arguments are supported:
* `name` - (Required) The name of the Vault. Names can be between 1 and 255 characters long and the valid characters are a-z, A-Z, 0-9, '_' (underscore), '-' (hyphen), and '.' (period).
* `access_policy` - (Required) The policy document. This is a JSON formatted string.
The heredoc syntax or `file` function is helpful here.
* `notification` - (Required) The notifications for the Vault. Fields documented below.
* `tags` - (Optional) A mapping of tags to assign to the resource.
**notification** supports the following:
* `events` - (Required) You can configure a vault to public a notification for `ArchiveRetrievalCompleted` and `InventoryRetrievalCompleted` events.
* `sns_topic` - (Required) The SNS Topic ARN.
The following attributes are exported:
* `location` - The URI of the vault that was created.
* `arn` - The ARN of the vault.

View File

@ -201,6 +201,15 @@
</ul>
</li>
<li<%= sidebar_current(/^docs-aws-resource-glacier/) %>>
<a href="#">Glacier Resources</a>
<ul class="nav nav-visible">
<li<%= sidebar_current("docs-aws-resource-glacier-vault") %>>
<a href="/docs/providers/aws/r/glacier_vault.html">aws_glacier_vault</a>
</li>
</ul>
</li>
<li<%= sidebar_current(/^docs-aws-resource-iam/) %>>
<a href="#">IAM Resources</a>