community / community.aws / 5.1.0 / module / directconnect_connection Creates, deletes, modifies a DirectConnect connection | "added in version" 1.0.0 of community.aws" Authors: Sloane Hertel (@s-hertel)community.aws.directconnect_connection (5.1.0) — module
Install with ansible-galaxy collection install community.aws:==5.1.0
collections: - name: community.aws version: 5.1.0
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 C(community.aws.aws_direct_connect_connection). The usage did not change.
# 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
name: description: - The name of the Direct Connect connection. This is required to create a new connection. - One of I(connection_id) or I(name) must be specified. type: str state: choices: - present - absent description: - The state of the Direct Connect connection. required: true type: str region: aliases: - aws_region - ec2_region description: - The AWS region to use. - For global services such as IAM, Route53 and CloudFront, I(region) is ignored. - The C(AWS_REGION) or C(EC2_REGION) environment variables may also be used. - See the Amazon AWS documentation for more information U(http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region). - The C(ec2_region) alias has been deprecated and will be removed in a release after 2024-12-01 - Support for the C(EC2_REGION) environment variable has been deprecated and will be removed in a release after 2024-12-01. type: str profile: aliases: - aws_profile description: - A named AWS profile to use for authentication. - See the AWS documentation for more information about named profiles U(https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html). - The C(AWS_PROFILE) environment variable may also be used. - The I(profile) option is mutually exclusive with the I(aws_access_key), I(aws_secret_key) and I(security_token) options. type: str location: description: - Where the Direct Connect connection is located. - Required when I(state=present). type: str bandwidth: choices: - 1Gbps - 10Gbps description: - The bandwidth of the Direct Connect connection. - Required when I(state=present). type: str access_key: aliases: - aws_access_key_id - aws_access_key - ec2_access_key description: - AWS access key ID. - See the AWS documentation for more information about access tokens U(https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys). - The C(AWS_ACCESS_KEY_ID), C(AWS_ACCESS_KEY) or C(EC2_ACCESS_KEY) environment variables may also be used in decreasing order of preference. - The I(aws_access_key) and I(profile) options are mutually exclusive. - The I(aws_access_key_id) alias was added in release 5.1.0 for consistency with the AWS botocore SDK. - The I(ec2_access_key) alias has been deprecated and will be removed in a release after 2024-12-01. - Support for the C(EC2_ACCESS_KEY) environment variable has been deprecated and will be removed in a release after 2024-12-01. type: str aws_config: description: - A dictionary to modify the botocore configuration. - Parameters can be found in the AWS documentation U(https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config). type: dict secret_key: aliases: - aws_secret_access_key - aws_secret_key - ec2_secret_key description: - AWS secret access key. - See the AWS documentation for more information about access tokens U(https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys). - The C(AWS_SECRET_ACCESS_KEY), C(AWS_SECRET_KEY), or C(EC2_SECRET_KEY) environment variables may also be used in decreasing order of preference. - The I(secret_key) and I(profile) options are mutually exclusive. - The I(aws_secret_access_key) alias was added in release 5.1.0 for consistency with the AWS botocore SDK. - The I(ec2_secret_key) alias has been deprecated and will be removed in a release after 2024-12-01. - Support for the C(EC2_SECRET_KEY) environment variable has been deprecated and will be removed in a release after 2024-12-01. type: str endpoint_url: aliases: - ec2_url - aws_endpoint_url - s3_url description: - 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 C(AWS_URL) or C(EC2_URL) environment variables may also be used, in decreasing order of preference. - The I(ec2_url) and I(s3_url) aliases have been deprecated and will be removed in a release after 2024-12-01. - Support for the C(EC2_URL) environment variable has been deprecated and will be removed in a release after 2024-12-01. type: str aws_ca_bundle: description: - The location of a CA Bundle to use when validating SSL certificates. - The C(AWS_CA_BUNDLE) environment variable may also be used. type: path connection_id: description: - The ID of the Direct Connect connection. - Modifying attributes of a connection with I(forced_update) will result in a new Direct Connect connection ID. - One of I(connection_id) or I(name) must be specified. type: str forced_update: default: false description: - To modify I(bandwidth) or I(location) the connection needs to be deleted and recreated. - By default this will not happen. This option must be explicitly set to C(true) to change I(bandwith) or I(location). type: bool session_token: aliases: - aws_session_token - security_token - aws_security_token - access_token description: - AWS STS session token for use with temporary credentials. - See the AWS documentation for more information about access tokens U(https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys). - The C(AWS_SESSION_TOKEN), C(AWS_SECURITY_TOKEN) or C(EC2_SECURITY_TOKEN) environment variables may also be used in decreasing order of preference. - The I(security_token) and I(profile) options are mutually exclusive. - Aliases I(aws_session_token) and I(session_token) were added in release 3.2.0, with the parameter being renamed from I(security_token) to I(session_token) in release 6.0.0. - The I(security_token), I(aws_security_token), and I(access_token) aliases have been deprecated and will be removed in a release after 2024-12-01. - Support for the C(EC2_SECRET_KEY) and C(AWS_SECURITY_TOKEN) environment variables has been deprecated and will be removed in a release after 2024-12-01. type: str validate_certs: default: true description: - When set to C(false), SSL certificates will not be validated for communication with the AWS APIs. - Setting I(validate_certs=false) is strongly discouraged, as an alternative, consider setting I(aws_ca_bundle) instead. type: bool link_aggregation_group: description: - The ID of the link aggregation group you want to associate with the connection. - This is optional when a stand-alone connection is desired. type: str debug_botocore_endpoint_logs: default: false description: - Use a C(botocore.endpoint) logger to parse the unique (rather than total) C("resource:action") API calls made during a task, outputing the set to the resource_actions key in the task results. Use the C(aws_resource_action) callback to output to total list made during a playbook. - The C(ANSIBLE_DEBUG_BOTOCORE_LOGS) environment variable may also be used. type: bool
connection: contains: aws_device: description: The endpoint which the physical connection terminates on. returned: when the requested state is no longer 'requested' sample: EqDC2-12pmo7hemtz1z type: str bandwidth: description: The bandwidth of the connection. returned: always sample: 1Gbps type: str connection_id: description: The ID of the connection. returned: always sample: dxcon-ffy9ywed type: str connection_name: description: The name of the connection. returned: always sample: ansible-test-connection type: str connection_state: description: The state of the connection. returned: always sample: pending type: str loa_issue_time: description: 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: '2018-03-20T17:36:26-04:00' type: str location: description: The location of the connection. returned: always sample: EqDC2 type: str owner_account: description: The account that owns the direct connect connection. returned: always sample: '123456789012' type: str region: description: The region in which the connection exists. returned: always sample: us-east-1 type: str description: The attributes of the direct connect connection. returned: I(state=present) type: complex