software.amazon.awscdk.services.apigateway

Class BasePathMapping

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.Resource

software.amazon.awscdk.services.apigateway.BasePathMapping

All Implemented Interfaces:

IResource, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:36.087Z")
 @Stability(value=Stable)
public class BasePathMapping
extends Resource

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

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

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.apigateway.*;
 DomainName domainName;
 RestApi restApi;
 Stage stage;
 BasePathMapping basePathMapping = BasePathMapping.Builder.create(this, "MyBasePathMapping")
         .domainName(domainName)
         .restApi(restApi)
         // the properties below are optional
         .basePath("basePath")
         .stage(stage)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BasePathMapping.Builder A fluent builder for BasePathMapping.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IResource

IResource.Jsii$Default

Constructor Summary

Constructors

Modifier	Constructor and Description
	BasePathMapping(software.constructs.Construct scope, String id, BasePathMappingProps props)
protected	BasePathMapping(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	BasePathMapping(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Methods inherited from class software.amazon.awscdk.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isOwnedResource, isResource

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

BasePathMapping

protected BasePathMapping(software.amazon.jsii.JsiiObjectRef objRef)

BasePathMapping

protected BasePathMapping(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

BasePathMapping

@Stability(value=Stable)
public BasePathMapping(@NotNull
                                                software.constructs.Construct scope,
                                                @NotNull
                                                String id,
                                                @NotNull
                                                BasePathMappingProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.