Route53Resolver / Client / create_resolver_rule

create_resolver_rule#

Route53Resolver.Client.create_resolver_rule(**kwargs)#

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.

Request Syntax

response = client.create_resolver_rule(
    CreatorRequestId='string',
    Name='string',
    RuleType='FORWARD'|'SYSTEM'|'RECURSIVE',
    DomainName='string',
    TargetIps=[
        {
            'Ip': 'string',
            'Port': 123,
            'Ipv6': 'string',
            'Protocol': 'DoH'|'Do53'|'DoH-FIPS',
            'ServerNameIndication': 'string'
        },
    ],
    ResolverEndpointId='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)

Parameters:

CreatorRequestId (string) –
[REQUIRED]

A unique string that identifies the request and that allows failed requests to be retried without the risk of running the operation twice. CreatorRequestId can be any unique string, for example, a date/time stamp.
Name (string) – A friendly name that lets you easily find a rule in the Resolver dashboard in the Route 53 console.
RuleType (string) –
[REQUIRED]

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.
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 (list) –
The IPs that you want Resolver to forward DNS queries to. You can specify either Ipv4 or Ipv6 addresses but not both in the same rule. Separate IP addresses with a space.

TargetIps is available only when the value of Rule type is FORWARD.
- (dict) –
  
  In a CreateResolverRule request, an array of the IPs that you want to forward DNS queries to.
  - Ip (string) –
    
    One IPv4 address that you want to forward DNS queries to.
  - Port (integer) –
    
    The port at Ip that you want to forward DNS queries to.
  - Ipv6 (string) –
    
    One IPv6 address that you want to forward DNS queries to.
  - Protocol (string) –
    
    The protocols for the target address. The protocol you choose needs to be supported by the outbound endpoint of the Resolver rule.
  - ServerNameIndication (string) –
    
    The Server Name Indication of the DoH server that you want to forward queries to. This is only used if the Protocol of the TargetAddress is DoH.
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 (list) –
A list of the tag keys and values that you want to associate with the endpoint.
- (dict) –
  
  One tag that you want to add to the specified resource. A tag consists of a Key (a name for the tag) and a Value.
  - Key (string) – [REQUIRED]
    
    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) – [REQUIRED]
    
    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.

Return type:

dict

Returns:

Response Syntax

{
    'ResolverRule': {
        'Id': 'string',
        'CreatorRequestId': 'string',
        'Arn': 'string',
        'DomainName': 'string',
        'Status': 'COMPLETE'|'DELETING'|'UPDATING'|'FAILED',
        'StatusMessage': 'string',
        'RuleType': 'FORWARD'|'SYSTEM'|'RECURSIVE',
        'Name': 'string',
        'TargetIps': [
            {
                'Ip': 'string',
                'Port': 123,
                'Ipv6': 'string',
                'Protocol': 'DoH'|'Do53'|'DoH-FIPS',
                'ServerNameIndication': 'string'
            },
        ],
        'ResolverEndpointId': 'string',
        'OwnerId': 'string',
        'ShareStatus': 'NOT_SHARED'|'SHARED_WITH_ME'|'SHARED_BY_ME',
        'CreationTime': 'string',
        'ModificationTime': 'string'
    }
}

Response Structure

(dict) –
- ResolverRule (dict) –
  
  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. CreatorRequestId identifies the request and allows failed requests to be retried without the risk of running 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.
  - StatusMessage (string) –
    
    A detailed description of the status of a Resolver rule.
  - RuleType (string) –
    
    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.
  - Name (string) –
    
    The name for the Resolver rule, which you specified when you created the Resolver rule.
  - TargetIps (list) –
    
    An array that contains the IP addresses and ports that an outbound endpoint forwards DNS queries to. Typically, these are the IP addresses of DNS resolvers on your network.
    - (dict) –
      
      In a CreateResolverRule request, an array of the IPs that you want to forward DNS queries to.
      - Ip (string) –
        
        One IPv4 address that you want to forward DNS queries to.
      - Port (integer) –
        
        The port at Ip that you want to forward DNS queries to.
      - Ipv6 (string) –
        
        One IPv6 address that you want to forward DNS queries to.
      - Protocol (string) –
        
        The protocols for the target address. The protocol you choose needs to be supported by the outbound endpoint of the Resolver rule.
      - ServerNameIndication (string) –
        
        The Server Name Indication of the DoH server that you want to forward queries to. This is only used if the Protocol of the TargetAddress is DoH.
  - ResolverEndpointId (string) –
    
    The ID of the endpoint that the rule is associated with.
  - OwnerId (string) –
    
    When a rule is shared with another Amazon Web Services account, the account ID of the account that the rule is shared with.
  - ShareStatus (string) –
    
    Whether the rule 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.
  - CreationTime (string) –
    
    The date and time that the Resolver rule was created, in Unix time format and Coordinated Universal Time (UTC).
  - ModificationTime (string) –
    
    The date and time that the Resolver rule was last updated, in Unix time format and Coordinated Universal Time (UTC).

Exceptions

Route53Resolver.Client.exceptions.InvalidParameterException
Route53Resolver.Client.exceptions.InvalidRequestException
Route53Resolver.Client.exceptions.LimitExceededException
Route53Resolver.Client.exceptions.ResourceNotFoundException
Route53Resolver.Client.exceptions.ResourceExistsException
Route53Resolver.Client.exceptions.ResourceUnavailableException
Route53Resolver.Client.exceptions.InternalServiceErrorException
Route53Resolver.Client.exceptions.AccessDeniedException
Route53Resolver.Client.exceptions.ThrottlingException