aws-cdk-lib.aws_apigateway.ApiDefinitionS3Location

interface ApiDefinitionS3Location

LanguageType name
.NETAmazon.CDK.AWS.APIGateway.ApiDefinitionS3Location
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsapigateway#ApiDefinitionS3Location
Javasoftware.amazon.awscdk.services.apigateway.ApiDefinitionS3Location
Pythonaws_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

NameTypeDescription
bucketstringThe S3 bucket.
keystringThe S3 key.
version?stringAn optional version.

bucket

Type: string

The S3 bucket.


key

Type: string

The S3 key.


version?

Type: string (optional, default: latest version)

An optional version.