CfnResolverRuleProps

class aws_cdk.aws_route53resolver.CfnResolverRuleProps(*, domain_name, rule_type, name=None, resolver_endpoint_id=None, tags=None, target_ips=None)

Bases: object

Properties for defining a CfnResolverRule.

Parameters:
  • domain_name (str) – 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).

  • rule_type (str) – 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 (Optional[str]) – The name for the Resolver rule, which you specified when you created the Resolver rule.

  • resolver_endpoint_id (Optional[str]) – The ID of the endpoint that the rule is associated with.

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – Tags help organize and categorize your Resolver rules. Each tag consists of a key and an optional value, both of which you define.

  • target_ips (Union[IResolvable, Sequence[Union[IResolvable, TargetAddressProperty, Dict[str, Any]]], None]) – 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.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-resolverrule.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_route53resolver as route53resolver

cfn_resolver_rule_props = route53resolver.CfnResolverRuleProps(
    domain_name="domainName",
    rule_type="ruleType",

    # the properties below are optional
    name="name",
    resolver_endpoint_id="resolverEndpointId",
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    target_ips=[route53resolver.CfnResolverRule.TargetAddressProperty(
        ip="ip",
        ipv6="ipv6",
        port="port",
        protocol="protocol"
    )]
)

Attributes

domain_name

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

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-resolverrule.html#cfn-route53resolver-resolverrule-domainname

name

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

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-resolverrule.html#cfn-route53resolver-resolverrule-name

resolver_endpoint_id

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

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-resolverrule.html#cfn-route53resolver-resolverrule-resolverendpointid

rule_type

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 .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-resolverrule.html#cfn-route53resolver-resolverrule-ruletype

tags

Tags help organize and categorize your Resolver rules.

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

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-resolverrule.html#cfn-route53resolver-resolverrule-tags

target_ips

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.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-resolverrule.html#cfn-route53resolver-resolverrule-targetips