EndpointConfiguration¶

class aws_cdk.aws_apigateway.EndpointConfiguration(*, types, 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
vpc_endpoints (Optional[Sequence[IVpcEndpoint]]) – A list of VPC Endpoints against which to create Route53 ALIASes. Default: - no ALIASes are created for the endpoint.

Example:

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

Attributes

types¶

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

Default: EndpointType.EDGE
Return type: List[EndpointType]

vpc_endpoints¶

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

Default

no ALIASes are created for the endpoint.

Return type

Optional[List[IVpcEndpoint]]