Interface IApiDefinitionConfig

Namespace

Amazon.CDK.AWS.APIGateway

Assembly

Amazon.CDK.AWS.APIGateway.dll

Post-Binding Configuration for a CDK construct.

public interface IApiDefinitionConfig

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"
                }
            };

Remarks

ExampleMetadata: fixture=_generated

Properties

InlineDefinition

Inline specification (mutually exclusive with s3Location).

object? InlineDefinition { get; }

Property Value

object

Remarks

Default: - API definition is not defined inline

S3Location

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

IApiDefinitionS3Location? S3Location { get; }

Property Value

IApiDefinitionS3Location

Remarks

Default: - API definition is not an S3 location