Interface IBasePathMappingOptions

Namespace

Amazon.CDK.AWS.APIGateway

Assembly

Amazon.CDK.AWS.APIGateway.dll

public interface IBasePathMappingOptions

Examples

DomainName domain;
            RestApi api1;
            RestApi api2;


            domain.AddBasePathMapping(api1, new BasePathMappingOptions { BasePath = "go-to-api1" });
            domain.AddBasePathMapping(api2, new BasePathMappingOptions { BasePath = "boom" });

Remarks

ExampleMetadata: infused

Properties

BasePath

The base path name that callers of the API must provide in the URL after the domain name (e.g. example.com/base-path). If you specify this property, it can't be an empty string.

string? BasePath { get; }

Property Value

string

Remarks

Default: - map requests from the domain root (e.g. example.com). If this is undefined, no additional mappings will be allowed on this domain name.

Stage

The Deployment stage of API [disable-awslint:ref-via-interface].

Stage? Stage { get; }

Property Value

Stage

Remarks

Default: - map to deploymentStage of restApi otherwise stage needs to pass in URL