Package software.amazon.awscdk.services.ec2

Interface CfnVerifiedAccessEndpointProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnVerifiedAccessEndpointProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-08T21:35:06.053Z")
@Stability(Stable)
public interface CfnVerifiedAccessEndpointProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnVerifiedAccessEndpoint.

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.*;
 CfnVerifiedAccessEndpointProps cfnVerifiedAccessEndpointProps = CfnVerifiedAccessEndpointProps.builder()
         .applicationDomain("applicationDomain")
         .attachmentType("attachmentType")
         .domainCertificateArn("domainCertificateArn")
         .endpointDomainPrefix("endpointDomainPrefix")
         .endpointType("endpointType")
         .verifiedAccessGroupId("verifiedAccessGroupId")
         // the properties below are optional
         .description("description")
         .loadBalancerOptions(LoadBalancerOptionsProperty.builder()
                 .loadBalancerArn("loadBalancerArn")
                 .port(123)
                 .protocol("protocol")
                 .subnetIds(List.of("subnetIds"))
                 .build())
         .networkInterfaceOptions(NetworkInterfaceOptionsProperty.builder()
                 .networkInterfaceId("networkInterfaceId")
                 .port(123)
                 .protocol("protocol")
                 .build())
         .policyDocument("policyDocument")
         .policyEnabled(false)
         .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	Interface	Description
static final class	CfnVerifiedAccessEndpointProps.Builder	A builder for CfnVerifiedAccessEndpointProps
static final class	CfnVerifiedAccessEndpointProps.Jsii$Proxy	An implementation for CfnVerifiedAccessEndpointProps

Method Summary

Modifier and Type	Method	Description
static CfnVerifiedAccessEndpointProps.Builder	builder()
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.
default 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.
default Object	getLoadBalancerOptions()	The load balancer details if creating the AWS Verified Access endpoint as load-balancer type.
default Object	getNetworkInterfaceOptions()	The options for network-interface type endpoint.
default String	getPolicyDocument()	The Verified Access policy document.
default Object	getPolicyEnabled()	The status of the Verified Access policy.
default List<String>	getSecurityGroupIds()	The IDs of the security groups for the endpoint.
default Object	getSseSpecification()	The options for additional server side encryption.
default List<CfnTag>	getTags()	The tags.
String	getVerifiedAccessGroupId()	The ID of the AWS Verified Access group.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getApplicationDomain

@Stability(Stable)
@NotNull
String getApplicationDomain()

The DNS name for users to reach your application.

See Also:

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

getAttachmentType

@Stability(Stable)
@NotNull
String getAttachmentType()

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

See Also:

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

getDomainCertificateArn

@Stability(Stable)
@NotNull
String getDomainCertificateArn()

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

See Also:

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

getEndpointDomainPrefix

@Stability(Stable)
@NotNull
String getEndpointDomainPrefix()

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

See Also:

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

getEndpointType

@Stability(Stable)
@NotNull
String getEndpointType()

The type of AWS Verified Access endpoint.

Incoming application requests will be sent to an IP address, load balancer or a network interface depending on the endpoint type specified.

See Also:

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

getVerifiedAccessGroupId

@Stability(Stable)
@NotNull
String getVerifiedAccessGroupId()

The ID of the AWS Verified Access group.

See Also:

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

getDescription

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

A description for the AWS Verified Access endpoint.

See Also:

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

getLoadBalancerOptions

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

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

See Also:

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

getNetworkInterfaceOptions

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

The options for network-interface type endpoint.

See Also:

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

getPolicyDocument

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

The Verified Access policy document.

See Also:

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

getPolicyEnabled

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

The status of the Verified Access policy.

See Also:

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

getSecurityGroupIds

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

The IDs of the security groups for the endpoint.

See Also:

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

getSseSpecification

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

The options for additional server side encryption.

See Also:

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

getTags

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

The tags.

See Also:

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

builder

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

Returns:

a CfnVerifiedAccessEndpointProps.Builder of CfnVerifiedAccessEndpointProps