ResiLien
/
terraform
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
terraform/website/source/docs/providers/aws/r/ami_copy.html.markdown

61 lines
2.0 KiB
Markdown
Raw Normal View History

Three resources for AWS AMIs. AWS provides three different ways to create AMIs that each have different inputs, but once they are complete the same management operations apply. Thus these three resources each have a different "Create" implementation but then share the same "Read", "Update" and "Delete" implementations.
2015-08-30 06:35:45 +02:00
---
layout: "aws"
page_title: "AWS: aws_ami_copy"
sidebar_current: "docs-aws-resource-ami-copy"
description: |-
Duplicates an existing Amazon Machine Image (AMI)
---
# aws\_ami\_copy
The "AMI copy" resource allows duplication of an Amazon Machine Image (AMI),
including cross-region copies.
If the source AMI has associated EBS snapshots, those will also be duplicated
along with the AMI.
This is useful for taking a single AMI provisioned in one region and making
it available in another for a multi-region deployment.
Copying an AMI can take several minutes. The creation of this resource will
block until the new AMI is available for use on new instances.
## Example Usage
```
resource "aws_ami_copy" "example" {
website/docs: Run `terraform fmt` on code examples (#12075) * docs/vsphere: Fix code block * docs: Convert `...` to `# ...` to allow `terraform fmt`ing * docs: Trim trailing whitespace * docs: First-pass run of `terraform fmt` on code examples
2017-02-18 23:48:50 +01:00
name = "terraform-example"
description = "A copy of ami-xxxxxxxx"
source_ami_id = "ami-xxxxxxxx"
source_ami_region = "us-west-1"
tags {
Name = "HelloWorld"
}
Three resources for AWS AMIs. AWS provides three different ways to create AMIs that each have different inputs, but once they are complete the same management operations apply. Thus these three resources each have a different "Create" implementation but then share the same "Read", "Update" and "Delete" implementations.
2015-08-30 06:35:45 +02:00
}
```
## Argument Reference
The following arguments are supported:
* `name` - (Required) A region-unique name for the AMI.
* `source_ami_id` - (Required) The id of the AMI to copy. This id must be valid in the region
given by `source_ami_region`.
Update ami_copy.html.markdown
2017-01-21 14:50:15 +01:00
* `source_ami_region` - (Required) The region from which the AMI will be copied. This may be the
Three resources for AWS AMIs. AWS provides three different ways to create AMIs that each have different inputs, but once they are complete the same management operations apply. Thus these three resources each have a different "Create" implementation but then share the same "Read", "Update" and "Delete" implementations.
2015-08-30 06:35:45 +02:00
same as the AWS provider region in order to create a copy within the same region.
docs/aws: Add and as docs to the AWS resource (#7988)
2016-08-05 02:38:00 +02:00
* `encrypted` - (Optional) Specifies whether the destination snapshots of the copied image should be encrypted. Defaults to `false`
website/docs: Run `terraform fmt` on code examples (#12075) * docs/vsphere: Fix code block * docs: Convert `...` to `# ...` to allow `terraform fmt`ing * docs: Trim trailing whitespace * docs: First-pass run of `terraform fmt` on code examples
2017-02-18 23:48:50 +01:00
* `kms_key_id` - (Optional) The full ARN of the KMS Key to use when encrypting the snapshots of an image during a copy operation. If not specified, then the default AWS KMS Key will be used
Three resources for AWS AMIs. AWS provides three different ways to create AMIs that each have different inputs, but once they are complete the same management operations apply. Thus these three resources each have a different "Create" implementation but then share the same "Read", "Update" and "Delete" implementations.
2015-08-30 06:35:45 +02:00
Link aws_ami_copy documentation to aws_ami Clarify that aws_ami_copy can use the arguments from aws_ami.
2016-02-13 14:36:09 +01:00
This resource also exposes the full set of arguments from the [`aws_ami`](ami.html) resource.
Three resources for AWS AMIs. AWS provides three different ways to create AMIs that each have different inputs, but once they are complete the same management operations apply. Thus these three resources each have a different "Create" implementation but then share the same "Read", "Update" and "Delete" implementations.
2015-08-30 06:35:45 +02:00
## Attributes Reference
The following attributes are exported:
* `id` - The ID of the created AMI.
This resource also exports a full set of attributes corresponding to the arguments of the
Link aws_ami_copy documentation to aws_ami Clarify that aws_ami_copy can use the arguments from aws_ami.
2016-02-13 14:36:09 +01:00
[`aws_ami`](ami.html) resource, allowing the properties of the created AMI to be used elsewhere in the
Three resources for AWS AMIs. AWS provides three different ways to create AMIs that each have different inputs, but once they are complete the same management operations apply. Thus these three resources each have a different "Create" implementation but then share the same "Read", "Update" and "Delete" implementations.
2015-08-30 06:35:45 +02:00
configuration.