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.102.0 (build e354887)",
date="2024-08-29T22:54:12.533Z")
@Stability(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:
RestApi api; IDomainName domainName = DomainName.fromDomainNameAttributes(this, "DomainName", DomainNameAttributes.builder() .domainName("domainName") .domainNameAliasHostedZoneId("domainNameAliasHostedZoneId") .domainNameAliasTarget("domainNameAliasTarget") .build()); BasePathMapping.Builder.create(this, "BasePathMapping") .domainName(domainName) .restApi(api) .build();
-
Nested Class Summary
Nested ClassesNested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.IResource
IResource.Jsii$Default
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
BasePathMapping
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
BasePathMapping
(software.amazon.jsii.JsiiObjectRef objRef) BasePathMapping
(software.constructs.Construct scope, String id, BasePathMappingProps props) -
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 Details
-
BasePathMapping
protected BasePathMapping(software.amazon.jsii.JsiiObjectRef objRef) -
BasePathMapping
protected BasePathMapping(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
BasePathMapping
@Stability(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.
-