Package software.amazon.awscdk.services.route53resolver

Interface CfnResolverEndpointProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnResolverEndpointProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.125.0 (build fdbe357)",
           date="2026-01-19T12:04:01.347Z")
@Stability(Stable)
public interface CfnResolverEndpointProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnResolverEndpoint.

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.*;
 CfnResolverEndpointProps cfnResolverEndpointProps = CfnResolverEndpointProps.builder()
         .direction("direction")
         .ipAddresses(List.of(IpAddressRequestProperty.builder()
                 .subnetId("subnetId")
                 // the properties below are optional
                 .ip("ip")
                 .ipv6("ipv6")
                 .build()))
         .securityGroupIds(List.of("securityGroupIds"))
         // the properties below are optional
         .name("name")
         .outpostArn("outpostArn")
         .preferredInstanceType("preferredInstanceType")
         .protocols(List.of("protocols"))
         .resolverEndpointType("resolverEndpointType")
         .rniEnhancedMetricsEnabled(false)
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .targetNameServerMetricsEnabled(false)
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-resolverendpoint.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnResolverEndpointProps.Builder	A builder for CfnResolverEndpointProps
static final class	CfnResolverEndpointProps.Jsii$Proxy	An implementation for CfnResolverEndpointProps

Method Summary

Modifier and Type	Method	Description
static CfnResolverEndpointProps.Builder	builder()
String	getDirection()	Indicates whether the Resolver endpoint allows inbound or outbound DNS queries:.
Object	getIpAddresses()	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).
default String	getName()	A friendly name that lets you easily find a configuration in the Resolver dashboard in the Route 53 console.
default String	getOutpostArn()	The ARN (Amazon Resource Name) for the Outpost.
default String	getPreferredInstanceType()	The Amazon EC2 instance type.
default List<String>	getProtocols()	Protocols used for the endpoint.
default String	getResolverEndpointType()	The Resolver endpoint IP address type.
default Object	getRniEnhancedMetricsEnabled()	Indicates whether RNI enhanced metrics are enabled for the Resolver endpoint.
List<String>	getSecurityGroupIds()	The ID of one or more security groups that control access to this VPC.
default List<CfnTag>	getTags()	Route 53 Resolver doesn't support updating tags through CloudFormation.
default Object	getTargetNameServerMetricsEnabled()	Indicates whether target name server metrics are enabled for the outbound Resolver endpoint.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDirection

@Stability(Stable)
@NotNull
String getDirection()

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 network
• INBOUND_DELEGATION : Resolver delegates queries to Route 53 private hosted zones from your network.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-resolverendpoint.html#cfn-route53resolver-resolverendpoint-direction

getIpAddresses

@Stability(Stable)
@NotNull
Object getIpAddresses()

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.

Even though the minimum is 1, Route 53 requires that you create at least two.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnResolverEndpoint.IpAddressRequestProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-resolverendpoint.html#cfn-route53resolver-resolverendpoint-ipaddresses

getSecurityGroupIds

@Stability(Stable)
@NotNull
List<String> getSecurityGroupIds()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-resolverendpoint.html#cfn-route53resolver-resolverendpoint-securitygroupids

getName

@Stability(Stable)
@Nullable
default String getName()

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

See Also:

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

getOutpostArn

@Stability(Stable)
@Nullable
default String getOutpostArn()

The ARN (Amazon Resource Name) for the Outpost.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-resolverendpoint.html#cfn-route53resolver-resolverendpoint-outpostarn

getPreferredInstanceType

@Stability(Stable)
@Nullable
default String getPreferredInstanceType()

The Amazon EC2 instance type.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-resolverendpoint.html#cfn-route53resolver-resolverendpoint-preferredinstancetype

getProtocols

@Stability(Stable)
@Nullable
default List<String> getProtocols()

Protocols used for the endpoint. DoH-FIPS is applicable for a default inbound endpoints only.

For an inbound endpoint you can apply the protocols as follows:

• Do53 and DoH in combination.
• Do53 and DoH-FIPS in combination.
• Do53 alone.
• DoH alone.
• DoH-FIPS alone.
• None, which is treated as Do53.

For a delegation inbound endpoint you can use Do53 only.

For an outbound endpoint you can apply the protocols as follows:

• Do53 and DoH in combination.
• Do53 alone.
• DoH alone.
• None, which is treated as Do53.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-resolverendpoint.html#cfn-route53resolver-resolverendpoint-protocols

getResolverEndpointType

@Stability(Stable)
@Nullable
default String getResolverEndpointType()

The Resolver endpoint IP address type.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-resolverendpoint.html#cfn-route53resolver-resolverendpoint-resolverendpointtype

getRniEnhancedMetricsEnabled

@Stability(Stable)
@Nullable
default Object getRniEnhancedMetricsEnabled()

Indicates whether RNI enhanced metrics are enabled for the Resolver endpoint.

When enabled, one-minute granular metrics are published in CloudWatch for each RNI associated with this endpoint. When disabled, these metrics are not published.

Returns union: either Boolean or IResolvable

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-resolverendpoint.html#cfn-route53resolver-resolverendpoint-rnienhancedmetricsenabled

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

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

See Also:

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

getTargetNameServerMetricsEnabled

@Stability(Stable)
@Nullable
default Object getTargetNameServerMetricsEnabled()

Indicates whether target name server metrics are enabled for the outbound Resolver endpoint.

When enabled, one-minute granular metrics are published in CloudWatch for each target name server associated with this endpoint. When disabled, these metrics are not published. This feature is not supported for inbound Resolver endpoint.

Returns union: either Boolean or IResolvable

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-route53resolver-resolverendpoint.html#cfn-route53resolver-resolverendpoint-targetnameservermetricsenabled

builder

@Stability(Stable)
static CfnResolverEndpointProps.Builder builder()

Returns:

a CfnResolverEndpointProps.Builder of CfnResolverEndpointProps