community.aws.directconnect_connection module – Creates, deletes, modifies a DirectConnect connection
Note
This module is part of the community.aws collection (version 9.3.0).
You might already have this collection installed if you are using the ansible package.
It is not included in ansible-core.
To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install community.aws.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: community.aws.directconnect_connection.
New in community.aws 1.0.0
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.
Prior to release 5.0.0 this module was called
community.aws.aws_direct_connect_connection. The usage did not change.
Aliases: aws_direct_connect_connection
Requirements
The below requirements are needed on the host that executes this module.
python >= 3.6
boto3 >= 1.28.0
botocore >= 1.31.0
Parameters
Parameter |
Comments |
|---|---|
AWS access key ID. See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. The The aws_access_key and profile options are mutually exclusive. The aws_access_key_id alias was added in release 5.1.0 for consistency with the AWS botocore SDK. The ec2_access_key alias has been deprecated and will be removed in a release after 2024-12-01. Support for the |
|
The location of a CA Bundle to use when validating SSL certificates. The |
|
A dictionary to modify the botocore configuration. Parameters can be found in the AWS documentation https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config. |
|
The bandwidth of the Direct Connect connection. Required when state=present. Choices:
|
|
The ID of the Direct Connect connection. Modifying attributes of a connection with forced_update will result in a new Direct Connect connection ID. One of connection_id or name must be specified. |
|
Use a The Choices:
|
|
URL to connect to instead of the default AWS endpoints. While this can be used to connection to other AWS-compatible services the amazon.aws and community.aws collections are only tested against AWS. The The ec2_url and s3_url aliases have been deprecated and will be removed in a release after 2024-12-01. Support for the |
|
To modify bandwidth or location the connection needs to be deleted and recreated. By default this will not happen. This option must be explicitly set to Choices:
|
|
The ID of the link aggregation group you want to associate with the connection. This is optional when a stand-alone connection is desired. |
|
Where the Direct Connect connection is located. Required when state=present. |
|
The name of the Direct Connect connection. This is required to create a new connection. One of connection_id or name must be specified. |
|
A named AWS profile to use for authentication. See the AWS documentation for more information about named profiles https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html. The The profile option is mutually exclusive with the aws_access_key, aws_secret_key and security_token options. |
|
The AWS region to use. For global services such as IAM, Route53 and CloudFront, region is ignored. The See the Amazon AWS documentation for more information http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region. The Support for the |
|
AWS secret access key. See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. The The secret_key and profile options are mutually exclusive. The aws_secret_access_key alias was added in release 5.1.0 for consistency with the AWS botocore SDK. The ec2_secret_key alias has been deprecated and will be removed in a release after 2024-12-01. Support for the |
|
AWS STS session token for use with temporary credentials. See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. The The security_token and profile options are mutually exclusive. Aliases aws_session_token and session_token were added in release 3.2.0, with the parameter being renamed from security_token to session_token in release 6.0.0. The security_token, aws_security_token, and access_token aliases have been deprecated and will be removed in a release after 2024-12-01. Support for the |
|
The state of the Direct Connect connection. Choices:
|
|
When set to Setting validate_certs=false is strongly discouraged, as an alternative, consider setting aws_ca_bundle instead. Choices:
|
Notes
Note
Caution: For modules, environment variables and configuration files are read from the Ansible ‘host’ context and not the ‘controller’ context. As such, files may need to be explicitly copied to the ‘host’. For lookup and connection plugins, environment variables and configuration files are read from the Ansible ‘controller’ context and not the ‘host’ context.
The AWS SDK (boto3) that Ansible uses may also read defaults for credentials and other settings, such as the region, from its configuration files in the Ansible ‘host’ context (typically
~/.aws/credentials). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information.
Examples
# create a Direct Connect connection
- community.aws.directconnect_connection:
name: ansible-test-connection
state: present
location: EqDC2
link_aggregation_group: dxlag-xxxxxxxx
bandwidth: 1Gbps
register: dc
# disassociate the LAG from the connection
- community.aws.directconnect_connection:
state: present
connection_id: dc.connection.connection_id
location: EqDC2
bandwidth: 1Gbps
# replace the connection with one with more bandwidth
- community.aws.directconnect_connection:
state: present
name: ansible-test-connection
location: EqDC2
bandwidth: 10Gbps
forced_update: true
# delete the connection
- community.aws.directconnect_connection:
state: absent
name: ansible-test-connection
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
The attributes of the direct connect connection. Returned: state=present |
|
The endpoint which the physical connection terminates on. Returned: when the requested state is no longer ‘requested’ Sample: |
|
The bandwidth of the connection. Returned: always Sample: |
|
The ID of the connection. Returned: always Sample: |
|
The name of the connection. Returned: always Sample: |
|
The state of the connection. Returned: always Sample: |
|
The issue time of the connection’s Letter of Authorization - Connecting Facility Assignment. Returned: when the LOA-CFA has been issued (the connection state will no longer be ‘requested’) Sample: |
|
The location of the connection. Returned: always Sample: |
|
The account that owns the direct connect connection. Returned: always Sample: |
|
The region in which the connection exists. Returned: always Sample: |