@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)", date="2023-03-22T19:35:43.876Z") public class CfnResolverRule extends CfnResource implements IInspectable
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();
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.
|
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
Modifier | Constructor and Description |
---|---|
|
CfnResolverRule(Construct scope,
java.lang.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) |
Modifier and Type | Method and Description |
---|---|
java.lang.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` .
|
java.lang.String |
getAttrDomainName()
DNS queries for this domain name are forwarded to the IP addresses that are specified in TargetIps.
|
java.lang.String |
getAttrName()
A friendly name that lets you easily find a rule in the Resolver dashboard in the Route 53 console.
|
java.lang.String |
getAttrResolverEndpointId()
The ID of the outbound endpoint that the rule is associated with, such as `rslvr-out-fdc049932dexample` .
|
java.lang.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 java.util.Map<java.lang.String,java.lang.Object> |
getCfnProperties() |
java.lang.String |
getDomainName()
DNS queries for this domain name are forwarded to the IP addresses that are specified in `TargetIps` .
|
java.lang.String |
getName()
The name for the Resolver rule, which you specified when you created the Resolver rule.
|
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` .
|
TagManager |
getTags()
Tags help organize and categorize your Resolver rules.
|
java.lang.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 java.util.Map<java.lang.String,java.lang.Object> |
renderProperties(java.util.Map<java.lang.String,java.lang.Object> props) |
void |
setDomainName(java.lang.String value)
DNS queries for this domain name are forwarded to the IP addresses that are specified in `TargetIps` .
|
void |
setName(java.lang.String value)
The name for the Resolver rule, which you specified when you created the Resolver rule.
|
void |
setResolverEndpointId(java.lang.String value)
The ID of the endpoint that the rule is associated with.
|
void |
setRuleType(java.lang.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(java.util.List<java.lang.Object> value)
An array that contains the IP addresses and ports that an outbound endpoint forwards DNS queries to.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnResolverRule(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnResolverRule(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnResolverRule(Construct scope, java.lang.String id, CfnResolverRuleProps props)
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.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.public java.lang.String getAttrArn()
public java.lang.String getAttrDomainName()
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).
public java.lang.String getAttrName()
public java.lang.String getAttrResolverEndpointId()
public java.lang.String getAttrResolverRuleId()
This value isn't applicable when RuleType
is SYSTEM
.
public IResolvable getAttrTargetIps()
This value isn't applicable when RuleType
is SYSTEM
.
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public TagManager getTags()
Each tag consists of a key and an optional value, both of which you define.
public java.lang.String getDomainName()
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).
public void setDomainName(java.lang.String value)
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).
public java.lang.String getRuleType()
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
.
public void setRuleType(java.lang.String value)
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
.
public java.lang.String getName()
public void setName(java.lang.String value)
public java.lang.String getResolverEndpointId()
public void setResolverEndpointId(java.lang.String value)
public java.lang.Object getTargetIps()
Typically, these are the IP addresses of DNS resolvers on your network.
public void setTargetIps(IResolvable value)
Typically, these are the IP addresses of DNS resolvers on your network.
public void setTargetIps(java.util.List<java.lang.Object> value)
Typically, these are the IP addresses of DNS resolvers on your network.