aws-cdk-lib.aws_apigatewayv2.CfnApi.BodyS3LocationProperty

BodyS3LocationProperty Struct

The BodyS3Location property specifies an S3 location from which to import an OpenAPI definition.

Supported only for HTTP APIs.

Source

Generated code

Type last changed

v2.93.0 · 23 Aug 2023

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_apigatewayv2 as apigatewayv2 } from 'aws-cdk-lib';
const bodyS3LocationProperty: apigatewayv2.CfnApi.BodyS3LocationProperty = {
  bucket: 'bucket',
  etag: 'etag',
  key: 'key',
  version: 'version',
};

Properties

bucketstringbucketstrbucketStringBucketstringBucket*string#

The S3 bucket that contains the OpenAPI definition to import.

Required if you specify a BodyS3Location for an API.

etagstringetagstretagStringEtagstringEtag*string#

The Etag of the S3 object.

keystringkeystrkeyStringKeystringKey*string#

The key of the S3 object.

Required if you specify a BodyS3Location for an API.

versionstringversionstrversionStringVersionstringVersion*string#

The version of the S3 object.