S3LocationProperty Struct
S3Location is a property of the AWS::ApiGateway::RestApi resource that specifies the Amazon S3 location of a OpenAPI (formerly Swagger) file that defines a set of RESTful APIs in JSON or YAML.
On January 1, 2016, the Swagger Specification was donated to the OpenAPI initiative , becoming the foundation of the OpenAPI Specification.
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_apigateway as apigateway } from 'aws-cdk-lib';
const s3LocationProperty: apigateway.CfnRestApi.S3LocationProperty = {
bucket: 'bucket',
eTag: 'eTag',
key: 'key',
version: 'version',
};
Properties
The name of the S3 bucket where the OpenAPI file is stored.
The Amazon S3 ETag (a file checksum) of the OpenAPI file.
If you don't specify a value, API Gateway skips ETag validation of your OpenAPI file.
The file name of the OpenAPI file (Amazon S3 object name).
For versioning-enabled buckets, a specific version of the OpenAPI file.