software.amazon.awscdk.services.route53resolver

Class CfnResolverRule

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.route53resolver.CfnResolverRule

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:41.717Z")
 @Stability(value=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")
                 // the properties below are optional
                 .port("port")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnResolverRule.Builder A fluent builder for CfnResolverRule.
static interface	CfnResolverRule.TargetAddressProperty In a [CreateResolverRule](https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_CreateResolverRule.html) request, an array of the IPs that you want to forward DNS queries to.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnResolverRule(software.constructs.Construct scope, String id, CfnResolverRuleProps props) Create a new `AWS::Route53Resolver::ResolverRule`.
protected	CfnResolverRule(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnResolverRule(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
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` .
String	getAttrDomainName() DNS queries for this domain name are forwarded to the IP addresses that are specified in TargetIps.
String	getAttrName() A friendly name that lets you easily find a rule in the Resolver dashboard in the Route 53 console.
String	getAttrResolverEndpointId() The ID of the outbound endpoint that the rule is associated with, such as `rslvr-out-fdc049932dexample` .
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` .
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.
protected Map<String,Object>	getCfnProperties()
String	getDomainName() DNS queries for this domain name are forwarded to the IP addresses that are specified in `TargetIps` .
String	getName() The name for the Resolver rule, which you specified when you created the Resolver rule.
String	getResolverEndpointId() The ID of the endpoint that the rule is associated with.
String	getRuleType() When you want to forward DNS queries for specified domain name to resolvers on your network, specify `FORWARD` .
TagManager	getTags() Route 53 Resolver doesn't support updating tags through CloudFormation.
Object	getTargetIps() An array that contains the IP addresses and ports that an outbound endpoint forwards DNS queries to.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDomainName(String value) DNS queries for this domain name are forwarded to the IP addresses that are specified in `TargetIps` .
void	setName(String value) The name for the Resolver rule, which you specified when you created the Resolver rule.
void	setResolverEndpointId(String value) The ID of the endpoint that the rule is associated with.
void	setRuleType(String value) When you want to forward DNS queries for specified domain name to resolvers on your network, specify `FORWARD` .
void	setTargetIps(IResolvable value) An array that contains the IP addresses and ports that an outbound endpoint forwards DNS queries to.
void	setTargetIps(List<Object> value) An array that contains the IP addresses and ports that an outbound endpoint forwards DNS queries to.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnResolverRule

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

CfnResolverRule

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

CfnResolverRule

@Stability(value=Stable)
public CfnResolverRule(@NotNull
                                                software.constructs.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 Detail

inspect

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

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

getAttrResolverRuleId

@Stability(value=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(value=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(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

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

getDomainName

@Stability(value=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(value=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(value=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(value=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(value=Stable)
 @Nullable
public String getName()

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

setName

@Stability(value=Stable)
public void setName(@Nullable
                                             String value)

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

getResolverEndpointId

@Stability(value=Stable)
 @Nullable
public String getResolverEndpointId()

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

setResolverEndpointId

@Stability(value=Stable)
public void setResolverEndpointId(@Nullable
                                                           String value)

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

getTargetIps

@Stability(value=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. Specify IPv4 addresses. IPv6 is not supported.

setTargetIps

@Stability(value=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. Specify IPv4 addresses. IPv6 is not supported.

setTargetIps

@Stability(value=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. Specify IPv4 addresses. IPv6 is not supported.