CfnResolverEndpoint

java.lang.Object
- software.constructs.Construct
- - software.amazon.awscdk.core.Construct
  - - software.amazon.awscdk.core.CfnElement
    - - software.amazon.awscdk.core.CfnRefElement
      - software.amazon.awscdk.core.CfnResource
        
        software.amazon.awscdk.services.route53resolver.CfnResolverEndpoint

All Implemented Interfaces:: IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:43.863Z")
public class CfnResolverEndpoint
extends CfnResource
implements 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 software.amazon.awscdk.services.route53resolver.*;
 CfnResolverEndpoint cfnResolverEndpoint = CfnResolverEndpoint.Builder.create(this, "MyCfnResolverEndpoint")
         .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")
         .resolverEndpointType("resolverEndpointType")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`CfnResolverEndpoint.Builder` A fluent builder for `CfnResolverEndpoint`.
`static interface`	`CfnResolverEndpoint.IpAddressRequestProperty` In a [CreateResolverEndpoint](https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_CreateResolverEndpoint.html) request, the IP address that DNS queries originate from (for outbound endpoints) or that you forward DNS queries to (for inbound endpoints).

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct
IConstruct.Jsii$Default

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`CFN_RESOURCE_TYPE_NAME` The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors
Modifier	Constructor and Description
	`CfnResolverEndpoint(Construct scope, java.lang.String id, CfnResolverEndpointProps props)` Create a new `AWS::Route53Resolver::ResolverEndpoint`.
`protected`	`CfnResolverEndpoint(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)`
`protected`	`CfnResolverEndpoint(software.amazon.jsii.JsiiObjectRef objRef)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getAttrArn()` The Amazon Resource Name (ARN) of the resolver endpoint, such as `arn:aws:route53resolver:us-east-1:123456789012:resolver-endpoint/resolver-endpoint-a1bzhi` .
`java.lang.String`	`getAttrDirection()` Indicates whether the resolver endpoint allows inbound or outbound DNS queries.
`java.lang.String`	`getAttrHostVpcId()` The ID of the VPC that you want to create the resolver endpoint in.
`java.lang.String`	`getAttrIpAddressCount()` The number of IP addresses that the resolver endpoint can use for DNS queries.
`java.lang.String`	`getAttrName()` The name that you assigned to the resolver endpoint when you created the endpoint.
`java.lang.String`	`getAttrOutpostArn()`
`java.lang.String`	`getAttrPreferredInstanceType()`
`java.lang.String`	`getAttrResolverEndpointId()` The ID of the resolver endpoint.
`java.lang.String`	`getAttrResolverEndpointType()` For the endpoint type you can choose either IPv4, IPv6.
`protected java.util.Map<java.lang.String,java.lang.Object>`	`getCfnProperties()`
`java.lang.String`	`getDirection()` Indicates whether the Resolver endpoint allows inbound or outbound DNS queries:.
`java.lang.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).
`java.lang.String`	`getName()` A friendly name that lets you easily find a configuration in the Resolver dashboard in the Route 53 console.
`java.lang.String`	`getOutpostArn()` `AWS::Route53Resolver::ResolverEndpoint.OutpostArn`.
`java.lang.String`	`getPreferredInstanceType()` `AWS::Route53Resolver::ResolverEndpoint.PreferredInstanceType`.
`java.lang.String`	`getResolverEndpointType()` The Resolver endpoint IP address type.
`java.util.List<java.lang.String>`	`getSecurityGroupIds()` The ID of one or more security groups that control access to this VPC.
`TagManager`	`getTags()` Route 53 Resolver doesn't support updating tags through CloudFormation.
`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`	`setDirection(java.lang.String value)` Indicates whether the Resolver endpoint allows inbound or outbound DNS queries:.
`void`	`setIpAddresses(IResolvable value)` 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).
`void`	`setIpAddresses(java.util.List<java.lang.Object> value)` 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).
`void`	`setName(java.lang.String value)` A friendly name that lets you easily find a configuration in the Resolver dashboard in the Route 53 console.
`void`	`setOutpostArn(java.lang.String value)` `AWS::Route53Resolver::ResolverEndpoint.OutpostArn`.
`void`	`setPreferredInstanceType(java.lang.String value)` `AWS::Route53Resolver::ResolverEndpoint.PreferredInstanceType`.
`void`	`setResolverEndpointType(java.lang.String value)` The Resolver endpoint IP address type.
`void`	`setSecurityGroupIds(java.util.List<java.lang.String> value)` The ID of one or more security groups that control access to this VPC.

Methods inherited from class software.amazon.awscdk.core.CfnResource
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement
getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - CFN_RESOURCE_TYPE_NAME
```
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
```
    The CloudFormation resource type name for this resource class.
- Constructor Detail
  - CfnResolverEndpoint
```
protected CfnResolverEndpoint(software.amazon.jsii.JsiiObjectRef objRef)
```
  - CfnResolverEndpoint
```
protected CfnResolverEndpoint(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
```
  - CfnResolverEndpoint
```
public CfnResolverEndpoint(Construct scope,
                           java.lang.String id,
                           CfnResolverEndpointProps props)
```
    Create a new `AWS::Route53Resolver::ResolverEndpoint`.
    
    Parameters:
    
    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.
- Method Detail
  - inspect
```
public void inspect(TreeInspector inspector)
```
    Examines the CloudFormation resource and discloses attributes.
    
    Specified by:
    
    inspect in interface IInspectable
    
    Parameters:
    
    inspector - - tree inspector to collect and process attributes. This parameter is required.
  - renderProperties
```
protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
```
    Overrides:
    
    renderProperties in class CfnResource
    
    Parameters:
    
    props - This parameter is required.
  - getAttrArn
```
public java.lang.String getAttrArn()
```
    The Amazon Resource Name (ARN) of the resolver endpoint, such as `arn:aws:route53resolver:us-east-1:123456789012:resolver-endpoint/resolver-endpoint-a1bzhi` .
  - getAttrDirection
```
public java.lang.String getAttrDirection()
```
    Indicates whether the resolver endpoint allows inbound or outbound DNS queries.
  - getAttrHostVpcId
```
public java.lang.String getAttrHostVpcId()
```
    The ID of the VPC that you want to create the resolver endpoint in.
  - getAttrIpAddressCount
```
public java.lang.String getAttrIpAddressCount()
```
    The number of IP addresses that the resolver endpoint can use for DNS queries.
  - getAttrName
```
public java.lang.String getAttrName()
```
    The name that you assigned to the resolver endpoint when you created the endpoint.
  - getAttrOutpostArn
```
public java.lang.String getAttrOutpostArn()
```
  - getAttrPreferredInstanceType
```
public java.lang.String getAttrPreferredInstanceType()
```
  - getAttrResolverEndpointId
```
public java.lang.String getAttrResolverEndpointId()
```
    The ID of the resolver endpoint.
  - getAttrResolverEndpointType
```
public java.lang.String getAttrResolverEndpointType()
```
    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.
  - getCfnProperties
```
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
```
    Overrides:
    
    getCfnProperties in class CfnResource
  - getTags
```
public TagManager getTags()
```
    Route 53 Resolver doesn't support updating tags through CloudFormation.
  - getDirection
```
public java.lang.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
  - setDirection
```
public void setDirection(java.lang.String value)
```
    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
  - getIpAddresses
```
public java.lang.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.
  - setIpAddresses
```
public void setIpAddresses(IResolvable value)
```
    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.
  - setIpAddresses
```
public void setIpAddresses(java.util.List<java.lang.Object> value)
```
    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.
  - getSecurityGroupIds
```
public java.util.List<java.lang.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.
  - setSecurityGroupIds
```
public void setSecurityGroupIds(java.util.List<java.lang.String> value)
```
    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.
  - getName
```
public java.lang.String getName()
```
    A friendly name that lets you easily find a configuration in the Resolver dashboard in the Route 53 console.
  - setName
```
public void setName(java.lang.String value)
```
    A friendly name that lets you easily find a configuration in the Resolver dashboard in the Route 53 console.
  - getOutpostArn
```
public java.lang.String getOutpostArn()
```
    `AWS::Route53Resolver::ResolverEndpoint.OutpostArn`.
  - setOutpostArn
```
public void setOutpostArn(java.lang.String value)
```
    `AWS::Route53Resolver::ResolverEndpoint.OutpostArn`.
  - getPreferredInstanceType
```
public java.lang.String getPreferredInstanceType()
```
    `AWS::Route53Resolver::ResolverEndpoint.PreferredInstanceType`.
  - setPreferredInstanceType
```
public void setPreferredInstanceType(java.lang.String value)
```
    `AWS::Route53Resolver::ResolverEndpoint.PreferredInstanceType`.
  - getResolverEndpointType
```
public java.lang.String getResolverEndpointType()
```
    The Resolver endpoint IP address type.
  - setResolverEndpointType
```
public void setResolverEndpointType(java.lang.String value)
```
    The Resolver endpoint IP address type.

Class CfnResolverEndpoint

Nested Class Summary

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

Field Summary

Constructor Summary

Method Summary

Methods inherited from class software.amazon.awscdk.core.CfnResource

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

Methods inherited from class software.amazon.awscdk.core.CfnElement

Methods inherited from class software.amazon.awscdk.core.Construct

Methods inherited from class java.lang.Object

Field Detail

CFN_RESOURCE_TYPE_NAME

Constructor Detail

CfnResolverEndpoint

CfnResolverEndpoint

CfnResolverEndpoint

Method Detail

inspect

renderProperties

getAttrArn

getAttrDirection

getAttrHostVpcId

getAttrIpAddressCount

getAttrName

getAttrOutpostArn

getAttrPreferredInstanceType

getAttrResolverEndpointId

getAttrResolverEndpointType

getCfnProperties

getTags

getDirection

setDirection

getIpAddresses

setIpAddresses

setIpAddresses

getSecurityGroupIds

setSecurityGroupIds

getName

setName

getOutpostArn

setOutpostArn

getPreferredInstanceType

setPreferredInstanceType

getResolverEndpointType

setResolverEndpointType