amazon.aws.ec2_transit_gateway_vpc_attachment module – Create and delete AWS Transit Gateway VPC attachments

Note

This module is part of the amazon.aws collection (version 10.0.0-dev0).

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 amazon.aws. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: amazon.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.28.0

• botocore >= 1.31.0

Parameters

Parameter	Comments
access_key aliases: aws_access_key_id, aws_access_key, ec2_access_key string	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 AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variables may also be used in decreasing order of preference. 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 EC2_ACCESS_KEY environment variable has been deprecated and will be removed in a release after 2024-12-01.
appliance_mode_support boolean	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: false true
aws_ca_bundle path	The location of a CA Bundle to use when validating SSL certificates. The AWS_CA_BUNDLE environment variable may also be used.
aws_config dictionary	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.
debug_botocore_endpoint_logs boolean	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. Choices: false ← (default) true
dns_support boolean	Whether DNS support is enabled. Choices: false true
endpoint_url aliases: ec2_url, aws_endpoint_url, s3_url string	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 AWS_URL or EC2_URL environment variables may also be used, in decreasing order of preference. The ec2_url and s3_url aliases have been deprecated and will be removed in a release after 2024-12-01. Support for the EC2_URL environment variable has been deprecated and will be removed in a release after 2024-12-01.
id aliases: attachment_id string	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.
ipv6_support boolean	Whether IPv6 support is enabled. Choices: false true
name string	The Name tag of the Transit Gateway attachment. Providing both id and name will set the Name tag on an existing attachment the matching id. Setting the Name tag in tags will also result in the Name tag being updated. At least one of name, transit_gateway and id must be provided.
profile aliases: aws_profile string	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 AWS_PROFILE environment variable may also be used. The profile option is mutually exclusive with the aws_access_key, aws_secret_key and security_token options.
purge_subnets boolean	If purge_subnets=true, existing subnets will be removed from the attachment as necessary to match exactly what is defined by subnets. Choices: false true ← (default)
purge_tags boolean	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 aws: are reserved by Amazon and can not be modified. As such they will be ignored for the purposes of the purge_tags parameter. See the Amazon documentation for more information https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html#tag-conventions. Choices: false true ← (default)
region aliases: aws_region, ec2_region string	The AWS region to use. For global services such as IAM, Route53 and CloudFront, region is ignored. The AWS_REGION or EC2_REGION environment variables may also be used. See the Amazon AWS documentation for more information http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region. The ec2_region alias has been deprecated and will be removed in a release after 2024-12-01 Support for the EC2_REGION environment variable has been deprecated and will be removed in a release after 2024-12-01.
secret_key aliases: aws_secret_access_key, aws_secret_key, ec2_secret_key string	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 AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variables may also be used in decreasing order of preference. 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 EC2_SECRET_KEY environment variable has been deprecated and will be removed in a release after 2024-12-01.
session_token aliases: aws_session_token, security_token, aws_security_token, access_token string	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 AWS_SESSION_TOKEN, AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variables may also be used in decreasing order of preference. 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 EC2_SECRET_KEY and AWS_SECURITY_TOKEN environment variables has been deprecated and will be removed in a release after 2024-12-01.
state string	Create or remove the Transit Gateway attachment. Choices: "present" ← (default) "absent"
subnets list / elements=string	The ID of the subnets in which to create the transit gateway VPC attachment. Required when creating a new attachment.
tags aliases: resource_tags dictionary	A dictionary representing the tags to be applied to the resource. If the tags parameter is not set then tags will not be modified.
transit_gateway aliases: transit_gateway_id string	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.
validate_certs boolean	When set to false, SSL certificates will not be validated for communication with the AWS APIs. Setting validate_certs=false is strongly discouraged, as an alternative, consider setting aws_ca_bundle instead. Choices: false true ← (default)
wait boolean	Whether to wait for the Transit Gateway attachment to reach the Available or Deleted state before the module returns. Choices: false true ← (default)
wait_timeout integer	Maximum time, in seconds, to wait for the Transit Gateway attachment to reach the expected state. Defaults to 600 seconds. Default: 600

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

- name: Create a Transit Gateway attachment
  amazon.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"

- name: Set sub options on a Transit Gateway attachment
  amazon.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

- name: Delete the transit gateway
  amazon.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
attachments list / elements=dictionary	The attributes of the Transit Gateway attachments. Returned: success
creation_time string	An ISO 8601 date time stamp of when the attachment was created. Returned: success Sample: "2022-03-10T16:40:26+00:00"
options dictionary	Additional VPC attachment options. Returned: success
appliance_mode_support string	Indicates whether appliance mode support is enabled. Returned: success Sample: "enable"
dns_support string	Indicates whether DNS support is enabled. Returned: success Sample: "disable"
ipv6_support string	Indicates whether IPv6 support is disabled. Returned: success Sample: "disable"
security_group_referencing_support string	Indicated weather security group referencing support is disabled. Returned: success Sample: "enable"
state string	The state of the attachment. Returned: success Sample: "deleting"
subnet_ids list / elements=string	The IDs of the subnets in use by the attachment. Returned: success Sample: ["subnet-0123456789abcdef0", "subnet-11111111111111111"]
tags dictionary	A dictionary representing the resource tags. Returned: success
transit_gateway_attachment_id string	The ID of the attachment. Returned: success Sample: "tgw-attach-0c0c5fd0b0f01d1c9"
transit_gateway_id string	The ID of the transit gateway that the attachment is connected to. Returned: success Sample: "tgw-0123456789abcdef0"
vpc_id string	The ID of the VPC that the attachment is connected to. Returned: success Sample: "vpc-0123456789abcdef0"
vpc_owner_id string	The ID of the account that the VPC belongs to. Returned: success Sample: "1234567890122"

Authors

• Mark Chappell (@tremble)

• Alina Buzachis (@alinabuzachis)

Collection links

• Issue Tracker
• Repository (Sources)
• Communication