Package software.amazon.awscdk.services.apigateway

Enum EndpointAccessMode

java.lang.Object

java.lang.Enum<EndpointAccessMode>

software.amazon.awscdk.services.apigateway.EndpointAccessMode

All Implemented Interfaces:

Serializable, Comparable<EndpointAccessMode>, java.lang.constant.Constable

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-19T12:54:56.898Z")
@Stability(Stable)
public enum EndpointAccessMode
extends Enum<EndpointAccessMode>

The endpoint access mode for the domain name.

When using enhanced security policies (those starting with SecurityPolicy_), you must set the endpoint access mode to either STRICT or BASIC. Use STRICT for production workloads requiring the highest security. Use BASIC for migration scenarios or certain application architectures.

Example:

 Object acmCertificateForExampleCom;
 // For regional or private APIs with enhanced security policy
 // For regional or private APIs with enhanced security policy
 DomainName.Builder.create(this, "custom-domain-tls13")
         .domainName("example.com")
         .certificate(acmCertificateForExampleCom)
         .securityPolicy(SecurityPolicy.TLS13_1_3_2025_09) // TLS 1.3
         .endpointAccessMode(EndpointAccessMode.STRICT)
         .build();
 // For edge-optimized APIs with enhanced security policy
 // For edge-optimized APIs with enhanced security policy
 DomainName.Builder.create(this, "custom-domain-edge-tls13")
         .domainName("example.com")
         .certificate(acmCertificateForExampleCom)
         .endpointType(EndpointType.EDGE)
         .securityPolicy(SecurityPolicy.TLS13_2025_EDGE) // Enhanced security policy for edge
         .endpointAccessMode(EndpointAccessMode.STRICT)
         .build();
 

See Also:

• https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-security-policies.html#apigateway-security-policies-endpoint-access-mode

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
BASIC	Basic mode - one of the two valid endpoint access modes for enhanced security policies.
STRICT	Strict mode - only accepts connections from clients using the specified security policy.

Method Summary

Modifier and Type	Method	Description
static EndpointAccessMode	valueOf(String name)	Returns the enum constant of this type with the specified name.
static EndpointAccessMode[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

STRICT

@Stability(Stable)
public static final EndpointAccessMode STRICT

Strict mode - only accepts connections from clients using the specified security policy.

Recommended for production workloads.

BASIC

@Stability(Stable)
public static final EndpointAccessMode BASIC

Basic mode - one of the two valid endpoint access modes for enhanced security policies.

Suitable for migration scenarios or certain application architectures. Note: legacy security policies (TLS_1_0, TLS_1_2) do not use this attribute.

Method Details

values

public static EndpointAccessMode[] values()

Returns an array containing the constants of this enum type, in the order they are declared.

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static EndpointAccessMode valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null