Try SpotterManage AWS Direct Connect gateway
| "added in version" 1.0.0 of community.aws"
Authors: Gobin Sougrakpam (@gobins)
Install with ansible-galaxy collection install community.aws:==4.3.0
collections:
- name: community.aws
version: 4.3.0Creates 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
community.aws.aws_direct_connect_gateway:
state: present
name: my-dx-gateway
amazon_asn: 7224
virtual_gateway_id: vpg-12345
register: created_dxgw
- name: Create a new unattached dxgw
community.aws.aws_direct_connect_gateway:
state: present
name: my-dx-gateway
amazon_asn: 7224
register: created_dxgw
name:
description:
- Name of the Direct Connect Gateway to be created or deleted.
type: str
state:
choices:
- present
- absent
default: present
description:
- Set I(state=present) to ensure a resource is created.
- Set I(state=absent) to remove a resource.
type: str
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:
- Uses a boto profile. Only works with boto >= 2.24.0.
- 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:
- The Amazon side ASN.
- Required when I(state=present).
type: str
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
wait_timeout:
default: 320
description:
- How long to wait for the association to be deleted.
type: int
aws_ca_bundle:
description:
- 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.'
type: path
aws_access_key:
aliases:
- ec2_access_key
- access_key
description:
- 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 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:
- 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 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_security_token
- access_token
description:
- AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or 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.
type: str
validate_certs:
default: true
description:
- When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
type: bool
virtual_gateway_id:
description:
- The VPN gateway ID of an existing virtual gateway.
type: str
direct_connect_gateway_id:
description:
- The ID of an existing Direct Connect Gateway.
- Required when I(state=absent).
type: str
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.
type: str
direct_connect_gateway_id:
description: The ID of the direct connect gateway.
type: str
direct_connect_gateway_name:
description: The name of the direct connect gateway.
type: str
direct_connect_gateway_state:
description: The state of the direct connect gateway.
type: str
owner_account:
description: The AWS account ID of the owner of the direct connect gateway.
type: str
description:
- The attributes of the Direct Connect Gateway
returned: I(state=present)
type: complex