CfnResolverRule
- class aws_cdk.aws_route53resolver.CfnResolverRule(scope, id, *, domain_name, rule_type, name=None, resolver_endpoint_id=None, tags=None, target_ips=None)
Bases:
CfnResource
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.
- CloudformationResource
AWS::Route53Resolver::ResolverRule
- Link
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_route53resolver as route53resolver cfn_resolver_rule = route53resolver.CfnResolverRule(self, "MyCfnResolverRule", 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", # the properties below are optional port="port" )] )
Create a new
AWS::Route53Resolver::ResolverRule
.- Parameters
scope (
Construct
) –scope in which this resource is defined.
id (
str
) –scoped id of the resource.
domain_name (
str
) – DNS queries for this domain name are forwarded to the IP addresses that are specified inTargetIps
. 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, specifyFORWARD
. 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, specifySYSTEM
. For example, to forward DNS queries for example.com to resolvers on your network, you create a rule and specifyFORWARD
forRuleType
. To then have Resolver process queries for apex.example.com, you create a rule and specifySYSTEM
forRuleType
. Currently, only Resolver can create rules that have a value ofRECURSIVE
forRuleType
.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
]]]]) – Route 53 Resolver doesn’t support updating tags through CloudFormation.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. Specify IPv4 addresses. IPv6 is not supported.
Methods
- add_deletion_override(path)
Syntactic sugar for
addOverride(path, undefined)
.- Parameters
path (
str
) – The path of the value to delete.- Return type
None
- add_depends_on(target)
Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.
- Parameters
target (
CfnResource
) –- Return type
None
- add_metadata(key, value)
Add a value to the CloudFormation Resource Metadata.
- Parameters
key (
str
) –value (
Any
) –
- See
- Return type
None
https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.
- add_override(path, value)
Adds an override to the synthesized CloudFormation resource.
To add a property override, either use
addPropertyOverride
or prefixpath
with “Properties.” (i.e.Properties.TopicName
).If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.
To include a literal
.
in the property name, prefix with a\
. In most programming languages you will need to write this as"\\."
because the\
itself will need to be escaped.For example:
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"]) cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")
would add the overrides Example:
"Properties": { "GlobalSecondaryIndexes": [ { "Projection": { "NonKeyAttributes": [ "myattribute" ] ... } ... }, { "ProjectionType": "INCLUDE" ... }, ] ... }
The
value
argument toaddOverride
will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.- Parameters
path (
str
) –The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
value (
Any
) –The value. Could be primitive or complex.
- Return type
None
- add_property_deletion_override(property_path)
Adds an override that deletes the value of a property from the resource definition.
- Parameters
property_path (
str
) – The path to the property.- Return type
None
- add_property_override(property_path, value)
Adds an override to a resource property.
Syntactic sugar for
addOverride("Properties.<...>", value)
.- Parameters
property_path (
str
) – The path of the property.value (
Any
) – The value.
- Return type
None
- apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)
Sets the deletion policy of the resource based on the removal policy specified.
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.
The resource can be deleted (
RemovalPolicy.DESTROY
), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN
).- Parameters
policy (
Optional
[RemovalPolicy
]) –apply_to_update_replace_policy (
Optional
[bool
]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: truedefault (
Optional
[RemovalPolicy
]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resoure, please consult that specific resource’s documentation.
- Return type
None
- get_att(attribute_name)
Returns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g.
resource.arn
), but this can be used for future compatibility in case there is no generated attribute.- Parameters
attribute_name (
str
) – The name of the attribute.- Return type
- get_metadata(key)
Retrieve a value value from the CloudFormation Resource Metadata.
- Parameters
key (
str
) –- See
- Return type
Any
https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.
- inspect(inspector)
Examines the CloudFormation resource and discloses attributes.
- Parameters
inspector (
TreeInspector
) –tree inspector to collect and process attributes.
- Return type
None
- override_logical_id(new_logical_id)
Overrides the auto-generated logical ID with a specific ID.
- Parameters
new_logical_id (
str
) – The new logical ID to use for this stack element.- Return type
None
- to_string()
Returns a string representation of this construct.
- Return type
str
- Returns
a string representation of this resource
Attributes
- CFN_RESOURCE_TYPE_NAME = 'AWS::Route53Resolver::ResolverRule'
- attr_arn
The Amazon Resource Name (ARN) of the resolver rule, such as
arn:aws:route53resolver:us-east-1:123456789012:resolver-rule/resolver-rule-a1bzhi
.- CloudformationAttribute
Arn
- attr_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).
- CloudformationAttribute
DomainName
- attr_name
A friendly name that lets you easily find a rule in the Resolver dashboard in the Route 53 console.
- CloudformationAttribute
Name
- attr_resolver_endpoint_id
The ID of the outbound endpoint that the rule is associated with, such as
rslvr-out-fdc049932dexample
.- CloudformationAttribute
ResolverEndpointId
- attr_resolver_rule_id
When the value of
RuleType
isFORWARD
, the ID that Resolver assigned to the resolver rule when you created it, such asrslvr-rr-5328a0899aexample
.This value isn’t applicable when
RuleType
isSYSTEM
.- CloudformationAttribute
ResolverRuleId
- attr_target_ips
When the value of
RuleType
isFORWARD
, 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
isSYSTEM
.- CloudformationAttribute
TargetIps
- cfn_options
Options for this resource, such as condition, update policy etc.
- cfn_resource_type
AWS resource type.
- creation_stack
return:
the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.
- 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).
- logical_id
The logical ID for this CloudFormation stack element.
The logical ID of the element is calculated from the path of the resource node in the construct tree.
To override this value, use
overrideLogicalId(newLogicalId)
.- Returns
the logical ID as a stringified token. This value will only get resolved during synthesis.
- name
The name for the Resolver rule, which you specified when you created the Resolver rule.
- node
The construct tree node associated with this construct.
- ref
Return a string that will be resolved to a CloudFormation
{ Ref }
for this element.If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through
Lazy.any({ produce: resource.ref })
.
- resolver_endpoint_id
The ID of the endpoint that the rule is associated with.
- 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
forRuleType
. To then have Resolver process queries for apex.example.com, you create a rule and specifySYSTEM
forRuleType
.Currently, only Resolver can create rules that have a value of
RECURSIVE
forRuleType
.
- stack
The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
- tags
Route 53 Resolver doesn’t support updating tags through CloudFormation.
- 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. Specify IPv4 addresses. IPv6 is not supported.
Static Methods
- classmethod is_cfn_element(x)
Returns
true
if a construct is a stack element (i.e. part of the synthesized cloudformation template).Uses duck-typing instead of
instanceof
to allow stack elements from different versions of this library to be included in the same stack.- Parameters
x (
Any
) –- Return type
bool
- Returns
The construct as a stack element or undefined if it is not a stack element.
- classmethod is_cfn_resource(construct)
Check whether the given construct is a CfnResource.
- Parameters
construct (
IConstruct
) –- Return type
bool
- classmethod is_construct(x)
Return whether the given object is a Construct.
- Parameters
x (
Any
) –- Return type
bool
TargetAddressProperty
- class CfnResolverRule.TargetAddressProperty(*, ip, port=None)
Bases:
object
In a CreateResolverRule request, an array of the IPs that you want to forward DNS queries to.
- Parameters
ip (
str
) – One IP address that you want to forward DNS queries to. You can specify only IPv4 addresses.port (
Optional
[str
]) – The port atIp
that you want to forward DNS queries to.
- Link
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_route53resolver as route53resolver target_address_property = route53resolver.CfnResolverRule.TargetAddressProperty( ip="ip", # the properties below are optional port="port" )
Attributes
- ip
One IP address that you want to forward DNS queries to.
You can specify only IPv4 addresses.
- port
The port at
Ip
that you want to forward DNS queries to.