Class CfnResolverRule

A CloudFormation AWS::Route53Resolver::ResolverRule.

Inheritance
System.Object
Construct
CfnElement
CfnRefElement
CfnResource
CfnResolverRule
Implements
Constructs.IConstruct
Inherited Members
Namespace: Amazon.CDK.AWS.Route53Resolver
Assembly: Amazon.CDK.AWS.Route53Resolver.dll
Syntax (csharp)
public class CfnResolverRule : CfnResource, IConstruct, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnResolverRule
    Inherits CfnResource
    Implements IConstruct, IConstruct, IDependable, IInspectable
Remarks

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.

CloudformationResource: AWS::Route53Resolver::ResolverRule

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

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Route53Resolver;

CfnResolverRule cfnResolverRule = new CfnResolverRule(this, "MyCfnResolverRule", new CfnResolverRuleProps {
    DomainName = "domainName",
    RuleType = "ruleType",

    // the properties below are optional
    Name = "name",
    ResolverEndpointId = "resolverEndpointId",
    Tags = new [] { new CfnTag {
        Key = "key",
        Value = "value"
    } },
    TargetIps = new [] { new TargetAddressProperty {
        Ip = "ip",

        // the properties below are optional
        Port = "port"
    } }
});

Synopsis

Constructors

CfnResolverRule(Construct, String, ICfnResolverRuleProps)

Create a new AWS::Route53Resolver::ResolverRule.
CfnResolverRule(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference
CfnResolverRule(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

Properties

AttrArn

The Amazon Resource Name (ARN) of the resolver rule, such as arn:aws:route53resolver:us-east-1:123456789012:resolver-rule/resolver-rule-a1bzhi .
AttrDomainName

DNS queries for this domain name are forwarded to the IP addresses that are specified in TargetIps.
AttrName

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

The ID of the outbound endpoint that the rule is associated with, such as rslvr-out-fdc049932dexample .
AttrResolverRuleId

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

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

The CloudFormation resource type name for this resource class.
CfnProperties
DomainName

DNS queries for this domain name are forwarded to the IP addresses that are specified in TargetIps .
Name

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

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

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

Route 53 Resolver doesn't support updating tags through CloudFormation.
TargetIps

An array that contains the IP addresses and ports that an outbound endpoint forwards DNS queries to.

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.
RenderProperties(IDictionary<String, Object>)

Constructors

CfnResolverRule(Construct, String, ICfnResolverRuleProps)

Create a new AWS::Route53Resolver::ResolverRule.

public CfnResolverRule(Construct scope, string id, ICfnResolverRuleProps props)
Parameters
scope Construct
  • scope in which this resource is defined.
id System.String
  • scoped id of the resource.
props ICfnResolverRuleProps
  • resource properties.

CfnResolverRule(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected CfnResolverRule(ByRefValue reference)
Parameters
reference Amazon.JSII.Runtime.Deputy.ByRefValue

The Javascript-owned object reference

CfnResolverRule(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected CfnResolverRule(DeputyBase.DeputyProps props)
Parameters
props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps

The deputy props

Properties

AttrArn

The Amazon Resource Name (ARN) of the resolver rule, such as arn:aws:route53resolver:us-east-1:123456789012:resolver-rule/resolver-rule-a1bzhi .

public virtual string AttrArn { get; }
Property Value

System.String

Remarks

CloudformationAttribute: Arn

AttrDomainName

DNS queries for this domain name are forwarded to the IP addresses that are specified in TargetIps.

public virtual string AttrDomainName { get; }
Property Value

System.String

Remarks

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

CloudformationAttribute: DomainName

AttrName

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

public virtual string AttrName { get; }
Property Value

System.String

Remarks

CloudformationAttribute: Name

AttrResolverEndpointId

The ID of the outbound endpoint that the rule is associated with, such as rslvr-out-fdc049932dexample .

public virtual string AttrResolverEndpointId { get; }
Property Value

System.String

Remarks

CloudformationAttribute: ResolverEndpointId

AttrResolverRuleId

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 .

public virtual string AttrResolverRuleId { get; }
Property Value

System.String

Remarks

This value isn't applicable when RuleType is SYSTEM .

CloudformationAttribute: ResolverRuleId

AttrTargetIps

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.

public virtual IResolvable AttrTargetIps { get; }
Property Value

IResolvable

Remarks

This value isn't applicable when RuleType is SYSTEM .

CloudformationAttribute: TargetIps

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value

System.String

CfnProperties

protected override IDictionary<string, object> CfnProperties { get; }
Property Value

System.Collections.Generic.IDictionary<System.String, System.Object>

Overrides

DomainName

DNS queries for this domain name are forwarded to the IP addresses that are specified in TargetIps .

public virtual string DomainName { get; set; }
Property Value

System.String

Remarks

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

Link: 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.

public virtual string Name { get; set; }
Property Value

System.String

Remarks

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

ResolverEndpointId

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

public virtual string ResolverEndpointId { get; set; }
Property Value

System.String

Remarks

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

RuleType

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

public virtual string RuleType { get; set; }
Property Value

System.String

Remarks

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 .

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

Tags

Route 53 Resolver doesn't support updating tags through CloudFormation.

public virtual TagManager Tags { get; }
Property Value

TagManager

Remarks

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

TargetIps

An array that contains the IP addresses and ports that an outbound endpoint forwards DNS queries to.

public virtual object TargetIps { get; set; }
Property Value

System.Object

Remarks

Typically, these are the IP addresses of DNS resolvers on your network. Specify IPv4 addresses. IPv6 is not supported.

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

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)
Parameters
inspector TreeInspector
  • tree inspector to collect and process attributes.

RenderProperties(IDictionary<String, Object>)

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns

System.Collections.Generic.IDictionary<System.String, System.Object>

Overrides

Implements

Constructs.IConstruct