aws_direct_connect_connection - Creates, deletes, modifies a DirectConnect connection
New in version 2.4.
Synopsis
- Create, update, or delete a Direct Connect connection between a network and a specific AWS Direct Connect location. Upon creation the connection may be added to a link aggregation group or established as a standalone connection. The connection may later be associated or disassociated with a link aggregation group.
Requirements (on host that executes module)
- boto3
- botocore
Options
parameter | required | default | choices | comments |
---|---|---|---|---|
bandwidth |
no |
|
The bandwidth of the Direct Connect connection. Required when
state=present.
|
|
connection_id |
no |
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
force_update will result in a new Direct Connect connection ID.
|
||
force_update |
no |
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 |
no |
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 |
no |
Where the Direct Connect connection is located. Required when
state=present.
|
||
name |
no |
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.
|
||
state |
no |
|
The state of the Direct Connect connection.
|
Examples
# 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 force_update: True # delete the connection aws_direct_connect_connection: state: absent name: ansible-test-connection
Return Values
Common return values are documented here Return Values, the following are the fields unique to this module:
name | description | returned | type | sample | ||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
connection |
The attributes of the Direct Connect connection
|
I(state=present) | complex | |||||||||||||||||||||||||||||||||||||||||
contains: |
|
Status
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/aws_direct_connect_connection_module.html