Parameter |
Choices/Defaults |
Comments |
allow_reassociation
(added in 2.5) |
Default:
no
|
Specify this option to allow an Elastic IP address that is already associated with another network interface or instance to be re-associated with the specified instance or interface.
|
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
|
device_id
(added in 2.0) |
|
The id of the device for the EIP. Can be an EC2 Instance id or Elastic Network Interface (ENI) id.
aliases: instance_id
|
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.
|
in_vpc
(added in 1.4) |
Default:
no
|
Allocate an EIP inside a VPC or not. Required if specifying an ENI.
|
private_ip_address
(added in 2.3) |
|
The primary or secondary private IP address to associate with the Elastic IP address.
|
profile
(added in 1.6) |
|
Uses a boto profile. Only works with boto >= 2.24.0.
|
public_ip
|
|
The IP address of a previously allocated EIP.
If present and device is specified, the EIP is associated with the device.
If absent and device is specified, the EIP is disassociated from the device.
aliases: ip
|
region
|
|
aliases: aws_region, ec2_region
|
release_on_disassociation
(added in 2.0) |
Default:
no
|
whether or not to automatically release the EIP when it is disassociated
|
reuse_existing_ip_allowed
(added in 1.6) |
Default:
no
|
Reuse an EIP that is not associated to a device (when available), instead of allocating a new one.
|
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
|
If present, allocate an EIP or associate an existing EIP with a device.
If absent, disassociate the EIP from the device and optionally release it.
|
validate_certs
bool
(added in 1.5) |
|
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
|