Class: Aws::Route53Resolver::Client

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

Overview

An API client for Route53Resolver. To construct a client, you need to configure a :region and :credentials.

client = Aws::Route53Resolver::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

For details on configuring region and credentials see the developer guide.

See #initialize for a full list of supported configuration options.

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

  • :plugins (Array<Seahorse::Client::Plugin>) — default: []] —

    A list of plugins to apply to the client. Each plugin is either a class name or an instance of a plugin class.

  • :credentials (required, Aws::CredentialProvider) —

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

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

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

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

    • Aws::AssumeRoleWebIdentityCredentials - Used when you need to assume a role after providing credentials via the web.

    • Aws::SSOCredentials - Used for loading credentials from AWS SSO using an access token generated from aws login.

    • Aws::ProcessCredentials - Used for loading credentials from a process that outputs to stdout.

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

    • Aws::ECSCredentials - Used for loading credentials from instances running in ECS.

    • Aws::CognitoIdentityCredentials - Used for loading credentials from the Cognito Identity service.

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

    • Aws.config[:credentials]

    • The :access_key_id, :secret_access_key, :session_token, and :account_id options.

    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY'], ENV['AWS_SESSION_TOKEN'], and ENV['AWS_ACCOUNT_ID'].

    • ~/.aws/credentials

    • ~/.aws/config

    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentials or Aws::ECSCredentials to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED'] to true.

  • :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 searched 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)
  • :account_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.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

    Used only in adaptive retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a RetryCapacityNotAvailableError and will not retry instead of sleeping.

  • :auth_scheme_preference (Array<String>) —

    A list of preferred authentication schemes to use when making a request. Supported values are: sigv4, sigv4a, httpBearerAuth, and noAuth. When set using ENV['AWS_AUTH_SCHEME_PREFERENCE'] or in shared config as auth_scheme_preference, the value should be a comma-separated list.

  • :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.

  • :correct_clock_skew (Boolean) — default: true —

    Used only in standard and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :defaults_mode (String) — default: "legacy" —

    See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :disable_host_prefix_injection (Boolean) — default: false —

    When true, the SDK will not prepend the modeled host prefix to the endpoint.

  • :disable_request_compression (Boolean) — default: false —

    When set to 'true' the request body will not be compressed for supported operations.

  • :endpoint (String, URI::HTTPS, URI::HTTP) —

    Normally you should not configure the :endpoint option directly. This is normally constructed from the :region option. Configuring :endpoint is normally reserved for connecting to test or custom endpoints. The endpoint should be a URI formatted like:

    'http://example.com'
'https://example.com'
'http://example.com:123'
  • :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.

  • :ignore_configured_endpoint_urls (Boolean) —

    Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.

  • :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.

  • :max_attempts (Integer) — default: 3 —

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in standard and adaptive retry modes.

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

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

  • :request_checksum_calculation (String) — default: "when_supported" —

    Determines when a checksum will be calculated for request payloads. Values are:

    • when_supported - (default) When set, a checksum will be calculated for all request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true and/or a requestAlgorithmMember is modeled.
    • when_required - When set, a checksum will only be calculated for request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true or where a requestAlgorithmMember is modeled and supplied.
  • :request_min_compression_size_bytes (Integer) — default: 10240 —

    The minimum size in bytes that triggers compression for request bodies. The value must be non-negative integer value between 0 and 10485780 bytes inclusive.

  • :response_checksum_validation (String) — default: "when_supported" —

    Determines when checksum validation will be performed on response payloads. Values are:

    • when_supported - (default) When set, checksum validation is performed on all response payloads of operations modeled with the httpChecksum trait where responseAlgorithms is modeled, except when no modeled checksum algorithms are supported.
    • when_required - When set, checksum validation is not performed on response payloads of operations unless the checksum algorithm is supported and the requestValidationModeMember member is set to ENABLED.
  • :retry_backoff (Proc) —

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the legacy retry mode.

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function. This option is only used in the legacy retry mode.

  • :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. This option is only used in the legacy retry mode.

    @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, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the legacy retry mode.

  • :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. This option is only used in the legacy retry mode.

  • :retry_mode (String) — default: "legacy" —

    Specifies which retry algorithm to use. Values are:

    • legacy - The pre-existing retry behavior. This is default value if no retry mode is provided.

    • standard - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • adaptive - An experimental retry mode that includes all the functionality of standard mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.

  • :sdk_ua_app_id (String) —

    A unique and opaque application ID that is appended to the User-Agent header as app/sdk_ua_app_id. It should have a maximum length of 50. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.

  • :secret_access_key (String)
  • :session_token (String)
  • :sigv4a_signing_region_set (Array) —

    A list of regions that should be signed with SigV4a signing. When not passed, a default :sigv4a_signing_region_set is searched for in the following locations:

    • Aws.config[:sigv4a_signing_region_set]
    • ENV['AWS_SIGV4A_SIGNING_REGION_SET']
    • ~/.aws/config
  • :simple_json (Boolean) — default: false —

    Disables request parameter conversion, validation, and formatting. Also disables response data type conversions. The request parameters hash must be formatted exactly as the API expects.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.

  • :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.

  • :telemetry_provider (Aws::Telemetry::TelemetryProviderBase) — default: Aws::Telemetry::NoOpTelemetryProvider —

    Allows you to provide a telemetry provider, which is used to emit telemetry data. By default, uses NoOpTelemetryProvider which will not record or emit any telemetry data. The SDK supports the following telemetry providers:

    • OpenTelemetry (OTel) - To use the OTel provider, install and require the opentelemetry-sdk gem and then, pass in an instance of a Aws::Telemetry::OTelProvider for telemetry provider.
  • :token_provider (Aws::TokenProvider) —

    Your Bearer token used for authentication. This can be an instance of any one of the following classes:

    • Aws::StaticTokenProvider - Used for configuring static, non-refreshing tokens.

    • Aws::SSOTokenProvider - Used for loading tokens from AWS SSO using an access token generated from aws login.

    When :token_provider is not configured directly, the Aws::TokenProviderChain will be used to search for tokens configured for your profile in shared configuration files.

  • :use_dualstack_endpoint (Boolean) —

    When set to true, dualstack enabled endpoints (with .aws TLD) will be used if available.

  • :use_fips_endpoint (Boolean) —

    When set to true, fips compatible endpoints will be used if available. When a fips region is used, the region is normalized and this config is set to true.

  • :validate_params (Boolean) — default: true —

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

  • :endpoint_provider (Aws::Route53Resolver::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to #resolve_endpoint(parameters) where parameters is a Struct similar to Aws::Route53Resolver::EndpointParameters.

  • :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.

  • :http_idle_timeout (Float) — default: 5 —

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

  • :http_open_timeout (Float) — default: 15 —

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

  • :http_proxy (URI::HTTP, String) —

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

  • :http_read_timeout (Float) — default: 60 —

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

  • :http_wire_trace (Boolean) — default: false —

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

  • :on_chunk_received (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the response body is received. It provides three arguments: the chunk, the number of bytes received, and the total number of bytes in the response (or nil if the server did not send a content-length).

  • :on_chunk_sent (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the request body is sent. It provides three arguments: the chunk, the number of bytes read from the body, and the total number of bytes in the body.

  • :raise_response_errors (Boolean) — default: true —

    When true, response errors are raised.

  • :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.

  • :ssl_ca_store (String) —

    Sets the X509::Store to verify peer certificate.

  • :ssl_cert (OpenSSL::X509::Certificate) —

    Sets a client certificate when creating http connections.

  • :ssl_key (OpenSSL::PKey) —

    Sets a client key when creating http connections.

  • :ssl_timeout (Float) —

    Sets the SSL timeout in seconds

  • :ssl_verify_peer (Boolean) — default: true —

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



483
484
485
 
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/client.rb', line 483

def initialize(*args)
  super
end

Instance Method Details

#associate_firewall_rule_group(params = {}) ⇒ Types::AssociateFirewallRuleGroupResponse

Associates a FirewallRuleGroup with a VPC, to provide DNS filtering for the VPC.

Examples:

Request syntax with placeholder values


resp = client.associate_firewall_rule_group({
  creator_request_id: "CreatorRequestId", # required
  firewall_rule_group_id: "ResourceId", # required
  vpc_id: "ResourceId", # required
  priority: 1, # required
  name: "Name", # required
  mutation_protection: "ENABLED", # accepts ENABLED, DISABLED
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Response structure


resp.firewall_rule_group_association.id #=> String
resp.firewall_rule_group_association.arn #=> String
resp.firewall_rule_group_association.firewall_rule_group_id #=> String
resp.firewall_rule_group_association.vpc_id #=> String
resp.firewall_rule_group_association.name #=> String
resp.firewall_rule_group_association.priority #=> Integer
resp.firewall_rule_group_association.mutation_protection #=> String, one of "ENABLED", "DISABLED"
resp.firewall_rule_group_association.managed_owner_name #=> String
resp.firewall_rule_group_association.status #=> String, one of "COMPLETE", "DELETING", "UPDATING"
resp.firewall_rule_group_association.status_message #=> String
resp.firewall_rule_group_association.creator_request_id #=> String
resp.firewall_rule_group_association.creation_time #=> String
resp.firewall_rule_group_association.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 running the operation twice. CreatorRequestId can be any unique string, for example, a date/time stamp.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :firewall_rule_group_id (required, String) —

    The unique identifier of the firewall rule group.

  • :vpc_id (required, String) —

    The unique identifier of the VPC that you want to associate with the rule group.

  • :priority (required, Integer) —

    The setting that determines the processing order of the rule group among the rule groups that you associate with the specified VPC. DNS Firewall filters VPC traffic starting from the rule group with the lowest numeric priority setting.

    You must specify a unique priority for each rule group that you associate with a single VPC. To make it easier to insert rule groups later, leave space between the numbers, for example, use 101, 200, and so on. You can change the priority setting for a rule group association after you create it.

    The allowed values for Priority are between 100 and 9900.

  • :name (required, String) —

    A name that lets you identify the association, to manage and use it.

  • :mutation_protection (String) —

    If enabled, this setting disallows modification or removal of the association, to help prevent against accidentally altering DNS firewall protections. When you create the association, the default setting is DISABLED.

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

    A list of the tag keys and values that you want to associate with the rule group association.

Returns:

See Also:



576
577
578
579
 
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/client.rb', line 576

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

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

Adds IP addresses to an inbound or an outbound Resolver endpoint. If you want to add 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",
    ipv_6: "Ipv6",
  },
})

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", "INBOUND_DELEGATION"
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
resp.resolver_endpoint.outpost_arn #=> String
resp.resolver_endpoint.preferred_instance_type #=> String
resp.resolver_endpoint.resolver_endpoint_type #=> String, one of "IPV6", "IPV4", "DUALSTACK"
resp.resolver_endpoint.protocols #=> Array
resp.resolver_endpoint.protocols[0] #=> String, one of "DoH", "Do53", "DoH-FIPS"

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:



642
643
644
645
 
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/client.rb', line 642

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

#associate_resolver_query_log_config(params = {}) ⇒ Types::AssociateResolverQueryLogConfigResponse

Associates an Amazon VPC with a specified query logging configuration. Route 53 Resolver logs DNS queries that originate in all of the Amazon VPCs that are associated with a specified query logging configuration. To associate more than one VPC with a configuration, submit one AssociateResolverQueryLogConfig request for each VPC.

The VPCs that you associate with a query logging configuration must be in the same Region as the configuration.

To remove a VPC from a query logging configuration, see DisassociateResolverQueryLogConfig.

Examples:

Request syntax with placeholder values


resp = client.associate_resolver_query_log_config({
  resolver_query_log_config_id: "ResourceId", # required
  resource_id: "ResourceId", # required
})

Response structure


resp.resolver_query_log_config_association.id #=> String
resp.resolver_query_log_config_association.resolver_query_log_config_id #=> String
resp.resolver_query_log_config_association.resource_id #=> String
resp.resolver_query_log_config_association.status #=> String, one of "CREATING", "ACTIVE", "ACTION_NEEDED", "DELETING", "FAILED"
resp.resolver_query_log_config_association.error #=> String, one of "NONE", "DESTINATION_NOT_FOUND", "ACCESS_DENIED", "INTERNAL_SERVICE_ERROR"
resp.resolver_query_log_config_association.error_message #=> String
resp.resolver_query_log_config_association.creation_time #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :resolver_query_log_config_id (required, String) —

    The ID of the query logging configuration that you want to associate a VPC with.

  • :resource_id (required, String) —

    The ID of an Amazon VPC that you want this query logging configuration to log queries for.

    The VPCs and the query logging configuration must be in the same Region.

Returns:

See Also:



703
704
705
706
 
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/client.rb', line 703

def associate_resolver_query_log_config(params = {}, options = {})
  req = build_request(:associate_resolver_query_log_config, 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:



759
760
761
762
 
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/client.rb', line 759

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

#create_firewall_domain_list(params = {}) ⇒ Types::CreateFirewallDomainListResponse

Creates an empty firewall domain list for use in DNS Firewall rules. You can populate the domains for the new list with a file, using ImportFirewallDomains, or with domain strings, using UpdateFirewallDomains.

Examples:

Request syntax with placeholder values


resp = client.create_firewall_domain_list({
  creator_request_id: "CreatorRequestId", # required
  name: "Name", # required
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Response structure


resp.firewall_domain_list.id #=> String
resp.firewall_domain_list.arn #=> String
resp.firewall_domain_list.name #=> String
resp.firewall_domain_list.domain_count #=> Integer
resp.firewall_domain_list.status #=> String, one of "COMPLETE", "COMPLETE_IMPORT_FAILED", "IMPORTING", "DELETING", "UPDATING"
resp.firewall_domain_list.status_message #=> String
resp.firewall_domain_list.managed_owner_name #=> String
resp.firewall_domain_list.creator_request_id #=> String
resp.firewall_domain_list.creation_time #=> String
resp.firewall_domain_list.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 you to retry failed requests without the risk of running the operation twice. CreatorRequestId can be any unique string, for example, a date/time stamp.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :name (required, String) —

    A name that lets you identify the domain list to manage and use it.

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

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

Returns:

See Also:



819
820
821
822
 
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/client.rb', line 819

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

#create_firewall_rule(params = {}) ⇒ Types::CreateFirewallRuleResponse

Creates a single DNS Firewall rule in the specified rule group, using the specified domain list.

Examples:

Request syntax with placeholder values


resp = client.create_firewall_rule({
  creator_request_id: "CreatorRequestId", # required
  firewall_rule_group_id: "ResourceId", # required
  firewall_domain_list_id: "ResourceId",
  priority: 1, # required
  action: "ALLOW", # required, accepts ALLOW, BLOCK, ALERT
  block_response: "NODATA", # accepts NODATA, NXDOMAIN, OVERRIDE
  block_override_domain: "BlockOverrideDomain",
  block_override_dns_type: "CNAME", # accepts CNAME
  block_override_ttl: 1,
  name: "Name", # required
  firewall_domain_redirection_action: "INSPECT_REDIRECTION_DOMAIN", # accepts INSPECT_REDIRECTION_DOMAIN, TRUST_REDIRECTION_DOMAIN
  qtype: "Qtype",
  dns_threat_protection: "DGA", # accepts DGA, DNS_TUNNELING
  confidence_threshold: "LOW", # accepts LOW, MEDIUM, HIGH
})

Response structure


resp.firewall_rule.firewall_rule_group_id #=> String
resp.firewall_rule.firewall_domain_list_id #=> String
resp.firewall_rule.firewall_threat_protection_id #=> String
resp.firewall_rule.name #=> String
resp.firewall_rule.priority #=> Integer
resp.firewall_rule.action #=> String, one of "ALLOW", "BLOCK", "ALERT"
resp.firewall_rule.block_response #=> String, one of "NODATA", "NXDOMAIN", "OVERRIDE"
resp.firewall_rule.block_override_domain #=> String
resp.firewall_rule.block_override_dns_type #=> String, one of "CNAME"
resp.firewall_rule.block_override_ttl #=> Integer
resp.firewall_rule.creator_request_id #=> String
resp.firewall_rule.creation_time #=> String
resp.firewall_rule.modification_time #=> String
resp.firewall_rule.firewall_domain_redirection_action #=> String, one of "INSPECT_REDIRECTION_DOMAIN", "TRUST_REDIRECTION_DOMAIN"
resp.firewall_rule.qtype #=> String
resp.firewall_rule.dns_threat_protection #=> String, one of "DGA", "DNS_TUNNELING"
resp.firewall_rule.confidence_threshold #=> String, one of "LOW", "MEDIUM", "HIGH"

Parameters:

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

    ({})

Options Hash (params):

  • :creator_request_id (required, String) —

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

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :firewall_rule_group_id (required, String) —

    The unique identifier of the firewall rule group where you want to create the rule.

  • :firewall_domain_list_id (String) —

    The ID of the domain list that you want to use in the rule. Can't be used together with DnsThreatProtecton.

  • :priority (required, Integer) —

    The setting that determines the processing order of the rule in the rule group. DNS Firewall processes the rules in a rule group by order of priority, starting from the lowest setting.

    You must specify a unique priority for each rule in a rule group. To make it easier to insert rules later, leave space between the numbers, for example, use 100, 200, and so on. You can change the priority setting for the rules in a rule group at any time.

  • :action (required, String) —

    The action that DNS Firewall should take on a DNS query when it matches one of the domains in the rule's domain list, or a threat in a DNS Firewall Advanced rule:

    • ALLOW - Permit the request to go through. Not available for DNS Firewall Advanced rules.

    • ALERT - Permit the request and send metrics and logs to Cloud Watch.

    • BLOCK - Disallow the request. This option requires additional details in the rule's BlockResponse.

  • :block_response (String) —

    The way that you want DNS Firewall to block the request, used with the rule action setting BLOCK.

    • NODATA - Respond indicating that the query was successful, but no response is available for it.

    • NXDOMAIN - Respond indicating that the domain name that's in the query doesn't exist.

    • OVERRIDE - Provide a custom override in the response. This option requires custom handling details in the rule's BlockOverride* settings.

    This setting is required if the rule action setting is BLOCK.

  • :block_override_domain (String) —

    The custom DNS record to send back in response to the query. Used for the rule action BLOCK with a BlockResponse setting of OVERRIDE.

    This setting is required if the BlockResponse setting is OVERRIDE.

  • :block_override_dns_type (String) —

    The DNS record's type. This determines the format of the record value that you provided in BlockOverrideDomain. Used for the rule action BLOCK with a BlockResponse setting of OVERRIDE.

    This setting is required if the BlockResponse setting is OVERRIDE.

  • :block_override_ttl (Integer) —

    The recommended amount of time, in seconds, for the DNS resolver or web browser to cache the provided override record. Used for the rule action BLOCK with a BlockResponse setting of OVERRIDE.

    This setting is required if the BlockResponse setting is OVERRIDE.

  • :name (required, String) —

    A name that lets you identify the rule in the rule group.

  • :firewall_domain_redirection_action (String) —

    How you want the the rule to evaluate DNS redirection in the DNS redirection chain, such as CNAME or DNAME.

    INSPECT_REDIRECTION_DOMAIN: (Default) inspects all domains in the redirection chain. The individual domains in the redirection chain must be added to the domain list.

    TRUST_REDIRECTION_DOMAIN: Inspects only the first domain in the redirection chain. You don't need to add the subsequent domains in the domain in the redirection list to the domain list.

  • :qtype (String) —

    The DNS query type you want the rule to evaluate. Allowed values are;

    • A: Returns an IPv4 address.

    • AAAA: Returns an Ipv6 address.

    • CAA: Restricts CAs that can create SSL/TLS certifications for the domain.

    • CNAME: Returns another domain name.

    • DS: Record that identifies the DNSSEC signing key of a delegated zone.

    • MX: Specifies mail servers.

    • NAPTR: Regular-expression-based rewriting of domain names.

    • NS: Authoritative name servers.

    • PTR: Maps an IP address to a domain name.

    • SOA: Start of authority record for the zone.

    • SPF: Lists the servers authorized to send emails from a domain.

    • SRV: Application specific values that identify servers.

    • TXT: Verifies email senders and application-specific values.

    • A query type you define by using the DNS type ID, for example 28 for AAAA. The values must be defined as TYPENUMBER, where the NUMBER can be 1-65334, for example, TYPE28. For more information, see List of DNS record types.

  • :dns_threat_protection (String) —

    Use to create a DNS Firewall Advanced rule.

  • :confidence_threshold (String) —

    The confidence threshold for DNS Firewall Advanced. You must provide this value when you create a DNS Firewall Advanced rule. The confidence level values mean:

    • LOW: Provides the highest detection rate for threats, but also increases false positives.

    • MEDIUM: Provides a balance between detecting threats and false positives.

    • HIGH: Detects only the most well corroborated threats with a low rate of false positives.

Returns:

See Also:



1023
1024
1025
1026
 
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/client.rb', line 1023

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

#create_firewall_rule_group(params = {}) ⇒ Types::CreateFirewallRuleGroupResponse

Creates an empty DNS Firewall rule group for filtering DNS network traffic in a VPC. You can add rules to the new rule group by calling CreateFirewallRule.

Examples:

Request syntax with placeholder values


resp = client.create_firewall_rule_group({
  creator_request_id: "CreatorRequestId", # required
  name: "Name", # required
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Response structure


resp.firewall_rule_group.id #=> String
resp.firewall_rule_group.arn #=> String
resp.firewall_rule_group.name #=> String
resp.firewall_rule_group.rule_count #=> Integer
resp.firewall_rule_group.status #=> String, one of "COMPLETE", "DELETING", "UPDATING"
resp.firewall_rule_group.status_message #=> String
resp.firewall_rule_group.owner_id #=> String
resp.firewall_rule_group.creator_request_id #=> String
resp.firewall_rule_group.share_status #=> String, one of "NOT_SHARED", "SHARED_WITH_ME", "SHARED_BY_ME"
resp.firewall_rule_group.creation_time #=> String
resp.firewall_rule_group.modification_time #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :creator_request_id (required, String) —

    A unique string defined by you to identify the request. This allows you to retry failed requests without the risk of running the operation twice. This can be any unique string, for example, a timestamp.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :name (required, String) —

    A name that lets you identify the rule group, to manage and use it.

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

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

Returns:

See Also:



1082
1083
1084
1085
 
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/client.rb', line 1082

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

#create_outpost_resolver(params = {}) ⇒ Types::CreateOutpostResolverResponse

Creates a Route 53 Resolver on an Outpost.

Examples:

Request syntax with placeholder values


resp = client.create_outpost_resolver({
  creator_request_id: "CreatorRequestId", # required
  name: "OutpostResolverName", # required
  instance_count: 1,
  preferred_instance_type: "OutpostInstanceType", # required
  outpost_arn: "OutpostArn", # required
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Response structure


resp.outpost_resolver.arn #=> String
resp.outpost_resolver.creation_time #=> String
resp.outpost_resolver.modification_time #=> String
resp.outpost_resolver.creator_request_id #=> String
resp.outpost_resolver.id #=> String
resp.outpost_resolver.instance_count #=> Integer
resp.outpost_resolver.preferred_instance_type #=> String
resp.outpost_resolver.name #=> String
resp.outpost_resolver.status #=> String, one of "CREATING", "OPERATIONAL", "UPDATING", "DELETING", "ACTION_NEEDED", "FAILED_CREATION", "FAILED_DELETION"
resp.outpost_resolver.status_message #=> String
resp.outpost_resolver.outpost_arn #=> 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 running the operation twice.

    CreatorRequestId can be any unique string, for example, a date/time stamp.

  • :name (required, String) —

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

  • :instance_count (Integer) —

    Number of Amazon EC2 instances for the Resolver on Outpost. The default and minimal value is 4.

  • :preferred_instance_type (required, String) —

    The Amazon EC2 instance type. If you specify this, you must also specify a value for the OutpostArn.

  • :outpost_arn (required, String) —

    The Amazon Resource Name (ARN) of the Outpost. If you specify this, you must also specify a value for the PreferredInstanceType.

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

    A string that helps identify the Route 53 Resolvers on Outpost.

Returns:

See Also:



1154
1155
1156
1157
 
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/client.rb', line 1154

def create_outpost_resolver(params = {}, options = {})
  req = build_request(:create_outpost_resolver, 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.

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

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, INBOUND_DELEGATION
  ip_addresses: [ # required
    {
      subnet_id: "SubnetId", # required
      ip: "Ip",
      ipv_6: "Ipv6",
    },
  ],
  outpost_arn: "OutpostArn",
  preferred_instance_type: "OutpostInstanceType",
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  resolver_endpoint_type: "IPV6", # accepts IPV6, IPV4, DUALSTACK
  protocols: ["DoH"], # accepts DoH, Do53, DoH-FIPS
})

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", "INBOUND_DELEGATION"
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
resp.resolver_endpoint.outpost_arn #=> String
resp.resolver_endpoint.preferred_instance_type #=> String
resp.resolver_endpoint.resolver_endpoint_type #=> String, one of "IPV6", "IPV4", "DUALSTACK"
resp.resolver_endpoint.protocols #=> Array
resp.resolver_endpoint.protocols[0] #=> String, one of "DoH", "Do53", "DoH-FIPS"

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 running 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). Inbound and outbound rules must allow TCP and UDP access. For inbound access, open port 53. For outbound access, open the port that you're using for DNS queries on your network.

    Some security group rules will cause your connection to be tracked. For outbound resolver endpoint, it can potentially impact the maximum queries per second from outbound endpoint to your target name server. For inbound resolver endpoint, it can bring down the overall maximum queries per second per IP address to as low as 1500. To avoid connection tracking caused by security group, see Untracked connections.

  • :direction (required, String) —

    Specify the applicable value:

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

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

    • INBOUND_DELEGATION: Resolver delegates queries to Route 53 private hosted zones from your network.

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

    The subnets and IP addresses in your VPC that DNS queries originate from (for outbound endpoints) or that you forward DNS queries to (for inbound endpoints). The subnet ID uniquely identifies a VPC.

    Even though the minimum is 1, Route 53 requires that you create at least two.

  • :outpost_arn (String) —

    The Amazon Resource Name (ARN) of the Outpost. If you specify this, you must also specify a value for the PreferredInstanceType.

  • :preferred_instance_type (String) —

    The instance type. If you specify this, you must also specify a value for the OutpostArn.

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

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

  • :resolver_endpoint_type (String) —

    For the endpoint type you can choose either IPv4, IPv6, or dual-stack. A dual-stack endpoint means that it will resolve via both IPv4 and IPv6. This endpoint type is applied to all IP addresses.

  • :protocols (Array<String>) —

    The protocols you want to use for the endpoint. DoH-FIPS is applicable for default inbound endpoints only.

    For a default inbound endpoint you can apply the protocols as follows:

    • Do53 and DoH in combination.

    • Do53 and DoH-FIPS in combination.

    • Do53 alone.

    • DoH alone.

    • DoH-FIPS alone.

    • None, which is treated as Do53.

    For a delegation inbound endpoint you can use Do53 only.

    For an outbound endpoint you can apply the protocols as follows:

    • Do53 and DoH in combination.

    • Do53 alone.

    • DoH alone.

    • None, which is treated as Do53.

Returns:

See Also:



1323
1324
1325
1326
 
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/client.rb', line 1323

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

#create_resolver_query_log_config(params = {}) ⇒ Types::CreateResolverQueryLogConfigResponse

Creates a Resolver query logging configuration, which defines where you want Resolver to save DNS query logs that originate in your VPCs. Resolver can log queries only for VPCs that are in the same Region as the query logging configuration.

To specify which VPCs you want to log queries for, you use AssociateResolverQueryLogConfig. For more information, see AssociateResolverQueryLogConfig.

You can optionally use Resource Access Manager (RAM) to share a query logging configuration with other Amazon Web Services accounts. The other accounts can then associate VPCs with the configuration. The query logs that Resolver creates for a configuration include all DNS queries that originate in all VPCs that are associated with the configuration.

Examples:

Request syntax with placeholder values


resp = client.create_resolver_query_log_config({
  name: "ResolverQueryLogConfigName", # required
  destination_arn: "DestinationArn", # required
  creator_request_id: "CreatorRequestId", # required
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Response structure


resp.resolver_query_log_config.id #=> String
resp.resolver_query_log_config.owner_id #=> String
resp.resolver_query_log_config.status #=> String, one of "CREATING", "CREATED", "DELETING", "FAILED"
resp.resolver_query_log_config.share_status #=> String, one of "NOT_SHARED", "SHARED_WITH_ME", "SHARED_BY_ME"
resp.resolver_query_log_config.association_count #=> Integer
resp.resolver_query_log_config.arn #=> String
resp.resolver_query_log_config.name #=> String
resp.resolver_query_log_config.destination_arn #=> String
resp.resolver_query_log_config.creator_request_id #=> String
resp.resolver_query_log_config.creation_time #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :name (required, String) —

    The name that you want to give the query logging configuration.

  • :destination_arn (required, String) —

    The ARN of the resource that you want Resolver to send query logs. You can send query logs to an S3 bucket, a CloudWatch Logs log group, or a Kinesis Data Firehose delivery stream. Examples of valid values include the following:

    • S3 bucket:

      arn:aws:s3:::amzn-s3-demo-bucket

      You can optionally append a file prefix to the end of the ARN.

      arn:aws:s3:::amzn-s3-demo-bucket/development/

    • CloudWatch Logs log group:

      arn:aws:logs:us-west-1:123456789012:log-group:/mystack-testgroup-12ABC1AB12A1:*

    • Kinesis Data Firehose delivery stream:

      arn:aws:kinesis:us-east-2:0123456789:stream/my_stream_name

  • :creator_request_id (required, String) —

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

    A suitable default value is auto-generated. You should normally not need to pass this option.**

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

    A list of the tag keys and values that you want to associate with the query logging configuration.

Returns:

See Also:



1421
1422
1423
1424
 
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/client.rb', line 1421

def create_resolver_query_log_config(params = {}, options = {})
  req = build_request(:create_resolver_query_log_config, 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, DELEGATE
  domain_name: "DomainName",
  target_ips: [
    {
      ip: "Ip",
      port: 1,
      ipv_6: "Ipv6",
      protocol: "DoH", # accepts DoH, Do53, DoH-FIPS
      server_name_indication: "ServerNameIndication",
    },
  ],
  resolver_endpoint_id: "ResourceId",
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  delegation_record: "DelegationRecord",
})

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", "DELEGATE"
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.target_ips[0].ipv_6 #=> String
resp.resolver_rule.target_ips[0].protocol #=> String, one of "DoH", "Do53", "DoH-FIPS"
resp.resolver_rule.target_ips[0].server_name_indication #=> String
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"
resp.resolver_rule.creation_time #=> String
resp.resolver_rule.modification_time #=> String
resp.resolver_rule.delegation_record #=> 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 running 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) —

    When you want to forward DNS queries for specified domain name to resolvers on your network, specify FORWARD or DELEGATE.

    When you have a forwarding rule to forward DNS queries for a domain to your network and you want Resolver to process queries for a subdomain of that domain, specify SYSTEM.

    For example, to forward DNS queries for example.com to resolvers on your network, you create a rule and specify FORWARD for RuleType. To then have Resolver process queries for apex.example.com, you create a rule and specify SYSTEM for RuleType.

    Currently, only Resolver can create rules that have a value of RECURSIVE for RuleType.

  • :domain_name (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 either Ipv4 or Ipv6 addresses but not both in the same rule. Separate IP addresses with a space.

    TargetIps is available only when the value of Rule type is FORWARD.

  • :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.

  • :delegation_record (String) —

    DNS queries with the delegation records that match this domain name are forwarded to the resolvers on your network.

Returns:

See Also:



1541
1542
1543
1544
 
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/client.rb', line 1541

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

#delete_firewall_domain_list(params = {}) ⇒ Types::DeleteFirewallDomainListResponse

Deletes the specified domain list.

Examples:

Request syntax with placeholder values


resp = client.delete_firewall_domain_list({
  firewall_domain_list_id: "ResourceId", # required
})

Response structure


resp.firewall_domain_list.id #=> String
resp.firewall_domain_list.arn #=> String
resp.firewall_domain_list.name #=> String
resp.firewall_domain_list.domain_count #=> Integer
resp.firewall_domain_list.status #=> String, one of "COMPLETE", "COMPLETE_IMPORT_FAILED", "IMPORTING", "DELETING", "UPDATING"
resp.firewall_domain_list.status_message #=> String
resp.firewall_domain_list.managed_owner_name #=> String
resp.firewall_domain_list.creator_request_id #=> String
resp.firewall_domain_list.creation_time #=> String
resp.firewall_domain_list.modification_time #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :firewall_domain_list_id (required, String) —

    The ID of the domain list that you want to delete.

Returns:

See Also:



1578
1579
1580
1581
 
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/client.rb', line 1578

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

#delete_firewall_rule(params = {}) ⇒ Types::DeleteFirewallRuleResponse

Deletes the specified firewall rule.

Examples:

Request syntax with placeholder values


resp = client.delete_firewall_rule({
  firewall_rule_group_id: "ResourceId", # required
  firewall_domain_list_id: "ResourceId",
  firewall_threat_protection_id: "ResourceId",
  qtype: "Qtype",
})

Response structure


resp.firewall_rule.firewall_rule_group_id #=> String
resp.firewall_rule.firewall_domain_list_id #=> String
resp.firewall_rule.firewall_threat_protection_id #=> String
resp.firewall_rule.name #=> String
resp.firewall_rule.priority #=> Integer
resp.firewall_rule.action #=> String, one of "ALLOW", "BLOCK", "ALERT"
resp.firewall_rule.block_response #=> String, one of "NODATA", "NXDOMAIN", "OVERRIDE"
resp.firewall_rule.block_override_domain #=> String
resp.firewall_rule.block_override_dns_type #=> String, one of "CNAME"
resp.firewall_rule.block_override_ttl #=> Integer
resp.firewall_rule.creator_request_id #=> String
resp.firewall_rule.creation_time #=> String
resp.firewall_rule.modification_time #=> String
resp.firewall_rule.firewall_domain_redirection_action #=> String, one of "INSPECT_REDIRECTION_DOMAIN", "TRUST_REDIRECTION_DOMAIN"
resp.firewall_rule.qtype #=> String
resp.firewall_rule.dns_threat_protection #=> String, one of "DGA", "DNS_TUNNELING"
resp.firewall_rule.confidence_threshold #=> String, one of "LOW", "MEDIUM", "HIGH"

Parameters:

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

    ({})

Options Hash (params):

  • :firewall_rule_group_id (required, String) —

    The unique identifier of the firewall rule group that you want to delete the rule from.

  • :firewall_domain_list_id (String) —

    The ID of the domain list that's used in the rule.

  • :firewall_threat_protection_id (String) —

    The ID that is created for a DNS Firewall Advanced rule.

  • :qtype (String) —

    The DNS query type that the rule you are deleting evaluates. Allowed values are;

    • A: Returns an IPv4 address.

    • AAAA: Returns an Ipv6 address.

    • CAA: Restricts CAs that can create SSL/TLS certifications for the domain.

    • CNAME: Returns another domain name.

    • DS: Record that identifies the DNSSEC signing key of a delegated zone.

    • MX: Specifies mail servers.

    • NAPTR: Regular-expression-based rewriting of domain names.

    • NS: Authoritative name servers.

    • PTR: Maps an IP address to a domain name.

    • SOA: Start of authority record for the zone.

    • SPF: Lists the servers authorized to send emails from a domain.

    • SRV: Application specific values that identify servers.

    • TXT: Verifies email senders and application-specific values.

    • A query type you define by using the DNS type ID, for example 28 for AAAA. The values must be defined as TYPENUMBER, where the NUMBER can be 1-65334, for example, TYPE28. For more information, see List of DNS record types.

Returns:

See Also:



1673
1674
1675
1676
 
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/client.rb', line 1673

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

#delete_firewall_rule_group(params = {}) ⇒ Types::DeleteFirewallRuleGroupResponse

Deletes the specified firewall rule group.

Examples:

Request syntax with placeholder values


resp = client.delete_firewall_rule_group({
  firewall_rule_group_id: "ResourceId", # required
})

Response structure


resp.firewall_rule_group.id #=> String
resp.firewall_rule_group.arn #=> String
resp.firewall_rule_group.name #=> String
resp.firewall_rule_group.rule_count #=> Integer
resp.firewall_rule_group.status #=> String, one of "COMPLETE", "DELETING", "UPDATING"
resp.firewall_rule_group.status_message #=> String
resp.firewall_rule_group.owner_id #=> String
resp.firewall_rule_group.creator_request_id #=> String
resp.firewall_rule_group.share_status #=> String, one of "NOT_SHARED", "SHARED_WITH_ME", "SHARED_BY_ME"
resp.firewall_rule_group.creation_time #=> String
resp.firewall_rule_group.modification_time #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :firewall_rule_group_id (required, String) —

    The unique identifier of the firewall rule group that you want to delete.

Returns:

See Also:



1712
1713
1714
1715
 
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/client.rb', line 1712

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

#delete_outpost_resolver(params = {}) ⇒ Types::DeleteOutpostResolverResponse

Deletes a Resolver on the Outpost.

Examples:

Request syntax with placeholder values


resp = client.delete_outpost_resolver({
  id: "ResourceId", # required
})

Response structure


resp.outpost_resolver.arn #=> String
resp.outpost_resolver.creation_time #=> String
resp.outpost_resolver.modification_time #=> String
resp.outpost_resolver.creator_request_id #=> String
resp.outpost_resolver.id #=> String
resp.outpost_resolver.instance_count #=> Integer
resp.outpost_resolver.preferred_instance_type #=> String
resp.outpost_resolver.name #=> String
resp.outpost_resolver.status #=> String, one of "CREATING", "OPERATIONAL", "UPDATING", "DELETING", "ACTION_NEEDED", "FAILED_CREATION", "FAILED_DELETION"
resp.outpost_resolver.status_message #=> String
resp.outpost_resolver.outpost_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String) —

    A unique string that identifies the Resolver on the Outpost.

Returns:

See Also:



1750
1751
1752
1753
 
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/client.rb', line 1750

def delete_outpost_resolver(params = {}, options = {})
  req = build_request(:delete_outpost_resolver, 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 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.

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", "INBOUND_DELEGATION"
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
resp.resolver_endpoint.outpost_arn #=> String
resp.resolver_endpoint.preferred_instance_type #=> String
resp.resolver_endpoint.resolver_endpoint_type #=> String, one of "IPV6", "IPV4", "DUALSTACK"
resp.resolver_endpoint.protocols #=> Array
resp.resolver_endpoint.protocols[0] #=> String, one of "DoH", "Do53", "DoH-FIPS"

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:



1803
1804
1805
1806
 
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/client.rb', line 1803

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

#delete_resolver_query_log_config(params = {}) ⇒ Types::DeleteResolverQueryLogConfigResponse

Deletes a query logging configuration. When you delete a configuration, Resolver stops logging DNS queries for all of the Amazon VPCs that are associated with the configuration. This also applies if the query logging configuration is shared with other Amazon Web Services accounts, and the other accounts have associated VPCs with the shared configuration.

Before you can delete a query logging configuration, you must first disassociate all VPCs from the configuration. See DisassociateResolverQueryLogConfig.

If you used Resource Access Manager (RAM) to share a query logging configuration with other accounts, you must stop sharing the configuration before you can delete a configuration. The accounts that you shared the configuration with can first disassociate VPCs that they associated with the configuration, but that's not necessary. If you stop sharing the configuration, those VPCs are automatically disassociated from the configuration.

Examples:

Request syntax with placeholder values


resp = client.delete_resolver_query_log_config({
  resolver_query_log_config_id: "ResourceId", # required
})

Response structure


resp.resolver_query_log_config.id #=> String
resp.resolver_query_log_config.owner_id #=> String
resp.resolver_query_log_config.status #=> String, one of "CREATING", "CREATED", "DELETING", "FAILED"
resp.resolver_query_log_config.share_status #=> String, one of "NOT_SHARED", "SHARED_WITH_ME", "SHARED_BY_ME"
resp.resolver_query_log_config.association_count #=> Integer
resp.resolver_query_log_config.arn #=> String
resp.resolver_query_log_config.name #=> String
resp.resolver_query_log_config.destination_arn #=> String
resp.resolver_query_log_config.creator_request_id #=> String
resp.resolver_query_log_config.creation_time #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :resolver_query_log_config_id (required, String) —

    The ID of the query logging configuration that you want to delete.

Returns:

See Also:



1861
1862
1863
1864
 
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/client.rb', line 1861

def delete_resolver_query_log_config(params = {}, options = {})
  req = build_request(:delete_resolver_query_log_config, 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 information, 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", "DELEGATE"
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.target_ips[0].ipv_6 #=> String
resp.resolver_rule.target_ips[0].protocol #=> String, one of "DoH", "Do53", "DoH-FIPS"
resp.resolver_rule.target_ips[0].server_name_indication #=> String
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"
resp.resolver_rule.creation_time #=> String
resp.resolver_rule.modification_time #=> String
resp.resolver_rule.delegation_record #=> String

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:



1915
1916
1917
1918
 
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/client.rb', line 1915

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

#disassociate_firewall_rule_group(params = {}) ⇒ Types::DisassociateFirewallRuleGroupResponse

Disassociates a FirewallRuleGroup from a VPC, to remove DNS filtering from the VPC.

Examples:

Request syntax with placeholder values


resp = client.disassociate_firewall_rule_group({
  firewall_rule_group_association_id: "ResourceId", # required
})

Response structure


resp.firewall_rule_group_association.id #=> String
resp.firewall_rule_group_association.arn #=> String
resp.firewall_rule_group_association.firewall_rule_group_id #=> String
resp.firewall_rule_group_association.vpc_id #=> String
resp.firewall_rule_group_association.name #=> String
resp.firewall_rule_group_association.priority #=> Integer
resp.firewall_rule_group_association.mutation_protection #=> String, one of "ENABLED", "DISABLED"
resp.firewall_rule_group_association.managed_owner_name #=> String
resp.firewall_rule_group_association.status #=> String, one of "COMPLETE", "DELETING", "UPDATING"
resp.firewall_rule_group_association.status_message #=> String
resp.firewall_rule_group_association.creator_request_id #=> String
resp.firewall_rule_group_association.creation_time #=> String
resp.firewall_rule_group_association.modification_time #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :firewall_rule_group_association_id (required, String) —

    The identifier of the FirewallRuleGroupAssociation.

Returns:

See Also:



1956
1957
1958
1959
 
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/client.rb', line 1956

def disassociate_firewall_rule_group(params = {}, options = {})
  req = build_request(:disassociate_firewall_rule_group, 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",
    ipv_6: "Ipv6",
  },
})

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", "INBOUND_DELEGATION"
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
resp.resolver_endpoint.outpost_arn #=> String
resp.resolver_endpoint.preferred_instance_type #=> String
resp.resolver_endpoint.resolver_endpoint_type #=> String, one of "IPV6", "IPV4", "DUALSTACK"
resp.resolver_endpoint.protocols #=> Array
resp.resolver_endpoint.protocols[0] #=> String, one of "DoH", "Do53", "DoH-FIPS"

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:



2020
2021
2022
2023
 
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/client.rb', line 2020

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

#disassociate_resolver_query_log_config(params = {}) ⇒ Types::DisassociateResolverQueryLogConfigResponse

Disassociates a VPC from a query logging configuration.

Before you can delete a query logging configuration, you must first disassociate all VPCs from the configuration. If you used Resource Access Manager (RAM) to share a query logging configuration with other accounts, VPCs can be disassociated from the configuration in the following ways:

  • The accounts that you shared the configuration with can disassociate VPCs from the configuration.

  • You can stop sharing the configuration.

Examples:

Request syntax with placeholder values


resp = client.disassociate_resolver_query_log_config({
  resolver_query_log_config_id: "ResourceId", # required
  resource_id: "ResourceId", # required
})

Response structure


resp.resolver_query_log_config_association.id #=> String
resp.resolver_query_log_config_association.resolver_query_log_config_id #=> String
resp.resolver_query_log_config_association.resource_id #=> String
resp.resolver_query_log_config_association.status #=> String, one of "CREATING", "ACTIVE", "ACTION_NEEDED", "DELETING", "FAILED"
resp.resolver_query_log_config_association.error #=> String, one of "NONE", "DESTINATION_NOT_FOUND", "ACCESS_DENIED", "INTERNAL_SERVICE_ERROR"
resp.resolver_query_log_config_association.error_message #=> String
resp.resolver_query_log_config_association.creation_time #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :resolver_query_log_config_id (required, String) —

    The ID of the query logging configuration that you want to disassociate a specified VPC from.

  • :resource_id (required, String) —

    The ID of the Amazon VPC that you want to disassociate from a specified query logging configuration.

Returns:

See Also:



2073
2074
2075
2076
 
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/client.rb', line 2073

def disassociate_resolver_query_log_config(params = {}, options = {})
  req = build_request(:disassociate_resolver_query_log_config, 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:



2117
2118
2119
2120
 
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/client.rb', line 2117

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

#get_firewall_config(params = {}) ⇒ Types::GetFirewallConfigResponse

Retrieves the configuration of the firewall behavior provided by DNS Firewall for a single VPC from Amazon Virtual Private Cloud (Amazon VPC).

Examples:

Request syntax with placeholder values


resp = client.get_firewall_config({
  resource_id: "ResourceId", # required
})

Response structure


resp.firewall_config.id #=> String
resp.firewall_config.resource_id #=> String
resp.firewall_config.owner_id #=> String
resp.firewall_config.firewall_fail_open #=> String, one of "ENABLED", "DISABLED", "USE_LOCAL_RESOURCE_SETTING"

Parameters:

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

    ({})

Options Hash (params):

  • :resource_id (required, String) —

    The ID of the VPC from Amazon VPC that the configuration is for.

Returns:

See Also:



2150
2151
2152
2153
 
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/client.rb', line 2150

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

#get_firewall_domain_list(params = {}) ⇒ Types::GetFirewallDomainListResponse

Retrieves the specified firewall domain list.

Examples:

Request syntax with placeholder values


resp = client.get_firewall_domain_list({
  firewall_domain_list_id: "ResourceId", # required
})

Response structure


resp.firewall_domain_list.id #=> String
resp.firewall_domain_list.arn #=> String
resp.firewall_domain_list.name #=> String
resp.firewall_domain_list.domain_count #=> Integer
resp.firewall_domain_list.status #=> String, one of "COMPLETE", "COMPLETE_IMPORT_FAILED", "IMPORTING", "DELETING", "UPDATING"
resp.firewall_domain_list.status_message #=> String
resp.firewall_domain_list.managed_owner_name #=> String
resp.firewall_domain_list.creator_request_id #=> String
resp.firewall_domain_list.creation_time #=> String
resp.firewall_domain_list.modification_time #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :firewall_domain_list_id (required, String) —

    The ID of the domain list.

Returns:

See Also:



2187
2188
2189
2190
 
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/client.rb', line 2187

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

#get_firewall_rule_group(params = {}) ⇒ Types::GetFirewallRuleGroupResponse

Retrieves the specified firewall rule group.

Examples:

Request syntax with placeholder values


resp = client.get_firewall_rule_group({
  firewall_rule_group_id: "ResourceId", # required
})

Response structure


resp.firewall_rule_group.id #=> String
resp.firewall_rule_group.arn #=> String
resp.firewall_rule_group.name #=> String
resp.firewall_rule_group.rule_count #=> Integer
resp.firewall_rule_group.status #=> String, one of "COMPLETE", "DELETING", "UPDATING"
resp.firewall_rule_group.status_message #=> String
resp.firewall_rule_group.owner_id #=> String
resp.firewall_rule_group.creator_request_id #=> String
resp.firewall_rule_group.share_status #=> String, one of "NOT_SHARED", "SHARED_WITH_ME", "SHARED_BY_ME"
resp.firewall_rule_group.creation_time #=> String
resp.firewall_rule_group.modification_time #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :firewall_rule_group_id (required, String) —

    The unique identifier of the firewall rule group.

Returns:

See Also:



2225
2226
2227
2228
 
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/client.rb', line 2225

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

#get_firewall_rule_group_association(params = {}) ⇒ Types::GetFirewallRuleGroupAssociationResponse

Retrieves a firewall rule group association, which enables DNS filtering for a VPC with one rule group. A VPC can have more than one firewall rule group association, and a rule group can be associated with more than one VPC.

Examples:

Request syntax with placeholder values


resp = client.get_firewall_rule_group_association({
  firewall_rule_group_association_id: "ResourceId", # required
})

Response structure


resp.firewall_rule_group_association.id #=> String
resp.firewall_rule_group_association.arn #=> String
resp.firewall_rule_group_association.firewall_rule_group_id #=> String
resp.firewall_rule_group_association.vpc_id #=> String
resp.firewall_rule_group_association.name #=> String
resp.firewall_rule_group_association.priority #=> Integer
resp.firewall_rule_group_association.mutation_protection #=> String, one of "ENABLED", "DISABLED"
resp.firewall_rule_group_association.managed_owner_name #=> String
resp.firewall_rule_group_association.status #=> String, one of "COMPLETE", "DELETING", "UPDATING"
resp.firewall_rule_group_association.status_message #=> String
resp.firewall_rule_group_association.creator_request_id #=> String
resp.firewall_rule_group_association.creation_time #=> String
resp.firewall_rule_group_association.modification_time #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :firewall_rule_group_association_id (required, String) —

    The identifier of the FirewallRuleGroupAssociation.

Returns:

See Also:



2268
2269
2270
2271
 
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/client.rb', line 2268

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

#get_firewall_rule_group_policy(params = {}) ⇒ Types::GetFirewallRuleGroupPolicyResponse

Returns the Identity and Access Management (Amazon Web Services IAM) policy for sharing the specified rule group. You can use the policy to share the rule group using Resource Access Manager (RAM).

Examples:

Request syntax with placeholder values


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

Response structure


resp.firewall_rule_group_policy #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :arn (required, String) —

    The ARN (Amazon Resource Name) for the rule group.

Returns:

See Also:



2298
2299
2300
2301
 
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/client.rb', line 2298

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

#get_outpost_resolver(params = {}) ⇒ Types::GetOutpostResolverResponse

Gets information about a specified Resolver on the Outpost, such as its instance count and type, name, and the current status of the Resolver.

Examples:

Request syntax with placeholder values


resp = client.get_outpost_resolver({
  id: "ResourceId", # required
})

Response structure


resp.outpost_resolver.arn #=> String
resp.outpost_resolver.creation_time #=> String
resp.outpost_resolver.modification_time #=> String
resp.outpost_resolver.creator_request_id #=> String
resp.outpost_resolver.id #=> String
resp.outpost_resolver.instance_count #=> Integer
resp.outpost_resolver.preferred_instance_type #=> String
resp.outpost_resolver.name #=> String
resp.outpost_resolver.status #=> String, one of "CREATING", "OPERATIONAL", "UPDATING", "DELETING", "ACTION_NEEDED", "FAILED_CREATION", "FAILED_DELETION"
resp.outpost_resolver.status_message #=> String
resp.outpost_resolver.outpost_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String) —

    The ID of the Resolver on the Outpost.

Returns:

See Also:



2338
2339
2340
2341
 
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/client.rb', line 2338

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

#get_resolver_config(params = {}) ⇒ Types::GetResolverConfigResponse

Retrieves the behavior configuration of Route 53 Resolver behavior for a single VPC from Amazon Virtual Private Cloud.

Examples:

Request syntax with placeholder values


resp = client.get_resolver_config({
  resource_id: "ResourceId", # required
})

Response structure


resp.resolver_config.id #=> String
resp.resolver_config.resource_id #=> String
resp.resolver_config.owner_id #=> String
resp.resolver_config.autodefined_reverse #=> String, one of "ENABLING", "ENABLED", "DISABLING", "DISABLED", "UPDATING_TO_USE_LOCAL_RESOURCE_SETTING", "USE_LOCAL_RESOURCE_SETTING"

Parameters:

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

    ({})

Options Hash (params):

  • :resource_id (required, String) —

    Resource ID of the Amazon VPC that you want to get information about.

Returns:

See Also:



2370
2371
2372
2373
 
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/client.rb', line 2370

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

#get_resolver_dnssec_config(params = {}) ⇒ Types::GetResolverDnssecConfigResponse

Gets DNSSEC validation information for a specified resource.

Examples:

Request syntax with placeholder values


resp = client.get_resolver_dnssec_config({
  resource_id: "ResourceId", # required
})

Response structure


resp.resolver_dnssec_config.id #=> String
resp.resolver_dnssec_config.owner_id #=> String
resp.resolver_dnssec_config.resource_id #=> String
resp.resolver_dnssec_config.validation_status #=> String, one of "ENABLING", "ENABLED", "DISABLING", "DISABLED", "UPDATING_TO_USE_LOCAL_RESOURCE_SETTING", "USE_LOCAL_RESOURCE_SETTING"

Parameters:

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

    ({})

Options Hash (params):

  • :resource_id (required, String) —

    The ID of the virtual private cloud (VPC) for the DNSSEC validation status.

Returns:

See Also:



2402
2403
2404
2405
 
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/client.rb', line 2402

def get_resolver_dnssec_config(params = {}, options = {})
  req = build_request(:get_resolver_dnssec_config, 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", "INBOUND_DELEGATION"
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
resp.resolver_endpoint.outpost_arn #=> String
resp.resolver_endpoint.preferred_instance_type #=> String
resp.resolver_endpoint.resolver_endpoint_type #=> String, one of "IPV6", "IPV4", "DUALSTACK"
resp.resolver_endpoint.protocols #=> Array
resp.resolver_endpoint.protocols[0] #=> String, one of "DoH", "Do53", "DoH-FIPS"

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:



2450
2451
2452
2453
 
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/client.rb', line 2450

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

#get_resolver_query_log_config(params = {}) ⇒ Types::GetResolverQueryLogConfigResponse

Gets information about a specified Resolver query logging configuration, such as the number of VPCs that the configuration is logging queries for and the location that logs are sent to.

Examples:

Request syntax with placeholder values


resp = client.get_resolver_query_log_config({
  resolver_query_log_config_id: "ResourceId", # required
})

Response structure


resp.resolver_query_log_config.id #=> String
resp.resolver_query_log_config.owner_id #=> String
resp.resolver_query_log_config.status #=> String, one of "CREATING", "CREATED", "DELETING", "FAILED"
resp.resolver_query_log_config.share_status #=> String, one of "NOT_SHARED", "SHARED_WITH_ME", "SHARED_BY_ME"
resp.resolver_query_log_config.association_count #=> Integer
resp.resolver_query_log_config.arn #=> String
resp.resolver_query_log_config.name #=> String
resp.resolver_query_log_config.destination_arn #=> String
resp.resolver_query_log_config.creator_request_id #=> String
resp.resolver_query_log_config.creation_time #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :resolver_query_log_config_id (required, String) —

    The ID of the Resolver query logging configuration that you want to get information about.

Returns:

See Also:



2490
2491
2492
2493
 
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/client.rb', line 2490

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

#get_resolver_query_log_config_association(params = {}) ⇒ Types::GetResolverQueryLogConfigAssociationResponse

Gets information about a specified association between a Resolver query logging configuration and an Amazon VPC. When you associate a VPC with a query logging configuration, Resolver logs DNS queries that originate in that VPC.

Examples:

Request syntax with placeholder values


resp = client.get_resolver_query_log_config_association({
  resolver_query_log_config_association_id: "ResourceId", # required
})

Response structure


resp.resolver_query_log_config_association.id #=> String
resp.resolver_query_log_config_association.resolver_query_log_config_id #=> String
resp.resolver_query_log_config_association.resource_id #=> String
resp.resolver_query_log_config_association.status #=> String, one of "CREATING", "ACTIVE", "ACTION_NEEDED", "DELETING", "FAILED"
resp.resolver_query_log_config_association.error #=> String, one of "NONE", "DESTINATION_NOT_FOUND", "ACCESS_DENIED", "INTERNAL_SERVICE_ERROR"
resp.resolver_query_log_config_association.error_message #=> String
resp.resolver_query_log_config_association.creation_time #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :resolver_query_log_config_association_id (required, String) —

    The ID of the Resolver query logging configuration association that you want to get information about.

Returns:

See Also:



2528
2529
2530
2531
 
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/client.rb', line 2528

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

#get_resolver_query_log_config_policy(params = {}) ⇒ Types::GetResolverQueryLogConfigPolicyResponse

Gets information about a query logging policy. A query logging policy specifies the Resolver query logging operations and resources that you want to allow another Amazon Web Services account to be able to use.

Examples:

Request syntax with placeholder values


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

Response structure


resp.resolver_query_log_config_policy #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :arn (required, String) —

    The ARN of the query logging configuration that you want to get the query logging policy for.

Returns:

See Also:



2559
2560
2561
2562
 
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/client.rb', line 2559

def get_resolver_query_log_config_policy(params = {}, options = {})
  req = build_request(:get_resolver_query_log_config_policy, 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", "DELEGATE"
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.target_ips[0].ipv_6 #=> String
resp.resolver_rule.target_ips[0].protocol #=> String, one of "DoH", "Do53", "DoH-FIPS"
resp.resolver_rule.target_ips[0].server_name_indication #=> String
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"
resp.resolver_rule.creation_time #=> String
resp.resolver_rule.modification_time #=> String
resp.resolver_rule.delegation_record #=> String

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:



2608
2609
2610
2611
 
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/client.rb', line 2608

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:



2648
2649
2650
2651
 
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/client.rb', line 2648

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 the Resolver rule policy for a specified rule. A Resolver rule policy includes the rule that you want to share with another account, the account that you want to share the rule with, and the Resolver operations that you want to allow the account 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 that you want to get the Resolver rule policy for.

Returns:

See Also:



2680
2681
2682
2683
 
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/client.rb', line 2680

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

#import_firewall_domains(params = {}) ⇒ Types::ImportFirewallDomainsResponse

Imports domain names from a file into a domain list, for use in a DNS firewall rule group.

Each domain specification in your domain list must satisfy the following requirements:

  • It can optionally start with * (asterisk).

  • With the exception of the optional starting asterisk, it must only contain the following characters: A-Z, a-z, 0-9, - (hyphen).

  • It must be from 1-255 characters in length.

Examples:

Request syntax with placeholder values


resp = client.import_firewall_domains({
  firewall_domain_list_id: "ResourceId", # required
  operation: "REPLACE", # required, accepts REPLACE
  domain_file_url: "DomainListFileUrl", # required
})

Response structure


resp.id #=> String
resp.name #=> String
resp.status #=> String, one of "COMPLETE", "COMPLETE_IMPORT_FAILED", "IMPORTING", "DELETING", "UPDATING"
resp.status_message #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :firewall_domain_list_id (required, String) —

    The ID of the domain list that you want to modify with the import operation.

  • :operation (required, String) —

    What you want DNS Firewall to do with the domains that are listed in the file. This must be set to REPLACE, which updates the domain list to exactly match the list in the file.

  • :domain_file_url (required, String) —

    The fully qualified URL or URI of the file stored in Amazon Simple Storage Service (Amazon S3) that contains the list of domains to import.

    The file must be in an S3 bucket that's in the same Region as your DNS Firewall. The file must be a text file and must contain a single domain per line.

Returns:

See Also:



2742
2743
2744
2745
 
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/client.rb', line 2742

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

#list_firewall_configs(params = {}) ⇒ Types::ListFirewallConfigsResponse

Retrieves the firewall configurations that you have defined. DNS Firewall uses the configurations to manage firewall behavior for your VPCs.

A single call might return only a partial list of the configurations. For information, see MaxResults.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_firewall_configs({
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.next_token #=> String
resp.firewall_configs #=> Array
resp.firewall_configs[0].id #=> String
resp.firewall_configs[0].resource_id #=> String
resp.firewall_configs[0].owner_id #=> String
resp.firewall_configs[0].firewall_fail_open #=> String, one of "ENABLED", "DISABLED", "USE_LOCAL_RESOURCE_SETTING"

Parameters:

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

    ({})

Options Hash (params):

  • :max_results (Integer) —

    The maximum number of objects that you want Resolver to return for this request. If more objects are available, in the response, Resolver provides a NextToken value that you can use in a subsequent call to get the next batch of objects.

    If you don't specify a value for MaxResults, Resolver returns up to 100 objects.

  • :next_token (String) —

    For the first call to this list request, omit this value.

    When you request a list of objects, Resolver returns at most the number of objects specified in MaxResults. If more objects are available for retrieval, Resolver returns a NextToken value in the response. To retrieve the next batch of objects, use the token that was returned for the prior request in your next request.

Returns:

See Also:



2799
2800
2801
2802
 
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/client.rb', line 2799

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

#list_firewall_domain_lists(params = {}) ⇒ Types::ListFirewallDomainListsResponse

Retrieves the firewall domain lists that you have defined. For each firewall domain list, you can retrieve the domains that are defined for a list by calling ListFirewallDomains.

A single call to this list operation might return only a partial list of the domain lists. For information, see MaxResults.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_firewall_domain_lists({
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.next_token #=> String
resp.firewall_domain_lists #=> Array
resp.firewall_domain_lists[0].id #=> String
resp.firewall_domain_lists[0].arn #=> String
resp.firewall_domain_lists[0].name #=> String
resp.firewall_domain_lists[0].creator_request_id #=> String
resp.firewall_domain_lists[0].managed_owner_name #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :max_results (Integer) —

    The maximum number of objects that you want Resolver to return for this request. If more objects are available, in the response, Resolver provides a NextToken value that you can use in a subsequent call to get the next batch of objects.

    If you don't specify a value for MaxResults, Resolver returns up to 100 objects.

  • :next_token (String) —

    For the first call to this list request, omit this value.

    When you request a list of objects, Resolver returns at most the number of objects specified in MaxResults. If more objects are available for retrieval, Resolver returns a NextToken value in the response. To retrieve the next batch of objects, use the token that was returned for the prior request in your next request.

Returns:

See Also:



2857
2858
2859
2860
 
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/client.rb', line 2857

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

#list_firewall_domains(params = {}) ⇒ Types::ListFirewallDomainsResponse

Retrieves the domains that you have defined for the specified firewall domain list.

A single call might return only a partial list of the domains. For information, see MaxResults.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


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

Response structure


resp.next_token #=> String
resp.domains #=> Array
resp.domains[0] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :firewall_domain_list_id (required, String) —

    The ID of the domain list whose domains you want to retrieve.

  • :max_results (Integer) —

    The maximum number of objects that you want Resolver to return for this request. If more objects are available, in the response, Resolver provides a NextToken value that you can use in a subsequent call to get the next batch of objects.

    If you don't specify a value for MaxResults, Resolver returns up to 100 objects.

  • :next_token (String) —

    For the first call to this list request, omit this value.

    When you request a list of objects, Resolver returns at most the number of objects specified in MaxResults. If more objects are available for retrieval, Resolver returns a NextToken value in the response. To retrieve the next batch of objects, use the token that was returned for the prior request in your next request.

Returns:

See Also:



2914
2915
2916
2917
 
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/client.rb', line 2914

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

#list_firewall_rule_group_associations(params = {}) ⇒ Types::ListFirewallRuleGroupAssociationsResponse

Retrieves the firewall rule group associations that you have defined. Each association enables DNS filtering for a VPC with one rule group.

A single call might return only a partial list of the associations. For information, see MaxResults.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_firewall_rule_group_associations({
  firewall_rule_group_id: "ResourceId",
  vpc_id: "ResourceId",
  priority: 1,
  status: "COMPLETE", # accepts COMPLETE, DELETING, UPDATING
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.next_token #=> String
resp.firewall_rule_group_associations #=> Array
resp.firewall_rule_group_associations[0].id #=> String
resp.firewall_rule_group_associations[0].arn #=> String
resp.firewall_rule_group_associations[0].firewall_rule_group_id #=> String
resp.firewall_rule_group_associations[0].vpc_id #=> String
resp.firewall_rule_group_associations[0].name #=> String
resp.firewall_rule_group_associations[0].priority #=> Integer
resp.firewall_rule_group_associations[0].mutation_protection #=> String, one of "ENABLED", "DISABLED"
resp.firewall_rule_group_associations[0].managed_owner_name #=> String
resp.firewall_rule_group_associations[0].status #=> String, one of "COMPLETE", "DELETING", "UPDATING"
resp.firewall_rule_group_associations[0].status_message #=> String
resp.firewall_rule_group_associations[0].creator_request_id #=> String
resp.firewall_rule_group_associations[0].creation_time #=> String
resp.firewall_rule_group_associations[0].modification_time #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :firewall_rule_group_id (String) —

    The unique identifier of the firewall rule group that you want to retrieve the associations for. Leave this blank to retrieve associations for any rule group.

  • :vpc_id (String) —

    The unique identifier of the VPC that you want to retrieve the associations for. Leave this blank to retrieve associations for any VPC.

  • :priority (Integer) —

    The setting that determines the processing order of the rule group among the rule groups that are associated with a single VPC. DNS Firewall filters VPC traffic starting from the rule group with the lowest numeric priority setting.

  • :status (String) —

    The association Status setting that you want DNS Firewall to filter on for the list. If you don't specify this, then DNS Firewall returns all associations, regardless of status.

  • :max_results (Integer) —

    The maximum number of objects that you want Resolver to return for this request. If more objects are available, in the response, Resolver provides a NextToken value that you can use in a subsequent call to get the next batch of objects.

    If you don't specify a value for MaxResults, Resolver returns up to 100 objects.

  • :next_token (String) —

    For the first call to this list request, omit this value.

    When you request a list of objects, Resolver returns at most the number of objects specified in MaxResults. If more objects are available for retrieval, Resolver returns a NextToken value in the response. To retrieve the next batch of objects, use the token that was returned for the prior request in your next request.

Returns:

See Also:



3004
3005
3006
3007
 
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/client.rb', line 3004

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

#list_firewall_rule_groups(params = {}) ⇒ Types::ListFirewallRuleGroupsResponse

Retrieves the minimal high-level information for the rule groups that you have defined.

A single call might return only a partial list of the rule groups. For information, see MaxResults.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_firewall_rule_groups({
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.next_token #=> String
resp.firewall_rule_groups #=> Array
resp.firewall_rule_groups[0].id #=> String
resp.firewall_rule_groups[0].arn #=> String
resp.firewall_rule_groups[0].name #=> String
resp.firewall_rule_groups[0].owner_id #=> String
resp.firewall_rule_groups[0].creator_request_id #=> String
resp.firewall_rule_groups[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 objects that you want Resolver to return for this request. If more objects are available, in the response, Resolver provides a NextToken value that you can use in a subsequent call to get the next batch of objects.

    If you don't specify a value for MaxResults, Resolver returns up to 100 objects.

  • :next_token (String) —

    For the first call to this list request, omit this value.

    When you request a list of objects, Resolver returns at most the number of objects specified in MaxResults. If more objects are available for retrieval, Resolver returns a NextToken value in the response. To retrieve the next batch of objects, use the token that was returned for the prior request in your next request.

Returns:

See Also:



3062
3063
3064
3065
 
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/client.rb', line 3062

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

#list_firewall_rules(params = {}) ⇒ Types::ListFirewallRulesResponse

Retrieves the firewall rules that you have defined for the specified firewall rule group. DNS Firewall uses the rules in a rule group to filter DNS network traffic for a VPC.

A single call might return only a partial list of the rules. For information, see MaxResults.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_firewall_rules({
  firewall_rule_group_id: "ResourceId", # required
  priority: 1,
  action: "ALLOW", # accepts ALLOW, BLOCK, ALERT
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.next_token #=> String
resp.firewall_rules #=> Array
resp.firewall_rules[0].firewall_rule_group_id #=> String
resp.firewall_rules[0].firewall_domain_list_id #=> String
resp.firewall_rules[0].firewall_threat_protection_id #=> String
resp.firewall_rules[0].name #=> String
resp.firewall_rules[0].priority #=> Integer
resp.firewall_rules[0].action #=> String, one of "ALLOW", "BLOCK", "ALERT"
resp.firewall_rules[0].block_response #=> String, one of "NODATA", "NXDOMAIN", "OVERRIDE"
resp.firewall_rules[0].block_override_domain #=> String
resp.firewall_rules[0].block_override_dns_type #=> String, one of "CNAME"
resp.firewall_rules[0].block_override_ttl #=> Integer
resp.firewall_rules[0].creator_request_id #=> String
resp.firewall_rules[0].creation_time #=> String
resp.firewall_rules[0].modification_time #=> String
resp.firewall_rules[0].firewall_domain_redirection_action #=> String, one of "INSPECT_REDIRECTION_DOMAIN", "TRUST_REDIRECTION_DOMAIN"
resp.firewall_rules[0].qtype #=> String
resp.firewall_rules[0].dns_threat_protection #=> String, one of "DGA", "DNS_TUNNELING"
resp.firewall_rules[0].confidence_threshold #=> String, one of "LOW", "MEDIUM", "HIGH"

Parameters:

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

    ({})

Options Hash (params):

  • :firewall_rule_group_id (required, String) —

    The unique identifier of the firewall rule group that you want to retrieve the rules for.

  • :priority (Integer) —

    Optional additional filter for the rules to retrieve.

    The setting that determines the processing order of the rules in a rule group. DNS Firewall processes the rules in a rule group by order of priority, starting from the lowest setting.

  • :action (String) —

    Optional additional filter for the rules to retrieve.

    The action that DNS Firewall should take on a DNS query when it matches one of the domains in the rule's domain list, or a threat in a DNS Firewall Advanced rule:

    • ALLOW - Permit the request to go through. Not availabe for DNS Firewall Advanced rules.

    • ALERT - Permit the request to go through but send an alert to the logs.

    • BLOCK - Disallow the request. If this is specified, additional handling details are provided in the rule's BlockResponse setting.

  • :max_results (Integer) —

    The maximum number of objects that you want Resolver to return for this request. If more objects are available, in the response, Resolver provides a NextToken value that you can use in a subsequent call to get the next batch of objects.

    If you don't specify a value for MaxResults, Resolver returns up to 100 objects.

  • :next_token (String) —

    For the first call to this list request, omit this value.

    When you request a list of objects, Resolver returns at most the number of objects specified in MaxResults. If more objects are available for retrieval, Resolver returns a NextToken value in the response. To retrieve the next batch of objects, use the token that was returned for the prior request in your next request.

Returns:

See Also:



3163
3164
3165
3166
 
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/client.rb', line 3163

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

#list_outpost_resolvers(params = {}) ⇒ Types::ListOutpostResolversResponse

Lists all the Resolvers on Outposts that were created using the current Amazon Web Services account.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_outpost_resolvers({
  outpost_arn: "OutpostArn",
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.outpost_resolvers #=> Array
resp.outpost_resolvers[0].arn #=> String
resp.outpost_resolvers[0].creation_time #=> String
resp.outpost_resolvers[0].modification_time #=> String
resp.outpost_resolvers[0].creator_request_id #=> String
resp.outpost_resolvers[0].id #=> String
resp.outpost_resolvers[0].instance_count #=> Integer
resp.outpost_resolvers[0].preferred_instance_type #=> String
resp.outpost_resolvers[0].name #=> String
resp.outpost_resolvers[0].status #=> String, one of "CREATING", "OPERATIONAL", "UPDATING", "DELETING", "ACTION_NEEDED", "FAILED_CREATION", "FAILED_DELETION"
resp.outpost_resolvers[0].status_message #=> String
resp.outpost_resolvers[0].outpost_arn #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :outpost_arn (String) —

    The Amazon Resource Name (ARN) of the Outpost.

  • :max_results (Integer) —

    The maximum number of Resolvers on the Outpost that you want to return in the response to a ListOutpostResolver request. If you don't specify a value for MaxResults, the request returns up to 100 Resolvers.

  • :next_token (String) —

    For the first ListOutpostResolver request, omit this value.

Returns:

See Also:



3218
3219
3220
3221
 
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/client.rb', line 3218

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

#list_resolver_configs(params = {}) ⇒ Types::ListResolverConfigsResponse

Retrieves the Resolver configurations that you have defined. Route 53 Resolver uses the configurations to manage DNS resolution behavior for your VPCs.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_resolver_configs({
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.next_token #=> String
resp.resolver_configs #=> Array
resp.resolver_configs[0].id #=> String
resp.resolver_configs[0].resource_id #=> String
resp.resolver_configs[0].owner_id #=> String
resp.resolver_configs[0].autodefined_reverse #=> String, one of "ENABLING", "ENABLED", "DISABLING", "DISABLED", "UPDATING_TO_USE_LOCAL_RESOURCE_SETTING", "USE_LOCAL_RESOURCE_SETTING"

Parameters:

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

    ({})

Options Hash (params):

  • :max_results (Integer) —

    The maximum number of Resolver configurations that you want to return in the response to a ListResolverConfigs request. If you don't specify a value for MaxResults, up to 100 Resolver configurations are returned.

  • :next_token (String) — default: Optional —

    If the current Amazon Web Services account has more than MaxResults Resolver configurations, use NextToken to get the second and subsequent pages of results.

    For the first ListResolverConfigs request, omit this value.

    For the second and subsequent requests, get the value of NextToken from the previous response and specify that value for NextToken in the request.

Returns:

See Also:



3271
3272
3273
3274
 
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/client.rb', line 3271

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

#list_resolver_dnssec_configs(params = {}) ⇒ Types::ListResolverDnssecConfigsResponse

Lists the configurations for DNSSEC validation that are associated with the current Amazon Web Services account.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


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

Response structure


resp.next_token #=> String
resp.resolver_dnssec_configs #=> Array
resp.resolver_dnssec_configs[0].id #=> String
resp.resolver_dnssec_configs[0].owner_id #=> String
resp.resolver_dnssec_configs[0].resource_id #=> String
resp.resolver_dnssec_configs[0].validation_status #=> String, one of "ENABLING", "ENABLED", "DISABLING", "DISABLED", "UPDATING_TO_USE_LOCAL_RESOURCE_SETTING", "USE_LOCAL_RESOURCE_SETTING"

Parameters:

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

    ({})

Options Hash (params):

  • :max_results (Integer) —

    Optional: An integer that specifies the maximum number of DNSSEC configuration results that you want Amazon Route 53 to return. If you don't specify a value for MaxResults, Route 53 returns up to 100 configuration per page.

  • :next_token (String) — default: Optional —

    If the current Amazon Web Services account has more than MaxResults DNSSEC configurations, use NextToken to get the second and subsequent pages of results.

    For the first ListResolverDnssecConfigs request, omit this value.

    For the second and subsequent requests, get the value of NextToken from the previous response and specify that value for NextToken in the request.

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

    An optional specification to return a subset of objects.

Returns:

See Also:



3332
3333
3334
3335
 
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/client.rb', line 3332

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

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

Gets the IP addresses for a specified Resolver endpoint.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

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].ipv_6 #=> 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", "UPDATING", "UPDATE_FAILED", "ISOLATED"
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:



3391
3392
3393
3394
 
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/client.rb', line 3391

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 Amazon Web Services account.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

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", "INBOUND_DELEGATION"
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
resp.resolver_endpoints[0].outpost_arn #=> String
resp.resolver_endpoints[0].preferred_instance_type #=> String
resp.resolver_endpoints[0].resolver_endpoint_type #=> String, one of "IPV6", "IPV4", "DUALSTACK"
resp.resolver_endpoints[0].protocols #=> Array
resp.resolver_endpoints[0].protocols[0] #=> String, one of "DoH", "Do53", "DoH-FIPS"

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:



3472
3473
3474
3475
 
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/client.rb', line 3472

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

#list_resolver_query_log_config_associations(params = {}) ⇒ Types::ListResolverQueryLogConfigAssociationsResponse

Lists information about associations between Amazon VPCs and query logging configurations.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_resolver_query_log_config_associations({
  max_results: 1,
  next_token: "NextToken",
  filters: [
    {
      name: "FilterName",
      values: ["FilterValue"],
    },
  ],
  sort_by: "SortByKey",
  sort_order: "ASCENDING", # accepts ASCENDING, DESCENDING
})

Response structure


resp.next_token #=> String
resp.total_count #=> Integer
resp.total_filtered_count #=> Integer
resp.resolver_query_log_config_associations #=> Array
resp.resolver_query_log_config_associations[0].id #=> String
resp.resolver_query_log_config_associations[0].resolver_query_log_config_id #=> String
resp.resolver_query_log_config_associations[0].resource_id #=> String
resp.resolver_query_log_config_associations[0].status #=> String, one of "CREATING", "ACTIVE", "ACTION_NEEDED", "DELETING", "FAILED"
resp.resolver_query_log_config_associations[0].error #=> String, one of "NONE", "DESTINATION_NOT_FOUND", "ACCESS_DENIED", "INTERNAL_SERVICE_ERROR"
resp.resolver_query_log_config_associations[0].error_message #=> String
resp.resolver_query_log_config_associations[0].creation_time #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :max_results (Integer) —

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

  • :next_token (String) —

    For the first ListResolverQueryLogConfigAssociations request, omit this value.

    If there are more than MaxResults query logging associations that match the values that you specify for Filters, you can submit another ListResolverQueryLogConfigAssociations request to get the next group of 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 query logging associations.

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

  • :sort_by (String) —

    The element that you want Resolver to sort query logging associations by.

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

    Valid values include the following elements:

    • CreationTime: The ID of the query logging association.

    • Error: If the value of Status is FAILED, the value of Error indicates the cause:

      • DESTINATION_NOT_FOUND: The specified destination (for example, an Amazon S3 bucket) was deleted.

      • ACCESS_DENIED: Permissions don't allow sending logs to the destination. If Status is a value other than FAILED, ERROR is null.

    • Id: The ID of the query logging association

    • ResolverQueryLogConfigId: The ID of the query logging configuration

    • ResourceId: The ID of the VPC that is associated with the query logging configuration

    • Status: The current status of the configuration. Valid values include the following:

      • CREATING: Resolver is creating an association between an Amazon VPC and a query logging configuration.

      • CREATED: The association between an Amazon VPC and a query logging configuration was successfully created. Resolver is logging queries that originate in the specified VPC.

      • DELETING: Resolver is deleting this query logging association.

      • FAILED: Resolver either couldn't create or couldn't delete the query logging association. Here are two common causes:

        • The specified destination (for example, an Amazon S3 bucket) was deleted.

        • Permissions don't allow sending logs to the destination.

  • :sort_order (String) —

    If you specified a value for SortBy, the order that you want query logging associations to be listed in, ASCENDING or DESCENDING.

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

Returns:

See Also:



3613
3614
3615
3616
 
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/client.rb', line 3613

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

#list_resolver_query_log_configs(params = {}) ⇒ Types::ListResolverQueryLogConfigsResponse

Lists information about the specified query logging configurations. Each configuration defines where you want Resolver to save DNS query logs and specifies the VPCs that you want to log queries for.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_resolver_query_log_configs({
  max_results: 1,
  next_token: "NextToken",
  filters: [
    {
      name: "FilterName",
      values: ["FilterValue"],
    },
  ],
  sort_by: "SortByKey",
  sort_order: "ASCENDING", # accepts ASCENDING, DESCENDING
})

Response structure


resp.next_token #=> String
resp.total_count #=> Integer
resp.total_filtered_count #=> Integer
resp.resolver_query_log_configs #=> Array
resp.resolver_query_log_configs[0].id #=> String
resp.resolver_query_log_configs[0].owner_id #=> String
resp.resolver_query_log_configs[0].status #=> String, one of "CREATING", "CREATED", "DELETING", "FAILED"
resp.resolver_query_log_configs[0].share_status #=> String, one of "NOT_SHARED", "SHARED_WITH_ME", "SHARED_BY_ME"
resp.resolver_query_log_configs[0].association_count #=> Integer
resp.resolver_query_log_configs[0].arn #=> String
resp.resolver_query_log_configs[0].name #=> String
resp.resolver_query_log_configs[0].destination_arn #=> String
resp.resolver_query_log_configs[0].creator_request_id #=> String
resp.resolver_query_log_configs[0].creation_time #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :max_results (Integer) —

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

  • :next_token (String) —

    For the first ListResolverQueryLogConfigs request, omit this value.

    If there are more than MaxResults query logging configurations that match the values that you specify for Filters, you can submit another ListResolverQueryLogConfigs request to get the next group of configurations. 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 query logging configurations.

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

  • :sort_by (String) —

    The element that you want Resolver to sort query logging configurations by.

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

    Valid values include the following elements:

    • Arn: The ARN of the query logging configuration

    • AssociationCount: The number of VPCs that are associated with the specified configuration

    • CreationTime: The date and time that Resolver returned when the configuration was created

    • CreatorRequestId: The value that was specified for CreatorRequestId when the configuration was created

    • DestinationArn: The location that logs are sent to

    • Id: The ID of the configuration

    • Name: The name of the configuration

    • OwnerId: The Amazon Web Services account number of the account that created the configuration

    • ShareStatus: Whether the configuration is shared with other Amazon Web Services accounts or shared with the current account by another Amazon Web Services account. Sharing is configured through Resource Access Manager (RAM).

    • Status: The current status of the configuration. Valid values include the following:

      • CREATING: Resolver is creating the query logging configuration.

      • CREATED: The query logging configuration was successfully created. Resolver is logging queries that originate in the specified VPC.

      • DELETING: Resolver is deleting this query logging configuration.

      • FAILED: Resolver either couldn't create or couldn't delete the query logging configuration. Here are two common causes:

        • The specified destination (for example, an Amazon S3 bucket) was deleted.

        • Permissions don't allow sending logs to the destination.

  • :sort_order (String) —

    If you specified a value for SortBy, the order that you want query logging configurations to be listed in, ASCENDING or DESCENDING.

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

Returns:

See Also:



3758
3759
3760
3761
 
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/client.rb', line 3758

def list_resolver_query_log_configs(params = {}, options = {})
  req = build_request(:list_resolver_query_log_configs, 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 Amazon Web Services account.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

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:



3827
3828
3829
3830
 
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/client.rb', line 3827

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 Amazon Web Services account.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

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", "DELEGATE"
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].target_ips[0].ipv_6 #=> String
resp.resolver_rules[0].target_ips[0].protocol #=> String, one of "DoH", "Do53", "DoH-FIPS"
resp.resolver_rules[0].target_ips[0].server_name_indication #=> String
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"
resp.resolver_rules[0].creation_time #=> String
resp.resolver_rules[0].modification_time #=> String
resp.resolver_rules[0].delegation_record #=> String

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:



3910
3911
3912
3913
 
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/client.rb', line 3910

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.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

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:



3960
3961
3962
3963
 
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/client.rb', line 3960

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

#put_firewall_rule_group_policy(params = {}) ⇒ Types::PutFirewallRuleGroupPolicyResponse

Attaches an Identity and Access Management (Amazon Web Services IAM) policy for sharing the rule group. You can use the policy to share the rule group using Resource Access Manager (RAM).

Examples:

Request syntax with placeholder values


resp = client.put_firewall_rule_group_policy({
  arn: "Arn", # required
  firewall_rule_group_policy: "FirewallRuleGroupPolicy", # required
})

Response structure


resp.return_value #=> Boolean

Parameters:

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

    ({})

Options Hash (params):

  • :arn (required, String) —

    The ARN (Amazon Resource Name) for the rule group that you want to share.

  • :firewall_rule_group_policy (required, String) —

    The Identity and Access Management (Amazon Web Services IAM) policy to attach to the rule group.

Returns:

See Also:



3996
3997
3998
3999
 
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/client.rb', line 3996

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

#put_resolver_query_log_config_policy(params = {}) ⇒ Types::PutResolverQueryLogConfigPolicyResponse

Specifies an Amazon Web Services account that you want to share a query logging configuration with, the query logging configuration that you want to share, and the operations that you want the account to be able to perform on the configuration.

Examples:

Request syntax with placeholder values


resp = client.put_resolver_query_log_config_policy({
  arn: "Arn", # required
  resolver_query_log_config_policy: "ResolverQueryLogConfigPolicy", # 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 share rules with.

  • :resolver_query_log_config_policy (required, String) —

    An Identity and Access Management policy statement that lists the query logging configurations that you want to share with another Amazon Web Services account and the operations that you want the account to be able to perform. You can specify the following operations in the Actions section of the statement:

    • route53resolver:AssociateResolverQueryLogConfig

    • route53resolver:DisassociateResolverQueryLogConfig

    • route53resolver:ListResolverQueryLogConfigs

    In the Resource section of the statement, you specify the ARNs for the query logging configurations that you want to share with the account that you specified in Arn.

Returns:

See Also:



4046
4047
4048
4049
 
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/client.rb', line 4046

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

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

Specifies an Amazon Web Services rule that you want to share with another account, the account that you want to share the rule with, and the operations that you want the account to be able to perform on the rule.

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 rule that you want to share with another account.

  • :resolver_rule_policy (required, String) —

    An Identity and Access Management policy statement that lists the rules that you want to share with another Amazon Web Services account and the operations that you want the account to be able to perform. You can specify the following operations in the Action section of the statement:

    • route53resolver:GetResolverRule

    • route53resolver:AssociateResolverRule

    • route53resolver:DisassociateResolverRule

    • route53resolver:ListResolverRules

    • route53resolver:ListResolverRuleAssociations

    In the Resource section of the statement, specify the ARN for the rule that you want to share with another account. Specify the same ARN that you specified in Arn.

Returns:

See Also:



4100
4101
4102
4103
 
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/client.rb', line 4100

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", # required
      value: "TagValue", # required
    },
  ],
})

Parameters:

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

    ({})

Options Hash (params):

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



4154
4155
4156
4157
 
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/client.rb', line 4154

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



4203
4204
4205
4206
 
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/client.rb', line 4203

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

#update_firewall_config(params = {}) ⇒ Types::UpdateFirewallConfigResponse

Updates the configuration of the firewall behavior provided by DNS Firewall for a single VPC from Amazon Virtual Private Cloud (Amazon VPC).

Examples:

Request syntax with placeholder values


resp = client.update_firewall_config({
  resource_id: "ResourceId", # required
  firewall_fail_open: "ENABLED", # required, accepts ENABLED, DISABLED, USE_LOCAL_RESOURCE_SETTING
})

Response structure


resp.firewall_config.id #=> String
resp.firewall_config.resource_id #=> String
resp.firewall_config.owner_id #=> String
resp.firewall_config.firewall_fail_open #=> String, one of "ENABLED", "DISABLED", "USE_LOCAL_RESOURCE_SETTING"

Parameters:

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

    ({})

Options Hash (params):

  • :resource_id (required, String) —

    The ID of the VPC that the configuration is for.

  • :firewall_fail_open (required, String) —

    Determines how Route 53 Resolver handles queries during failures, for example when all traffic that is sent to DNS Firewall fails to receive a reply.

    • By default, fail open is disabled, which means the failure mode is closed. This approach favors security over availability. DNS Firewall blocks queries that it is unable to evaluate properly.

    • If you enable this option, the failure mode is open. This approach favors availability over security. DNS Firewall allows queries to proceed if it is unable to properly evaluate them.

    This behavior is only enforced for VPCs that have at least one DNS Firewall rule group association.

Returns:

See Also:



4253
4254
4255
4256
 
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/client.rb', line 4253

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

#update_firewall_domains(params = {}) ⇒ Types::UpdateFirewallDomainsResponse

Updates the firewall domain list from an array of domain specifications.

Examples:

Request syntax with placeholder values


resp = client.update_firewall_domains({
  firewall_domain_list_id: "ResourceId", # required
  operation: "ADD", # required, accepts ADD, REMOVE, REPLACE
  domains: ["FirewallDomainName"], # required
})

Response structure


resp.id #=> String
resp.name #=> String
resp.status #=> String, one of "COMPLETE", "COMPLETE_IMPORT_FAILED", "IMPORTING", "DELETING", "UPDATING"
resp.status_message #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :firewall_domain_list_id (required, String) —

    The ID of the domain list whose domains you want to update.

  • :operation (required, String) —

    What you want DNS Firewall to do with the domains that you are providing:

    • ADD - Add the domains to the ones that are already in the domain list.

    • REMOVE - Search the domain list for the domains and remove them from the list.

    • REPLACE - Update the domain list to exactly match the list that you are providing.

  • :domains (required, Array<String>) —

    A list of domains to use in the update operation.

    There is a limit of 1000 domains per request.

    Each domain specification in your domain list must satisfy the following requirements:

    • It can optionally start with * (asterisk).

    • With the exception of the optional starting asterisk, it must only contain the following characters: A-Z, a-z, 0-9, - (hyphen).

    • It must be from 1-255 characters in length.

Returns:

See Also:



4318
4319
4320
4321
 
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/client.rb', line 4318

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

#update_firewall_rule(params = {}) ⇒ Types::UpdateFirewallRuleResponse

Updates the specified firewall rule.

Examples:

Request syntax with placeholder values


resp = client.update_firewall_rule({
  firewall_rule_group_id: "ResourceId", # required
  firewall_domain_list_id: "ResourceId",
  firewall_threat_protection_id: "ResourceId",
  priority: 1,
  action: "ALLOW", # accepts ALLOW, BLOCK, ALERT
  block_response: "NODATA", # accepts NODATA, NXDOMAIN, OVERRIDE
  block_override_domain: "BlockOverrideDomain",
  block_override_dns_type: "CNAME", # accepts CNAME
  block_override_ttl: 1,
  name: "Name",
  firewall_domain_redirection_action: "INSPECT_REDIRECTION_DOMAIN", # accepts INSPECT_REDIRECTION_DOMAIN, TRUST_REDIRECTION_DOMAIN
  qtype: "Qtype",
  dns_threat_protection: "DGA", # accepts DGA, DNS_TUNNELING
  confidence_threshold: "LOW", # accepts LOW, MEDIUM, HIGH
})

Response structure


resp.firewall_rule.firewall_rule_group_id #=> String
resp.firewall_rule.firewall_domain_list_id #=> String
resp.firewall_rule.firewall_threat_protection_id #=> String
resp.firewall_rule.name #=> String
resp.firewall_rule.priority #=> Integer
resp.firewall_rule.action #=> String, one of "ALLOW", "BLOCK", "ALERT"
resp.firewall_rule.block_response #=> String, one of "NODATA", "NXDOMAIN", "OVERRIDE"
resp.firewall_rule.block_override_domain #=> String
resp.firewall_rule.block_override_dns_type #=> String, one of "CNAME"
resp.firewall_rule.block_override_ttl #=> Integer
resp.firewall_rule.creator_request_id #=> String
resp.firewall_rule.creation_time #=> String
resp.firewall_rule.modification_time #=> String
resp.firewall_rule.firewall_domain_redirection_action #=> String, one of "INSPECT_REDIRECTION_DOMAIN", "TRUST_REDIRECTION_DOMAIN"
resp.firewall_rule.qtype #=> String
resp.firewall_rule.dns_threat_protection #=> String, one of "DGA", "DNS_TUNNELING"
resp.firewall_rule.confidence_threshold #=> String, one of "LOW", "MEDIUM", "HIGH"

Parameters:

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

    ({})

Options Hash (params):

  • :firewall_rule_group_id (required, String) —

    The unique identifier of the firewall rule group for the rule.

  • :firewall_domain_list_id (String) —

    The ID of the domain list to use in the rule.

  • :firewall_threat_protection_id (String) —

    The DNS Firewall Advanced rule ID.

  • :priority (Integer) —

    The setting that determines the processing order of the rule in the rule group. DNS Firewall processes the rules in a rule group by order of priority, starting from the lowest setting.

    You must specify a unique priority for each rule in a rule group. To make it easier to insert rules later, leave space between the numbers, for example, use 100, 200, and so on. You can change the priority setting for the rules in a rule group at any time.

  • :action (String) —

    The action that DNS Firewall should take on a DNS query when it matches one of the domains in the rule's domain list, or a threat in a DNS Firewall Advanced rule:

    • ALLOW - Permit the request to go through. Not available for DNS Firewall Advanced rules.

    • ALERT - Permit the request to go through but send an alert to the logs.

    • BLOCK - Disallow the request. This option requires additional details in the rule's BlockResponse.

  • :block_response (String) —

    The way that you want DNS Firewall to block the request. Used for the rule action setting BLOCK.

    • NODATA - Respond indicating that the query was successful, but no response is available for it.

    • NXDOMAIN - Respond indicating that the domain name that's in the query doesn't exist.

    • OVERRIDE - Provide a custom override in the response. This option requires custom handling details in the rule's BlockOverride* settings.

  • :block_override_domain (String) —

    The custom DNS record to send back in response to the query. Used for the rule action BLOCK with a BlockResponse setting of OVERRIDE.

  • :block_override_dns_type (String) —

    The DNS record's type. This determines the format of the record value that you provided in BlockOverrideDomain. Used for the rule action BLOCK with a BlockResponse setting of OVERRIDE.

  • :block_override_ttl (Integer) —

    The recommended amount of time, in seconds, for the DNS resolver or web browser to cache the provided override record. Used for the rule action BLOCK with a BlockResponse setting of OVERRIDE.

  • :name (String) —

    The name of the rule.

  • :firewall_domain_redirection_action (String) —

    How you want the the rule to evaluate DNS redirection in the DNS redirection chain, such as CNAME or DNAME.

    INSPECT_REDIRECTION_DOMAIN: (Default) inspects all domains in the redirection chain. The individual domains in the redirection chain must be added to the domain list.

    TRUST_REDIRECTION_DOMAIN: Inspects only the first domain in the redirection chain. You don't need to add the subsequent domains in the domain in the redirection list to the domain list.

  • :qtype (String) —

    The DNS query type you want the rule to evaluate. Allowed values are;

    • A: Returns an IPv4 address.

    • AAAA: Returns an Ipv6 address.

    • CAA: Restricts CAs that can create SSL/TLS certifications for the domain.

    • CNAME: Returns another domain name.

    • DS: Record that identifies the DNSSEC signing key of a delegated zone.

    • MX: Specifies mail servers.

    • NAPTR: Regular-expression-based rewriting of domain names.

    • NS: Authoritative name servers.

    • PTR: Maps an IP address to a domain name.

    • SOA: Start of authority record for the zone.

    • SPF: Lists the servers authorized to send emails from a domain.

    • SRV: Application specific values that identify servers.

    • TXT: Verifies email senders and application-specific values.

    • A query type you define by using the DNS type ID, for example 28 for AAAA. The values must be defined as TYPENUMBER, where the NUMBER can be 1-65334, for example, TYPE28. For more information, see List of DNS record types.

      If you set up a firewall BLOCK rule with action NXDOMAIN on query type equals AAAA, this action will not be applied to synthetic IPv6 addresses generated when DNS64 is enabled.

  • :dns_threat_protection (String) —

    The type of the DNS Firewall Advanced rule. Valid values are:

    • DGA: Domain generation algorithms detection. DGAs are used by attackers to generate a large number of domains to to launch malware attacks.

    • DNS_TUNNELING: DNS tunneling detection. DNS tunneling is used by attackers to exfiltrate data from the client by using the DNS tunnel without making a network connection to the client.

  • :confidence_threshold (String) —

    The confidence threshold for DNS Firewall Advanced. You must provide this value when you create a DNS Firewall Advanced rule. The confidence level values mean:

    • LOW: Provides the highest detection rate for threats, but also increases false positives.

    • MEDIUM: Provides a balance between detecting threats and false positives.

    • HIGH: Detects only the most well corroborated threats with a low rate of false positives.

Returns:

See Also:



4519
4520
4521
4522
 
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/client.rb', line 4519

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

#update_firewall_rule_group_association(params = {}) ⇒ Types::UpdateFirewallRuleGroupAssociationResponse

Changes the association of a FirewallRuleGroup with a VPC. The association enables DNS filtering for the VPC.

Examples:

Request syntax with placeholder values


resp = client.update_firewall_rule_group_association({
  firewall_rule_group_association_id: "ResourceId", # required
  priority: 1,
  mutation_protection: "ENABLED", # accepts ENABLED, DISABLED
  name: "Name",
})

Response structure


resp.firewall_rule_group_association.id #=> String
resp.firewall_rule_group_association.arn #=> String
resp.firewall_rule_group_association.firewall_rule_group_id #=> String
resp.firewall_rule_group_association.vpc_id #=> String
resp.firewall_rule_group_association.name #=> String
resp.firewall_rule_group_association.priority #=> Integer
resp.firewall_rule_group_association.mutation_protection #=> String, one of "ENABLED", "DISABLED"
resp.firewall_rule_group_association.managed_owner_name #=> String
resp.firewall_rule_group_association.status #=> String, one of "COMPLETE", "DELETING", "UPDATING"
resp.firewall_rule_group_association.status_message #=> String
resp.firewall_rule_group_association.creator_request_id #=> String
resp.firewall_rule_group_association.creation_time #=> String
resp.firewall_rule_group_association.modification_time #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :firewall_rule_group_association_id (required, String) —

    The identifier of the FirewallRuleGroupAssociation.

  • :priority (Integer) —

    The setting that determines the processing order of the rule group among the rule groups that you associate with the specified VPC. DNS Firewall filters VPC traffic starting from the rule group with the lowest numeric priority setting.

    You must specify a unique priority for each rule group that you associate with a single VPC. To make it easier to insert rule groups later, leave space between the numbers, for example, use 100, 200, and so on. You can change the priority setting for a rule group association after you create it.

  • :mutation_protection (String) —

    If enabled, this setting disallows modification or removal of the association, to help prevent against accidentally altering DNS firewall protections.

  • :name (String) —

    The name of the rule group association.

Returns:

See Also:



4583
4584
4585
4586
 
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/client.rb', line 4583

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

#update_outpost_resolver(params = {}) ⇒ Types::UpdateOutpostResolverResponse

You can use UpdateOutpostResolver to update the instance count, type, or name of a Resolver on an Outpost.

Examples:

Request syntax with placeholder values


resp = client.update_outpost_resolver({
  id: "ResourceId", # required
  name: "OutpostResolverName",
  instance_count: 1,
  preferred_instance_type: "OutpostInstanceType",
})

Response structure


resp.outpost_resolver.arn #=> String
resp.outpost_resolver.creation_time #=> String
resp.outpost_resolver.modification_time #=> String
resp.outpost_resolver.creator_request_id #=> String
resp.outpost_resolver.id #=> String
resp.outpost_resolver.instance_count #=> Integer
resp.outpost_resolver.preferred_instance_type #=> String
resp.outpost_resolver.name #=> String
resp.outpost_resolver.status #=> String, one of "CREATING", "OPERATIONAL", "UPDATING", "DELETING", "ACTION_NEEDED", "FAILED_CREATION", "FAILED_DELETION"
resp.outpost_resolver.status_message #=> String
resp.outpost_resolver.outpost_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String) —

    A unique string that identifies Resolver on an Outpost.

  • :name (String) —

    Name of the Resolver on the Outpost.

  • :instance_count (Integer) —

    The Amazon EC2 instance count for a Resolver on the Outpost.

  • :preferred_instance_type (String) —

    Amazon EC2 instance type.

Returns:

See Also:



4634
4635
4636
4637
 
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/client.rb', line 4634

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

#update_resolver_config(params = {}) ⇒ Types::UpdateResolverConfigResponse

Updates the behavior configuration of Route 53 Resolver behavior for a single VPC from Amazon Virtual Private Cloud.

Examples:

Request syntax with placeholder values


resp = client.update_resolver_config({
  resource_id: "ResourceId", # required
  autodefined_reverse_flag: "ENABLE", # required, accepts ENABLE, DISABLE, USE_LOCAL_RESOURCE_SETTING
})

Response structure


resp.resolver_config.id #=> String
resp.resolver_config.resource_id #=> String
resp.resolver_config.owner_id #=> String
resp.resolver_config.autodefined_reverse #=> String, one of "ENABLING", "ENABLED", "DISABLING", "DISABLED", "UPDATING_TO_USE_LOCAL_RESOURCE_SETTING", "USE_LOCAL_RESOURCE_SETTING"

Parameters:

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

    ({})

Options Hash (params):

  • :resource_id (required, String) —

    The ID of the Amazon Virtual Private Cloud VPC or a Route 53 Profile that you're configuring Resolver for.

  • :autodefined_reverse_flag (required, String) —

    Indicates whether or not the Resolver will create autodefined rules for reverse DNS lookups. This is enabled by default. Disabling this option will also affect EC2-Classic instances using ClassicLink. For more information, see ClassicLink in the Amazon EC2 guide.

    We are retiring EC2-Classic on August 15, 2022. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon EC2 guide and the blog EC2-Classic Networking is Retiring – Here’s How to Prepare.

    It can take some time for the status change to be completed.

Returns:

See Also:



4691
4692
4693
4694
 
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/client.rb', line 4691

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

#update_resolver_dnssec_config(params = {}) ⇒ Types::UpdateResolverDnssecConfigResponse

Updates an existing DNSSEC validation configuration. If there is no existing DNSSEC validation configuration, one is created.

Examples:

Request syntax with placeholder values


resp = client.update_resolver_dnssec_config({
  resource_id: "ResourceId", # required
  validation: "ENABLE", # required, accepts ENABLE, DISABLE, USE_LOCAL_RESOURCE_SETTING
})

Response structure


resp.resolver_dnssec_config.id #=> String
resp.resolver_dnssec_config.owner_id #=> String
resp.resolver_dnssec_config.resource_id #=> String
resp.resolver_dnssec_config.validation_status #=> String, one of "ENABLING", "ENABLED", "DISABLING", "DISABLED", "UPDATING_TO_USE_LOCAL_RESOURCE_SETTING", "USE_LOCAL_RESOURCE_SETTING"

Parameters:

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

    ({})

Options Hash (params):

  • :resource_id (required, String) —

    The ID of the virtual private cloud (VPC) that you're updating the DNSSEC validation status for.

  • :validation (required, String) —

    The new value that you are specifying for DNSSEC validation for the VPC. The value can be ENABLE or DISABLE. Be aware that it can take time for a validation status change to be completed.

Returns:

See Also:



4730
4731
4732
4733
 
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/client.rb', line 4730

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

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

Updates the name, or endpoint type for an inbound or an outbound Resolver endpoint. You can only update between IPV4 and DUALSTACK, IPV6 endpoint type can't be updated to other type.

Examples:

Request syntax with placeholder values


resp = client.update_resolver_endpoint({
  resolver_endpoint_id: "ResourceId", # required
  name: "Name",
  resolver_endpoint_type: "IPV6", # accepts IPV6, IPV4, DUALSTACK
  update_ip_addresses: [
    {
      ip_id: "ResourceId", # required
      ipv_6: "Ipv6", # required
    },
  ],
  protocols: ["DoH"], # accepts DoH, Do53, DoH-FIPS
})

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", "INBOUND_DELEGATION"
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
resp.resolver_endpoint.outpost_arn #=> String
resp.resolver_endpoint.preferred_instance_type #=> String
resp.resolver_endpoint.resolver_endpoint_type #=> String, one of "IPV6", "IPV4", "DUALSTACK"
resp.resolver_endpoint.protocols #=> Array
resp.resolver_endpoint.protocols[0] #=> String, one of "DoH", "Do53", "DoH-FIPS"

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.

  • :resolver_endpoint_type (String) —

    Specifies the endpoint type for what type of IP address the endpoint uses to forward DNS queries.

    Updating to IPV6 type isn't currently supported.

  • :update_ip_addresses (Array<Types::UpdateIpAddress>) —

    Specifies the IPv6 address when you update the Resolver endpoint from IPv4 to dual-stack. If you don't specify an IPv6 address, one will be automatically chosen from your subnet.

  • :protocols (Array<String>) —

    The protocols you want to use for the endpoint. DoH-FIPS is applicable for default inbound endpoints only.

    For a default inbound endpoint you can apply the protocols as follows:

    • Do53 and DoH in combination.

    • Do53 and DoH-FIPS in combination.

    • Do53 alone.

    • DoH alone.

    • DoH-FIPS alone.

    • None, which is treated as Do53.

    For a delegation inbound endpoint you can use Do53 only.

    For an outbound endpoint you can apply the protocols as follows:

    • Do53 and DoH in combination.

    • Do53 alone.

    • DoH alone.

    • None, which is treated as Do53.

    You can't change the protocol of an inbound endpoint directly from only Do53 to only DoH, or DoH-FIPS. This is to prevent a sudden disruption to incoming traffic that relies on Do53. To change the protocol from Do53 to DoH, or DoH-FIPS, you must first enable both Do53 and DoH, or Do53 and DoH-FIPS, to make sure that all incoming traffic has transferred to using the DoH protocol, or DoH-FIPS, and then remove the Do53.

Returns:

See Also:



4838
4839
4840
4841
 
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/client.rb', line 4838

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",
        port: 1,
        ipv_6: "Ipv6",
        protocol: "DoH", # accepts DoH, Do53, DoH-FIPS
        server_name_indication: "ServerNameIndication",
      },
    ],
    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", "DELEGATE"
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.target_ips[0].ipv_6 #=> String
resp.resolver_rule.target_ips[0].protocol #=> String, one of "DoH", "Do53", "DoH-FIPS"
resp.resolver_rule.target_ips[0].server_name_indication #=> String
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"
resp.resolver_rule.creation_time #=> String
resp.resolver_rule.modification_time #=> String
resp.resolver_rule.delegation_record #=> String

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:



4903
4904
4905
4906
 
# File 'gems/aws-sdk-route53resolver/lib/aws-sdk-route53resolver/client.rb', line 4903

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