software.amazon.awscdk.services.apigateway

Enum EndpointType

java.lang.Object

java.lang.Enum<EndpointType>

software.amazon.awscdk.services.apigateway.EndpointType

All Implemented Interfaces:

Serializable, Comparable<EndpointType>

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:36.161Z")
 @Stability(value=Stable)
public enum EndpointType
extends Enum<EndpointType>

Example:

 ApiDefinition apiDefinition;
 SpecRestApi api = SpecRestApi.Builder.create(this, "ExampleRestApi")
         .apiDefinition(apiDefinition)
         .endpointTypes(List.of(EndpointType.PRIVATE))
         .build();
 

Enum Constant Summary

Enum Constants

Enum Constant and Description
EDGE For an edge-optimized API and its custom domain name.
PRIVATE For a private API and its custom domain name.
REGIONAL For a regional API and its custom domain name.

Method Summary

Modifier and Type	Method and Description
static EndpointType	valueOf(String name) Returns the enum constant of this type with the specified name.
static EndpointType[]	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, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

EDGE

@Stability(value=Stable)
public static final EndpointType EDGE

For an edge-optimized API and its custom domain name.

REGIONAL

@Stability(value=Stable)
public static final EndpointType REGIONAL

For a regional API and its custom domain name.

PRIVATE

@Stability(value=Stable)
public static final EndpointType PRIVATE

For a private API and its custom domain name.

Method Detail

values

public static EndpointType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (EndpointType c : EndpointType.values())
    System.out.println(c);

Returns:

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

valueOf

public static EndpointType 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