diff --git a/website/source/docs/builders/amazon-chroot.html.md b/website/source/docs/builders/amazon-chroot.html.md index 8ac5cbd7d..030c43a3a 100644 --- a/website/source/docs/builders/amazon-chroot.html.md +++ b/website/source/docs/builders/amazon-chroot.html.md @@ -170,6 +170,33 @@ each category, the available configuration keys are alphabetized. - `skip_region_validation` (boolean) - Set to true if you want to skip validation of the `ami_regions` configuration option. Defaults to false. +- `source_ami_filter` (object) - Filters used to populate the `source_ami` field. + Example: + ``` {.javascript} + "source_ami_filter": { + "filters": { + "virtualization-type": "hvm", + "name": "*ubuntu-xenial-16.04-amd64-server-*", + "root-device-type": "ebs" + }, + "owners": ["099720109477"], + "most_recent": true + } + ``` + This selects the most recent Ubuntu 16.04 HVM EBS AMI from Canonical. + NOTE: This will fail unless *exactly* one AMI is returned. + + - `filters` (map of strings) - filters used to select a `source_ami`. + NOTE: This will fail unless *exactly* one AMI is returned. + Any filter described in the docs for [DescribeImages](http://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeImages.html) + is valid. + + - `owners` (array of strings) - This scopes the AMIs to certain Amazon account IDs. + This is helpful to limit the AMIs to a trusted third party, or to your own account. + + - `most_recent` (bool) - Selects the newest created image when true. + This is most useful for selecting a daily distro build. + - `tags` (object of key/value strings) - Tags applied to the AMI. ## Basic Example diff --git a/website/source/docs/builders/amazon-ebs.html.md b/website/source/docs/builders/amazon-ebs.html.md index 21b958f11..2359c7f8c 100644 --- a/website/source/docs/builders/amazon-ebs.html.md +++ b/website/source/docs/builders/amazon-ebs.html.md @@ -188,16 +188,18 @@ builder. } ``` This selects the most recent Ubuntu 16.04 HVM EBS AMI from Canonical. + NOTE: This will fail unless *exactly* one AMI is returned. -- `source_ami_filter.filters` (map of strings) - filters used to select a `source_ami`. - Any filter described in the docs for [DescribeImages](http://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeImages.html) - is valid. + - `filters` (map of strings) - filters used to select a `source_ami`. + NOTE: This will fail unless *exactly* one AMI is returned. + Any filter described in the docs for [DescribeImages](http://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeImages.html) + is valid. -- `source_ami_filter.owners` (array of strings) - This scopes the AMIs to certain Amazon account IDs. - This is helpful to limit the AMIs to a trusted third party, or to your own account. + - `owners` (array of strings) - This scopes the AMIs to certain Amazon account IDs. + This is helpful to limit the AMIs to a trusted third party, or to your own account. -- `source_ami_filter.most_recent` (bool) - Selects the newest created image when true. - This is most useful for selecting a daily distro build. + - `most_recent` (bool) - Selects the newest created image when true. + This is most useful for selecting a daily distro build. - `spot_price` (string) - The maximum hourly price to pay for a spot instance to create the AMI. Spot instances are a type of instance that EC2 starts diff --git a/website/source/docs/builders/amazon-instance.html.md b/website/source/docs/builders/amazon-instance.html.md index 846f0f556..148020771 100644 --- a/website/source/docs/builders/amazon-instance.html.md +++ b/website/source/docs/builders/amazon-instance.html.md @@ -194,6 +194,33 @@ builder. - `skip_region_validation` (boolean) - Set to true if you want to skip validation of the region configuration option. Defaults to false. +- `source_ami_filter` (object) - Filters used to populate the `source_ami` field. + Example: + ``` {.javascript} + "source_ami_filter": { + "filters": { + "virtualization-type": "hvm", + "name": "*ubuntu-xenial-16.04-amd64-server-*", + "root-device-type": "ebs" + }, + "owners": ["099720109477"], + "most_recent": true + } + ``` + This selects the most recent Ubuntu 16.04 HVM EBS AMI from Canonical. + NOTE: This will fail unless *exactly* one AMI is returned. + + - `filters` (map of strings) - filters used to select a `source_ami`. + NOTE: This will fail unless *exactly* one AMI is returned. + Any filter described in the docs for [DescribeImages](http://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeImages.html) + is valid. + + - `owners` (array of strings) - This scopes the AMIs to certain Amazon account IDs. + This is helpful to limit the AMIs to a trusted third party, or to your own account. + + - `most_recent` (bool) - Selects the newest created image when true. + This is most useful for selecting a daily distro build. + - `spot_price` (string) - The maximum hourly price to launch a spot instance to create the AMI. It is a type of instances that EC2 starts when the maximum price that you specify exceeds the current spot price. Spot price