community.aws.ec2_transit_gateway_vpc_attachment module – Create and delete AWS Transit Gateway VPC attachments
Note
This module is part of the community.aws collection (version 8.0.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.ec2_transit_gateway_vpc_attachment.
New in community.aws 4.0.0
Synopsis
Creates, Deletes and Updates AWS Transit Gateway VPC Attachments.
Requirements
The below requirements are needed on the host that executes this module.
python >= 3.6
boto3 >= 1.26.0
botocore >= 1.29.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 |
|
Whether the attachment is configured for appliance mode. When appliance mode is enabled, Transit Gateway, using 4-tuples of an IP packet, selects a single Transit Gateway ENI in the Appliance VPC for the life of a flow to send traffic to. Choices:
|
|
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. |
|
Use a The Choices:
|
|
Whether DNS support is enabled. 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 |
|
The ID of the Transit Gateway Attachment. When id is not set, a search using transit_gateway and name will be performed. If multiple results are returned, the module will fail. At least one of name, transit_gateway and id must be provided. |
|
Whether IPv6 support is enabled. Choices:
|
|
The Providing both id and name will set the Setting the At least one of name, transit_gateway and id must be provided. |
|
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. |
|
If purge_subnets=true, existing subnets will be removed from the attachment as necessary to match exactly what is defined by subnets. Choices:
|
|
If purge_tags=true and tags is set, existing tags will be purged from the resource to match exactly what is defined by tags parameter. If the tags parameter is not set then tags will not be modified, even if purge_tags=True. Tag keys beginning with Choices:
|
|
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 |
|
Create or remove the Transit Gateway attachment. Choices:
|
|
The ID of the subnets in which to create the transit gateway VPC attachment. Required when creating a new attachment. |
|
A dictionary representing the tags to be applied to the resource. If the tags parameter is not set then tags will not be modified. |
|
The ID of the Transit Gateway that the attachment belongs to. When creating a new attachment, transit_gateway must be provided. At least one of name, transit_gateway and id must be provided. transit_gateway is an immutable setting and can not be updated on an existing attachment. |
|
When set to Setting validate_certs=false is strongly discouraged, as an alternative, consider setting aws_ca_bundle instead. Choices:
|
|
Whether to wait for the Transit Gateway attachment to reach the Choices:
|
|
Maximum time, in seconds, to wait for the Transit Gateway attachment to reach the expected state. Defaults to 600 seconds. |
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 Transit Gateway attachment
- community.aws.ec2_transit_gateway_vpc_attachment:
state: present
transit_gateway: 'tgw-123456789abcdef01'
name: AnsibleTest-1
subnets:
- subnet-00000000000000000
- subnet-11111111111111111
- subnet-22222222222222222
ipv6_support: true
purge_subnets: true
dns_support: true
appliance_mode_support: true
tags:
TestTag: changed data in Test Tag
# Set sub options on a Transit Gateway attachment
- community.aws.ec2_transit_gateway_vpc_attachment:
state: present
id: 'tgw-attach-0c0c5fd0b0f01d1c9'
name: AnsibleTest-1
ipv6_support: true
purge_subnets: false
dns_support: false
appliance_mode_support: true
# Delete the transit gateway
- community.aws.ec2_transit_gateway_vpc_attachment:
state: absent
id: 'tgw-attach-0c0c5fd0b0f01d1c9'
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
The attributes of the Transit Gateway attachments. Returned: success |
|
An ISO 8601 date time stamp of when the attachment was created. Returned: success Sample: |
|
Additional VPC attachment options. Returned: success |
|
Indicates whether appliance mode support is enabled. Returned: success Sample: |
|
Indicates whether DNS support is enabled. Returned: success Sample: |
|
Indicates whether IPv6 support is disabled. Returned: success Sample: |
|
The state of the attachment. Returned: success Sample: |
|
The IDs of the subnets in use by the attachment. Returned: success Sample: |
|
A dictionary representing the resource tags. Returned: success |
|
The ID of the attachment. Returned: success Sample: |
|
The ID of the transit gateway that the attachment is connected to. Returned: success Sample: |
|
The ID of the VPC that the attachment is connected to. Returned: success Sample: |
|
The ID of the account that the VPC belongs to. Returned: success Sample: |