Class BasePathMappingProps
Inheritance
Namespace: Amazon.CDK.AWS.APIGateway
Assembly: Amazon.CDK.AWS.APIGateway.dll
Syntax (csharp)
public class BasePathMappingProps : Object, IBasePathMappingProps, IBasePathMappingOptions
Syntax (vb)
Public Class BasePathMappingProps
Inherits Object
Implements IBasePathMappingProps, IBasePathMappingOptions
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;
DomainName domainName;
RestApi restApi;
Stage stage;
var basePathMappingProps = new BasePathMappingProps {
DomainName = domainName,
RestApi = restApi,
// the properties below are optional
BasePath = "basePath",
Stage = stage
};
Synopsis
Constructors
BasePathMappingProps() |
Properties
BasePath | The base path name that callers of the API must provide in the URL after the domain name (e.g. |
DomainName | The DomainName to associate with this base path mapping. |
RestApi | The RestApi resource to target. |
Stage | The Deployment stage of API [disable-awslint:ref-via-interface]. |
Constructors
BasePathMappingProps()
public BasePathMappingProps()
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.
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.
DomainName
The DomainName to associate with this base path mapping.
public IDomainName DomainName { get; set; }
Property Value
RestApi
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