AWS Provider
The following tables and example YAML configuration file snippets contain details needed to provision resources via the
Contra HDSL.
Additional reference can be made to the Linchpin AWS provider documentation
as well as the Ansible ec2 module , on which the
Linchpin AWS provider is based.
Requirements for the content of the credentials file for this provider can be seen in the Linchpin
documentation
AWS configuration keys
ami
| Type |
Required |
Purpose |
| String |
true |
Defines the AMI of the resource to deploy. |
region
| Type |
Required |
Purpose |
| String |
false |
Defines the region to deploy the resource. |
name
| Type |
Required |
Purpose |
| String |
true |
A user defined name to refer to this resource. |
Note
Names should be unique per resource type.
instance_type
| Type |
Required |
Purpose |
| String |
true |
The instance type for the resource. |
key_pair
| Type |
Required |
Purpose |
| String |
false |
The name of the keypair to use when provisioning resources. |
Note
The SSH keypair name defaults to provider.ssh unless specifically provided.
vpc_subnet_id
| Type |
Required |
Purpose |
| String |
false |
The subnet ID in which to launch the instance (VPC). |
user
| Type |
Required |
Purpose |
| String |
true |
The username to use when connecting to this instance via SSH. |
assign_public_ip
| Type |
Required |
Purpose |
| Boolean |
false |
When provisioning within vpc, assign a public IP address. |
count
| Type |
Required |
Purpose |
| Integer |
false |
The number of this specific instance to launch. |
security_groups
| Type |
Required |
Purpose |
| List |
false |
Security group(s) to use with the instance. |