@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)", date="2023-03-14T16:25:33.200Z") public class CfnBasePathMapping extends CfnResource implements IInspectable
The AWS::ApiGateway::BasePathMapping
resource creates a base path that clients who call your API must use in the invocation URL.
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.*; CfnBasePathMapping cfnBasePathMapping = CfnBasePathMapping.Builder.create(this, "MyCfnBasePathMapping") .domainName("domainName") // the properties below are optional .basePath("basePath") .id("id") .restApiId("restApiId") .stage("stage") .build();
Modifier and Type | Class and Description |
---|---|
static class |
CfnBasePathMapping.Builder
A fluent builder for
CfnBasePathMapping . |
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
Modifier | Constructor and Description |
---|---|
|
CfnBasePathMapping(Construct scope,
java.lang.String id,
CfnBasePathMappingProps props)
Create a new `AWS::ApiGateway::BasePathMapping`.
|
protected |
CfnBasePathMapping(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) |
protected |
CfnBasePathMapping(software.amazon.jsii.JsiiObjectRef objRef) |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getBasePath()
The base path name that callers of the API must provide as part of the URL after the domain name.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
getCfnProperties() |
java.lang.String |
getDomainName()
The domain name of the BasePathMapping resource to be described.
|
java.lang.String |
getId()
`AWS::ApiGateway::BasePathMapping.Id`.
|
java.lang.String |
getRestApiId()
The string identifier of the associated RestApi.
|
java.lang.String |
getStage()
The name of the associated stage.
|
void |
inspect(TreeInspector inspector)
Examines the CloudFormation resource and discloses attributes.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
renderProperties(java.util.Map<java.lang.String,java.lang.Object> props) |
void |
setBasePath(java.lang.String value)
The base path name that callers of the API must provide as part of the URL after the domain name.
|
void |
setDomainName(java.lang.String value)
The domain name of the BasePathMapping resource to be described.
|
void |
setId(java.lang.String value)
`AWS::ApiGateway::BasePathMapping.Id`.
|
void |
setRestApiId(java.lang.String value)
The string identifier of the associated RestApi.
|
void |
setStage(java.lang.String value)
The name of the associated stage.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnBasePathMapping(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnBasePathMapping(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnBasePathMapping(Construct scope, java.lang.String id, CfnBasePathMappingProps props)
scope
- - scope in which this resource is defined. This parameter is required.id
- - scoped id of the resource. This parameter is required.props
- - resource properties. This parameter is required.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public java.lang.String getDomainName()
public void setDomainName(java.lang.String value)
public java.lang.String getBasePath()
public void setBasePath(java.lang.String value)
public java.lang.String getId()
public void setId(java.lang.String value)
public java.lang.String getRestApiId()
public void setRestApiId(java.lang.String value)
public java.lang.String getStage()
public void setStage(java.lang.String value)