interface ApiDefinitionConfig
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.APIGateway.ApiDefinitionConfig |
![]() | software.amazon.awscdk.services.apigateway.ApiDefinitionConfig |
![]() | aws_cdk.aws_apigateway.ApiDefinitionConfig |
![]() | @aws-cdk/aws-apigateway » ApiDefinitionConfig |
Obtainable from
Api
.bind()
, Asset
.bind()
, Inline
.bind()
, S3
.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 * as apigateway from '@aws-cdk/aws-apigateway';
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 |
---|---|---|
inline | any | Inline specification (mutually exclusive with s3Location ). |
s3 | Api | 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:
Api
(optional, default: API definition is not an S3 location)
The location of the specification in S3 (mutually exclusive with inlineDefinition
).