Class: Aws::EC2::Types::DescribeDhcpOptionsRequest

Inherits:

Struct

• Object
• Struct
• Aws::EC2::Types::DescribeDhcpOptionsRequest

Includes:

Structure

Defined in:

lib/aws-sdk-ec2/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #dhcp_options_ids ⇒ Array<String>

  The IDs of one or more DHCP options sets.

• #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>

  The filters.

• #max_results ⇒ Integer

  The maximum number of items to return for this request.

• #next_token ⇒ String

  The token returned from a previous paginated request.

Instance Attribute Details

#dhcp_options_ids ⇒ Array<String>

The IDs of one or more DHCP options sets.

Default: Describes all your DHCP options sets.

Returns:

• (Array<String>)

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

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

#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 'lib/aws-sdk-ec2/types.rb', line 17626

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

#filters ⇒ Array<Types::Filter>

The filters.

• ‘dhcp-options-id` - The ID of a DHCP options set.

• ‘key` - The key for one of the options (for example, `domain-name`).

• ‘value` - The value for one of the options.

• ‘owner-id` - The ID of the Amazon Web Services account that owns the DHCP options set.

• ‘tag`:&lt;key&gt; - 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.

• ‘tag-key` - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

Returns:

• (Array<Types::Filter>)

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

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

#max_results ⇒ Integer

The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see [Pagination].

[1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination

Returns:

• (Integer)

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

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

#next_token ⇒ String

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

Returns:

• (String)

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

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