Class: Aws::EC2::Types::DescribeTransitGatewaysRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-ec2/types.rb

Overview

Note:

When making an API call, you may pass DescribeTransitGatewaysRequest data as a hash:

{
  transit_gateway_ids: ["String"],
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  max_results: 1,
  next_token: "String",
  dry_run: false,
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#dry_run ⇒ Boolean

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

Returns:

  • (Boolean) 


15891
15892
15893
15894
15895
15896
15897
15898
 
# File 'lib/aws-sdk-ec2/types.rb', line 15891

class DescribeTransitGatewaysRequest < Struct.new(
  :transit_gateway_ids,
  :filters,
  :max_results,
  :next_token,
  :dry_run)
  include Aws::Structure
end

#filters ⇒ Array<Types::Filter>

One or more filters. The possible values are:

  • ‘owner-id` - The ID of the AWS account that owns the transit gateway.

  • ‘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`).

  • ‘state` - The state of the attachment (`pendingAcceptance` | `pending` | `available` | `modifying` | `deleting` | `deleted` | `failed` | `rejected`).

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

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

Returns:



15891
15892
15893
15894
15895
15896
15897
15898
 
# File 'lib/aws-sdk-ec2/types.rb', line 15891

class DescribeTransitGatewaysRequest < Struct.new(
  :transit_gateway_ids,
  :filters,
  :max_results,
  :next_token,
  :dry_run)
  include Aws::Structure
end

#max_results ⇒ Integer

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

Returns:

  • (Integer) 


15891
15892
15893
15894
15895
15896
15897
15898
 
# File 'lib/aws-sdk-ec2/types.rb', line 15891

class DescribeTransitGatewaysRequest < Struct.new(
  :transit_gateway_ids,
  :filters,
  :max_results,
  :next_token,
  :dry_run)
  include Aws::Structure
end

#next_token ⇒ String

The token for the next page of results.

Returns:

  • (String) 


15891
15892
15893
15894
15895
15896
15897
15898
 
# File 'lib/aws-sdk-ec2/types.rb', line 15891

class DescribeTransitGatewaysRequest < Struct.new(
  :transit_gateway_ids,
  :filters,
  :max_results,
  :next_token,
  :dry_run)
  include Aws::Structure
end

#transit_gateway_ids ⇒ Array<String>

The IDs of the transit gateways.

Returns:

  • (Array<String>) 


15891
15892
15893
15894
15895
15896
15897
15898
 
# File 'lib/aws-sdk-ec2/types.rb', line 15891

class DescribeTransitGatewaysRequest < Struct.new(
  :transit_gateway_ids,
  :filters,
  :max_results,
  :next_token,
  :dry_run)
  include Aws::Structure
end