Package software.amazon.awscdk.services.apigateway

Enum SecurityPolicy

java.lang.Object

java.lang.Enum<SecurityPolicy>

software.amazon.awscdk.services.apigateway.SecurityPolicy

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-04-02T21:55:03.744Z")
@Stability(Stable)
public enum SecurityPolicy
extends Enum<SecurityPolicy>

The minimum version of the SSL protocol that you want API Gateway to use for HTTPS connections.

Example:

 Object acmCertificateForExampleCom;
 DomainName.Builder.create(this, "custom-domain")
         .domainName("example.com")
         .certificate(acmCertificateForExampleCom)
         .endpointType(EndpointType.EDGE) // default is REGIONAL
         .securityPolicy(SecurityPolicy.TLS_1_2)
         .build();
 

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
TLS_1_0	Cipher suite TLS 1.0.
TLS_1_2	Cipher suite TLS 1.2.
TLS12_2018_EDGE	Cipher suite TLS 1.2 for edge-optimized endpoints (legacy).
TLS12_PFS_2025_EDGE	Cipher suite TLS 1.2 with Perfect Forward Secrecy for edge-optimized endpoints.
TLS13_1_2_PFS_PQ_2025_09	Cipher suite TLS 1.3 and TLS 1.2 with Perfect Forward Secrecy and post-quantum cryptography for regional/private endpoints.
TLS13_1_2_PQ_2025_09	Cipher suite TLS 1.3 and TLS 1.2 with post-quantum cryptography for regional/private endpoints.
TLS13_1_3_2025_09	Cipher suite TLS 1.3 for regional/private endpoints.
TLS13_1_3_FIPS_2025_09	Cipher suite TLS 1.3 (FIPS compliant) for regional/private endpoints.
TLS13_2025_EDGE	Cipher suite TLS 1.3 for edge-optimized endpoints.

Method Summary

Modifier and Type	Method	Description
static SecurityPolicy	valueOf(String name)	Returns the enum constant of this type with the specified name.
static SecurityPolicy[]	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

TLS_1_0

@Stability(Stable)
public static final SecurityPolicy TLS_1_0

Cipher suite TLS 1.0.

TLS_1_2

@Stability(Stable)
public static final SecurityPolicy TLS_1_2

Cipher suite TLS 1.2.

TLS13_1_3_2025_09

@Stability(Stable)
public static final SecurityPolicy TLS13_1_3_2025_09

Cipher suite TLS 1.3 for regional/private endpoints.

See Also:

• https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-custom-domain-tls-version.html

TLS13_1_3_FIPS_2025_09

@Stability(Stable)
public static final SecurityPolicy TLS13_1_3_FIPS_2025_09

Cipher suite TLS 1.3 (FIPS compliant) for regional/private endpoints.

See Also:

• https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-custom-domain-tls-version.html

TLS13_1_2_PQ_2025_09

@Stability(Stable)
public static final SecurityPolicy TLS13_1_2_PQ_2025_09

Cipher suite TLS 1.3 and TLS 1.2 with post-quantum cryptography for regional/private endpoints.

See Also:

• https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-custom-domain-tls-version.html

TLS13_1_2_PFS_PQ_2025_09

@Stability(Stable)
public static final SecurityPolicy TLS13_1_2_PFS_PQ_2025_09

Cipher suite TLS 1.3 and TLS 1.2 with Perfect Forward Secrecy and post-quantum cryptography for regional/private endpoints.

See Also:

• https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-custom-domain-tls-version.html

TLS13_2025_EDGE

@Stability(Stable)
public static final SecurityPolicy TLS13_2025_EDGE

Cipher suite TLS 1.3 for edge-optimized endpoints.

See Also:

• https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-custom-domain-tls-version.html

TLS12_PFS_2025_EDGE

@Stability(Stable)
public static final SecurityPolicy TLS12_PFS_2025_EDGE

Cipher suite TLS 1.2 with Perfect Forward Secrecy for edge-optimized endpoints.

See Also:

• https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-custom-domain-tls-version.html

TLS12_2018_EDGE

@Stability(Stable)
public static final SecurityPolicy TLS12_2018_EDGE

Cipher suite TLS 1.2 for edge-optimized endpoints (legacy).

See Also:

• https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-custom-domain-tls-version.html

Method Details

values

public static SecurityPolicy[] 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 SecurityPolicy 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