diff --git a/website/source/docs/post-processors/amazon-import.html.md b/website/source/docs/post-processors/amazon-import.html.md index dfe698b15..2c3810151 100644 --- a/website/source/docs/post-processors/amazon-import.html.md +++ b/website/source/docs/post-processors/amazon-import.html.md @@ -43,22 +43,48 @@ Required: Optional: -- `s3_key_name` (string) - The name of the key in `s3_bucket_name` where the OVA file will be copied to for import. If not specified, this will default to "packer-import-{{timestamp}}.ova". This key (ie, the uploaded OVA) will be removed after import, unless `skip_clean` is `true`. +- `ami_description` (string) - The description to set for the resulting + imported AMI. By default this description is generated by the AMI import + process. -- `skip_clean` (boolean) - Whether we should skip removing the OVA file uploaded to S3 after the import process has completed. "true" means that we should leave it in the S3 bucket, "false" means to clean it out. Defaults to `false`. +- `ami_groups` (array of strings) - A list of groups that have access to + launch the imported AMI. By default no groups have permission to launch the + AMI. `all` will make the AMI publically accessible. AWS currently doesn't + accept any value other than "all". -- `ami_name` (string) - The name of the ami within the console. If not specified, this will default to something like `ami-import-sfwerwf`. Please note, specifying this option will result in a slightly longer execution time. +- `ami_name` (string) - The name of the ami within the console. If not + specified, this will default to something like `ami-import-sfwerwf`. + Please note, specifying this option will result in a slightly longer + execution time. -- `tags` (object of key/value strings) - Tags applied to the created AMI and +- `ami_users` (array of strings) - A list of account IDs that have access to + launch the imported AMI. By default no additional users other than the user + importing the AMI has permission to launch it. + +- `license_type` (string) - The license type to be used for the Amazon Machine + Image (AMI) after importing. Valid values: `AWS` or `BYOL` (default). + For more details regarding licensing, see + [Prerequisites](http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/VMImportPrerequisites.html) + in the VM Import/Export User Guide. + +- `mfa_code` (string) - The MFA [TOTP](https://en.wikipedia.org/wiki/Time-based_One-time_Password_Algorithm) + code. This should probably be a user variable since it changes all the time. + +- `s3_key_name` (string) - The name of the key in `s3_bucket_name` where the + OVA file will be copied to for import. If not specified, this will default + to "packer-import-{{timestamp}}.ova". This key (ie, the uploaded OVA) will + be removed after import, unless `skip_clean` is `true`. + +- `skip_clean` (boolean) - Whether we should skip removing the OVA file uploaded to S3 after the + import process has completed. "true" means that we should leave it in the S3 bucket, "false" means to clean it out. Defaults to `false`. + +- `tags` (object of key/value strings) - Tags applied to the created AMI and relevant snapshots. -- `ami_users` (array of strings) - A list of account IDs that have access to launch the imported AMI. By default no additional users other than the user importing the AMI has permission to launch it. - -- `ami_groups` (array of strings) - A list of groups that have access to launch the imported AMI. By default no groups have permission to launch the AMI. `all` will make the AMI publically accessible. AWS currently doesn't accept any value other than "all". - -- `ami_description` (string) - The description to set for the resulting imported AMI. By default this description is generated by the AMI import process. - -- `license_type` (string) - The license type to be used for the Amazon Machine Image (AMI) after importing. Valid values: `AWS` or `BYOL` (default). For more details regarding licensing, see [Prerequisites](http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/VMImportPrerequisites.html) in the VM Import/Export User Guide. +- `token` (string) - The access token to use. This is different from the + access key and secret key. If you're not sure what this is, then you + probably don't need it. This will also be read from the `AWS_SESSION_TOKEN` + environmental variable. ## Basic Example