community.aws.ec2_transit_gateway_vpc_attachment_info (4.3.0) — module

describes AWS Transit Gateway VPC attachments

| "added in version" 4.0.0 of community.aws"

Authors: Mark Chappell (@tremble)

Install collection

Install with ansible-galaxy collection install community.aws:==4.3.0


Add to requirements.yml

  collections:
    - name: community.aws
      version: 4.3.0

Description

Describes AWS Transit Gateway VPC Attachments.


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
# Describe a specific Transit Gateway attachment.
- community.aws.ec2_transit_gateway_vpc_attachment_info:
    state: present
    id: 'tgw-attach-0123456789abcdef0'
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
# Describe all attachments attached to a transit gateway.
- community.aws.ec2_transit_gateway_vpc_attachment_info:
    state: present
    filters:
      transit-gateway-id: tgw-0fedcba9876543210'
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
# Describe all attachments in an account.
- community.aws.ec2_transit_gateway_vpc_attachment_info:
    state: present
    filters:
      transit-gateway-id: tgw-0fedcba9876543210'

Inputs

    
id:
    aliases:
    - attachment_id
    description:
    - The ID of the Transit Gateway Attachment.
    - Mutually exclusive with I(name) and I(filters)
    required: false
    type: str

name:
    description:
    - The C(Name) tag of the Transit Gateway attachment.
    required: false
    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

filters:
    description:
    - A dictionary of filters to apply. Each dict item consists of a filter key and a
      filter value.
    - Setting a C(tag:Name) filter will override the I(name) parameter.
    required: false
    type: dict

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

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.
    - 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

include_deleted:
    default: false
    description:
    - If I(include_deleted=True), then attachments in a deleted state will also be returned.
    - Setting a C(state) filter will override the I(include_deleted) parameter.
    required: false
    type: bool

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

Outputs

transit_gateway_attachments:
  contains:
    creation_time:
      description:
      - An ISO 8601 date time stamp of when the attachment was created.
      example: '2022-03-10T16:40:26+00:00'
      returned: success
      type: str
    options:
      contains:
        appliance_mode_support:
          description:
          - Indicates whether appliance mode support is enabled.
          example: enable
          returned: success
          type: str
        dns_support:
          description:
          - Indicates whether DNS support is enabled.
          example: disable
          returned: success
          type: str
        ipv6_support:
          description:
          - Indicates whether IPv6 support is disabled.
          example: disable
          returned: success
          type: str
      description:
      - Additional VPC attachment options.
      returned: success
      type: dict
    state:
      description:
      - The state of the attachment.
      example: deleting
      returned: success
      type: str
    subnet_ids:
      description:
      - The IDs of the subnets in use by the attachment.
      elements: str
      example:
      - subnet-0123456789abcdef0
      - subnet-11111111111111111
      returned: success
      type: list
    tags:
      description:
      - A dictionary representing the resource tags.
      returned: success
      type: dict
    transit_gateway_attachment_id:
      description:
      - The ID of the attachment.
      example: tgw-attach-0c0c5fd0b0f01d1c9
      returned: success
      type: str
    transit_gateway_id:
      description:
      - The ID of the transit gateway that the attachment is connected to.
      example: tgw-0123456789abcdef0
      returned: success
      type: str
    vpc_id:
      description:
      - The ID of the VPC that the attachment is connected to.
      example: vpc-0123456789abcdef0
      returned: success
      type: str
    vpc_owner_id:
      description:
      - The ID of the account that the VPC belongs to.
      example: 012345678901
      returned: success
      type: str
  description: The attributes of the Transit Gateway attachments.
  elements: dict
  returned: success
  type: list