community.aws.aws_direct_connect_connection – Creates, deletes, modifies a DirectConnect connection¶

Note

This plugin is part of the community.aws collection (version 1.4.0).

To install it use: ansible-galaxy collection install community.aws.

To use it in a playbook, specify: community.aws.aws_direct_connect_connection.

New in version 1.0.0: of community.aws

Synopsis
Requirements
Parameters
Notes
Examples
Return Values

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 ¶

The below requirements are needed on the host that executes this module.

boto
boto3
botocore
python >= 2.6

Parameters ¶

Parameter	Choices/Defaults	Comments
aws_access_key string		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. If profile is set this parameter is ignored. Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01. aliases: ec2_access_key, access_key
aws_ca_bundle path		The location of a CA Bundle to use when validating SSL certificates. Only used for boto3 based modules. Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
aws_config dictionary		A dictionary to modify the botocore configuration. Parameters can be found at https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config. Only the 'user_agent' key is used for boto modules. See http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto for more boto configuration.
aws_secret_key string		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. If profile is set this parameter is ignored. Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01. aliases: ec2_secret_key, secret_key
bandwidth string	Choices: 1Gbps 10Gbps	The bandwidth of the Direct Connect connection. Required when state=present.
connection_id string		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.
debug_botocore_endpoint_logs boolean	Choices: no ← yes	Use a botocore.endpoint logger to parse the unique (rather than total) "resource:action" API calls made during a task, outputing the set to the resource_actions key in the task results. Use the aws_resource_action callback to output to total list made during a playbook. The ANSIBLE_DEBUG_BOTOCORE_LOGS environment variable may also be used.
ec2_url string		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. aliases: aws_endpoint_url, endpoint_url
forced_update boolean	Choices: no ← yes	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 `true` to change bandwith or location.
link_aggregation_group string		The ID of the link aggregation group you want to associate with the connection. This is optional when a stand-alone connection is desired.
location string		Where the Direct Connect connection is located. Required when state=present.
name string		The name of the Direct Connect connection. This is required to create a new connection. One of connection_id or name must be specified.
profile string		Uses a boto profile. Only works with boto >= 2.24.0. Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated. aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01. aliases: aws_profile
region string		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 string		AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used. If profile is set this parameter is ignored. Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01. aliases: aws_security_token, access_token
state string / required	Choices: present absent	The state of the Direct Connect connection.
validate_certs boolean	Choices: no yes ←	When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.

Notes ¶

Note

If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence AWS_URL or EC2_URL, AWS_PROFILE or AWS_DEFAULT_PROFILE, AWS_ACCESS_KEY_ID or AWS_ACCESS_KEY or EC2_ACCESS_KEY, AWS_SECRET_ACCESS_KEY or AWS_SECRET_KEY or EC2_SECRET_KEY, AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN, AWS_REGION or EC2_REGION, AWS_CA_BUNDLE
Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html
AWS_REGION or EC2_REGION can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file

Examples ¶

# create a Direct Connect connection
- community.aws.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
- community.aws.aws_direct_connect_connection:
    state: present
    connection_id: dc.connection.connection_id
    location: EqDC2
    bandwidth: 1Gbps

# replace the connection with one with more bandwidth
- community.aws.aws_direct_connect_connection:
    state: present
    name: ansible-test-connection
    location: EqDC2
    bandwidth: 10Gbps
    forced_update: true

# delete the connection
- community.aws.aws_direct_connect_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		Returned	Description
connection complex		state=present	The attributes of the direct connect connection.
	aws_device string	when the requested state is no longer 'requested'	The endpoint which the physical connection terminates on. Sample: EqDC2-12pmo7hemtz1z
	bandwidth string	always	The bandwidth of the connection. Sample: 1Gbps
	connection_id string	always	The ID of the connection. Sample: dxcon-ffy9ywed
	connection_name string	always	The name of the connection. Sample: ansible-test-connection
	connection_state string	always	The state of the connection. Sample: pending
	loa_issue_time string	when the LOA-CFA has been issued (the connection state will no longer be 'requested')	The issue time of the connection's Letter of Authorization - Connecting Facility Assignment. Sample: 2018-03-20T17:36:26-04:00
	location string	always	The location of the connection. Sample: EqDC2
	owner_account string	always	The account that owns the direct connect connection. Sample: 123456789012
	region string	always	The region in which the connection exists. Sample: us-east-1

Authors¶

Sloane Hertel (@s-hertel)

community.aws.aws_direct_connect_connection – Creates, deletes, modifies a DirectConnect connection¶

Synopsis¶

Requirements¶

Parameters¶

Notes¶

Examples¶

Return Values¶