interface BodyS3LocationProperty

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.ApiGatewayV2.Mixins.CfnApiPropsMixin.BodyS3LocationProperty
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsapigatewayv2/mixins#CfnApiPropsMixin_BodyS3LocationProperty
Java	software.amazon.awscdk.mixins.preview.services.apigatewayv2.mixins.CfnApiPropsMixin.BodyS3LocationProperty
Python	aws_cdk.mixins_preview.aws_apigatewayv2.mixins.CfnApiPropsMixin.BodyS3LocationProperty
TypeScript	@aws-cdk/mixins-preview » aws_apigatewayv2 » mixins » CfnApiPropsMixin » BodyS3LocationProperty

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

Supported only for HTTP APIs.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-api-bodys3location.html

Example

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

Properties

Name	Type	Description
bucket?	string	The S3 bucket that contains the OpenAPI definition to import.
etag?	string	The Etag of the S3 object.
key?	string	The key of the S3 object.
version?	string	The 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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-api-bodys3location.html#cfn-apigatewayv2-api-bodys3location-bucket

---

etag?

Type: string (optional)

The Etag of the S3 object.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-api-bodys3location.html#cfn-apigatewayv2-api-bodys3location-etag

---

key?

Type: string (optional)

The key of the S3 object.

Required if you specify a BodyS3Location for an API.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-api-bodys3location.html#cfn-apigatewayv2-api-bodys3location-key

---

version?

Type: string (optional)

The version of the S3 object.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-api-bodys3location.html#cfn-apigatewayv2-api-bodys3location-version