Package software.amazon.smithy.aws.apigateway.traits

Class EndpointConfigurationTrait

java.lang.Object

software.amazon.smithy.model.traits.AbstractTrait

software.amazon.smithy.aws.apigateway.traits.EndpointConfigurationTrait

All Implemented Interfaces:

FromSourceLocation, ToNode, ToShapeId, Trait, ToSmithyBuilder<EndpointConfigurationTrait>

public final class EndpointConfigurationTrait
extends AbstractTrait
implements ToSmithyBuilder<EndpointConfigurationTrait>

Defines the endpoint configuration for an API Gateway REST API, including the endpoint type, VPC endpoint IDs, whether the default execute-api endpoint is disabled, and the IP address type.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	EndpointConfigurationTrait.Builder
static final class	EndpointConfigurationTrait.Provider

Field Summary

Fields

Modifier and Type	Field	Description
static final ShapeId	ID

Method Summary

Modifier and Type	Method	Description
static EndpointConfigurationTrait.Builder	builder()	Creates a builder for the trait.
protected ObjectNode	createNode()	The result of toNode is used for hashCodes and equality.
Optional<Boolean>	getDisableExecuteApiEndpoint()	Gets whether the default execute-api endpoint is disabled.
Optional<String>	getIpAddressType()	Gets the IP address type that can invoke the API.
List<String>	getTypes()	Gets the endpoint types for the API.
Optional<List<String>>	getVpcEndpointIds()	Gets the VPC endpoint IDs for PRIVATE endpoint type APIs.
EndpointConfigurationTrait.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.

Methods inherited from class software.amazon.smithy.model.traits.AbstractTrait

equals, getSourceLocation, hashCode, setNodeCache, toNode, toShapeId, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.smithy.model.traits.Trait

isSynthetic

Field Details

ID

public static final ShapeId ID

Method Details

builder

public static EndpointConfigurationTrait.Builder builder()

Creates a builder for the trait.

Returns:

Returns the created builder.

getTypes

public List<String> getTypes()

Gets the endpoint types for the API.

Returns:

Returns the list of endpoint types.

getVpcEndpointIds

public Optional<List<String>> getVpcEndpointIds()

Gets the VPC endpoint IDs for PRIVATE endpoint type APIs.

Returns:

Returns the optional list of VPC endpoint IDs.

getDisableExecuteApiEndpoint

public Optional<Boolean> getDisableExecuteApiEndpoint()

Gets whether the default execute-api endpoint is disabled.

Returns:

Returns the optional disable flag.

getIpAddressType

public Optional<String> getIpAddressType()

Gets the IP address type that can invoke the API.

Supported values are ipv4 and dualstack.

Returns:

Returns the optional IP address type.

createNode

protected ObjectNode createNode()

Description copied from class: AbstractTrait

The result of toNode is used for hashCodes and equality. Subclasses must implement createNode to turn the trait into a Node. This is then cached for subsequent retrievals.

Specified by:

createNode in class AbstractTrait

Returns:

Returns the trait as a node.

toBuilder

public EndpointConfigurationTrait.Builder toBuilder()

Description copied from interface: ToSmithyBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToSmithyBuilder<EndpointConfigurationTrait>

Returns:

a builder for type T