community / community.aws / 5.1.0 / module / ec2_transit_gateway Create and delete AWS Transit Gateways | "added in version" 1.0.0 of community.aws" Authors: Bob Boldin (@BobBoldin)community.aws.ec2_transit_gateway (5.1.0) — module
Install with ansible-galaxy collection install community.aws:==5.1.0
collections: - name: community.aws version: 5.1.0
Creates AWS Transit Gateways.
Deletes AWS Transit Gateways.
Updates tags on existing transit gateways.
- name: Create a new transit gateway using defaults community.aws.ec2_transit_gateway: state: present region: us-east-1 description: personal-testing register: created_tgw
- name: Create a new transit gateway with options community.aws.ec2_transit_gateway: asn: 64514 auto_associate: false auto_propagate: false dns_support: True description: "nonprod transit gateway" purge_tags: False state: present region: us-east-1 tags: Name: nonprod transit gateway status: testing
- name: Remove a transit gateway by description community.aws.ec2_transit_gateway: state: absent region: us-east-1 description: personal-testing
- name: Remove a transit gateway by id community.aws.ec2_transit_gateway: state: absent region: ap-southeast-2 transit_gateway_id: tgw-3a9aa123 register: deleted_tgw
asn: description: - A private Autonomous System Number (ASN) for the Amazon side of a BGP session. - The range is 64512 to 65534 for 16-bit ASNs and 4200000000 to 4294967294 for 32-bit ASNs. type: int tags: aliases: - resource_tags description: - A dictionary representing the tags to be applied to the resource. - If the I(tags) parameter is not set then tags will not be modified. required: false type: dict wait: default: true description: - Whether to wait for status type: bool state: choices: - present - absent default: present description: - C(present) to ensure resource is created. - C(absent) to remove resource. 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 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 purge_tags: default: true description: - If I(purge_tags=true) and I(tags) is set, existing tags will be purged from the resource to match exactly what is defined by I(tags) parameter. - If the I(tags) parameter is not set then tags will not be modified, even if I(purge_tags=True). - Tag keys beginning with C(aws:) are reserved by Amazon and can not be modified. As such they will be ignored for the purposes of the I(purge_tags) parameter. See the Amazon documentation for more information U(https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html#tag-conventions). required: false type: bool 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 auto_attach: default: false description: - Enable or disable automatic acceptance of attachment requests. type: bool description: description: - The description of the transit gateway. type: str dns_support: default: true description: - Whether to enable AWS DNS support. type: bool 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 wait_timeout: default: 300 description: - number of seconds to wait for status type: int 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 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 auto_associate: default: true description: - Enable or disable automatic association with the default association route table. type: bool auto_propagate: default: true description: - Enable or disable automatic propagation of routes to the default propagation route table. type: bool 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 vpn_ecmp_support: default: true description: - Enable or disable Equal Cost Multipath Protocol support. type: bool transit_gateway_id: description: - The ID of the transit gateway. 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
transit_gateway: contains: creation_time: description: The creation time of the transit gateway. returned: always sample: '2019-03-06T17:13:51+00:00' type: str description: description: The description of the transit gateway. returned: always sample: my test tgw type: str options: contains: amazon_side_asn: description: - A private Autonomous System Number (ASN) for the Amazon side of a BGP session. The range is 64512 to 65534 for 16-bit ASNs and 4200000000 to 4294967294 for 32-bit ASNs. returned: always sample: 64512 type: str association_default_route_table_id: description: The ID of the default association route table. returned: Iwhen exists sample: tgw-rtb-abc123444 type: str auto_accept_shared_attachements: description: Indicates whether attachment requests are automatically accepted. returned: always sample: disable type: str default_route_table_association: description: - Indicates whether resource attachments are automatically associated with the default association route table. returned: always sample: enable type: str default_route_table_propagation: description: - Indicates whether resource attachments automatically propagate routes to the default propagation route table. returned: always sample: disable type: str dns_support: description: Indicates whether DNS support is enabled. returned: always sample: enable type: str propagation_default_route_table_id: description: The ID of the default propagation route table. returned: when exists sample: tgw-rtb-def456777 type: str vpn_ecmp_support: description: Indicates whether Equal Cost Multipath Protocol support is enabled. returned: always sample: enable type: str description: The options attributes of the transit gateway returned: always type: complex owner_id: description: The account that owns the transit gateway. returned: always sample: '123456789012' type: str state: description: The state of the transit gateway. returned: always sample: pending type: str tags: description: A dictionary of resource tags returned: always sample: tags: Name: nonprod_tgw type: dict transit_gateway_arn: description: The ID of the transit_gateway. returned: always sample: tgw-3a9aa123 type: str transit_gateway_id: description: The ID of the transit_gateway. returned: always sample: tgw-3a9aa123 type: str description: The attributes of the transit gateway. returned: I(state=present) type: complex