New in version 2.4.
The below requirements are needed on the host that executes this module.
Parameter |
Choices/Defaults |
Comments |
---|---|---|
aws_access_key
|
Default:
None
|
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
|
Default:
None
|
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 |
bandwidth
|
|
The bandwidth of the Direct Connect connection. Required when state=present.
|
connection_id
|
|
The ID of the Direct Connect connection. name or connection_id is required to recreate or delete a connection. Modifying attributes of a connection with forced_update will result in a new Direct Connect connection ID.
|
ec2_url
|
Default:
None
|
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.
|
forced_update
|
|
To modify bandwidth or location the connection will need to be deleted and recreated. By default this will not happen - this option must be set to True.
|
link_aggregation_group
|
|
The ID of the link aggregation group you want to associate with the connection. This is optional in case a stand-alone connection is desired.
|
location
|
|
Where the Direct Connect connection is located. Required when state=present.
|
name
|
|
The name of the Direct Connect connection. This is required to create a new connection. To recreate or delete a connection name or connection_id is required.
|
profile
(added in 1.6) |
Default:
None
|
Uses a boto profile. Only works with boto >= 2.24.0.
|
region
|
|
The AWS region to use. If not specified then the value of the AWS_REGION or EC2_REGION environment variable, if any, is used. See http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region
aliases: aws_region, ec2_region |
security_token
(added in 1.6) |
Default:
None
|
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
|
|
The state of the Direct Connect connection.
|
validate_certs
(added in 1.5) |
|
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
|
Note
# create a Direct Connect connection
- aws_direct_connect_connection:
name: ansible-test-connection
state: present
location: EqDC2
link_aggregation_group: dxlag-xxxxxxxx
bandwidth: 1Gbps
register: dc
# disassociate the LAG from the connection
- aws_direct_connect_connection:
state: present
connection_id: dc.connection.connection_id
location: EqDC2
bandwidth: 1Gbps
# replace the connection with one with more bandwidth
- aws_direct_connect_connection:
state: present
name: ansible-test-connection
location: EqDC2
bandwidth: 10Gbps
forced_update: True
# delete the connection
- aws_direct_connect_connection:
state: absent
name: ansible-test-connection
Common return values are documented here, the following are the fields unique to this module:
Key |
Returned |
Description |
---|---|---|
connection
complex
|
state=present |
The attributes of the Direct Connect connection
|
owner_account
|
The owner of the connection.
|
|
aws_device
|
The endpoint which the physical connection terminates on.
|
|
location
|
Where the connection is located.
|
|
region
|
The region in which the connection exists.
|
|
bandwidth
|
The bandwidth of the connection.
|
|
connection_state
|
The state of the connection.
|
|
connection_id
|
ID of the Direct Connect connection.
|
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
Hint
If you notice any issues in this documentation you can edit this document to improve it.