x-amazon-apigateway-endpoint-구성 객체 - Amazon API Gateway

기계 번역으로 제공되는 번역입니다. 제공된 번역과 원본 영어의 내용이 상충하는 경우에는 영어 버전이 우선합니다.

x-amazon-apigateway-endpoint-구성 객체

API에 대한 엔드포인트 구성의 세부 사항을 지정합니다. 이 확장은 OpenAPI 작업 객체의 확장된 속성입니다. 이 객체는 Swagger 2.0의 최상위 공급 업체 확장에 있어야 합니다. OpenAPI 3.0의 경우 서버 객체의 공급 업체 확장 아래에 있어야 합니다.

속성
속성 이름 유형 설명
disableExecuteApiEndpoint

클라이언트가 기본 execute-api 엔드포인트를 사용하여 API를 호출할 수 있는지 여부를 지정합니다. 기본적으로 클라이언트는 기본 https://{api_id}.execute-api.{region}.amazonaws.com 엔드포인트로 API를 호출할 수 있습니다. 클라이언트가 사용자 지정 도메인 이름을 사용하여 API를 호출하도록 요구하려면 true를 지정합니다.

vpcEndpointIds String의 어레이

REST API의 Route 53 별칭 레코드를 생성하는 데 사용할 VpcEndpoint 식별자 목록입니다. PRIVATE 엔드포인트 유형인 REST API에만 지원됩니다.

x-amazon-apigateway-endpoint-구성 예제

다음 예제는 지정된 VPC 종단점을 REST API에 연결합니다.

"x-amazon-apigateway-endpoint-configuration": { "vpcEndpointIds": ["vpce-0212a4ababd5b8c3e", "vpce-01d622316a7df47f9"] }

다음 예제는 API에 대한 기본 엔드포인트를 비활성화합니다.

"x-amazon-apigateway-endpoint-configuration": { "disableExecuteApiEndpoint": true }