Package software.amazon.awscdk.services.route53resolver

Class CfnResolverRule

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.route53resolver.CfnResolverRule
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:40.397Z") @Stability(Stable) public class CfnResolverRule extends CfnResource implements IInspectable
A CloudFormation AWS::Route53Resolver::ResolverRule.

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.

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.*;
 CfnResolverRule cfnResolverRule = CfnResolverRule.Builder.create(this, "MyCfnResolverRule")
         .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();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnResolverRule

      protected CfnResolverRule(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnResolverRule

      protected CfnResolverRule(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnResolverRule

      @Stability(Stable) public CfnResolverRule(@NotNull Construct scope, @NotNull String id, @NotNull CfnResolverRuleProps props)
      Create a new AWS::Route53Resolver::ResolverRule.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.
      This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector -
      • tree inspector to collect and process attributes.
      This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The Amazon Resource Name (ARN) of the resolver rule, such as arn:aws:route53resolver:us-east-1:123456789012:resolver-rule/resolver-rule-a1bzhi .

    • getAttrDomainName

      @Stability(Stable) @NotNull public String getAttrDomainName()
      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).

    • getAttrName

      @Stability(Stable) @NotNull public String getAttrName()
      A friendly name that lets you easily find a rule in the Resolver dashboard in the Route 53 console.

    • getAttrResolverEndpointId

      @Stability(Stable) @NotNull public String getAttrResolverEndpointId()
      The ID of the outbound endpoint that the rule is associated with, such as rslvr-out-fdc049932dexample .

    • getAttrResolverRuleId

      @Stability(Stable) @NotNull public String getAttrResolverRuleId()
      When the value of RuleType is FORWARD , the ID that Resolver assigned to the resolver rule when you created it, such as rslvr-rr-5328a0899aexample .

      This value isn't applicable when RuleType is SYSTEM .

    • getAttrTargetIps

      @Stability(Stable) @NotNull public IResolvable getAttrTargetIps()
      When the value of RuleType is FORWARD , the IP addresses that the outbound endpoint forwards DNS queries to, typically the IP addresses for DNS resolvers on your network.

      This value isn't applicable when RuleType is SYSTEM .

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tags help organize and categorize your Resolver rules.

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

    • getDomainName

      @Stability(Stable) @NotNull public 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).

    • setDomainName

      @Stability(Stable) public void setDomainName(@NotNull String value)
      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

      @Stability(Stable) @NotNull public 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 .

    • setRuleType

      @Stability(Stable) public void setRuleType(@NotNull String value)
      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

      @Stability(Stable) @Nullable public String getName()
      The name for the Resolver rule, which you specified when you created the Resolver rule.

    • setName

      @Stability(Stable) public void setName(@Nullable String value)
      The name for the Resolver rule, which you specified when you created the Resolver rule.

    • getResolverEndpointId

      @Stability(Stable) @Nullable public String getResolverEndpointId()
      The ID of the endpoint that the rule is associated with.

    • setResolverEndpointId

      @Stability(Stable) public void setResolverEndpointId(@Nullable String value)
      The ID of the endpoint that the rule is associated with.

    • getTargetIps

      @Stability(Stable) @Nullable public 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.

    • setTargetIps

      @Stability(Stable) public void setTargetIps(@Nullable IResolvable value)
      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.

    • setTargetIps

      @Stability(Stable) public void setTargetIps(@Nullable List<Object> value)
      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.