Class: AWS.Route53Resolver

Inherits:
AWS.Service show all
Identifier:
route53resolver
API Version:
2018-04-01
Defined in:
(unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

Here's how you set up to query an Amazon Route 53 private hosted zone from your network:

  1. Connect your network to a VPC using AWS Direct Connect or a VPN.

  2. Run the following AWS CLI command to create a Resolver endpoint:

    create-resolver-endpoint --name [endpoint_name] --direction INBOUND --creator-request-id [unique_string] --security-group-ids [security_group_with_inbound_rules] --ip-addresses SubnetId=[subnet_id] SubnetId=[subnet_id_in_different_AZ]

    Note the resolver endpoint ID that appears in the response. You'll use it in step 3.

  3. Get the IP addresses for the Resolver endpoints:

    get-resolver-endpoint --resolver-endpoint-id [resolver_endpoint_id]

  4. In your network configuration, define the IP addresses that you got in step 3 as DNS servers.

    You can now query instance names in your VPCs and the names of records in your private hosted zone.

You can also perform the following operations using the AWS CLI:

  • list-resolver-endpoints: List all endpoints. The syntax includes options for pagination and filtering.

  • update-resolver-endpoints: Add IP addresses to an endpoint or remove IP addresses from an endpoint.

To delete an endpoint, use the following AWS CLI command:

delete-resolver-endpoint --resolver-endpoint-id [resolver_endpoint_id]

Sending a Request Using Route53Resolver

var route53resolver = new AWS.Route53Resolver();
route53resolver.associateResolverEndpointIpAddress(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the Route53Resolver object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var route53resolver = new AWS.Route53Resolver({apiVersion: '2018-04-01'});

You can also set the API version globally in AWS.config.apiVersions using the route53resolver service identifier:

AWS.config.apiVersions = {
  route53resolver: '2018-04-01',
  // other service API versions
};

var route53resolver = new AWS.Route53Resolver();

Version:

  • 2018-04-01

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.Route53Resolver(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Examples:

Constructing a Route53Resolver object

var route53resolver = new AWS.Route53Resolver({apiVersion: '2018-04-01'});

Options Hash (options):

  • params (map)

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String)

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com'.

  • accessKeyId (String)

    your AWS access key ID.

  • secretAccessKey (String)

    your AWS secret access key.

  • sessionToken (AWS.Credentials)

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials)

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain)

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String)

    the region to send service requests to. See AWS.Route53Resolver.region for more information.

  • maxRetries (Integer)

    the maximum amount of retries to attempt with a request. See AWS.Route53Resolver.maxRetries for more information.

  • maxRedirects (Integer)

    the maximum amount of redirects to follow with a request. See AWS.Route53Resolver.maxRedirects for more information.

  • sslEnabled (Boolean)

    whether to enable SSL for requests.

  • paramValidation (Boolean|map)

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean)

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean)

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean)

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean)

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean)

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean)

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • retryDelayOptions (map)

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied.
  • httpOptions (map)

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date)

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>)

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log)

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number)

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String)

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean)

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean)

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

  • useAccelerateEndpoint (Boolean)

    Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

  • clientSideMonitoring (Boolean)

    whether to collect and publish this client's performance metrics of all its API requests.

  • endpointDiscoveryEnabled (Boolean)

    whether to enable endpoint discovery for operations that allow optionally using an endpoint returned by the service. Defaults to 'false'

  • endpointCacheSize (Number)

    the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

  • hostPrefixEnabled (Boolean)

    whether to marshal request parameters to the prefix of hostname. Defaults to true.

  • stsRegionalEndpoints ('legacy'|'regional')

    whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

Property Details

endpointAWS.Endpoint (readwrite)

Returns an Endpoint object representing the endpoint URL for service requests.

Returns:

  • (AWS.Endpoint)

    an Endpoint object representing the endpoint URL for service requests.

Method Details

associateResolverEndpointIpAddress(params = {}, callback) ⇒ AWS.Request

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

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

Examples:

Calling the associateResolverEndpointIpAddress operation

var params = {
  IpAddress: { /* required */
    Ip: 'STRING_VALUE',
    IpId: 'STRING_VALUE',
    SubnetId: 'STRING_VALUE'
  },
  ResolverEndpointId: 'STRING_VALUE' /* required */
};
route53resolver.associateResolverEndpointIpAddress(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ResolverEndpointId — (String)

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

    • IpAddress — (map)

      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.

      • IpId — (String)

        Only when removing an IP address from a resolver endpoint: The ID of the IP address that you want to remove. To get this ID, use GetResolverEndpoint.

      • SubnetId — (String)

        The ID of the subnet that includes the IP address that you want to update. To get this ID, use GetResolverEndpoint.

      • Ip — (String)

        The new IP address.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ResolverEndpoint — (map)

        The response to an AssociateResolverEndpointIpAddress request.

        • Id — (String)

          The ID of the resolver endpoint.

        • CreatorRequestId — (String)

          A unique string that identifies the request that created the resolver endpoint. The CreatorRequestId allows failed requests to be retried without the risk of executing the operation twice.

        • Arn — (String)

          The ARN (Amazon Resource Name) for the resolver endpoint.

        • Name — (String)

          The name that you assigned to the resolver endpoint when you submitted a CreateResolverEndpoint request.

        • SecurityGroupIds — (Array<String>)

          The ID of one or more security groups that control access to this VPC. The security group must include one or more inbound resolver rules.

        • Direction — (String)

          Indicates whether the resolver endpoint allows inbound or outbound DNS queries:

          • INBOUND: allows DNS queries to your VPC from your network or another VPC

          • OUTBOUND: allows DNS queries from your VPC to your network or another VPC

          Possible values include:
          • "INBOUND"
          • "OUTBOUND"
        • IpAddressCount — (Integer)

          The number of IP addresses that the resolver endpoint can use for DNS queries.

        • HostVPCId — (String)

          The ID of the VPC that you want to create the resolver endpoint in.

        • Status — (String)

          A code that specifies the current status of the resolver endpoint.

          Possible values include:
          • "CREATING"
          • "OPERATIONAL"
          • "UPDATING"
          • "AUTO_RECOVERING"
          • "ACTION_NEEDED"
          • "DELETING"
        • StatusMessage — (String)

          A detailed description of the status of the resolver endpoint.

        • CreationTime — (String)

          The date and time that the endpoint was created, in Unix time format and Coordinated Universal Time (UTC).

        • ModificationTime — (String)

          The date and time that the endpoint was last modified, in Unix time format and Coordinated Universal Time (UTC).

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

associateResolverRule(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the associateResolverRule operation

var params = {
  ResolverRuleId: 'STRING_VALUE', /* required */
  VPCId: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE'
};
route53resolver.associateResolverRule(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ResolverRuleId — (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.

    • VPCId — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ResolverRuleAssociation — (map)

        Information about the AssociateResolverRule request, including the status of the request.

        • Id — (String)

          The ID of the association between a resolver rule and a VPC. Resolver assigns this value when you submit an AssociateResolverRule request.

        • ResolverRuleId — (String)

          The ID of the resolver rule that you associated with the VPC that is specified by VPCId.

        • Name — (String)

          The name of an association between a resolver rule and a VPC.

        • VPCId — (String)

          The ID of the VPC that you associated the resolver rule with.

        • Status — (String)

          A code that specifies the current status of the association between a resolver rule and a VPC.

          Possible values include:
          • "CREATING"
          • "COMPLETE"
          • "DELETING"
          • "FAILED"
          • "OVERRIDDEN"
        • StatusMessage — (String)

          A detailed description of the status of the association between a resolver rule and a VPC.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createResolverEndpoint(params = {}, callback) ⇒ AWS.Request

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

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

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

Service Reference:

Examples:

Calling the createResolverEndpoint operation

var params = {
  CreatorRequestId: 'STRING_VALUE', /* required */
  Direction: INBOUND | OUTBOUND, /* required */
  IpAddresses: [ /* required */
    {
      SubnetId: 'STRING_VALUE', /* required */
      Ip: 'STRING_VALUE'
    },
    /* more items */
  ],
  SecurityGroupIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  Name: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
route53resolver.createResolverEndpoint(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • CreatorRequestId — (String)

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

    • Name — (String)

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

    • SecurityGroupIds — (Array<String>)

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

    • Direction — (String)

      Specify the applicable value:

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

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

      Possible values include:
      • "INBOUND"
      • "OUTBOUND"
    • IpAddresses — (Array<map>)

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

      • SubnetIdrequired — (String)

        The subnet that contains the IP address.

      • Ip — (String)

        The IP address that you want to use for DNS queries.

    • Tags — (Array<map>)

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

      • Key — (String)

        The name for the tag. For example, if you want to associate Resolver resources with the account IDs of your customers for billing purposes, the value of Key might be account-id.

      • Value — (String)

        The value for the tag. For example, if Key is account-id, then Value might be the ID of the customer account that you're creating the resource for.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ResolverEndpoint — (map)

        Information about the CreateResolverEndpoint request, including the status of the request.

        • Id — (String)

          The ID of the resolver endpoint.

        • CreatorRequestId — (String)

          A unique string that identifies the request that created the resolver endpoint. The CreatorRequestId allows failed requests to be retried without the risk of executing the operation twice.

        • Arn — (String)

          The ARN (Amazon Resource Name) for the resolver endpoint.

        • Name — (String)

          The name that you assigned to the resolver endpoint when you submitted a CreateResolverEndpoint request.

        • SecurityGroupIds — (Array<String>)

          The ID of one or more security groups that control access to this VPC. The security group must include one or more inbound resolver rules.

        • Direction — (String)

          Indicates whether the resolver endpoint allows inbound or outbound DNS queries:

          • INBOUND: allows DNS queries to your VPC from your network or another VPC

          • OUTBOUND: allows DNS queries from your VPC to your network or another VPC

          Possible values include:
          • "INBOUND"
          • "OUTBOUND"
        • IpAddressCount — (Integer)

          The number of IP addresses that the resolver endpoint can use for DNS queries.

        • HostVPCId — (String)

          The ID of the VPC that you want to create the resolver endpoint in.

        • Status — (String)

          A code that specifies the current status of the resolver endpoint.

          Possible values include:
          • "CREATING"
          • "OPERATIONAL"
          • "UPDATING"
          • "AUTO_RECOVERING"
          • "ACTION_NEEDED"
          • "DELETING"
        • StatusMessage — (String)

          A detailed description of the status of the resolver endpoint.

        • CreationTime — (String)

          The date and time that the endpoint was created, in Unix time format and Coordinated Universal Time (UTC).

        • ModificationTime — (String)

          The date and time that the endpoint was last modified, in Unix time format and Coordinated Universal Time (UTC).

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createResolverRule(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the createResolverRule operation

var params = {
  CreatorRequestId: 'STRING_VALUE', /* required */
  DomainName: 'STRING_VALUE', /* required */
  RuleType: FORWARD | SYSTEM | RECURSIVE, /* required */
  Name: 'STRING_VALUE',
  ResolverEndpointId: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ],
  TargetIps: [
    {
      Ip: 'STRING_VALUE', /* required */
      Port: 'NUMBER_VALUE'
    },
    /* more items */
  ]
};
route53resolver.createResolverRule(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • CreatorRequestId — (String)

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

    • Name — (String)

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

    • RuleType — (String)

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

      Possible values include:
      • "FORWARD"
      • "SYSTEM"
      • "RECURSIVE"
    • DomainName — (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).

    • TargetIps — (Array<map>)

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

      • Iprequired — (String)

        One IP address that you want to forward DNS queries to. You can specify only IPv4 addresses.

      • Port — (Integer)

        The port at Ip that you want to forward DNS queries to.

    • ResolverEndpointId — (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<map>)

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

      • Key — (String)

        The name for the tag. For example, if you want to associate Resolver resources with the account IDs of your customers for billing purposes, the value of Key might be account-id.

      • Value — (String)

        The value for the tag. For example, if Key is account-id, then Value might be the ID of the customer account that you're creating the resource for.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ResolverRule — (map)

        Information about the CreateResolverRule request, including the status of the request.

        • Id — (String)

          The ID that Resolver assigned to the resolver rule when you created it.

        • CreatorRequestId — (String)

          A unique string that you specified when you created the resolver rule. CreatorRequestIdidentifies the request and allows failed requests to be retried without the risk of executing the operation twice.

        • Arn — (String)

          The ARN (Amazon Resource Name) for the resolver rule specified by Id.

        • DomainName — (String)

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

        • Status — (String)

          A code that specifies the current status of the resolver rule.

          Possible values include:
          • "COMPLETE"
          • "DELETING"
          • "UPDATING"
          • "FAILED"
        • StatusMessage — (String)

          A detailed description of the status of a resolver rule.

        • RuleType — (String)

          This value is always FORWARD. Other resolver rule types aren't supported.

          Possible values include:
          • "FORWARD"
          • "SYSTEM"
          • "RECURSIVE"
        • Name — (String)

          The name for the resolver rule, which you specified when you created the resolver rule.

        • TargetIps — (Array<map>)

          An array that contains the IP addresses and ports that you want to forward

          • Iprequired — (String)

            One IP address that you want to forward DNS queries to. You can specify only IPv4 addresses.

          • Port — (Integer)

            The port at Ip that you want to forward DNS queries to.

        • ResolverEndpointId — (String)

          The ID of the endpoint that the rule is associated with.

        • OwnerId — (String)

          When a rule is shared with another AWS account, the account ID of the account that the rule is shared with.

        • ShareStatus — (String)

          Whether the rules is shared and, if so, whether the current account is sharing the rule with another account, or another account is sharing the rule with the current account.

          Possible values include:
          • "NOT_SHARED"
          • "SHARED_WITH_ME"
          • "SHARED_BY_ME"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteResolverEndpoint(params = {}, callback) ⇒ AWS.Request

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

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

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

Service Reference:

Examples:

Calling the deleteResolverEndpoint operation

var params = {
  ResolverEndpointId: 'STRING_VALUE' /* required */
};
route53resolver.deleteResolverEndpoint(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ResolverEndpointId — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ResolverEndpoint — (map)

        Information about the DeleteResolverEndpoint request, including the status of the request.

        • Id — (String)

          The ID of the resolver endpoint.

        • CreatorRequestId — (String)

          A unique string that identifies the request that created the resolver endpoint. The CreatorRequestId allows failed requests to be retried without the risk of executing the operation twice.

        • Arn — (String)

          The ARN (Amazon Resource Name) for the resolver endpoint.

        • Name — (String)

          The name that you assigned to the resolver endpoint when you submitted a CreateResolverEndpoint request.

        • SecurityGroupIds — (Array<String>)

          The ID of one or more security groups that control access to this VPC. The security group must include one or more inbound resolver rules.

        • Direction — (String)

          Indicates whether the resolver endpoint allows inbound or outbound DNS queries:

          • INBOUND: allows DNS queries to your VPC from your network or another VPC

          • OUTBOUND: allows DNS queries from your VPC to your network or another VPC

          Possible values include:
          • "INBOUND"
          • "OUTBOUND"
        • IpAddressCount — (Integer)

          The number of IP addresses that the resolver endpoint can use for DNS queries.

        • HostVPCId — (String)

          The ID of the VPC that you want to create the resolver endpoint in.

        • Status — (String)

          A code that specifies the current status of the resolver endpoint.

          Possible values include:
          • "CREATING"
          • "OPERATIONAL"
          • "UPDATING"
          • "AUTO_RECOVERING"
          • "ACTION_NEEDED"
          • "DELETING"
        • StatusMessage — (String)

          A detailed description of the status of the resolver endpoint.

        • CreationTime — (String)

          The date and time that the endpoint was created, in Unix time format and Coordinated Universal Time (UTC).

        • ModificationTime — (String)

          The date and time that the endpoint was last modified, in Unix time format and Coordinated Universal Time (UTC).

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteResolverRule(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the deleteResolverRule operation

var params = {
  ResolverRuleId: 'STRING_VALUE' /* required */
};
route53resolver.deleteResolverRule(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ResolverRuleId — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ResolverRule — (map)

        Information about the DeleteResolverRule request, including the status of the request.

        • Id — (String)

          The ID that Resolver assigned to the resolver rule when you created it.

        • CreatorRequestId — (String)

          A unique string that you specified when you created the resolver rule. CreatorRequestIdidentifies the request and allows failed requests to be retried without the risk of executing the operation twice.

        • Arn — (String)

          The ARN (Amazon Resource Name) for the resolver rule specified by Id.

        • DomainName — (String)

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

        • Status — (String)

          A code that specifies the current status of the resolver rule.

          Possible values include:
          • "COMPLETE"
          • "DELETING"
          • "UPDATING"
          • "FAILED"
        • StatusMessage — (String)

          A detailed description of the status of a resolver rule.

        • RuleType — (String)

          This value is always FORWARD. Other resolver rule types aren't supported.

          Possible values include:
          • "FORWARD"
          • "SYSTEM"
          • "RECURSIVE"
        • Name — (String)

          The name for the resolver rule, which you specified when you created the resolver rule.

        • TargetIps — (Array<map>)

          An array that contains the IP addresses and ports that you want to forward

          • Iprequired — (String)

            One IP address that you want to forward DNS queries to. You can specify only IPv4 addresses.

          • Port — (Integer)

            The port at Ip that you want to forward DNS queries to.

        • ResolverEndpointId — (String)

          The ID of the endpoint that the rule is associated with.

        • OwnerId — (String)

          When a rule is shared with another AWS account, the account ID of the account that the rule is shared with.

        • ShareStatus — (String)

          Whether the rules is shared and, if so, whether the current account is sharing the rule with another account, or another account is sharing the rule with the current account.

          Possible values include:
          • "NOT_SHARED"
          • "SHARED_WITH_ME"
          • "SHARED_BY_ME"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

disassociateResolverEndpointIpAddress(params = {}, callback) ⇒ AWS.Request

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:

Calling the disassociateResolverEndpointIpAddress operation

var params = {
  IpAddress: { /* required */
    Ip: 'STRING_VALUE',
    IpId: 'STRING_VALUE',
    SubnetId: 'STRING_VALUE'
  },
  ResolverEndpointId: 'STRING_VALUE' /* required */
};
route53resolver.disassociateResolverEndpointIpAddress(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ResolverEndpointId — (String)

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

    • IpAddress — (map)

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

      • IpId — (String)

        Only when removing an IP address from a resolver endpoint: The ID of the IP address that you want to remove. To get this ID, use GetResolverEndpoint.

      • SubnetId — (String)

        The ID of the subnet that includes the IP address that you want to update. To get this ID, use GetResolverEndpoint.

      • Ip — (String)

        The new IP address.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ResolverEndpoint — (map)

        The response to an DisassociateResolverEndpointIpAddress request.

        • Id — (String)

          The ID of the resolver endpoint.

        • CreatorRequestId — (String)

          A unique string that identifies the request that created the resolver endpoint. The CreatorRequestId allows failed requests to be retried without the risk of executing the operation twice.

        • Arn — (String)

          The ARN (Amazon Resource Name) for the resolver endpoint.

        • Name — (String)

          The name that you assigned to the resolver endpoint when you submitted a CreateResolverEndpoint request.

        • SecurityGroupIds — (Array<String>)

          The ID of one or more security groups that control access to this VPC. The security group must include one or more inbound resolver rules.

        • Direction — (String)

          Indicates whether the resolver endpoint allows inbound or outbound DNS queries:

          • INBOUND: allows DNS queries to your VPC from your network or another VPC

          • OUTBOUND: allows DNS queries from your VPC to your network or another VPC

          Possible values include:
          • "INBOUND"
          • "OUTBOUND"
        • IpAddressCount — (Integer)

          The number of IP addresses that the resolver endpoint can use for DNS queries.

        • HostVPCId — (String)

          The ID of the VPC that you want to create the resolver endpoint in.

        • Status — (String)

          A code that specifies the current status of the resolver endpoint.

          Possible values include:
          • "CREATING"
          • "OPERATIONAL"
          • "UPDATING"
          • "AUTO_RECOVERING"
          • "ACTION_NEEDED"
          • "DELETING"
        • StatusMessage — (String)

          A detailed description of the status of the resolver endpoint.

        • CreationTime — (String)

          The date and time that the endpoint was created, in Unix time format and Coordinated Universal Time (UTC).

        • ModificationTime — (String)

          The date and time that the endpoint was last modified, in Unix time format and Coordinated Universal Time (UTC).

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

disassociateResolverRule(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the disassociateResolverRule operation

var params = {
  ResolverRuleId: 'STRING_VALUE', /* required */
  VPCId: 'STRING_VALUE' /* required */
};
route53resolver.disassociateResolverRule(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • VPCId — (String)

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

    • ResolverRuleId — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ResolverRuleAssociation — (map)

        Information about the DisassociateResolverRule request, including the status of the request.

        • Id — (String)

          The ID of the association between a resolver rule and a VPC. Resolver assigns this value when you submit an AssociateResolverRule request.

        • ResolverRuleId — (String)

          The ID of the resolver rule that you associated with the VPC that is specified by VPCId.

        • Name — (String)

          The name of an association between a resolver rule and a VPC.

        • VPCId — (String)

          The ID of the VPC that you associated the resolver rule with.

        • Status — (String)

          A code that specifies the current status of the association between a resolver rule and a VPC.

          Possible values include:
          • "CREATING"
          • "COMPLETE"
          • "DELETING"
          • "FAILED"
          • "OVERRIDDEN"
        • StatusMessage — (String)

          A detailed description of the status of the association between a resolver rule and a VPC.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getResolverEndpoint(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the getResolverEndpoint operation

var params = {
  ResolverEndpointId: 'STRING_VALUE' /* required */
};
route53resolver.getResolverEndpoint(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ResolverEndpointId — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ResolverEndpoint — (map)

        Information about the resolver endpoint that you specified in a GetResolverEndpoint request.

        • Id — (String)

          The ID of the resolver endpoint.

        • CreatorRequestId — (String)

          A unique string that identifies the request that created the resolver endpoint. The CreatorRequestId allows failed requests to be retried without the risk of executing the operation twice.

        • Arn — (String)

          The ARN (Amazon Resource Name) for the resolver endpoint.

        • Name — (String)

          The name that you assigned to the resolver endpoint when you submitted a CreateResolverEndpoint request.

        • SecurityGroupIds — (Array<String>)

          The ID of one or more security groups that control access to this VPC. The security group must include one or more inbound resolver rules.

        • Direction — (String)

          Indicates whether the resolver endpoint allows inbound or outbound DNS queries:

          • INBOUND: allows DNS queries to your VPC from your network or another VPC

          • OUTBOUND: allows DNS queries from your VPC to your network or another VPC

          Possible values include:
          • "INBOUND"
          • "OUTBOUND"
        • IpAddressCount — (Integer)

          The number of IP addresses that the resolver endpoint can use for DNS queries.

        • HostVPCId — (String)

          The ID of the VPC that you want to create the resolver endpoint in.

        • Status — (String)

          A code that specifies the current status of the resolver endpoint.

          Possible values include:
          • "CREATING"
          • "OPERATIONAL"
          • "UPDATING"
          • "AUTO_RECOVERING"
          • "ACTION_NEEDED"
          • "DELETING"
        • StatusMessage — (String)

          A detailed description of the status of the resolver endpoint.

        • CreationTime — (String)

          The date and time that the endpoint was created, in Unix time format and Coordinated Universal Time (UTC).

        • ModificationTime — (String)

          The date and time that the endpoint was last modified, in Unix time format and Coordinated Universal Time (UTC).

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getResolverRule(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the getResolverRule operation

var params = {
  ResolverRuleId: 'STRING_VALUE' /* required */
};
route53resolver.getResolverRule(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ResolverRuleId — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ResolverRule — (map)

        Information about the resolver rule that you specified in a GetResolverRule request.

        • Id — (String)

          The ID that Resolver assigned to the resolver rule when you created it.

        • CreatorRequestId — (String)

          A unique string that you specified when you created the resolver rule. CreatorRequestIdidentifies the request and allows failed requests to be retried without the risk of executing the operation twice.

        • Arn — (String)

          The ARN (Amazon Resource Name) for the resolver rule specified by Id.

        • DomainName — (String)

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

        • Status — (String)

          A code that specifies the current status of the resolver rule.

          Possible values include:
          • "COMPLETE"
          • "DELETING"
          • "UPDATING"
          • "FAILED"
        • StatusMessage — (String)

          A detailed description of the status of a resolver rule.

        • RuleType — (String)

          This value is always FORWARD. Other resolver rule types aren't supported.

          Possible values include:
          • "FORWARD"
          • "SYSTEM"
          • "RECURSIVE"
        • Name — (String)

          The name for the resolver rule, which you specified when you created the resolver rule.

        • TargetIps — (Array<map>)

          An array that contains the IP addresses and ports that you want to forward

          • Iprequired — (String)

            One IP address that you want to forward DNS queries to. You can specify only IPv4 addresses.

          • Port — (Integer)

            The port at Ip that you want to forward DNS queries to.

        • ResolverEndpointId — (String)

          The ID of the endpoint that the rule is associated with.

        • OwnerId — (String)

          When a rule is shared with another AWS account, the account ID of the account that the rule is shared with.

        • ShareStatus — (String)

          Whether the rules is shared and, if so, whether the current account is sharing the rule with another account, or another account is sharing the rule with the current account.

          Possible values include:
          • "NOT_SHARED"
          • "SHARED_WITH_ME"
          • "SHARED_BY_ME"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getResolverRuleAssociation(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the getResolverRuleAssociation operation

var params = {
  ResolverRuleAssociationId: 'STRING_VALUE' /* required */
};
route53resolver.getResolverRuleAssociation(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ResolverRuleAssociationId — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ResolverRuleAssociation — (map)

        Information about the resolver rule association that you specified in a GetResolverRuleAssociation request.

        • Id — (String)

          The ID of the association between a resolver rule and a VPC. Resolver assigns this value when you submit an AssociateResolverRule request.

        • ResolverRuleId — (String)

          The ID of the resolver rule that you associated with the VPC that is specified by VPCId.

        • Name — (String)

          The name of an association between a resolver rule and a VPC.

        • VPCId — (String)

          The ID of the VPC that you associated the resolver rule with.

        • Status — (String)

          A code that specifies the current status of the association between a resolver rule and a VPC.

          Possible values include:
          • "CREATING"
          • "COMPLETE"
          • "DELETING"
          • "FAILED"
          • "OVERRIDDEN"
        • StatusMessage — (String)

          A detailed description of the status of the association between a resolver rule and a VPC.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getResolverRulePolicy(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the getResolverRulePolicy operation

var params = {
  Arn: 'STRING_VALUE' /* required */
};
route53resolver.getResolverRulePolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Arn — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ResolverRulePolicy — (String)

        Information about the resolver rule policy that you specified in a GetResolverRulePolicy request.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listResolverEndpointIpAddresses(params = {}, callback) ⇒ AWS.Request

Gets the IP addresses for a specified resolver endpoint.

Service Reference:

Examples:

Calling the listResolverEndpointIpAddresses operation

var params = {
  ResolverEndpointId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
route53resolver.listResolverEndpointIpAddresses(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ResolverEndpointId — (String)

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

    • MaxResults — (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.

    • NextToken — (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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • NextToken — (String)

        If the specified 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.

      • MaxResults — (Integer)

        The value that you specified for MaxResults in the request.

      • IpAddresses — (Array<map>)

        The IP addresses that DNS queries pass through on their way to your network (outbound endpoint) or on the way to Resolver (inbound endpoint).

        • IpId — (String)

          The ID of one IP address.

        • SubnetId — (String)

          The ID of one subnet.

        • Ip — (String)

          One IP address that the resolver endpoint uses for DNS queries.

        • Status — (String)

          A status code that gives the current status of the request.

          Possible values include:
          • "CREATING"
          • "FAILED_CREATION"
          • "ATTACHING"
          • "ATTACHED"
          • "REMAP_DETACHING"
          • "REMAP_ATTACHING"
          • "DETACHING"
          • "FAILED_RESOURCE_GONE"
          • "DELETING"
          • "DELETE_FAILED_FAS_EXPIRED"
        • StatusMessage — (String)

          A message that provides additional information about the status of the request.

        • CreationTime — (String)

          The date and time that the IP address was created, in Unix time format and Coordinated Universal Time (UTC).

        • ModificationTime — (String)

          The date and time that the IP address was last modified, in Unix time format and Coordinated Universal Time (UTC).

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listResolverEndpoints(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the listResolverEndpoints operation

var params = {
  Filters: [
    {
      Name: 'STRING_VALUE',
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
route53resolver.listResolverEndpoints(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • MaxResults — (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.

    • NextToken — (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<map>)

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

      Note: 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.
      • Name — (String)

        When you're using a List operation and you want the operation to return a subset of objects, such as resolver endpoints or resolver rules, the name of the parameter that you want to use to filter objects. For example, to list only inbound resolver endpoints, specify Direction for the value of Name.

      • Values — (Array<String>)

        When you're using a List operation and you want the operation to return a subset of objects, such as resolver endpoints or resolver rules, the value of the parameter that you want to use to filter objects. For example, to list only inbound resolver endpoints, specify INBOUND for the value of Values.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • NextToken — (String)

        If more than MaxResults IP addresses match the specified criteria, you can submit another ListResolverEndpoint request to get the next group of results. In the next request, specify the value of NextToken from the previous response.

      • MaxResults — (Integer)

        The value that you specified for MaxResults in the request.

      • ResolverEndpoints — (Array<map>)

        The resolver endpoints that were created by using the current AWS account, and that match the specified filters, if any.

        • Id — (String)

          The ID of the resolver endpoint.

        • CreatorRequestId — (String)

          A unique string that identifies the request that created the resolver endpoint. The CreatorRequestId allows failed requests to be retried without the risk of executing the operation twice.

        • Arn — (String)

          The ARN (Amazon Resource Name) for the resolver endpoint.

        • Name — (String)

          The name that you assigned to the resolver endpoint when you submitted a CreateResolverEndpoint request.

        • SecurityGroupIds — (Array<String>)

          The ID of one or more security groups that control access to this VPC. The security group must include one or more inbound resolver rules.

        • Direction — (String)

          Indicates whether the resolver endpoint allows inbound or outbound DNS queries:

          • INBOUND: allows DNS queries to your VPC from your network or another VPC

          • OUTBOUND: allows DNS queries from your VPC to your network or another VPC

          Possible values include:
          • "INBOUND"
          • "OUTBOUND"
        • IpAddressCount — (Integer)

          The number of IP addresses that the resolver endpoint can use for DNS queries.

        • HostVPCId — (String)

          The ID of the VPC that you want to create the resolver endpoint in.

        • Status — (String)

          A code that specifies the current status of the resolver endpoint.

          Possible values include:
          • "CREATING"
          • "OPERATIONAL"
          • "UPDATING"
          • "AUTO_RECOVERING"
          • "ACTION_NEEDED"
          • "DELETING"
        • StatusMessage — (String)

          A detailed description of the status of the resolver endpoint.

        • CreationTime — (String)

          The date and time that the endpoint was created, in Unix time format and Coordinated Universal Time (UTC).

        • ModificationTime — (String)

          The date and time that the endpoint was last modified, in Unix time format and Coordinated Universal Time (UTC).

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listResolverRuleAssociations(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the listResolverRuleAssociations operation

var params = {
  Filters: [
    {
      Name: 'STRING_VALUE',
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
route53resolver.listResolverRuleAssociations(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • MaxResults — (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.

    • NextToken — (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<map>)

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

      Note: 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.
      • Name — (String)

        When you're using a List operation and you want the operation to return a subset of objects, such as resolver endpoints or resolver rules, the name of the parameter that you want to use to filter objects. For example, to list only inbound resolver endpoints, specify Direction for the value of Name.

      • Values — (Array<String>)

        When you're using a List operation and you want the operation to return a subset of objects, such as resolver endpoints or resolver rules, the value of the parameter that you want to use to filter objects. For example, to list only inbound resolver endpoints, specify INBOUND for the value of Values.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • NextToken — (String)

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

      • MaxResults — (Integer)

        The value that you specified for MaxResults in the request.

      • ResolverRuleAssociations — (Array<map>)

        The associations that were created between resolver rules and VPCs using the current AWS account, and that match the specified filters, if any.

        • Id — (String)

          The ID of the association between a resolver rule and a VPC. Resolver assigns this value when you submit an AssociateResolverRule request.

        • ResolverRuleId — (String)

          The ID of the resolver rule that you associated with the VPC that is specified by VPCId.

        • Name — (String)

          The name of an association between a resolver rule and a VPC.

        • VPCId — (String)

          The ID of the VPC that you associated the resolver rule with.

        • Status — (String)

          A code that specifies the current status of the association between a resolver rule and a VPC.

          Possible values include:
          • "CREATING"
          • "COMPLETE"
          • "DELETING"
          • "FAILED"
          • "OVERRIDDEN"
        • StatusMessage — (String)

          A detailed description of the status of the association between a resolver rule and a VPC.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listResolverRules(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the listResolverRules operation

var params = {
  Filters: [
    {
      Name: 'STRING_VALUE',
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
route53resolver.listResolverRules(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • MaxResults — (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.

    • NextToken — (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<map>)

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

      Note: 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.
      • Name — (String)

        When you're using a List operation and you want the operation to return a subset of objects, such as resolver endpoints or resolver rules, the name of the parameter that you want to use to filter objects. For example, to list only inbound resolver endpoints, specify Direction for the value of Name.

      • Values — (Array<String>)

        When you're using a List operation and you want the operation to return a subset of objects, such as resolver endpoints or resolver rules, the value of the parameter that you want to use to filter objects. For example, to list only inbound resolver endpoints, specify INBOUND for the value of Values.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • NextToken — (String)

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

      • MaxResults — (Integer)

        The value that you specified for MaxResults in the request.

      • ResolverRules — (Array<map>)

        The resolver rules that were created using the current AWS account and that match the specified filters, if any.

        • Id — (String)

          The ID that Resolver assigned to the resolver rule when you created it.

        • CreatorRequestId — (String)

          A unique string that you specified when you created the resolver rule. CreatorRequestIdidentifies the request and allows failed requests to be retried without the risk of executing the operation twice.

        • Arn — (String)

          The ARN (Amazon Resource Name) for the resolver rule specified by Id.

        • DomainName — (String)

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

        • Status — (String)

          A code that specifies the current status of the resolver rule.

          Possible values include:
          • "COMPLETE"
          • "DELETING"
          • "UPDATING"
          • "FAILED"
        • StatusMessage — (String)

          A detailed description of the status of a resolver rule.

        • RuleType — (String)

          This value is always FORWARD. Other resolver rule types aren't supported.

          Possible values include:
          • "FORWARD"
          • "SYSTEM"
          • "RECURSIVE"
        • Name — (String)

          The name for the resolver rule, which you specified when you created the resolver rule.

        • TargetIps — (Array<map>)

          An array that contains the IP addresses and ports that you want to forward

          • Iprequired — (String)

            One IP address that you want to forward DNS queries to. You can specify only IPv4 addresses.

          • Port — (Integer)

            The port at Ip that you want to forward DNS queries to.

        • ResolverEndpointId — (String)

          The ID of the endpoint that the rule is associated with.

        • OwnerId — (String)

          When a rule is shared with another AWS account, the account ID of the account that the rule is shared with.

        • ShareStatus — (String)

          Whether the rules is shared and, if so, whether the current account is sharing the rule with another account, or another account is sharing the rule with the current account.

          Possible values include:
          • "NOT_SHARED"
          • "SHARED_WITH_ME"
          • "SHARED_BY_ME"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listTagsForResource(params = {}, callback) ⇒ AWS.Request

Lists the tags that you associated with the specified resource.

Service Reference:

Examples:

Calling the listTagsForResource operation

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
route53resolver.listTagsForResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ResourceArn — (String)

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

    • MaxResults — (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.

    • NextToken — (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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Tags — (Array<map>)

        The tags that are associated with the resource that you specified in the ListTagsForResource request.

        • Key — (String)

          The name for the tag. For example, if you want to associate Resolver resources with the account IDs of your customers for billing purposes, the value of Key might be account-id.

        • Value — (String)

          The value for the tag. For example, if Key is account-id, then Value might be the ID of the customer account that you're creating the resource for.

      • NextToken — (String)

        If more than MaxResults tags match the specified criteria, you can submit another ListTagsForResource request to get the next group of results. In the next request, specify the value of NextToken from the previous response.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

putResolverRulePolicy(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the putResolverRulePolicy operation

var params = {
  Arn: 'STRING_VALUE', /* required */
  ResolverRulePolicy: 'STRING_VALUE' /* required */
};
route53resolver.putResolverRulePolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Arn — (String)

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

    • ResolverRulePolicy — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ReturnValue — (Boolean)

        Whether the PutResolverRulePolicy request was successful.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

tagResource(params = {}, callback) ⇒ AWS.Request

Adds one or more tags to a specified resource.

Service Reference:

Examples:

Calling the tagResource operation

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  Tags: [ /* required */
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
route53resolver.tagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ResourceArn — (String)

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

    • Tags — (Array<map>)

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

      • Key — (String)

        The name for the tag. For example, if you want to associate Resolver resources with the account IDs of your customers for billing purposes, the value of Key might be account-id.

      • Value — (String)

        The value for the tag. For example, if Key is account-id, then Value might be the ID of the customer account that you're creating the resource for.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

untagResource(params = {}, callback) ⇒ AWS.Request

Removes one or more tags from a specified resource.

Service Reference:

Examples:

Calling the untagResource operation

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  TagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
route53resolver.untagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateResolverEndpoint(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the updateResolverEndpoint operation

var params = {
  ResolverEndpointId: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE'
};
route53resolver.updateResolverEndpoint(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ResolverEndpointId — (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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ResolverEndpoint — (map)

        The response to an UpdateResolverEndpoint request.

        • Id — (String)

          The ID of the resolver endpoint.

        • CreatorRequestId — (String)

          A unique string that identifies the request that created the resolver endpoint. The CreatorRequestId allows failed requests to be retried without the risk of executing the operation twice.

        • Arn — (String)

          The ARN (Amazon Resource Name) for the resolver endpoint.

        • Name — (String)

          The name that you assigned to the resolver endpoint when you submitted a CreateResolverEndpoint request.

        • SecurityGroupIds — (Array<String>)

          The ID of one or more security groups that control access to this VPC. The security group must include one or more inbound resolver rules.

        • Direction — (String)

          Indicates whether the resolver endpoint allows inbound or outbound DNS queries:

          • INBOUND: allows DNS queries to your VPC from your network or another VPC

          • OUTBOUND: allows DNS queries from your VPC to your network or another VPC

          Possible values include:
          • "INBOUND"
          • "OUTBOUND"
        • IpAddressCount — (Integer)

          The number of IP addresses that the resolver endpoint can use for DNS queries.

        • HostVPCId — (String)

          The ID of the VPC that you want to create the resolver endpoint in.

        • Status — (String)

          A code that specifies the current status of the resolver endpoint.

          Possible values include:
          • "CREATING"
          • "OPERATIONAL"
          • "UPDATING"
          • "AUTO_RECOVERING"
          • "ACTION_NEEDED"
          • "DELETING"
        • StatusMessage — (String)

          A detailed description of the status of the resolver endpoint.

        • CreationTime — (String)

          The date and time that the endpoint was created, in Unix time format and Coordinated Universal Time (UTC).

        • ModificationTime — (String)

          The date and time that the endpoint was last modified, in Unix time format and Coordinated Universal Time (UTC).

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateResolverRule(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the updateResolverRule operation

var params = {
  Config: { /* required */
    Name: 'STRING_VALUE',
    ResolverEndpointId: 'STRING_VALUE',
    TargetIps: [
      {
        Ip: 'STRING_VALUE', /* required */
        Port: 'NUMBER_VALUE'
      },
      /* more items */
    ]
  },
  ResolverRuleId: 'STRING_VALUE' /* required */
};
route53resolver.updateResolverRule(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ResolverRuleId — (String)

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

    • Config — (map)

      The new settings for the resolver rule.

      • Name — (String)

        The new name for the resolver rule. The name that you specify appears in the Resolver dashboard in the Route 53 console.

      • TargetIps — (Array<map>)

        For DNS queries that originate in your VPC, the new IP addresses that you want to route outbound DNS queries to.

        • Iprequired — (String)

          One IP address that you want to forward DNS queries to. You can specify only IPv4 addresses.

        • Port — (Integer)

          The port at Ip that you want to forward DNS queries to.

      • ResolverEndpointId — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ResolverRule — (map)

        The response to an UpdateResolverRule request.

        • Id — (String)

          The ID that Resolver assigned to the resolver rule when you created it.

        • CreatorRequestId — (String)

          A unique string that you specified when you created the resolver rule. CreatorRequestIdidentifies the request and allows failed requests to be retried without the risk of executing the operation twice.

        • Arn — (String)

          The ARN (Amazon Resource Name) for the resolver rule specified by Id.

        • DomainName — (String)

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

        • Status — (String)

          A code that specifies the current status of the resolver rule.

          Possible values include:
          • "COMPLETE"
          • "DELETING"
          • "UPDATING"
          • "FAILED"
        • StatusMessage — (String)

          A detailed description of the status of a resolver rule.

        • RuleType — (String)

          This value is always FORWARD. Other resolver rule types aren't supported.

          Possible values include:
          • "FORWARD"
          • "SYSTEM"
          • "RECURSIVE"
        • Name — (String)

          The name for the resolver rule, which you specified when you created the resolver rule.

        • TargetIps — (Array<map>)

          An array that contains the IP addresses and ports that you want to forward

          • Iprequired — (String)

            One IP address that you want to forward DNS queries to. You can specify only IPv4 addresses.

          • Port — (Integer)

            The port at Ip that you want to forward DNS queries to.

        • ResolverEndpointId — (String)

          The ID of the endpoint that the rule is associated with.

        • OwnerId — (String)

          When a rule is shared with another AWS account, the account ID of the account that the rule is shared with.

        • ShareStatus — (String)

          Whether the rules is shared and, if so, whether the current account is sharing the rule with another account, or another account is sharing the rule with the current account.

          Possible values include:
          • "NOT_SHARED"
          • "SHARED_WITH_ME"
          • "SHARED_BY_ME"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.