Interface ISpecRestApiProps

Namespace

Amazon.CDK.AWS.APIGateway

Assembly

Amazon.CDK.AWS.APIGateway.dll

Props to instantiate a new SpecRestApi.

public interface ISpecRestApiProps : IRestApiBaseProps

Inherited Members

IRestApiBaseProps.CloudWatchRole

IRestApiBaseProps.Deploy

IRestApiBaseProps.DeployOptions

IRestApiBaseProps.DisableExecuteApiEndpoint

IRestApiBaseProps.DomainName

IRestApiBaseProps.EndpointExportName

IRestApiBaseProps.EndpointTypes

IRestApiBaseProps.FailOnWarnings

IRestApiBaseProps.Parameters

IRestApiBaseProps.Policy

IRestApiBaseProps.RestApiName

IRestApiBaseProps.RetainDeployments

Examples

Integration integration;


            var api = new SpecRestApi(this, "books-api", new SpecRestApiProps {
                ApiDefinition = ApiDefinition.FromAsset("path-to-file.json")
            });

            var booksResource = api.Root.AddResource("books");
            booksResource.AddMethod("GET", integration);

Remarks

ExampleMetadata: infused

Properties

ApiDefinition

An OpenAPI definition compatible with API Gateway.

ApiDefinition ApiDefinition { get; }

Property Value

ApiDefinition

Remarks

See: https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-import-api.html