EndpointConfiguration

class aws_cdk.aws_apigateway.EndpointConfiguration(*, types, ip_address_type=None, vpc_endpoints=None)

Bases: object

The endpoint configuration of a REST API, including VPCs and endpoint types.

EndpointConfiguration is a property of the AWS::ApiGateway::RestApi resource.

Parameters:

types (Sequence[EndpointType]) – A list of endpoint types of an API or its custom domain name. Default: EndpointType.EDGE
ip_address_type (Optional[IpAddressType]) – The IP address types that can invoke the API. Default: undefined - AWS default is DUAL_STACK for private API, IPV4 for all other APIs.
vpc_endpoints (Optional[Sequence[IVpcEndpoint]]) – A list of VPC Endpoints against which to create Route53 ALIASes. Default: - no ALIASes are created for the endpoint.

ExampleMetadata:

infused

Example:

# some_endpoint: ec2.IVpcEndpoint


api = apigateway.RestApi(self, "api",
    endpoint_configuration=apigateway.EndpointConfiguration(
        types=[apigateway.EndpointType.PRIVATE],
        vpc_endpoints=[some_endpoint]
    )
)

Attributes

ip_address_type

The IP address types that can invoke the API.

Default:: undefined - AWS default is DUAL_STACK for private API, IPV4 for all other APIs.
See:: https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-ip-address-type.html

types

A list of endpoint types of an API or its custom domain name.

Default:: EndpointType.EDGE

vpc_endpoints

A list of VPC Endpoints against which to create Route53 ALIASes.

Default:

no ALIASes are created for the endpoint.