interface ApiDefinitionConfig

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

Obtainable from ApiDefinition.bind(), AssetApiDefinition.bind(), InlineApiDefinition.bind(), S3ApiDefinition.bind()

Post-Binding Configuration for a CDK construct.

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';

declare const inlineDefinition: any;
const apiDefinitionConfig: apigateway.ApiDefinitionConfig = {
  inlineDefinition: inlineDefinition,
  s3Location: {
    bucket: 'bucket',
    key: 'key',

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

Properties

Name	Type	Description
inlineDefinition?	any	Inline specification (mutually exclusive with s3Location).
s3Location?	ApiDefinitionS3Location	The location of the specification in S3 (mutually exclusive with inlineDefinition).

---

inlineDefinition?

Type: any (optional, default: API definition is not defined inline)

Inline specification (mutually exclusive with s3Location).

---

s3Location?

Type: ApiDefinitionS3Location (optional, default: API definition is not an S3 location)

The location of the specification in S3 (mutually exclusive with inlineDefinition).