You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::EC2::Types::DescribeTransitGatewayAttachmentsRequest

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 DescribeTransitGatewayAttachmentsRequest data as a hash:

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

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)


16726
16727
16728
16729
16730
16731
16732
16733
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 16726

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

#filtersArray<Types::Filter>

One or more filters. The possible values are:

  • association.state - The state of the association (associating | associated | disassociating).

  • association.transit-gateway-route-table-id - The ID of the route table for the transit gateway.

  • resource-id - The ID of the resource.

  • resource-owner-id - The ID of the AWS account that owns the resource.

  • resource-type - The resource type (vpc | vpn).

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

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

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

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

Returns:



16726
16727
16728
16729
16730
16731
16732
16733
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 16726

class DescribeTransitGatewayAttachmentsRequest < Struct.new(
  :transit_gateway_attachment_ids,
  :filters,
  :max_results,
  :next_token,
  :dry_run)
  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)


16726
16727
16728
16729
16730
16731
16732
16733
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 16726

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

#next_tokenString

The token for the next page of results.

Returns:

  • (String)


16726
16727
16728
16729
16730
16731
16732
16733
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 16726

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

#transit_gateway_attachment_idsArray<String>

The IDs of the attachments.

Returns:

  • (Array<String>)


16726
16727
16728
16729
16730
16731
16732
16733
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 16726

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