Class BasePathMapping

Namespace: Amazon.CDK.AWS.APIGateway

Assembly: Amazon.CDK.AWS.APIGateway.dll

This resource creates a base path that clients who call your API must use in the invocation URL.

public class BasePathMapping : Resource

Inheritance: object

BasePathMapping

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
             });

Remarks

Unless you're importing a domain with DomainName.fromDomainNameAttributes(), you can use DomainName.addBasePathMapping() to define mappings.

ExampleMetadata: fixture=_generated

Constructors

BasePathMapping(Construct, string, IBasePathMappingProps)

public BasePathMapping(Construct scope, string id, IBasePathMappingProps props)

Parameters