software.amazon.awscdk.services.apigateway

Class CfnBasePathMapping

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.apigateway.CfnBasePathMapping

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-14T16:25:33.200Z")
public class CfnBasePathMapping
extends CfnResource
implements IInspectable

A CloudFormation `AWS::ApiGateway::BasePathMapping`.

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

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

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)

Method Summary

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.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

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

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnBasePathMapping

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

CfnBasePathMapping

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

CfnBasePathMapping

public CfnBasePathMapping(Construct scope,
                          java.lang.String id,
                          CfnBasePathMappingProps props)

Create a new `AWS::ApiGateway::BasePathMapping`.

Parameters:

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.

Method Detail

inspect

public void inspect(TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getDomainName

public java.lang.String getDomainName()

The domain name of the BasePathMapping resource to be described.

setDomainName

public void setDomainName(java.lang.String value)

The domain name of the BasePathMapping resource to be described.

getBasePath

public java.lang.String getBasePath()

The base path name that callers of the API must provide as part of the URL after the domain name.

setBasePath

public 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.

getId

public java.lang.String getId()

`AWS::ApiGateway::BasePathMapping.Id`.

setId

public void setId(java.lang.String value)

`AWS::ApiGateway::BasePathMapping.Id`.

getRestApiId

public java.lang.String getRestApiId()

The string identifier of the associated RestApi.

setRestApiId

public void setRestApiId(java.lang.String value)

The string identifier of the associated RestApi.

getStage

public java.lang.String getStage()

The name of the associated stage.

setStage

public void setStage(java.lang.String value)

The name of the associated stage.