interface ApiDefinitionS3Location

Language	Type name
.NET	Amazon.CDK.AWS.APIGateway.ApiDefinitionS3Location
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsapigateway#ApiDefinitionS3Location
Java	software.amazon.awscdk.services.apigateway.ApiDefinitionS3Location
Python	aws_cdk.aws_apigateway.ApiDefinitionS3Location
TypeScript (source)	aws-cdk-lib » aws_apigateway » ApiDefinitionS3Location

S3 location of the API definition file.

Example

// 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 apiDefinitionS3Location: apigateway.ApiDefinitionS3Location = {
  bucket: 'bucket',
  key: 'key',

  // the properties below are optional
  version: 'version',
};

Properties

Name	Type	Description
bucket	string	The S3 bucket.
key	string	The S3 key.
version?	string	An optional version.

---

bucket

Type: string

The S3 bucket.

---

key

Type: string

The S3 key.

---

version?

Type: string (optional, default: latest version)

An optional version.