ansible / ansible.builtin / v2.9.0 / module / aws_direct_connect_gateway Manage AWS Direct Connect Gateway. | "added in version" 2.5 of ansible.builtin" Authors: Gobin Sougrakpam (@gobins) preview | supported by communityansible.builtin.aws_direct_connect_gateway (v2.9.0) — module
pip
Install with pip install ansible==2.9.0
Creates AWS Direct Connect Gateway
Deletes AWS Direct Connect Gateway
Attaches Virtual Gateways to Direct Connect Gateway
Detaches Virtual Gateways to Direct Connect Gateway
- name: Create a new direct connect gateway attached to virtual private gateway dxgw: state: present name: my-dx-gateway amazon_asn: 7224 virtual_gateway_id: vpg-12345 register: created_dxgw
- name: Create a new unattached dxgw dxgw: state: present name: my-dx-gateway amazon_asn: 7224 register: created_dxgw
name: description: - name of the dxgw to be created or deleted required: false state: choices: - present - absent default: present description: - present to ensure resource is created. - absent to remove resource required: false region: aliases: - aws_region - ec2_region description: - 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 U(http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region) type: str ec2_url: aliases: - aws_endpoint_url - endpoint_url description: - 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. type: str profile: aliases: - aws_profile description: - Using I(profile) will override I(aws_access_key), I(aws_secret_key) and I(security_token) and support for passing them at the same time as I(profile) has been deprecated. - I(aws_access_key), I(aws_secret_key) and I(security_token) will be made mutually exclusive with I(profile) after 2022-06-01. type: str amazon_asn: description: - amazon side asn required: true aws_config: description: - A dictionary to modify the botocore configuration. - Parameters can be found at U(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 U(http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto) for more boto configuration. type: dict aws_ca_bundle: description: - The location of a CA Bundle to use when validating SSL certificates. - Not used by boto 2 based modules. - 'Note: The CA Bundle is read ''module'' side and may need to be explicitly copied from the controller if not run locally.' type: path aws_access_key: aliases: - ec2_access_key - access_key description: - C(AWS access key). If not set then the value of the C(AWS_ACCESS_KEY_ID), C(AWS_ACCESS_KEY) or C(EC2_ACCESS_KEY) environment variable is used. - If I(profile) is set this parameter is ignored. - Passing the I(aws_access_key) and I(profile) options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01. type: str aws_secret_key: aliases: - ec2_secret_key - secret_key description: - C(AWS secret key). If not set then the value of the C(AWS_SECRET_ACCESS_KEY), C(AWS_SECRET_KEY), or C(EC2_SECRET_KEY) environment variable is used. - If I(profile) is set this parameter is ignored. - Passing the I(aws_secret_key) and I(profile) options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01. type: str security_token: aliases: - aws_session_token - session_token - aws_security_token - access_token description: - C(AWS STS security token). If not set then the value of the C(AWS_SECURITY_TOKEN) or C(EC2_SECURITY_TOKEN) environment variable is used. - If I(profile) is set this parameter is ignored. - Passing the I(security_token) and I(profile) options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01. - Aliases I(aws_session_token) and I(session_token) have been added in version 3.2.0. type: str validate_certs: default: true description: - When set to "no", SSL certificates will not be validated for communication with the AWS APIs. type: bool virtual_gateway_id: description: - vpn gateway id of an existing virtual gateway required: false direct_connect_gateway_id: description: - id of an existing direct connect gateway required: false debug_botocore_endpoint_logs: default: 'no' description: - 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. type: bool
result: contains: amazon_side_asn: description: ASN on the amazon side. direct_connect_gateway_id: description: The ID of the direct connect gateway. direct_connect_gateway_name: description: The name of the direct connect gateway. direct_connect_gateway_state: description: The state of the direct connect gateway. owner_account: description: The AWS account ID of the owner of the direct connect gateway. description: - The attributes of the Direct Connect Gateway returned: I(state=present) type: complex