Package software.amazon.awscdk.services.ec2

Class CfnVerifiedAccessEndpoint

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.ec2.CfnVerifiedAccessEndpoint

All Implemented Interfaces:

IInspectable, IVerifiedAccessEndpointRef, IEnvironmentAware, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)",
           date="2025-11-13T16:10:03.313Z")
@Stability(Stable)
public class CfnVerifiedAccessEndpoint
extends CfnResource
implements IInspectable, IVerifiedAccessEndpointRef, ITaggable

An AWS Verified Access endpoint specifies the application that AWS Verified Access provides access to.

It must be attached to an AWS Verified Access group. An AWS Verified Access endpoint must also have an attached access policy before you attached it to a group.

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.ec2.*;
 CfnVerifiedAccessEndpoint cfnVerifiedAccessEndpoint = CfnVerifiedAccessEndpoint.Builder.create(this, "MyCfnVerifiedAccessEndpoint")
         .attachmentType("attachmentType")
         .endpointType("endpointType")
         .verifiedAccessGroupId("verifiedAccessGroupId")
         // the properties below are optional
         .applicationDomain("applicationDomain")
         .cidrOptions(CidrOptionsProperty.builder()
                 .cidr("cidr")
                 .portRanges(List.of(PortRangeProperty.builder()
                         .fromPort(123)
                         .toPort(123)
                         .build()))
                 .protocol("protocol")
                 .subnetIds(List.of("subnetIds"))
                 .build())
         .description("description")
         .domainCertificateArn("domainCertificateArn")
         .endpointDomainPrefix("endpointDomainPrefix")
         .loadBalancerOptions(LoadBalancerOptionsProperty.builder()
                 .loadBalancerArn("loadBalancerArn")
                 .port(123)
                 .portRanges(List.of(PortRangeProperty.builder()
                         .fromPort(123)
                         .toPort(123)
                         .build()))
                 .protocol("protocol")
                 .subnetIds(List.of("subnetIds"))
                 .build())
         .networkInterfaceOptions(NetworkInterfaceOptionsProperty.builder()
                 .networkInterfaceId("networkInterfaceId")
                 .port(123)
                 .portRanges(List.of(PortRangeProperty.builder()
                         .fromPort(123)
                         .toPort(123)
                         .build()))
                 .protocol("protocol")
                 .build())
         .policyDocument("policyDocument")
         .policyEnabled(false)
         .rdsOptions(RdsOptionsProperty.builder()
                 .port(123)
                 .protocol("protocol")
                 .rdsDbClusterArn("rdsDbClusterArn")
                 .rdsDbInstanceArn("rdsDbInstanceArn")
                 .rdsDbProxyArn("rdsDbProxyArn")
                 .rdsEndpoint("rdsEndpoint")
                 .subnetIds(List.of("subnetIds"))
                 .build())
         .securityGroupIds(List.of("securityGroupIds"))
         .sseSpecification(SseSpecificationProperty.builder()
                 .customerManagedKeyEnabled(false)
                 .kmsKeyArn("kmsKeyArn")
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-verifiedaccessendpoint.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnVerifiedAccessEndpoint.Builder	A fluent builder for CfnVerifiedAccessEndpoint.
static interface	CfnVerifiedAccessEndpoint.CidrOptionsProperty	Describes the CIDR options for a Verified Access endpoint.
static interface	CfnVerifiedAccessEndpoint.LoadBalancerOptionsProperty	Describes the load balancer options when creating an AWS Verified Access endpoint using the load-balancer type.
static interface	CfnVerifiedAccessEndpoint.NetworkInterfaceOptionsProperty	Describes the network interface options when creating an AWS Verified Access endpoint using the network-interface type.
static interface	CfnVerifiedAccessEndpoint.PortRangeProperty	Describes the port range for a Verified Access endpoint.
static interface	CfnVerifiedAccessEndpoint.RdsOptionsProperty	Describes the RDS options for a Verified Access endpoint.
static interface	CfnVerifiedAccessEndpoint.SseSpecificationProperty	AWS Verified Access provides server side encryption by default to data at rest using AWS -owned KMS keys.

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

software.amazon.jsii.JsiiObject.InitializationMode

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

software.constructs.IConstruct.Jsii$Default

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

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

ITaggable.Jsii$Default, ITaggable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.interfaces.ec2.IVerifiedAccessEndpointRef

IVerifiedAccessEndpointRef.Jsii$Default, IVerifiedAccessEndpointRef.Jsii$Proxy

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnVerifiedAccessEndpoint(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnVerifiedAccessEndpoint(software.amazon.jsii.JsiiObjectRef objRef)
	CfnVerifiedAccessEndpoint(software.constructs.Construct scope, String id, CfnVerifiedAccessEndpointProps props)	Create a new AWS::EC2::VerifiedAccessEndpoint.

Method Summary

Modifier and Type	Method	Description
static IVerifiedAccessEndpointRef	fromVerifiedAccessEndpointId(software.constructs.Construct scope, String id, String verifiedAccessEndpointId)	Creates a new IVerifiedAccessEndpointRef from a verifiedAccessEndpointId.
String	getApplicationDomain()	The DNS name for users to reach your application.
String	getAttachmentType()	The type of attachment used to provide connectivity between the AWS Verified Access endpoint and the application.
String	getAttrCreationTime()	The creation time.
String	getAttrDeviceValidationDomain()	Use this to construct the redirect URI to add to your OIDC provider's allow list.
String	getAttrEndpointDomain()	The DNS name generated for the endpoint.
String	getAttrLastUpdatedTime()	The last updated time.
String	getAttrStatus()	The endpoint status.
String	getAttrVerifiedAccessEndpointId()	The ID of the Verified Access endpoint.
String	getAttrVerifiedAccessInstanceId()	The instance identifier.
protected Map<String,Object>	getCfnProperties()
Object	getCidrOptions()	The options for a CIDR endpoint.
String	getDescription()	A description for the AWS Verified Access endpoint.
String	getDomainCertificateArn()	The ARN of a public TLS/SSL certificate imported into or created with ACM.
String	getEndpointDomainPrefix()	A custom identifier that is prepended to the DNS name that is generated for the endpoint.
String	getEndpointType()	The type of AWS Verified Access endpoint.
Object	getLoadBalancerOptions()	The load balancer details if creating the AWS Verified Access endpoint as load-balancer type.
Object	getNetworkInterfaceOptions()	The options for network-interface type endpoint.
String	getPolicyDocument()	The Verified Access policy document.
Object	getPolicyEnabled()	The status of the Verified Access policy.
Object	getRdsOptions()	The options for an RDS endpoint.
List<String>	getSecurityGroupIds()	The IDs of the security groups for the endpoint.
Object	getSseSpecification()	The options for additional server side encryption.
TagManager	getTags()	Tag Manager which manages the tags for this resource.
List<CfnTag>	getTagsRaw()	The tags.
VerifiedAccessEndpointReference	getVerifiedAccessEndpointRef()	A reference to a VerifiedAccessEndpoint resource.
String	getVerifiedAccessGroupId()	The ID of the AWS Verified Access group.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setApplicationDomain(String value)	The DNS name for users to reach your application.
void	setAttachmentType(String value)	The type of attachment used to provide connectivity between the AWS Verified Access endpoint and the application.
void	setCidrOptions(IResolvable value)	The options for a CIDR endpoint.
void	setCidrOptions(CfnVerifiedAccessEndpoint.CidrOptionsProperty value)	The options for a CIDR endpoint.
void	setDescription(String value)	A description for the AWS Verified Access endpoint.
void	setDomainCertificateArn(String value)	The ARN of a public TLS/SSL certificate imported into or created with ACM.
void	setEndpointDomainPrefix(String value)	A custom identifier that is prepended to the DNS name that is generated for the endpoint.
void	setEndpointType(String value)	The type of AWS Verified Access endpoint.
void	setLoadBalancerOptions(IResolvable value)	The load balancer details if creating the AWS Verified Access endpoint as load-balancer type.
void	setLoadBalancerOptions(CfnVerifiedAccessEndpoint.LoadBalancerOptionsProperty value)	The load balancer details if creating the AWS Verified Access endpoint as load-balancer type.
void	setNetworkInterfaceOptions(IResolvable value)	The options for network-interface type endpoint.
void	setNetworkInterfaceOptions(CfnVerifiedAccessEndpoint.NetworkInterfaceOptionsProperty value)	The options for network-interface type endpoint.
void	setPolicyDocument(String value)	The Verified Access policy document.
void	setPolicyEnabled(Boolean value)	The status of the Verified Access policy.
void	setPolicyEnabled(IResolvable value)	The status of the Verified Access policy.
void	setRdsOptions(IResolvable value)	The options for an RDS endpoint.
void	setRdsOptions(CfnVerifiedAccessEndpoint.RdsOptionsProperty value)	The options for an RDS endpoint.
void	setSecurityGroupIds(List<String> value)	The IDs of the security groups for the endpoint.
void	setSseSpecification(IResolvable value)	The options for additional server side encryption.
void	setSseSpecification(CfnVerifiedAccessEndpoint.SseSpecificationProperty value)	The options for additional server side encryption.
void	setTagsRaw(List<CfnTag> value)	The tags.
void	setVerifiedAccessGroupId(String value)	The ID of the AWS Verified Access group.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getEnv, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, 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.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.interfaces.IEnvironmentAware

getEnv

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnVerifiedAccessEndpoint

protected CfnVerifiedAccessEndpoint(software.amazon.jsii.JsiiObjectRef objRef)

CfnVerifiedAccessEndpoint

protected CfnVerifiedAccessEndpoint(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnVerifiedAccessEndpoint

@Stability(Stable)
public CfnVerifiedAccessEndpoint(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnVerifiedAccessEndpointProps props)

Create a new AWS::EC2::VerifiedAccessEndpoint.

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

props - Resource properties. This parameter is required.

Method Details

fromVerifiedAccessEndpointId

@Stability(Stable)
@NotNull
public static IVerifiedAccessEndpointRef fromVerifiedAccessEndpointId(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 String verifiedAccessEndpointId)

Creates a new IVerifiedAccessEndpointRef from a verifiedAccessEndpointId.

Parameters:

scope - This parameter is required.

id - This parameter is required.

verifiedAccessEndpointId - This parameter is required.

inspect

@Stability(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(Stable)
@NotNull
protected Map<String,Object> renderProperties(@NotNull
 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrCreationTime

@Stability(Stable)
@NotNull
public String getAttrCreationTime()

The creation time.

getAttrDeviceValidationDomain

@Stability(Stable)
@NotNull
public String getAttrDeviceValidationDomain()

Use this to construct the redirect URI to add to your OIDC provider's allow list.

getAttrEndpointDomain

@Stability(Stable)
@NotNull
public String getAttrEndpointDomain()

The DNS name generated for the endpoint.

getAttrLastUpdatedTime

@Stability(Stable)
@NotNull
public String getAttrLastUpdatedTime()

The last updated time.

getAttrStatus

@Stability(Stable)
@NotNull
public String getAttrStatus()

The endpoint status.

getAttrVerifiedAccessEndpointId

@Stability(Stable)
@NotNull
public String getAttrVerifiedAccessEndpointId()

The ID of the Verified Access endpoint.

getAttrVerifiedAccessInstanceId

@Stability(Stable)
@NotNull
public String getAttrVerifiedAccessInstanceId()

The instance identifier.

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(Stable)
@NotNull
public TagManager getTags()

Tag Manager which manages the tags for this resource.

Specified by:

getTags in interface ITaggable

getVerifiedAccessEndpointRef

@Stability(Stable)
@NotNull
public VerifiedAccessEndpointReference getVerifiedAccessEndpointRef()

A reference to a VerifiedAccessEndpoint resource.

Specified by:

getVerifiedAccessEndpointRef in interface IVerifiedAccessEndpointRef

getAttachmentType

@Stability(Stable)
@NotNull
public String getAttachmentType()

The type of attachment used to provide connectivity between the AWS Verified Access endpoint and the application.

setAttachmentType

@Stability(Stable)
public void setAttachmentType(@NotNull
 String value)

The type of attachment used to provide connectivity between the AWS Verified Access endpoint and the application.

getEndpointType

@Stability(Stable)
@NotNull
public String getEndpointType()

The type of AWS Verified Access endpoint.

setEndpointType

@Stability(Stable)
public void setEndpointType(@NotNull
 String value)

The type of AWS Verified Access endpoint.

getVerifiedAccessGroupId

@Stability(Stable)
@NotNull
public String getVerifiedAccessGroupId()

The ID of the AWS Verified Access group.

setVerifiedAccessGroupId

@Stability(Stable)
public void setVerifiedAccessGroupId(@NotNull
 String value)

The ID of the AWS Verified Access group.

getApplicationDomain

@Stability(Stable)
@Nullable
public String getApplicationDomain()

The DNS name for users to reach your application.

setApplicationDomain

@Stability(Stable)
public void setApplicationDomain(@Nullable
 String value)

The DNS name for users to reach your application.

getCidrOptions

@Stability(Stable)
@Nullable
public Object getCidrOptions()

The options for a CIDR endpoint.

Returns union: either IResolvable or CfnVerifiedAccessEndpoint.CidrOptionsProperty

setCidrOptions

@Stability(Stable)
public void setCidrOptions(@Nullable
 IResolvable value)

The options for a CIDR endpoint.

setCidrOptions

@Stability(Stable)
public void setCidrOptions(@Nullable
 CfnVerifiedAccessEndpoint.CidrOptionsProperty value)

The options for a CIDR endpoint.

getDescription

@Stability(Stable)
@Nullable
public String getDescription()

A description for the AWS Verified Access endpoint.

setDescription

@Stability(Stable)
public void setDescription(@Nullable
 String value)

A description for the AWS Verified Access endpoint.

getDomainCertificateArn

@Stability(Stable)
@Nullable
public String getDomainCertificateArn()

The ARN of a public TLS/SSL certificate imported into or created with ACM.

setDomainCertificateArn

@Stability(Stable)
public void setDomainCertificateArn(@Nullable
 String value)

The ARN of a public TLS/SSL certificate imported into or created with ACM.

getEndpointDomainPrefix

@Stability(Stable)
@Nullable
public String getEndpointDomainPrefix()

A custom identifier that is prepended to the DNS name that is generated for the endpoint.

setEndpointDomainPrefix

@Stability(Stable)
public void setEndpointDomainPrefix(@Nullable
 String value)

A custom identifier that is prepended to the DNS name that is generated for the endpoint.

getLoadBalancerOptions

@Stability(Stable)
@Nullable
public Object getLoadBalancerOptions()

The load balancer details if creating the AWS Verified Access endpoint as load-balancer type.

Returns union: either IResolvable or CfnVerifiedAccessEndpoint.LoadBalancerOptionsProperty

setLoadBalancerOptions

@Stability(Stable)
public void setLoadBalancerOptions(@Nullable
 IResolvable value)

The load balancer details if creating the AWS Verified Access endpoint as load-balancer type.

setLoadBalancerOptions

@Stability(Stable)
public void setLoadBalancerOptions(@Nullable
 CfnVerifiedAccessEndpoint.LoadBalancerOptionsProperty value)

The load balancer details if creating the AWS Verified Access endpoint as load-balancer type.

getNetworkInterfaceOptions

@Stability(Stable)
@Nullable
public Object getNetworkInterfaceOptions()

The options for network-interface type endpoint.

Returns union: either IResolvable or CfnVerifiedAccessEndpoint.NetworkInterfaceOptionsProperty

setNetworkInterfaceOptions

@Stability(Stable)
public void setNetworkInterfaceOptions(@Nullable
 IResolvable value)

The options for network-interface type endpoint.

setNetworkInterfaceOptions

@Stability(Stable)
public void setNetworkInterfaceOptions(@Nullable
 CfnVerifiedAccessEndpoint.NetworkInterfaceOptionsProperty value)

The options for network-interface type endpoint.

getPolicyDocument

@Stability(Stable)
@Nullable
public String getPolicyDocument()

The Verified Access policy document.

setPolicyDocument

@Stability(Stable)
public void setPolicyDocument(@Nullable
 String value)

The Verified Access policy document.

getPolicyEnabled

@Stability(Stable)
@Nullable
public Object getPolicyEnabled()

The status of the Verified Access policy.

Returns union: either Boolean or IResolvable

setPolicyEnabled

@Stability(Stable)
public void setPolicyEnabled(@Nullable
 Boolean value)

The status of the Verified Access policy.

setPolicyEnabled

@Stability(Stable)
public void setPolicyEnabled(@Nullable
 IResolvable value)

The status of the Verified Access policy.

getRdsOptions

@Stability(Stable)
@Nullable
public Object getRdsOptions()

The options for an RDS endpoint.

Returns union: either IResolvable or CfnVerifiedAccessEndpoint.RdsOptionsProperty

setRdsOptions

@Stability(Stable)
public void setRdsOptions(@Nullable
 IResolvable value)

The options for an RDS endpoint.

setRdsOptions

@Stability(Stable)
public void setRdsOptions(@Nullable
 CfnVerifiedAccessEndpoint.RdsOptionsProperty value)

The options for an RDS endpoint.

getSecurityGroupIds

@Stability(Stable)
@Nullable
public List<String> getSecurityGroupIds()

The IDs of the security groups for the endpoint.

setSecurityGroupIds

@Stability(Stable)
public void setSecurityGroupIds(@Nullable
 List<String> value)

The IDs of the security groups for the endpoint.

getSseSpecification

@Stability(Stable)
@Nullable
public Object getSseSpecification()

The options for additional server side encryption.

Returns union: either IResolvable or CfnVerifiedAccessEndpoint.SseSpecificationProperty

setSseSpecification

@Stability(Stable)
public void setSseSpecification(@Nullable
 IResolvable value)

The options for additional server side encryption.

setSseSpecification

@Stability(Stable)
public void setSseSpecification(@Nullable
 CfnVerifiedAccessEndpoint.SseSpecificationProperty value)

The options for additional server side encryption.

getTagsRaw

@Stability(Stable)
@Nullable
public List<CfnTag> getTagsRaw()

The tags.

setTagsRaw

@Stability(Stable)
public void setTagsRaw(@Nullable
 List<CfnTag> value)

The tags.