Class BasePathMapping
This resource creates a base path that clients who call your API must use in the invocation URL.
Inherited Members
Namespace: Amazon.CDK.AWS.APIGateway
Assembly: Amazon.CDK.AWS.APIGateway.dll
Syntax (csharp)
public class BasePathMapping : Resource, IResource, IConstruct, IDependable
Syntax (vb)
Public Class BasePathMapping
Inherits Resource
Implements IResource, IConstruct, IDependable
Remarks
Unless you're importing a domain with DomainName.fromDomainNameAttributes()
,
you can use DomainName.addBasePathMapping()
to define mappings.
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 basePathMapping = new BasePathMapping(this, "MyBasePathMapping", new BasePathMappingProps {
DomainName = domainName,
RestApi = restApi,
// the properties below are optional
BasePath = "basePath",
Stage = stage
});
Synopsis
Constructors
BasePathMapping(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
BasePathMapping(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
BasePathMapping(Construct, String, IBasePathMappingProps) |
Constructors
BasePathMapping(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected BasePathMapping(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
BasePathMapping(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected BasePathMapping(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
BasePathMapping(Construct, String, IBasePathMappingProps)
public BasePathMapping(Construct scope, string id, IBasePathMappingProps props)
Parameters
- scope Constructs.Construct
- id System.String
- props IBasePathMappingProps
Implements
Constructs.IConstruct