aws-cdk-lib.aws_route53resolver.CfnResolverEndpoint

class CfnResolverEndpoint (construct)

LanguageType name
.NETAmazon.CDK.AWS.Route53Resolver.CfnResolverEndpoint
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsroute53resolver#CfnResolverEndpoint
Javasoftware.amazon.awscdk.services.route53resolver.CfnResolverEndpoint
Pythonaws_cdk.aws_route53resolver.CfnResolverEndpoint
TypeScript aws-cdk-lib » aws_route53resolver » CfnResolverEndpoint

Implements IConstruct, IDependable, IInspectable

A 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 ResolverEndpointType and IpAddresses in 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.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_route53resolver as route53resolver } from 'aws-cdk-lib';
const cfnResolverEndpoint = new route53resolver.CfnResolverEndpoint(this, 'MyCfnResolverEndpoint', {
  direction: 'direction',
  ipAddresses: [{
    subnetId: 'subnetId',

    // the properties below are optional
    ip: 'ip',
    ipv6: 'ipv6',
  }],
  securityGroupIds: ['securityGroupIds'],

  // the properties below are optional
  name: 'name',
  outpostArn: 'outpostArn',
  preferredInstanceType: 'preferredInstanceType',
  resolverEndpointType: 'resolverEndpointType',
  tags: [{
    key: 'key',
    value: 'value',
  }],
});

Initializer

new CfnResolverEndpoint(scope: Construct, id: string, props: CfnResolverEndpointProps)

Parameters

  • scope Construct — - scope in which this resource is defined.
  • id string — - scoped id of the resource.
  • props CfnResolverEndpointProps — - resource properties.

Create a new AWS::Route53Resolver::ResolverEndpoint.

Construct Props

NameTypeDescription
directionstringIndicates whether the Resolver endpoint allows inbound or outbound DNS queries:.
ipAddressesIResolvable | IResolvable | IpAddressRequestProperty[]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).
securityGroupIdsstring[]The ID of one or more security groups that control access to this VPC.
name?stringA friendly name that lets you easily find a configuration in the Resolver dashboard in the Route 53 console.
outpostArn?stringAWS::Route53Resolver::ResolverEndpoint.OutpostArn.
preferredInstanceType?stringAWS::Route53Resolver::ResolverEndpoint.PreferredInstanceType.
resolverEndpointType?stringThe Resolver endpoint IP address type.
tags?CfnTag[]Route 53 Resolver doesn't support updating tags through CloudFormation.

direction

Type: string

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

ipAddresses

Type: IResolvable | IResolvable | IpAddressRequestProperty[]

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.


securityGroupIds

Type: string[]

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?

Type: string (optional)

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


outpostArn?

Type: string (optional)

AWS::Route53Resolver::ResolverEndpoint.OutpostArn.


preferredInstanceType?

Type: string (optional)

AWS::Route53Resolver::ResolverEndpoint.PreferredInstanceType.


resolverEndpointType?

Type: string (optional)

The Resolver endpoint IP address type.


tags?

Type: CfnTag[] (optional)

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

Properties

NameTypeDescription
attrArnstringThe Amazon Resource Name (ARN) of the resolver endpoint, such as arn:aws:route53resolver:us-east-1:123456789012:resolver-endpoint/resolver-endpoint-a1bzhi .
attrDirectionstringIndicates whether the resolver endpoint allows inbound or outbound DNS queries.
attrHostVpcIdstringThe ID of the VPC that you want to create the resolver endpoint in.
attrIpAddressCountstringThe number of IP addresses that the resolver endpoint can use for DNS queries.
attrNamestringThe name that you assigned to the resolver endpoint when you created the endpoint.
attrOutpostArnstring
attrPreferredInstanceTypestring
attrResolverEndpointIdstringThe ID of the resolver endpoint.
attrResolverEndpointTypestringFor the endpoint type you can choose either IPv4, IPv6.
cfnOptionsICfnResourceOptionsOptions for this resource, such as condition, update policy etc.
cfnProperties{ [string]: any }
cfnResourceTypestringAWS resource type.
creationStackstring[]
directionstringIndicates whether the Resolver endpoint allows inbound or outbound DNS queries:.
ipAddressesIResolvable | IResolvable | IpAddressRequestProperty[]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).
logicalIdstringThe logical ID for this CloudFormation stack element.
nodeNodeThe tree node.
refstringReturn a string that will be resolved to a CloudFormation { Ref } for this element.
securityGroupIdsstring[]The ID of one or more security groups that control access to this VPC.
stackStackThe stack in which this element is defined.
tagsTagManagerRoute 53 Resolver doesn't support updating tags through CloudFormation.
name?stringA friendly name that lets you easily find a configuration in the Resolver dashboard in the Route 53 console.
outpostArn?stringAWS::Route53Resolver::ResolverEndpoint.OutpostArn.
preferredInstanceType?stringAWS::Route53Resolver::ResolverEndpoint.PreferredInstanceType.
resolverEndpointType?stringThe Resolver endpoint IP address type.
static CFN_RESOURCE_TYPE_NAMEstringThe CloudFormation resource type name for this resource class.

attrArn

Type: string

The Amazon Resource Name (ARN) of the resolver endpoint, such as arn:aws:route53resolver:us-east-1:123456789012:resolver-endpoint/resolver-endpoint-a1bzhi .


attrDirection

Type: string

Indicates whether the resolver endpoint allows inbound or outbound DNS queries.


attrHostVpcId

Type: string

The ID of the VPC that you want to create the resolver endpoint in.


attrIpAddressCount

Type: string

The number of IP addresses that the resolver endpoint can use for DNS queries.


attrName

Type: string

The name that you assigned to the resolver endpoint when you created the endpoint.


attrOutpostArn

Type: string


attrPreferredInstanceType

Type: string


attrResolverEndpointId

Type: string

The ID of the resolver endpoint.


attrResolverEndpointType

Type: string

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.


cfnOptions

Type: ICfnResourceOptions

Options for this resource, such as condition, update policy etc.


cfnProperties

Type: { [string]: any }


cfnResourceType

Type: string

AWS resource type.


creationStack

Type: string[]


direction

Type: string

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

ipAddresses

Type: IResolvable | IResolvable | IpAddressRequestProperty[]

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.


logicalId

Type: string

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).


node

Type: Node

The tree node.


ref

Type: string

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 }).


securityGroupIds

Type: string[]

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

Type: Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).


tags

Type: TagManager

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


name?

Type: string (optional)

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


outpostArn?

Type: string (optional)

AWS::Route53Resolver::ResolverEndpoint.OutpostArn.


preferredInstanceType?

Type: string (optional)

AWS::Route53Resolver::ResolverEndpoint.PreferredInstanceType.


resolverEndpointType?

Type: string (optional)

The Resolver endpoint IP address type.


static CFN_RESOURCE_TYPE_NAME

Type: string

The CloudFormation resource type name for this resource class.

Methods

NameDescription
addDeletionOverride(path)Syntactic sugar for addOverride(path, undefined).
addDependency(target)Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addDependsOn(target)⚠️Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addMetadata(key, value)Add a value to the CloudFormation Resource Metadata.
addOverride(path, value)Adds an override to the synthesized CloudFormation resource.
addPropertyDeletionOverride(propertyPath)Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride(propertyPath, value)Adds an override to a resource property.
applyRemovalPolicy(policy?, options?)Sets the deletion policy of the resource based on the removal policy specified.
getAtt(attributeName, typeHint?)Returns a token for an runtime attribute of this resource.
getMetadata(key)Retrieve a value value from the CloudFormation Resource Metadata.
inspect(inspector)Examines the CloudFormation resource and discloses attributes.
obtainDependencies()Retrieves an array of resources this resource depends on.
obtainResourceDependencies()Get a shallow copy of dependencies between this resource and other resources in the same stack.
overrideLogicalId(newLogicalId)Overrides the auto-generated logical ID with a specific ID.
removeDependency(target)Indicates that this resource no longer depends on another resource.
replaceDependency(target, newTarget)Replaces one dependency with another.
toString()Returns a string representation of this construct.
protected renderProperties(props)

addDeletionOverride(path)

public addDeletionOverride(path: string): void

Parameters

  • path string — The path of the value to delete.

Syntactic sugar for addOverride(path, undefined).


addDependency(target)

public addDependency(target: CfnResource): void

Parameters

  • target CfnResource

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.


addDependsOn(target)⚠️

public addDependsOn(target: CfnResource): void

⚠️ Deprecated: use addDependency

Parameters

  • target CfnResource

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.


addMetadata(key, value)

public addMetadata(key: string, value: any): void

Parameters

  • key string
  • value any

Add a value to the CloudFormation Resource Metadata.

See also: [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.](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.)


addOverride(path, value)

public addOverride(path: string, value: any): void

Parameters

  • path string — - The path of the property, you can use dot notation to override values in complex types.
  • value any — - The value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path 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,

cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride 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.


addPropertyDeletionOverride(propertyPath)

public addPropertyDeletionOverride(propertyPath: string): void

Parameters

  • propertyPath string — The path to the property.

Adds an override that deletes the value of a property from the resource definition.


addPropertyOverride(propertyPath, value)

public addPropertyOverride(propertyPath: string, value: any): void

Parameters

  • propertyPath string — The path of the property.
  • value any — The value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).


applyRemovalPolicy(policy?, options?)

public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void

Parameters

  • policy RemovalPolicy
  • options RemovalPolicyOptions

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). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

See also: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options


getAtt(attributeName, typeHint?)

public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference

Parameters

  • attributeName string — The name of the attribute.
  • typeHint ResolutionTypeHint

Returns

  • Reference

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.


getMetadata(key)

public getMetadata(key: string): any

Parameters

  • key string

Returns

  • any

Retrieve a value value from the CloudFormation Resource Metadata.

See also: [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.](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)

public inspect(inspector: TreeInspector): void

Parameters

  • inspector TreeInspector — - tree inspector to collect and process attributes.

Examines the CloudFormation resource and discloses attributes.


obtainDependencies()

public obtainDependencies(): Stack &#124; CfnResource[]

Returns

  • Stack | CfnResource[]

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.


obtainResourceDependencies()

public obtainResourceDependencies(): CfnResource[]

Returns

  • CfnResource[]

Get a shallow copy of dependencies between this resource and other resources in the same stack.


overrideLogicalId(newLogicalId)

public overrideLogicalId(newLogicalId: string): void

Parameters

  • newLogicalId string — The new logical ID to use for this stack element.

Overrides the auto-generated logical ID with a specific ID.


removeDependency(target)

public removeDependency(target: CfnResource): void

Parameters

  • target CfnResource

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.


replaceDependency(target, newTarget)

public replaceDependency(target: CfnResource, newTarget: CfnResource): void

Parameters

  • target CfnResource — The dependency to replace.
  • newTarget CfnResource — The new dependency to add.

Replaces one dependency with another.


toString()

public toString(): string

Returns

  • string

Returns a string representation of this construct.


protected renderProperties(props)

protected renderProperties(props: { [string]: any }): { [string]: any }

Parameters

  • props { [string]: any }

Returns

  • { [string]: any }