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

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

Overview

Note:

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

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#dry_runBoolean

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)


21035
21036
21037
21038
21039
21040
21041
21042
21043
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 21035

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

#filtersArray<Types::Filter>

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 AWS account that owns the transit gateway.

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

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

Returns:



21035
21036
21037
21038
21039
21040
21041
21042
21043
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 21035

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

#max_resultsInteger

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)


21035
21036
21037
21038
21039
21040
21041
21042
21043
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 21035

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

#next_tokenString

The token for the next page of results.

Returns:

  • (String)


21035
21036
21037
21038
21039
21040
21041
21042
21043
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 21035

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

#transit_gateway_idsArray<String>

The IDs of the transit gateways.

Returns:

  • (Array<String>)


21035
21036
21037
21038
21039
21040
21041
21042
21043
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 21035

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