CfnResolverEndpoint (software.amazon.awscdk:aws-cdk-lib 2.42.1 API)

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

All Implemented Interfaces:: IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:41.703Z")
 @Stability(value=Stable)
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.

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")
                 .build()))
         .securityGroupIds(List.of("securityGroupIds"))
         // the properties below are optional
         .name("name")
         .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 class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode

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

Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default

Field Summary

Fields
Modifier and Type Field and Description

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

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

Constructor Summary

Constructors
Modifier	Constructor and Description
	`CfnResolverEndpoint(software.constructs.Construct scope, 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
`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` .
`String`	`getAttrDirection()` Indicates whether the resolver endpoint allows inbound or outbound DNS queries.
`String`	`getAttrHostVpcId()` The ID of the VPC that you want to create the resolver endpoint in.
`String`	`getAttrIpAddressCount()` The number of IP addresses that the resolver endpoint can use for DNS queries.
`String`	`getAttrName()` The name that you assigned to the resolver endpoint when you created the endpoint.
`String`	`getAttrResolverEndpointId()` The ID of the resolver endpoint.
`protected Map<String,Object>`	`getCfnProperties()`
`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).
`String`	`getName()` A friendly name that lets you easily find a configuration in the Resolver dashboard in the Route 53 console.
`List<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 Map<String,Object>`	`renderProperties(Map<String,Object> props)`
`void`	`setDirection(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(List<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(String value)` A friendly name that lets you easily find a configuration in the Resolver dashboard in the Route 53 console.
`void`	`setSecurityGroupIds(List<String> value)` The ID of one or more security groups that control access to this VPC.

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

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

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

Methods inherited from class software.constructs.Construct
getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson

- Field Detail
  - CFN_RESOURCE_TYPE_NAME
```
@Stability(value=Stable)
public static final 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
```
@Stability(value=Stable)
public CfnResolverEndpoint(@NotNull
                                                    software.constructs.Construct scope,
                                                    @NotNull
                                                    String id,
                                                    @NotNull
                                                    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
```
@Stability(value=Stable)
public void inspect(@NotNull
                                             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
```
@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)
```
    Overrides:
    
    renderProperties in class CfnResource
    
    Parameters:
    
    props - This parameter is required.
  - getAttrArn
```
@Stability(value=Stable)
 @NotNull
public 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
```
@Stability(value=Stable)
 @NotNull
public String getAttrDirection()
```
    Indicates whether the resolver endpoint allows inbound or outbound DNS queries.
  - getAttrHostVpcId
```
@Stability(value=Stable)
 @NotNull
public String getAttrHostVpcId()
```
    The ID of the VPC that you want to create the resolver endpoint in.
  - getAttrIpAddressCount
```
@Stability(value=Stable)
 @NotNull
public String getAttrIpAddressCount()
```
    The number of IP addresses that the resolver endpoint can use for DNS queries.
  - getAttrName
```
@Stability(value=Stable)
 @NotNull
public String getAttrName()
```
    The name that you assigned to the resolver endpoint when you created the endpoint.
  - getAttrResolverEndpointId
```
@Stability(value=Stable)
 @NotNull
public String getAttrResolverEndpointId()
```
    The ID of the resolver endpoint.
  - getCfnProperties
```
@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()
```
    Overrides:
    
    getCfnProperties in class CfnResource
  - getTags
```
@Stability(value=Stable)
 @NotNull
public TagManager getTags()
```
    Route 53 Resolver doesn't support updating tags through CloudFormation.
  - getDirection
```
@Stability(value=Stable)
 @NotNull
public 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
```
@Stability(value=Stable)
public void setDirection(@NotNull
                                                  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
```
@Stability(value=Stable)
 @NotNull
public 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
```
@Stability(value=Stable)
public void setIpAddresses(@NotNull
                                                    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
```
@Stability(value=Stable)
public void setIpAddresses(@NotNull
                                                    List<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
```
@Stability(value=Stable)
 @NotNull
public 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.
  - setSecurityGroupIds
```
@Stability(value=Stable)
public void setSecurityGroupIds(@NotNull
                                                         List<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
```
@Stability(value=Stable)
 @Nullable
public String getName()
```
    A friendly name that lets you easily find a configuration in the Resolver dashboard in the Route 53 console.
  - setName
```
@Stability(value=Stable)
public void setName(@Nullable
                                             String value)
```
    A friendly name that lets you easily find a configuration in the Resolver dashboard in the Route 53 console.

Class CfnResolverEndpoint

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

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

Nested classes/interfaces inherited from interface software.constructs.IConstruct

Field Summary

Constructor Summary

Method Summary

Methods inherited from class software.amazon.awscdk.CfnResource

Methods inherited from class software.amazon.awscdk.CfnRefElement

Methods inherited from class software.amazon.awscdk.CfnElement

Methods inherited from class software.constructs.Construct

Methods inherited from class software.amazon.jsii.JsiiObject

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.jsii.JsiiSerializable

Field Detail

CFN_RESOURCE_TYPE_NAME

Constructor Detail

CfnResolverEndpoint

CfnResolverEndpoint

CfnResolverEndpoint

Method Detail

inspect

renderProperties

getAttrArn

getAttrDirection

getAttrHostVpcId

getAttrIpAddressCount

getAttrName

getAttrResolverEndpointId

getCfnProperties

getTags

getDirection

setDirection

getIpAddresses

setIpAddresses

setIpAddresses

getSecurityGroupIds

setSecurityGroupIds

getName

setName