aws-cdk-lib.aws_apigatewayv2.CfnApi.BodyS3LocationProperty

interface BodyS3LocationProperty

LanguageType name
.NETAmazon.CDK.AWS.Apigatewayv2.CfnApi.BodyS3LocationProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsapigatewayv2#CfnApi_BodyS3LocationProperty
Javasoftware.amazon.awscdk.services.apigatewayv2.CfnApi.BodyS3LocationProperty
Pythonaws_cdk.aws_apigatewayv2.CfnApi.BodyS3LocationProperty
TypeScript aws-cdk-lib » aws_apigatewayv2 » CfnApi » BodyS3LocationProperty

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

Supported only for HTTP APIs.

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

NameTypeDescription
bucket?stringThe S3 bucket that contains the OpenAPI definition to import.
etag?stringThe Etag of the S3 object.
key?stringThe key of the S3 object.
version?stringThe version of the S3 object.

bucket?

Type: string (optional)

The S3 bucket that contains the OpenAPI definition to import.

Required if you specify a BodyS3Location for an API.


etag?

Type: string (optional)

The Etag of the S3 object.


key?

Type: string (optional)

The key of the S3 object.

Required if you specify a BodyS3Location for an API.


version?

Type: string (optional)

The version of the S3 object.