Package software.amazon.awscdk.services.apigateway

Class CfnRestApi.EndpointConfigurationProperty.Builder

java.lang.Object

software.amazon.awscdk.services.apigateway.CfnRestApi.EndpointConfigurationProperty.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnRestApi.EndpointConfigurationProperty>

Enclosing interface:

CfnRestApi.EndpointConfigurationProperty

@Stability(Stable)
public static final class CfnRestApi.EndpointConfigurationProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnRestApi.EndpointConfigurationProperty>

A builder for CfnRestApi.EndpointConfigurationProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnRestApi.EndpointConfigurationProperty	build()	Builds the configured instance.
CfnRestApi.EndpointConfigurationProperty.Builder	ipAddressType(String ipAddressType)	Sets the value of CfnRestApi.EndpointConfigurationProperty.getIpAddressType()
CfnRestApi.EndpointConfigurationProperty.Builder	types(List<String> types)	Sets the value of CfnRestApi.EndpointConfigurationProperty.getTypes()
CfnRestApi.EndpointConfigurationProperty.Builder	vpcEndpointIds(List<String> vpcEndpointIds)	Sets the value of CfnRestApi.EndpointConfigurationProperty.getVpcEndpointIds()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

ipAddressType

@Stability(Stable)
public CfnRestApi.EndpointConfigurationProperty.Builder ipAddressType(String ipAddressType)

Sets the value of CfnRestApi.EndpointConfigurationProperty.getIpAddressType()

Parameters:

ipAddressType - The IP address types that can invoke an API (RestApi). Use ipv4 to allow only IPv4 addresses to invoke an API, or use dualstack to allow both IPv4 and IPv6 addresses to invoke an API. For the PRIVATE endpoint type, only dualstack is supported.

Returns:

this

types

@Stability(Stable)
public CfnRestApi.EndpointConfigurationProperty.Builder types(List<String> types)

Sets the value of CfnRestApi.EndpointConfigurationProperty.getTypes()

Parameters:

types - 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 .

Returns:

this

vpcEndpointIds

@Stability(Stable)
public CfnRestApi.EndpointConfigurationProperty.Builder vpcEndpointIds(List<String> vpcEndpointIds)

Sets the value of CfnRestApi.EndpointConfigurationProperty.getVpcEndpointIds()

Parameters:

vpcEndpointIds - A list of VpcEndpointIds of an API (RestApi) against which to create Route53 ALIASes. It is only supported for PRIVATE endpoint type.

Returns:

this

build

@Stability(Stable)
public CfnRestApi.EndpointConfigurationProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnRestApi.EndpointConfigurationProperty>

Returns:

a new instance of CfnRestApi.EndpointConfigurationProperty

Throws:

NullPointerException - if any required attribute was not provided