Class BasePathMappingOptions
Inheritance
Implements
Namespace: Amazon.CDK.AWS.APIGateway
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class BasePathMappingOptions : Object, IBasePathMappingOptions
Syntax (vb)
Public Class BasePathMappingOptions
Inherits Object
Implements IBasePathMappingOptions
Remarks
ExampleMetadata: infused
Examples
DomainName domain;
RestApi api1;
RestApi api2;
domain.AddBasePathMapping(api1, new BasePathMappingOptions { BasePath = "go-to-api1" });
domain.AddBasePathMapping(api2, new BasePathMappingOptions { BasePath = "boom" });
Synopsis
Constructors
BasePathMappingOptions() |
Properties
AttachToStage | Whether to attach the base path mapping to a stage. |
BasePath | The base path name that callers of the API must provide in the URL after the domain name (e.g. |
Stage | The Deployment stage of API [disable-awslint:ref-via-interface]. |
Constructors
BasePathMappingOptions()
public BasePathMappingOptions()
Properties
AttachToStage
Whether to attach the base path mapping to a stage.
public Nullable<bool> AttachToStage { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
Use this property to create a base path mapping without attaching it to the Rest API default stage.
This property is ignored if stage
is provided.
Default: - true
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.
public string BasePath { get; set; }
Property Value
System.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].
public Stage Stage { get; set; }
Property Value
Remarks
Default: - map to deploymentStage of restApi otherwise stage needs to pass in URL