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

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

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

{
  dhcp_options_ids: ["String"],
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  dry_run: false,
}

Contains the parameters for DescribeDhcpOptions.

Instance Attribute Summary collapse

Instance Attribute Details

#dhcp_options_idsArray<String>

The IDs of one or more DHCP options sets.

Default: Describes all your DHCP options sets.

Returns:

  • (Array<String>)


5797
5798
5799
5800
5801
5802
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 5797

class DescribeDhcpOptionsRequest < Struct.new(
  :dhcp_options_ids,
  :filters,
  :dry_run)
  include Aws::Structure
end

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


5797
5798
5799
5800
5801
5802
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 5797

class DescribeDhcpOptionsRequest < Struct.new(
  :dhcp_options_ids,
  :filters,
  :dry_run)
  include Aws::Structure
end

#filtersArray<Types::Filter>

One or more filters.

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

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

  • value - The value for one of the options.

  • tag:key=value - The key/value combination of a tag assigned to the resource. Specify the key of the tag in the filter name and the value of the tag in the filter value. For example, for the tag Purpose=X, specify tag:Purpose for the filter name and X for the filter value.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

Returns:



5797
5798
5799
5800
5801
5802
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 5797

class DescribeDhcpOptionsRequest < Struct.new(
  :dhcp_options_ids,
  :filters,
  :dry_run)
  include Aws::Structure
end