software.amazon.awscdk.services.route53resolver

Interface CfnResolverRuleProps

All Known Implementing Classes:

CfnResolverRuleProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:43.880Z")
public interface CfnResolverRuleProps

Properties for defining a `CfnResolverRule`.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.route53resolver.*;
 CfnResolverRuleProps cfnResolverRuleProps = CfnResolverRuleProps.builder()
         .domainName("domainName")
         .ruleType("ruleType")
         // the properties below are optional
         .name("name")
         .resolverEndpointId("resolverEndpointId")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .targetIps(List.of(TargetAddressProperty.builder()
                 .ip("ip")
                 .ipv6("ipv6")
                 .port("port")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnResolverRuleProps.Builder A builder for CfnResolverRuleProps
static class	CfnResolverRuleProps.Jsii$Proxy An implementation for CfnResolverRuleProps

Method Summary

Modifier and Type	Method and Description
static CfnResolverRuleProps.Builder	builder()
java.lang.String	getDomainName() DNS queries for this domain name are forwarded to the IP addresses that are specified in `TargetIps` .
default java.lang.String	getName() The name for the Resolver rule, which you specified when you created the Resolver rule.
default java.lang.String	getResolverEndpointId() The ID of the endpoint that the rule is associated with.
java.lang.String	getRuleType() When you want to forward DNS queries for specified domain name to resolvers on your network, specify `FORWARD` .
default java.util.List<CfnTag>	getTags() Tags help organize and categorize your Resolver rules.
default java.lang.Object	getTargetIps() An array that contains the IP addresses and ports that an outbound endpoint forwards DNS queries to.

Method Detail

getDomainName

java.lang.String getDomainName()

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

getRuleType

java.lang.String getRuleType()

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 .

getName

default java.lang.String getName()

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

getResolverEndpointId

default java.lang.String getResolverEndpointId()

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

getTags

default java.util.List<CfnTag> getTags()

Tags help organize and categorize your Resolver rules.

Each tag consists of a key and an optional value, both of which you define.

getTargetIps

default java.lang.Object getTargetIps()

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.

builder

static CfnResolverRuleProps.Builder builder()

Returns:

a CfnResolverRuleProps.Builder of CfnResolverRuleProps