Class: Aws::EC2::Types::DescribeCoipPoolsRequest

Inherits:

Struct

• Object
• Struct
• Aws::EC2::Types::DescribeCoipPoolsRequest

Defined in:

gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #dry_run ⇒ Boolean

  Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.

• #filters ⇒ Array<Types::Filter>

  One or more filters.

• #max_results ⇒ Integer

  The maximum number of results to return with a single call.

• #next_token ⇒ String

  The token for the next page of results.

• #pool_ids ⇒ Array<String>

  The IDs of the address pools.

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)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 22657

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

#filters ⇒ Array<Types::Filter>

One or more filters.

• coip-pool.local-gateway-route-table-id - The ID of the local gateway route table.

• coip-pool.pool-id - The ID of the address pool.

Returns:

• (Array<Types::Filter>)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 22657

class DescribeCoipPoolsRequest < Struct.new(
  :pool_ids,
  :filters,
  :max_results,
  :next_token,
  :dry_run)
  SENSITIVE = []
  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)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 22657

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

#next_token ⇒ String

The token for the next page of results.

Returns:

• (String)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 22657

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

#pool_ids ⇒ Array<String>

The IDs of the address pools.

Returns:

• (Array<String>)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 22657

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