Skip to content

Describe Transit Gateways

ec2_describe_transit_gateways R Documentation

Describes one or more transit gateways

Description

Describes one or more transit gateways. By default, all transit gateways are described. Alternatively, you can filter the results.

Usage

ec2_describe_transit_gateways(TransitGatewayIds, Filters, MaxResults,
  NextToken, DryRun)

Arguments

TransitGatewayIds

The IDs of the transit gateways.
Filters

One or more filters. The possible values are:

  • options.propagation-default-route-table-id - The ID of the default propagation route table.

  • options.amazon-side-asn - The private ASN for the Amazon side of a BGP session.

  • options.association-default-route-table-id - The ID of the default association route table.

  • options.auto-accept-shared-attachments - Indicates whether there is automatic acceptance of attachment requests (enable | disable).

  • options.default-route-table-association - Indicates whether resource attachments are automatically associated with the default association route table (enable | disable).

  • options.default-route-table-propagation - Indicates whether resource attachments automatically propagate routes to the default propagation route table (enable | disable).

  • options.dns-support - Indicates whether DNS support is enabled (enable | disable).

  • options.vpn-ecmp-support - Indicates whether Equal Cost Multipath Protocol support is enabled (enable | disable).

  • owner-id - The ID of the Amazon Web Services account that owns the transit gateway.

  • state - The state of the transit gateway (available | deleted | deleting | modifying | pending).

  • transit-gateway-id - The ID of the transit gateway.

  • tag-key - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
MaxResults

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
NextToken

The token for the next page of results.
DryRun

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Value

A list with the following syntax:

list(
  TransitGateways = list(
    list(
      TransitGatewayId = "string",
      TransitGatewayArn = "string",
      State = "pending"|"available"|"modifying"|"deleting"|"deleted",
      OwnerId = "string",
      Description = "string",
      CreationTime = as.POSIXct(
        "2015-01-01"
      ),
      Options = list(
        AmazonSideAsn = 123,
        TransitGatewayCidrBlocks = list(
          "string"
        ),
        AutoAcceptSharedAttachments = "enable"|"disable",
        DefaultRouteTableAssociation = "enable"|"disable",
        AssociationDefaultRouteTableId = "string",
        DefaultRouteTablePropagation = "enable"|"disable",
        PropagationDefaultRouteTableId = "string",
        VpnEcmpSupport = "enable"|"disable",
        DnsSupport = "enable"|"disable",
        SecurityGroupReferencingSupport = "enable"|"disable",
        MulticastSupport = "enable"|"disable"
      ),
      Tags = list(
        list(
          Key = "string",
          Value = "string"
        )
      )
    )
  ),
  NextToken = "string"
)

Request syntax

svc$describe_transit_gateways(
  TransitGatewayIds = list(
    "string"
  ),
  Filters = list(
    list(
      Name = "string",
      Values = list(
        "string"
      )
    )
  ),
  MaxResults = 123,
  NextToken = "string",
  DryRun = TRUE|FALSE
)