Parameter |
Choices/Defaults |
Comments |
allocation_id
|
|
The id of the elastic IP allocation. If this is not passed and the eip_address is not passed. An EIP is generated for this NAT Gateway.
|
aws_access_key
|
|
AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
aliases: ec2_access_key, access_key
|
aws_secret_key
|
|
AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
aliases: ec2_secret_key, secret_key
|
client_token
|
|
Optional unique token to be used during create to ensure idempotency. When specifying this option, ensure you specify the eip_address parameter as well otherwise any subsequent runs will fail.
|
ec2_url
|
|
Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
|
eip_address
|
|
The elastic IP address of the EIP you want attached to this NAT Gateway. If this is not passed and the allocation_id is not passed, an EIP is generated for this NAT Gateway.
|
if_exist_do_not_create
|
Default:
no
|
if a NAT Gateway exists already in the subnet_id, then do not create a new one.
|
nat_gateway_id
|
|
The id AWS dynamically allocates to the NAT Gateway on creation. This is required when the absent option is present.
|
profile
(added in 1.6) |
|
Uses a boto profile. Only works with boto >= 2.24.0.
|
region
|
|
aliases: aws_region, ec2_region
|
release_eip
|
Default:
yes
|
Deallocate the EIP from the VPC.
Option is only valid with the absent state.
You should use this with the wait option. Since you can not release an address while a delete operation is happening.
|
security_token
(added in 1.6) |
|
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
aliases: access_token
|
state
|
Choices:
present ←
- absent
|
Ensure NAT Gateway is present or absent.
|
subnet_id
|
|
The id of the subnet to create the NAT Gateway in. This is required with the present option.
|
validate_certs
bool
(added in 1.5) |
|
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
|
wait
|
Default:
no
|
Wait for operation to complete before returning.
|
wait_timeout
|
Default:
300
|
How many seconds to wait for an operation to complete before timing out.
|