CfnResolverEndpoint
- class aws_cdk.aws_route53resolver.CfnResolverEndpoint(scope, id, *, direction, ip_addresses, security_group_ids, name=None, outpost_arn=None, preferred_instance_type=None, resolver_endpoint_type=None, tags=None)
Bases:
CfnResourceA CloudFormation
AWS::Route53Resolver::ResolverEndpoint.Creates a Resolver endpoint. There are two types of Resolver endpoints, inbound and outbound:
An inbound Resolver endpoint forwards DNS queries to the DNS service for a VPC from your network.
An outbound Resolver endpoint forwards DNS queries from the DNS service for a VPC to your network.
You cannot update
ResolverEndpointTypeandIpAddressesin the same request.When you update a dual-stack IP address, you must update both IP addresses. You can’t update only an IPv4 or IPv6 and keep an existing IP address.
- CloudformationResource:
AWS::Route53Resolver::ResolverEndpoint
- 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_endpoint = route53resolver.CfnResolverEndpoint(self, "MyCfnResolverEndpoint", direction="direction", ip_addresses=[route53resolver.CfnResolverEndpoint.IpAddressRequestProperty( subnet_id="subnetId", # the properties below are optional ip="ip", ipv6="ipv6" )], security_group_ids=["securityGroupIds"], # the properties below are optional name="name", outpost_arn="outpostArn", preferred_instance_type="preferredInstanceType", resolver_endpoint_type="resolverEndpointType", tags=[CfnTag( key="key", value="value" )] )
Create a new
AWS::Route53Resolver::ResolverEndpoint.- Parameters:
scope (
Construct) –scope in which this resource is defined.
id (
str) –scoped id of the resource.
direction (
str) – Indicates whether the Resolver endpoint allows inbound or outbound DNS queries:. -INBOUND: allows DNS queries to your VPC from your network -OUTBOUND: allows DNS queries from your VPC to your networkip_addresses (
Union[IResolvable,Sequence[Union[IResolvable,IpAddressRequestProperty,Dict[str,Any]]]]) – The subnets and IP addresses in your VPC that DNS queries originate from (for outbound endpoints) or that you forward DNS queries to (for inbound endpoints). The subnet ID uniquely identifies a VPC. .. epigraph:: Even though the minimum is 1, Route 53 requires that you create at least two.security_group_ids (
Sequence[str]) – The ID of one or more security groups that control access to this VPC. The security group must include one or more inbound rules (for inbound endpoints) or outbound rules (for outbound endpoints). Inbound and outbound rules must allow TCP and UDP access. For inbound access, open port 53. For outbound access, open the port that you’re using for DNS queries on your network.name (
Optional[str]) – A friendly name that lets you easily find a configuration in the Resolver dashboard in the Route 53 console.outpost_arn (
Optional[str]) –AWS::Route53Resolver::ResolverEndpoint.OutpostArn.preferred_instance_type (
Optional[str]) –AWS::Route53Resolver::ResolverEndpoint.PreferredInstanceType.resolver_endpoint_type (
Optional[str]) – The Resolver endpoint IP address type.tags (
Optional[Sequence[Union[CfnTag,Dict[str,Any]]]]) – Route 53 Resolver doesn’t support updating tags through CloudFormation.
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
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
addPropertyOverrideor prefixpathwith “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
valueargument toaddOverridewill 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
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::ResolverEndpoint'
- attr_arn
The Amazon Resource Name (ARN) of the resolver endpoint, such as
arn:aws:route53resolver:us-east-1:123456789012:resolver-endpoint/resolver-endpoint-a1bzhi.- CloudformationAttribute:
Arn
- attr_direction
Indicates whether the resolver endpoint allows inbound or outbound DNS queries.
- CloudformationAttribute:
Direction
- attr_host_vpc_id
The ID of the VPC that you want to create the resolver endpoint in.
- CloudformationAttribute:
HostVPCId
- attr_ip_address_count
The number of IP addresses that the resolver endpoint can use for DNS queries.
- CloudformationAttribute:
IpAddressCount
- attr_name
The name that you assigned to the resolver endpoint when you created the endpoint.
- CloudformationAttribute:
Name
- attr_outpost_arn
OutpostArn
- Type:
cloudformationAttribute
- attr_preferred_instance_type
PreferredInstanceType
- Type:
cloudformationAttribute
- attr_resolver_endpoint_id
The ID of the resolver endpoint.
- CloudformationAttribute:
ResolverEndpointId
- attr_resolver_endpoint_type
For the endpoint type you can choose either IPv4, IPv6.
or dual-stack. A dual-stack endpoint means that it will resolve via both IPv4 and IPv6. If you choose either IPv4 or IPv6, this endpoint type is applied to all IP addresses.
- CloudformationAttribute:
ResolverEndpointType
- 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.
- direction
.
INBOUND: allows DNS queries to your VPC from your networkOUTBOUND: allows DNS queries from your VPC to your network
- Link:
- Type:
Indicates whether the Resolver endpoint allows inbound or outbound DNS queries
- ip_addresses
The subnets and IP addresses in your VPC that DNS queries originate from (for outbound endpoints) or that you forward DNS queries to (for inbound endpoints).
The subnet ID uniquely identifies a VPC. .. epigraph:
Even though the minimum is 1, Route 53 requires that you create at least two.
- 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
A friendly name that lets you easily find a configuration in the Resolver dashboard in the Route 53 console.
- node
The construct tree node associated with this construct.
- outpost_arn
AWS::Route53Resolver::ResolverEndpoint.OutpostArn.
- preferred_instance_type
AWS::Route53Resolver::ResolverEndpoint.PreferredInstanceType.
- 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_type
The Resolver endpoint IP address type.
- security_group_ids
The ID of one or more security groups that control access to this VPC.
The security group must include one or more inbound rules (for inbound endpoints) or outbound rules (for outbound endpoints). Inbound and outbound rules must allow TCP and UDP access. For inbound access, open port 53. For outbound access, open the port that you’re using for DNS queries on your network.
- 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.
Static Methods
- classmethod is_cfn_element(x)
Returns
trueif a construct is a stack element (i.e. part of the synthesized cloudformation template).Uses duck-typing instead of
instanceofto 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
IpAddressRequestProperty
- class CfnResolverEndpoint.IpAddressRequestProperty(*, subnet_id, ip=None, ipv6=None)
Bases:
objectIn a CreateResolverEndpoint request, the IP address that DNS queries originate from (for outbound endpoints) or that you forward DNS queries to (for inbound endpoints).
IpAddressRequestalso includes the ID of the subnet that contains the IP address.- Parameters:
subnet_id (
str) – The ID of the subnet that contains the IP address.ip (
Optional[str]) – The IPv4 address that you want to use for DNS queries.ipv6 (
Optional[str]) – The IPv6 address that you want to use for DNS queries.
- 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 ip_address_request_property = route53resolver.CfnResolverEndpoint.IpAddressRequestProperty( subnet_id="subnetId", # the properties below are optional ip="ip", ipv6="ipv6" )
Attributes
- ip
The IPv4 address that you want to use for DNS queries.
- ipv6
The IPv6 address that you want to use for DNS queries.
- subnet_id
The ID of the subnet that contains the IP address.