Class BasePathMapping

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

Inheritance
System.Object
Resource
BasePathMapping
Implements
Constructs.IConstruct
Constructs.IDependable
Inherited Members
Namespace: Amazon.CDK.AWS.APIGateway
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class BasePathMapping : Resource, IResource
Syntax (vb)
Public Class BasePathMapping
    Inherits Resource
    Implements IResource
Remarks

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

ExampleMetadata: infused

Examples
RestApi api;


var domainName = DomainName.FromDomainNameAttributes(this, "DomainName", new DomainNameAttributes {
    DomainName = "domainName",
    DomainNameAliasHostedZoneId = "domainNameAliasHostedZoneId",
    DomainNameAliasTarget = "domainNameAliasTarget"
});

new BasePathMapping(this, "BasePathMapping", new BasePathMappingProps {
    DomainName = domainName,
    RestApi = api
});

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
Constructs.IDependable