createResolverRule method

Future<CreateResolverRuleResponse> createResolverRule({ required String creatorRequestId, required String domainName, required RuleTypeOption ruleType, String? name, String? resolverEndpointId, List<Tag>? tags, List<TargetAddress>? targetIps, })

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.

May throw InvalidParameterException. May throw InvalidRequestException. May throw LimitExceededException. May throw ResourceNotFoundException. May throw ResourceExistsException. May throw ResourceUnavailableException. May throw InternalServiceErrorException. May throw ThrottlingException.

Parameter creatorRequestId : 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.

Parameter domainName : 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).

Parameter ruleType : When you want to forward DNS queries for specified domain name to resolvers on your network, specify FORWARD.

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

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

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

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

Parameter resolverEndpointId : 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.

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

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

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

Implementation

Future<CreateResolverRuleResponse> createResolverRule({
  required String creatorRequestId,
  required String domainName,
  required RuleTypeOption ruleType,
  String? name,
  String? resolverEndpointId,
  List<Tag>? tags,
  List<TargetAddress>? targetIps,
}) async {
  ArgumentError.checkNotNull(creatorRequestId, 'creatorRequestId');
  _s.validateStringLength(
    'creatorRequestId',
    creatorRequestId,
    1,
    255,
    isRequired: true,
  );
  ArgumentError.checkNotNull(domainName, 'domainName');
  _s.validateStringLength(
    'domainName',
    domainName,
    1,
    256,
    isRequired: true,
  );
  ArgumentError.checkNotNull(ruleType, 'ruleType');
  _s.validateStringLength(
    'name',
    name,
    0,
    64,
  );
  _s.validateStringLength(
    'resolverEndpointId',
    resolverEndpointId,
    1,
    64,
  );
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'Route53Resolver.CreateResolverRule'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'CreatorRequestId': creatorRequestId,
      'DomainName': domainName,
      'RuleType': ruleType.toValue(),
      if (name != null) 'Name': name,
      if (resolverEndpointId != null)
        'ResolverEndpointId': resolverEndpointId,
      if (tags != null) 'Tags': tags,
      if (targetIps != null) 'TargetIps': targetIps,
    },
  );

  return CreateResolverRuleResponse.fromJson(jsonResponse.body);
}