Class BasePathMapping

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

Inheritance

object

Resource

BasePathMapping

Implements

IResource

IConstruct

IDependable

IEnvironmentAware

Inherited Members

Resource.IsOwnedResource(IConstruct)

Resource.IsResource(IConstruct)

Resource.ApplyRemovalPolicy(RemovalPolicy)

Resource.GeneratePhysicalName()

Resource.GetResourceArnAttribute(string, IArnComponents)

Resource.GetResourceNameAttribute(string)

Resource.Env

Resource.PhysicalName

Resource.Stack

Namespace: Amazon.CDK.AWS.APIGateway

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class BasePathMapping : Resource, IResource, IConstruct, IDependable, IEnvironmentAware

Syntax (vb)

Public Class BasePathMapping Inherits Resource Implements IResource, IConstruct, IDependable, IEnvironmentAware

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(Construct, string, IBasePathMappingProps)

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

Properties

PROPERTY_INJECTION_ID

Uniquely identifies this class.

Constructors

BasePathMapping(Construct, string, IBasePathMappingProps)

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

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

Parameters

scope Construct

id string

props IBasePathMappingProps

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

Properties

PROPERTY_INJECTION_ID

Uniquely identifies this class.

public static string PROPERTY_INJECTION_ID { get; }

Property Value

string

Remarks

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

ExampleMetadata: infused

Implements

IResource

Constructs.IConstruct

Constructs.IDependable

IEnvironmentAware