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

Class: Aws::Route53Resolver::Client

Inherits:
Seahorse::Client::Base show all
Includes:
ClientStubs
Defined in:
gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/client.rb

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations collapse

Instance Method Summary collapse

Methods included from ClientStubs

#api_requests, #stub_data, #stub_responses

Methods inherited from Seahorse::Client::Base

add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client

Parameters:

  • options (Hash)

Options Hash (options):

  • :credentials (required, Aws::CredentialProvider)

    Your AWS credentials. This can be an instance of any one of the following classes:

    • Aws::Credentials - Used for configuring static, non-refreshing credentials.

    • Aws::InstanceProfileCredentials - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • Aws::SharedCredentials - Used for loading credentials from a shared file, such as ~/.aws/config.

    • Aws::AssumeRoleCredentials - Used when you need to assume a role.

    When :credentials are not configured directly, the following locations will be searched for credentials:

    • Aws.config[:credentials]
    • The :access_key_id, :secret_access_key, and :session_token options.
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
    • ~/.aws/credentials
    • ~/.aws/config
    • EC2 IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentails to enable retries and extended timeouts.
  • :region (required, String)

    The AWS region to connect to. The configured :region is used to determine the service :endpoint. When not passed, a default :region is search for in the following locations:

    • Aws.config[:region]
    • ENV['AWS_REGION']
    • ENV['AMAZON_REGION']
    • ENV['AWS_DEFAULT_REGION']
    • ~/.aws/credentials
    • ~/.aws/config
  • :access_key_id (String)
  • :active_endpoint_cache (Boolean) — default: false

    When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false.

  • :client_side_monitoring (Boolean) — default: false

    When true, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: ""

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1"

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true

    When true, an attempt is made to coerce request parameters into the required types.

  • :disable_host_prefix_injection (Boolean) — default: false

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available.

  • :endpoint (String)

    The client endpoint is normally constructed from the :region option. You should only configure an :endpoint when connecting to test endpoints. This should be avalid HTTP(S) URI.

  • :endpoint_cache_max_entries (Integer) — default: 1000

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.

  • :endpoint_discovery (Boolean) — default: false

    When set to true, endpoint discovery will be enabled for operations when available. Defaults to false.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default

    The log formatter.

  • :log_level (Symbol) — default: :info

    The log level to send messages to the :logger at.

  • :logger (Logger)

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :profile (String) — default: "default"

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used.

  • :retry_base_delay (Float) — default: 0.3

    The base delay in seconds used by the default backoff function.

  • :retry_jitter (Symbol) — default: :none

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number.

    @see https://www.awsarchitectureblog.com/2015/03/backoff.html

  • :retry_limit (Integer) — default: 3

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors and auth errors from expired credentials.

  • :retry_max_delay (Integer) — default: 0

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function.

  • :secret_access_key (String)
  • :session_token (String)
  • :simple_json (Boolean) — default: false

    Disables request parameter conversion, validation, and formatting. Also disable response data type conversions. This option is useful when you want to ensure the highest level of performance by avoiding overhead of walking request parameters and response data structures.

    When :simple_json is enabled, the request parameters hash must be formatted exactly as the DynamoDB API expects.

  • :stub_responses (Boolean) — default: false

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

    Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

  • :validate_params (Boolean) — default: true

    When true, request parameters are validated before sending the request.

  • :http_proxy (URI::HTTP, String)

    A proxy to send requests through. Formatted like 'http://proxy.com:123'.

  • :http_open_timeout (Float) — default: 15

    The number of seconds to wait when opening a HTTP session before rasing a Timeout::Error.

  • :http_read_timeout (Integer) — default: 60

    The default number of seconds to wait for response data. This value can safely be set per-request on the session yeidled by #session_for.

  • :http_idle_timeout (Float) — default: 5

    The number of seconds a connection is allowed to sit idble before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_continue_timeout (Float) — default: 1

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has "Expect" header set to "100-continue". Defaults to nil which disables this behaviour. This value can safely be set per request on the session yeidled by #session_for.

  • :http_wire_trace (Boolean) — default: false

    When true, HTTP debug output will be sent to the :logger.

  • :ssl_verify_peer (Boolean) — default: true

    When true, SSL peer certificates are verified when establishing a connection.

  • :ssl_ca_bundle (String)

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_directory (String)

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.



261
262
263
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/client.rb', line 261

def initialize(*args)
  super
end

Instance Method Details

#associate_resolver_endpoint_ip_address(params = {}) ⇒ Types::AssociateResolverEndpointIpAddressResponse

Adds IP addresses to an inbound or an outbound resolver endpoint. If you want to adding more than one IP address, submit one AssociateResolverEndpointIpAddress request for each IP address.

To remove an IP address from an endpoint, see DisassociateResolverEndpointIpAddress.

Examples:

Request syntax with placeholder values


resp = client.associate_resolver_endpoint_ip_address({
  resolver_endpoint_id: "ResourceId", # required
  ip_address: { # required
    ip_id: "ResourceId",
    subnet_id: "SubnetId",
    ip: "Ip",
  },
})

Response structure


resp.resolver_endpoint.id #=> String
resp.resolver_endpoint.creator_request_id #=> String
resp.resolver_endpoint.arn #=> String
resp.resolver_endpoint.name #=> String
resp.resolver_endpoint.security_group_ids #=> Array
resp.resolver_endpoint.security_group_ids[0] #=> String
resp.resolver_endpoint.direction #=> String, one of "INBOUND", "OUTBOUND"
resp.resolver_endpoint.ip_address_count #=> Integer
resp.resolver_endpoint.host_vpc_id #=> String
resp.resolver_endpoint.status #=> String, one of "CREATING", "OPERATIONAL", "UPDATING", "AUTO_RECOVERING", "ACTION_NEEDED", "DELETING"
resp.resolver_endpoint.status_message #=> String
resp.resolver_endpoint.creation_time #=> String
resp.resolver_endpoint.modification_time #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :resolver_endpoint_id (required, String)

    The ID of the resolver endpoint that you want to associate IP addresses with.

  • :ip_address (required, Types::IpAddressUpdate)

    Either the IPv4 address that you want to add to a resolver endpoint or a subnet ID. If you specify a subnet ID, Resolver chooses an IP address for you from the available IPs in the specified subnet.

Returns:

See Also:



318
319
320
321
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/client.rb', line 318

def associate_resolver_endpoint_ip_address(params = {}, options = {})
  req = build_request(:associate_resolver_endpoint_ip_address, params)
  req.send_request(options)
end

#associate_resolver_rule(params = {}) ⇒ Types::AssociateResolverRuleResponse

Associates a resolver rule with a VPC. When you associate a rule with a VPC, Resolver forwards all DNS queries for the domain name that is specified in the rule and that originate in the VPC. The queries are forwarded to the IP addresses for the DNS resolvers that are specified in the rule. For more information about rules, see CreateResolverRule.

Examples:

Request syntax with placeholder values


resp = client.associate_resolver_rule({
  resolver_rule_id: "ResourceId", # required
  name: "Name",
  vpc_id: "ResourceId", # required
})

Response structure


resp.resolver_rule_association.id #=> String
resp.resolver_rule_association.resolver_rule_id #=> String
resp.resolver_rule_association.name #=> String
resp.resolver_rule_association.vpc_id #=> String
resp.resolver_rule_association.status #=> String, one of "CREATING", "COMPLETE", "DELETING", "FAILED", "OVERRIDDEN"
resp.resolver_rule_association.status_message #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :resolver_rule_id (required, String)

    The ID of the resolver rule that you want to associate with the VPC. To list the existing resolver rules, use ListResolverRules.

  • :name (String)

    A name for the association that you're creating between a resolver rule and a VPC.

  • :vpc_id (required, String)

    The ID of the VPC that you want to associate the resolver rule with.

Returns:

See Also:



365
366
367
368
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/client.rb', line 365

def associate_resolver_rule(params = {}, options = {})
  req = build_request(:associate_resolver_rule, params)
  req.send_request(options)
end

#create_resolver_endpoint(params = {}) ⇒ Types::CreateResolverEndpointResponse

Creates a resolver endpoint. There are two types of resolver endpoints, inbound and outbound:

  • An inbound resolver endpoint forwards DNS queries to the DNS service for a VPC from your network or another VPC.

  • An outbound resolver endpoint forwards DNS queries from the DNS service for a VPC to your network or another VPC.

Examples:

Request syntax with placeholder values


resp = client.create_resolver_endpoint({
  creator_request_id: "CreatorRequestId", # required
  name: "Name",
  security_group_ids: ["ResourceId"], # required
  direction: "INBOUND", # required, accepts INBOUND, OUTBOUND
  ip_addresses: [ # required
    {
      subnet_id: "SubnetId", # required
      ip: "Ip",
    },
  ],
  tags: [
    {
      key: "TagKey",
      value: "TagValue",
    },
  ],
})

Response structure


resp.resolver_endpoint.id #=> String
resp.resolver_endpoint.creator_request_id #=> String
resp.resolver_endpoint.arn #=> String
resp.resolver_endpoint.name #=> String
resp.resolver_endpoint.security_group_ids #=> Array
resp.resolver_endpoint.security_group_ids[0] #=> String
resp.resolver_endpoint.direction #=> String, one of "INBOUND", "OUTBOUND"
resp.resolver_endpoint.ip_address_count #=> Integer
resp.resolver_endpoint.host_vpc_id #=> String
resp.resolver_endpoint.status #=> String, one of "CREATING", "OPERATIONAL", "UPDATING", "AUTO_RECOVERING", "ACTION_NEEDED", "DELETING"
resp.resolver_endpoint.status_message #=> String
resp.resolver_endpoint.creation_time #=> String
resp.resolver_endpoint.modification_time #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :creator_request_id (required, String)

    A unique string that identifies the request and that allows failed requests to be retried without the risk of executing the operation twice. CreatorRequestId can be any unique string, for example, a date/time stamp.

  • :name (String)

    A friendly name that lets you easily find a configuration in the Resolver dashboard in the Route 53 console.

  • :security_group_ids (required, Array<String>)

    The ID of one or more security groups that you want to use to control access to this VPC. The security group that you specify must include one or more inbound rules (for inbound resolver endpoints) or outbound rules (for outbound resolver endpoints).

  • :direction (required, String)

    Specify the applicable value:

    • INBOUND: Resolver forwards DNS queries to the DNS service for a VPC from your network or another VPC

    • OUTBOUND: Resolver forwards DNS queries from the DNS service for a VPC to your network or another VPC

  • :ip_addresses (required, Array<Types::IpAddressRequest>)

    The subnets and IP addresses in your VPC that you want DNS queries to pass through on the way from your VPCs to your network (for outbound endpoints) or on the way from your network to your VPCs (for inbound resolver endpoints).

  • :tags (Array<Types::Tag>)

    A list of the tag keys and values that you want to associate with the endpoint.

Returns:

See Also:



459
460
461
462
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/client.rb', line 459

def create_resolver_endpoint(params = {}, options = {})
  req = build_request(:create_resolver_endpoint, params)
  req.send_request(options)
end

#create_resolver_rule(params = {}) ⇒ Types::CreateResolverRuleResponse

For DNS queries that originate in your VPCs, specifies which resolver endpoint the queries pass through, one domain name that you want to forward to your network, and the IP addresses of the DNS resolvers in your network.

Examples:

Request syntax with placeholder values


resp = client.create_resolver_rule({
  creator_request_id: "CreatorRequestId", # required
  name: "Name",
  rule_type: "FORWARD", # required, accepts FORWARD, SYSTEM, RECURSIVE
  domain_name: "DomainName", # required
  target_ips: [
    {
      ip: "Ip", # required
      port: 1,
    },
  ],
  resolver_endpoint_id: "ResourceId",
  tags: [
    {
      key: "TagKey",
      value: "TagValue",
    },
  ],
})

Response structure


resp.resolver_rule.id #=> String
resp.resolver_rule.creator_request_id #=> String
resp.resolver_rule.arn #=> String
resp.resolver_rule.domain_name #=> String
resp.resolver_rule.status #=> String, one of "COMPLETE", "DELETING", "UPDATING", "FAILED"
resp.resolver_rule.status_message #=> String
resp.resolver_rule.rule_type #=> String, one of "FORWARD", "SYSTEM", "RECURSIVE"
resp.resolver_rule.name #=> String
resp.resolver_rule.target_ips #=> Array
resp.resolver_rule.target_ips[0].ip #=> String
resp.resolver_rule.target_ips[0].port #=> Integer
resp.resolver_rule.resolver_endpoint_id #=> String
resp.resolver_rule.owner_id #=> String
resp.resolver_rule.share_status #=> String, one of "NOT_SHARED", "SHARED_WITH_ME", "SHARED_BY_ME"

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :creator_request_id (required, String)

    A unique string that identifies the request and that allows failed requests to be retried without the risk of executing the operation twice. CreatorRequestId can be any unique string, for example, a date/time stamp.

  • :name (String)

    A friendly name that lets you easily find a rule in the Resolver dashboard in the Route 53 console.

  • :rule_type (required, String)

    Specify FORWARD. Other resolver rule types aren't supported.

  • :domain_name (required, String)

    DNS queries for this domain name are forwarded to the IP addresses that you specify in TargetIps. If a query matches multiple resolver rules (example.com and www.example.com), outbound DNS queries are routed using the resolver rule that contains the most specific domain name (www.example.com).

  • :target_ips (Array<Types::TargetAddress>)

    The IPs that you want Resolver to forward DNS queries to. You can specify only IPv4 addresses. Separate IP addresses with a comma.

  • :resolver_endpoint_id (String)

    The ID of the outbound resolver endpoint that you want to use to route DNS queries to the IP addresses that you specify in TargetIps.

  • :tags (Array<Types::Tag>)

    A list of the tag keys and values that you want to associate with the endpoint.

Returns:

See Also:



548
549
550
551
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/client.rb', line 548

def create_resolver_rule(params = {}, options = {})
  req = build_request(:create_resolver_rule, params)
  req.send_request(options)
end

#delete_resolver_endpoint(params = {}) ⇒ Types::DeleteResolverEndpointResponse

Deletes a resolver endpoint. The effect of deleting a resolver endpoint depends on whether it's an inbound or an outbound resolver endpoint:

  • Inbound: DNS queries from your network or another VPC are no longer routed to the DNS service for the specified VPC.

  • Outbound: DNS queries from a VPC are no longer routed to your network or to another VPC.

Examples:

Request syntax with placeholder values


resp = client.delete_resolver_endpoint({
  resolver_endpoint_id: "ResourceId", # required
})

Response structure


resp.resolver_endpoint.id #=> String
resp.resolver_endpoint.creator_request_id #=> String
resp.resolver_endpoint.arn #=> String
resp.resolver_endpoint.name #=> String
resp.resolver_endpoint.security_group_ids #=> Array
resp.resolver_endpoint.security_group_ids[0] #=> String
resp.resolver_endpoint.direction #=> String, one of "INBOUND", "OUTBOUND"
resp.resolver_endpoint.ip_address_count #=> Integer
resp.resolver_endpoint.host_vpc_id #=> String
resp.resolver_endpoint.status #=> String, one of "CREATING", "OPERATIONAL", "UPDATING", "AUTO_RECOVERING", "ACTION_NEEDED", "DELETING"
resp.resolver_endpoint.status_message #=> String
resp.resolver_endpoint.creation_time #=> String
resp.resolver_endpoint.modification_time #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :resolver_endpoint_id (required, String)

    The ID of the resolver endpoint that you want to delete.

Returns:

See Also:



596
597
598
599
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/client.rb', line 596

def delete_resolver_endpoint(params = {}, options = {})
  req = build_request(:delete_resolver_endpoint, params)
  req.send_request(options)
end

#delete_resolver_rule(params = {}) ⇒ Types::DeleteResolverRuleResponse

Deletes a resolver rule. Before you can delete a resolver rule, you must disassociate it from all the VPCs that you associated the resolver rule with. For more infomation, see DisassociateResolverRule.

Examples:

Request syntax with placeholder values


resp = client.delete_resolver_rule({
  resolver_rule_id: "ResourceId", # required
})

Response structure


resp.resolver_rule.id #=> String
resp.resolver_rule.creator_request_id #=> String
resp.resolver_rule.arn #=> String
resp.resolver_rule.domain_name #=> String
resp.resolver_rule.status #=> String, one of "COMPLETE", "DELETING", "UPDATING", "FAILED"
resp.resolver_rule.status_message #=> String
resp.resolver_rule.rule_type #=> String, one of "FORWARD", "SYSTEM", "RECURSIVE"
resp.resolver_rule.name #=> String
resp.resolver_rule.target_ips #=> Array
resp.resolver_rule.target_ips[0].ip #=> String
resp.resolver_rule.target_ips[0].port #=> Integer
resp.resolver_rule.resolver_endpoint_id #=> String
resp.resolver_rule.owner_id #=> String
resp.resolver_rule.share_status #=> String, one of "NOT_SHARED", "SHARED_WITH_ME", "SHARED_BY_ME"

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :resolver_rule_id (required, String)

    The ID of the resolver rule that you want to delete.

Returns:

See Also:



639
640
641
642
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/client.rb', line 639

def delete_resolver_rule(params = {}, options = {})
  req = build_request(:delete_resolver_rule, params)
  req.send_request(options)
end

#disassociate_resolver_endpoint_ip_address(params = {}) ⇒ Types::DisassociateResolverEndpointIpAddressResponse

Removes IP addresses from an inbound or an outbound resolver endpoint. If you want to remove more than one IP address, submit one DisassociateResolverEndpointIpAddress request for each IP address.

To add an IP address to an endpoint, see AssociateResolverEndpointIpAddress.

Examples:

Request syntax with placeholder values


resp = client.disassociate_resolver_endpoint_ip_address({
  resolver_endpoint_id: "ResourceId", # required
  ip_address: { # required
    ip_id: "ResourceId",
    subnet_id: "SubnetId",
    ip: "Ip",
  },
})

Response structure


resp.resolver_endpoint.id #=> String
resp.resolver_endpoint.creator_request_id #=> String
resp.resolver_endpoint.arn #=> String
resp.resolver_endpoint.name #=> String
resp.resolver_endpoint.security_group_ids #=> Array
resp.resolver_endpoint.security_group_ids[0] #=> String
resp.resolver_endpoint.direction #=> String, one of "INBOUND", "OUTBOUND"
resp.resolver_endpoint.ip_address_count #=> Integer
resp.resolver_endpoint.host_vpc_id #=> String
resp.resolver_endpoint.status #=> String, one of "CREATING", "OPERATIONAL", "UPDATING", "AUTO_RECOVERING", "ACTION_NEEDED", "DELETING"
resp.resolver_endpoint.status_message #=> String
resp.resolver_endpoint.creation_time #=> String
resp.resolver_endpoint.modification_time #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :resolver_endpoint_id (required, String)

    The ID of the resolver endpoint that you want to disassociate an IP address from.

  • :ip_address (required, Types::IpAddressUpdate)

    The IPv4 address that you want to remove from a resolver endpoint.

Returns:

See Also:



693
694
695
696
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/client.rb', line 693

def disassociate_resolver_endpoint_ip_address(params = {}, options = {})
  req = build_request(:disassociate_resolver_endpoint_ip_address, params)
  req.send_request(options)
end

#disassociate_resolver_rule(params = {}) ⇒ Types::DisassociateResolverRuleResponse

Removes the association between a specified resolver rule and a specified VPC.

If you disassociate a resolver rule from a VPC, Resolver stops forwarding DNS queries for the domain name that you specified in the resolver rule.

Examples:

Request syntax with placeholder values


resp = client.disassociate_resolver_rule({
  vpc_id: "ResourceId", # required
  resolver_rule_id: "ResourceId", # required
})

Response structure


resp.resolver_rule_association.id #=> String
resp.resolver_rule_association.resolver_rule_id #=> String
resp.resolver_rule_association.name #=> String
resp.resolver_rule_association.vpc_id #=> String
resp.resolver_rule_association.status #=> String, one of "CREATING", "COMPLETE", "DELETING", "FAILED", "OVERRIDDEN"
resp.resolver_rule_association.status_message #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :vpc_id (required, String)

    The ID of the VPC that you want to disassociate the resolver rule from.

  • :resolver_rule_id (required, String)

    The ID of the resolver rule that you want to disassociate from the specified VPC.

Returns:

See Also:



737
738
739
740
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/client.rb', line 737

def disassociate_resolver_rule(params = {}, options = {})
  req = build_request(:disassociate_resolver_rule, params)
  req.send_request(options)
end

#get_resolver_endpoint(params = {}) ⇒ Types::GetResolverEndpointResponse

Gets information about a specified resolver endpoint, such as whether it's an inbound or an outbound resolver endpoint, and the current status of the endpoint.

Examples:

Request syntax with placeholder values


resp = client.get_resolver_endpoint({
  resolver_endpoint_id: "ResourceId", # required
})

Response structure


resp.resolver_endpoint.id #=> String
resp.resolver_endpoint.creator_request_id #=> String
resp.resolver_endpoint.arn #=> String
resp.resolver_endpoint.name #=> String
resp.resolver_endpoint.security_group_ids #=> Array
resp.resolver_endpoint.security_group_ids[0] #=> String
resp.resolver_endpoint.direction #=> String, one of "INBOUND", "OUTBOUND"
resp.resolver_endpoint.ip_address_count #=> Integer
resp.resolver_endpoint.host_vpc_id #=> String
resp.resolver_endpoint.status #=> String, one of "CREATING", "OPERATIONAL", "UPDATING", "AUTO_RECOVERING", "ACTION_NEEDED", "DELETING"
resp.resolver_endpoint.status_message #=> String
resp.resolver_endpoint.creation_time #=> String
resp.resolver_endpoint.modification_time #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :resolver_endpoint_id (required, String)

    The ID of the resolver endpoint that you want to get information about.

Returns:

See Also:



780
781
782
783
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/client.rb', line 780

def get_resolver_endpoint(params = {}, options = {})
  req = build_request(:get_resolver_endpoint, params)
  req.send_request(options)
end

#get_resolver_rule(params = {}) ⇒ Types::GetResolverRuleResponse

Gets information about a specified resolver rule, such as the domain name that the rule forwards DNS queries for and the ID of the outbound resolver endpoint that the rule is associated with.

Examples:

Request syntax with placeholder values


resp = client.get_resolver_rule({
  resolver_rule_id: "ResourceId", # required
})

Response structure


resp.resolver_rule.id #=> String
resp.resolver_rule.creator_request_id #=> String
resp.resolver_rule.arn #=> String
resp.resolver_rule.domain_name #=> String
resp.resolver_rule.status #=> String, one of "COMPLETE", "DELETING", "UPDATING", "FAILED"
resp.resolver_rule.status_message #=> String
resp.resolver_rule.rule_type #=> String, one of "FORWARD", "SYSTEM", "RECURSIVE"
resp.resolver_rule.name #=> String
resp.resolver_rule.target_ips #=> Array
resp.resolver_rule.target_ips[0].ip #=> String
resp.resolver_rule.target_ips[0].port #=> Integer
resp.resolver_rule.resolver_endpoint_id #=> String
resp.resolver_rule.owner_id #=> String
resp.resolver_rule.share_status #=> String, one of "NOT_SHARED", "SHARED_WITH_ME", "SHARED_BY_ME"

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :resolver_rule_id (required, String)

    The ID of the resolver rule that you want to get information about.

Returns:

See Also:



823
824
825
826
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/client.rb', line 823

def get_resolver_rule(params = {}, options = {})
  req = build_request(:get_resolver_rule, params)
  req.send_request(options)
end

#get_resolver_rule_association(params = {}) ⇒ Types::GetResolverRuleAssociationResponse

Gets information about an association between a specified resolver rule and a VPC. You associate a resolver rule and a VPC using AssociateResolverRule.

Examples:

Request syntax with placeholder values


resp = client.get_resolver_rule_association({
  resolver_rule_association_id: "ResourceId", # required
})

Response structure


resp.resolver_rule_association.id #=> String
resp.resolver_rule_association.resolver_rule_id #=> String
resp.resolver_rule_association.name #=> String
resp.resolver_rule_association.vpc_id #=> String
resp.resolver_rule_association.status #=> String, one of "CREATING", "COMPLETE", "DELETING", "FAILED", "OVERRIDDEN"
resp.resolver_rule_association.status_message #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :resolver_rule_association_id (required, String)

    The ID of the resolver rule association that you want to get information about.

Returns:

See Also:



859
860
861
862
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/client.rb', line 859

def get_resolver_rule_association(params = {}, options = {})
  req = build_request(:get_resolver_rule_association, params)
  req.send_request(options)
end

#get_resolver_rule_policy(params = {}) ⇒ Types::GetResolverRulePolicyResponse

Gets information about a resolver rule policy. A resolver rule policy specifies the Resolver operations and resources that you want to allow another AWS account to be able to use.

Examples:

Request syntax with placeholder values


resp = client.get_resolver_rule_policy({
  arn: "Arn", # required
})

Response structure


resp.resolver_rule_policy #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :arn (required, String)

    The ID of the resolver rule policy that you want to get information about.

Returns:

See Also:



890
891
892
893
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/client.rb', line 890

def get_resolver_rule_policy(params = {}, options = {})
  req = build_request(:get_resolver_rule_policy, params)
  req.send_request(options)
end

#list_resolver_endpoint_ip_addresses(params = {}) ⇒ Types::ListResolverEndpointIpAddressesResponse

Gets the IP addresses for a specified resolver endpoint.

Examples:

Request syntax with placeholder values


resp = client.list_resolver_endpoint_ip_addresses({
  resolver_endpoint_id: "ResourceId", # required
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.next_token #=> String
resp.max_results #=> Integer
resp.ip_addresses #=> Array
resp.ip_addresses[0].ip_id #=> String
resp.ip_addresses[0].subnet_id #=> String
resp.ip_addresses[0].ip #=> String
resp.ip_addresses[0].status #=> String, one of "CREATING", "FAILED_CREATION", "ATTACHING", "ATTACHED", "REMAP_DETACHING", "REMAP_ATTACHING", "DETACHING", "FAILED_RESOURCE_GONE", "DELETING", "DELETE_FAILED_FAS_EXPIRED"
resp.ip_addresses[0].status_message #=> String
resp.ip_addresses[0].creation_time #=> String
resp.ip_addresses[0].modification_time #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :resolver_endpoint_id (required, String)

    The ID of the resolver endpoint that you want to get IP addresses for.

  • :max_results (Integer)

    The maximum number of IP addresses that you want to return in the response to a ListResolverEndpointIpAddresses request. If you don't specify a value for MaxResults, Resolver returns up to 100 IP addresses.

  • :next_token (String)

    For the first ListResolverEndpointIpAddresses request, omit this value.

    If the specified resolver endpoint has more than MaxResults IP addresses, you can submit another ListResolverEndpointIpAddresses request to get the next group of IP addresses. In the next request, specify the value of NextToken from the previous response.

Returns:

See Also:



946
947
948
949
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/client.rb', line 946

def list_resolver_endpoint_ip_addresses(params = {}, options = {})
  req = build_request(:list_resolver_endpoint_ip_addresses, params)
  req.send_request(options)
end

#list_resolver_endpoints(params = {}) ⇒ Types::ListResolverEndpointsResponse

Lists all the resolver endpoints that were created using the current AWS account.

Examples:

Request syntax with placeholder values


resp = client.list_resolver_endpoints({
  max_results: 1,
  next_token: "NextToken",
  filters: [
    {
      name: "FilterName",
      values: ["FilterValue"],
    },
  ],
})

Response structure


resp.next_token #=> String
resp.max_results #=> Integer
resp.resolver_endpoints #=> Array
resp.resolver_endpoints[0].id #=> String
resp.resolver_endpoints[0].creator_request_id #=> String
resp.resolver_endpoints[0].arn #=> String
resp.resolver_endpoints[0].name #=> String
resp.resolver_endpoints[0].security_group_ids #=> Array
resp.resolver_endpoints[0].security_group_ids[0] #=> String
resp.resolver_endpoints[0].direction #=> String, one of "INBOUND", "OUTBOUND"
resp.resolver_endpoints[0].ip_address_count #=> Integer
resp.resolver_endpoints[0].host_vpc_id #=> String
resp.resolver_endpoints[0].status #=> String, one of "CREATING", "OPERATIONAL", "UPDATING", "AUTO_RECOVERING", "ACTION_NEEDED", "DELETING"
resp.resolver_endpoints[0].status_message #=> String
resp.resolver_endpoints[0].creation_time #=> String
resp.resolver_endpoints[0].modification_time #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :max_results (Integer)

    The maximum number of resolver endpoints that you want to return in the response to a ListResolverEndpoints request. If you don't specify a value for MaxResults, Resolver returns up to 100 resolver endpoints.

  • :next_token (String)

    For the first ListResolverEndpoints request, omit this value.

    If you have more than MaxResults resolver endpoints, you can submit another ListResolverEndpoints request to get the next group of resolver endpoints. In the next request, specify the value of NextToken from the previous response.

  • :filters (Array<Types::Filter>)

    An optional specification to return a subset of resolver endpoints, such as all inbound resolver endpoints.

    If you submit a second or subsequent ListResolverEndpoints request and specify the NextToken parameter, you must use the same values for Filters, if any, as in the previous request.

Returns:

See Also:



1020
1021
1022
1023
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/client.rb', line 1020

def list_resolver_endpoints(params = {}, options = {})
  req = build_request(:list_resolver_endpoints, params)
  req.send_request(options)
end

#list_resolver_rule_associations(params = {}) ⇒ Types::ListResolverRuleAssociationsResponse

Lists the associations that were created between resolver rules and VPCs using the current AWS account.

Examples:

Request syntax with placeholder values


resp = client.list_resolver_rule_associations({
  max_results: 1,
  next_token: "NextToken",
  filters: [
    {
      name: "FilterName",
      values: ["FilterValue"],
    },
  ],
})

Response structure


resp.next_token #=> String
resp.max_results #=> Integer
resp.resolver_rule_associations #=> Array
resp.resolver_rule_associations[0].id #=> String
resp.resolver_rule_associations[0].resolver_rule_id #=> String
resp.resolver_rule_associations[0].name #=> String
resp.resolver_rule_associations[0].vpc_id #=> String
resp.resolver_rule_associations[0].status #=> String, one of "CREATING", "COMPLETE", "DELETING", "FAILED", "OVERRIDDEN"
resp.resolver_rule_associations[0].status_message #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :max_results (Integer)

    The maximum number of rule associations that you want to return in the response to a ListResolverRuleAssociations request. If you don't specify a value for MaxResults, Resolver returns up to 100 rule associations.

  • :next_token (String)

    For the first ListResolverRuleAssociation request, omit this value.

    If you have more than MaxResults rule associations, you can submit another ListResolverRuleAssociation request to get the next group of rule associations. In the next request, specify the value of NextToken from the previous response.

  • :filters (Array<Types::Filter>)

    An optional specification to return a subset of resolver rules, such as resolver rules that are associated with the same VPC ID.

    If you submit a second or subsequent ListResolverRuleAssociations request and specify the NextToken parameter, you must use the same values for Filters, if any, as in the previous request.

Returns:

See Also:



1087
1088
1089
1090
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/client.rb', line 1087

def list_resolver_rule_associations(params = {}, options = {})
  req = build_request(:list_resolver_rule_associations, params)
  req.send_request(options)
end

#list_resolver_rules(params = {}) ⇒ Types::ListResolverRulesResponse

Lists the resolver rules that were created using the current AWS account.

Examples:

Request syntax with placeholder values


resp = client.list_resolver_rules({
  max_results: 1,
  next_token: "NextToken",
  filters: [
    {
      name: "FilterName",
      values: ["FilterValue"],
    },
  ],
})

Response structure


resp.next_token #=> String
resp.max_results #=> Integer
resp.resolver_rules #=> Array
resp.resolver_rules[0].id #=> String
resp.resolver_rules[0].creator_request_id #=> String
resp.resolver_rules[0].arn #=> String
resp.resolver_rules[0].domain_name #=> String
resp.resolver_rules[0].status #=> String, one of "COMPLETE", "DELETING", "UPDATING", "FAILED"
resp.resolver_rules[0].status_message #=> String
resp.resolver_rules[0].rule_type #=> String, one of "FORWARD", "SYSTEM", "RECURSIVE"
resp.resolver_rules[0].name #=> String
resp.resolver_rules[0].target_ips #=> Array
resp.resolver_rules[0].target_ips[0].ip #=> String
resp.resolver_rules[0].target_ips[0].port #=> Integer
resp.resolver_rules[0].resolver_endpoint_id #=> String
resp.resolver_rules[0].owner_id #=> String
resp.resolver_rules[0].share_status #=> String, one of "NOT_SHARED", "SHARED_WITH_ME", "SHARED_BY_ME"

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :max_results (Integer)

    The maximum number of resolver rules that you want to return in the response to a ListResolverRules request. If you don't specify a value for MaxResults, Resolver returns up to 100 resolver rules.

  • :next_token (String)

    For the first ListResolverRules request, omit this value.

    If you have more than MaxResults resolver rules, you can submit another ListResolverRules request to get the next group of resolver rules. In the next request, specify the value of NextToken from the previous response.

  • :filters (Array<Types::Filter>)

    An optional specification to return a subset of resolver rules, such as all resolver rules that are associated with the same resolver endpoint.

    If you submit a second or subsequent ListResolverRules request and specify the NextToken parameter, you must use the same values for Filters, if any, as in the previous request.

Returns:

See Also:



1162
1163
1164
1165
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/client.rb', line 1162

def list_resolver_rules(params = {}, options = {})
  req = build_request(:list_resolver_rules, params)
  req.send_request(options)
end

#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse

Lists the tags that you associated with the specified resource.

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  resource_arn: "Arn", # required
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :resource_arn (required, String)

    The Amazon Resource Name (ARN) for the resource that you want to list tags for.

  • :max_results (Integer)

    The maximum number of tags that you want to return in the response to a ListTagsForResource request. If you don't specify a value for MaxResults, Resolver returns up to 100 tags.

  • :next_token (String)

    For the first ListTagsForResource request, omit this value.

    If you have more than MaxResults tags, you can submit another ListTagsForResource request to get the next group of tags for the resource. In the next request, specify the value of NextToken from the previous response.

Returns:

See Also:



1210
1211
1212
1213
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/client.rb', line 1210

def list_tags_for_resource(params = {}, options = {})
  req = build_request(:list_tags_for_resource, params)
  req.send_request(options)
end

#put_resolver_rule_policy(params = {}) ⇒ Types::PutResolverRulePolicyResponse

Specifies the Resolver operations and resources that you want to allow another AWS account to be able to use.

Examples:

Request syntax with placeholder values


resp = client.put_resolver_rule_policy({
  arn: "Arn", # required
  resolver_rule_policy: "ResolverRulePolicy", # required
})

Response structure


resp.return_value #=> Boolean

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :arn (required, String)

    The Amazon Resource Name (ARN) of the account that you want to grant permissions to.

  • :resolver_rule_policy (required, String)

    An AWS Identity and Access Management policy statement that lists the permissions that you want to grant to another AWS account.

Returns:

See Also:



1245
1246
1247
1248
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/client.rb', line 1245

def put_resolver_rule_policy(params = {}, options = {})
  req = build_request(:put_resolver_rule_policy, params)
  req.send_request(options)
end

#tag_resource(params = {}) ⇒ Struct

Adds one or more tags to a specified resource.

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "Arn", # required
  tags: [ # required
    {
      key: "TagKey",
      value: "TagValue",
    },
  ],
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :resource_arn (required, String)

    The Amazon Resource Name (ARN) for the resource that you want to add tags to. To get the ARN for a resource, use the applicable Get or List command:

    • GetResolverEndpoint

    • GetResolverRule

    • GetResolverRuleAssociation

    • ListResolverEndpoints

    • ListResolverRuleAssociations

    • ListResolverRules

  • :tags (required, Array<Types::Tag>)

    The tags that you want to add to the specified resource.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1290
1291
1292
1293
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/client.rb', line 1290

def tag_resource(params = {}, options = {})
  req = build_request(:tag_resource, params)
  req.send_request(options)
end

#untag_resource(params = {}) ⇒ Struct

Removes one or more tags from a specified resource.

Examples:

Request syntax with placeholder values


resp = client.untag_resource({
  resource_arn: "Arn", # required
  tag_keys: ["TagKey"], # required
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :resource_arn (required, String)

    The Amazon Resource Name (ARN) for the resource that you want to remove tags from. To get the ARN for a resource, use the applicable Get or List command:

    • GetResolverEndpoint

    • GetResolverRule

    • GetResolverRuleAssociation

    • ListResolverEndpoints

    • ListResolverRuleAssociations

    • ListResolverRules

  • :tag_keys (required, Array<String>)

    The tags that you want to remove to the specified resource.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1330
1331
1332
1333
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/client.rb', line 1330

def untag_resource(params = {}, options = {})
  req = build_request(:untag_resource, params)
  req.send_request(options)
end

#update_resolver_endpoint(params = {}) ⇒ Types::UpdateResolverEndpointResponse

Updates the name of an inbound or an outbound resolver endpoint.

Examples:

Request syntax with placeholder values


resp = client.update_resolver_endpoint({
  resolver_endpoint_id: "ResourceId", # required
  name: "Name",
})

Response structure


resp.resolver_endpoint.id #=> String
resp.resolver_endpoint.creator_request_id #=> String
resp.resolver_endpoint.arn #=> String
resp.resolver_endpoint.name #=> String
resp.resolver_endpoint.security_group_ids #=> Array
resp.resolver_endpoint.security_group_ids[0] #=> String
resp.resolver_endpoint.direction #=> String, one of "INBOUND", "OUTBOUND"
resp.resolver_endpoint.ip_address_count #=> Integer
resp.resolver_endpoint.host_vpc_id #=> String
resp.resolver_endpoint.status #=> String, one of "CREATING", "OPERATIONAL", "UPDATING", "AUTO_RECOVERING", "ACTION_NEEDED", "DELETING"
resp.resolver_endpoint.status_message #=> String
resp.resolver_endpoint.creation_time #=> String
resp.resolver_endpoint.modification_time #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :resolver_endpoint_id (required, String)

    The ID of the resolver endpoint that you want to update.

  • :name (String)

    The name of the resolver endpoint that you want to update.

Returns:

See Also:



1374
1375
1376
1377
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/client.rb', line 1374

def update_resolver_endpoint(params = {}, options = {})
  req = build_request(:update_resolver_endpoint, params)
  req.send_request(options)
end

#update_resolver_rule(params = {}) ⇒ Types::UpdateResolverRuleResponse

Updates settings for a specified resolver rule. ResolverRuleId is required, and all other parameters are optional. If you don't specify a parameter, it retains its current value.

Examples:

Request syntax with placeholder values


resp = client.update_resolver_rule({
  resolver_rule_id: "ResourceId", # required
  config: { # required
    name: "Name",
    target_ips: [
      {
        ip: "Ip", # required
        port: 1,
      },
    ],
    resolver_endpoint_id: "ResourceId",
  },
})

Response structure


resp.resolver_rule.id #=> String
resp.resolver_rule.creator_request_id #=> String
resp.resolver_rule.arn #=> String
resp.resolver_rule.domain_name #=> String
resp.resolver_rule.status #=> String, one of "COMPLETE", "DELETING", "UPDATING", "FAILED"
resp.resolver_rule.status_message #=> String
resp.resolver_rule.rule_type #=> String, one of "FORWARD", "SYSTEM", "RECURSIVE"
resp.resolver_rule.name #=> String
resp.resolver_rule.target_ips #=> Array
resp.resolver_rule.target_ips[0].ip #=> String
resp.resolver_rule.target_ips[0].port #=> Integer
resp.resolver_rule.resolver_endpoint_id #=> String
resp.resolver_rule.owner_id #=> String
resp.resolver_rule.share_status #=> String, one of "NOT_SHARED", "SHARED_WITH_ME", "SHARED_BY_ME"

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :resolver_rule_id (required, String)

    The ID of the resolver rule that you want to update.

  • :config (required, Types::ResolverRuleConfig)

    The new settings for the resolver rule.

Returns:

See Also:



1430
1431
1432
1433
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/client.rb', line 1430

def update_resolver_rule(params = {}, options = {})
  req = build_request(:update_resolver_rule, params)
  req.send_request(options)
end