Package software.amazon.awscdk.services.apigateway

Interface CfnDomainNameV2.EndpointConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDomainNameV2.EndpointConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnDomainNameV2

@Stability(Stable)
public static interface CfnDomainNameV2.EndpointConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

The endpoint configuration to indicate the types of endpoints an API (RestApi) or its custom domain name (DomainName) has and the IP address types that can invoke it.

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.apigateway.*;
 EndpointConfigurationProperty endpointConfigurationProperty = EndpointConfigurationProperty.builder()
         .ipAddressType("ipAddressType")
         .types(List.of("types"))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-domainnamev2-endpointconfiguration.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnDomainNameV2.EndpointConfigurationProperty.Builder	A builder for CfnDomainNameV2.EndpointConfigurationProperty
static final class	CfnDomainNameV2.EndpointConfigurationProperty.Jsii$Proxy	An implementation for CfnDomainNameV2.EndpointConfigurationProperty

Method Summary

Modifier and Type	Method	Description
static CfnDomainNameV2.EndpointConfigurationProperty.Builder	builder()
default String	getIpAddressType()	The IP address types that can invoke an API (RestApi) or a DomainName.
default List<String>	getTypes()	A list of endpoint types of an API (RestApi) or its custom domain name (DomainName).

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getIpAddressType

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

The IP address types that can invoke an API (RestApi) or a DomainName.

Use ipv4 to allow only IPv4 addresses to invoke an API or DomainName, or use dualstack to allow both IPv4 and IPv6 addresses to invoke an API or a DomainName. For the PRIVATE endpoint type, only dualstack is supported.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-domainnamev2-endpointconfiguration.html#cfn-apigateway-domainnamev2-endpointconfiguration-ipaddresstype

getTypes

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

A list of endpoint types of an API (RestApi) or its custom domain name (DomainName).

For an edge-optimized API and its custom domain name, the endpoint type is "EDGE" . For a regional API and its custom domain name, the endpoint type is REGIONAL . For a private API, the endpoint type is PRIVATE .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-domainnamev2-endpointconfiguration.html#cfn-apigateway-domainnamev2-endpointconfiguration-types

builder

@Stability(Stable)
static CfnDomainNameV2.EndpointConfigurationProperty.Builder builder()

Returns:

a CfnDomainNameV2.EndpointConfigurationProperty.Builder of CfnDomainNameV2.EndpointConfigurationProperty