Interface IApiDefinitionConfig

Post-Binding Configuration for a CDK construct.

Namespace: Amazon.CDK.AWS.APIGateway
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface IApiDefinitionConfig
Syntax (vb)
Public Interface IApiDefinitionConfig
Remarks

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.APIGateway;

var inlineDefinition;

var apiDefinitionConfig = new ApiDefinitionConfig {
    InlineDefinition = inlineDefinition,
    S3Location = new ApiDefinitionS3Location {
        Bucket = "bucket",
        Key = "key",

        // the properties below are optional
        Version = "version"
    }
};

Synopsis

Properties

InlineDefinition

Inline specification (mutually exclusive with s3Location).
S3Location

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

Properties

InlineDefinition

Inline specification (mutually exclusive with s3Location).

virtual object InlineDefinition { get; }
Property Value

System.Object

Remarks

Default: - API definition is not defined inline

S3Location

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

virtual IApiDefinitionS3Location S3Location { get; }
Property Value

IApiDefinitionS3Location

Remarks

Default: - API definition is not an S3 location