software.amazon.awscdk.services.apigateway

Class CfnBasePathMapping

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.apigateway.CfnBasePathMapping

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.30.0 (build adae23f)",
           date="2021-06-30T10:00:46.012Z")
 @Stability(value=Stable)
public class CfnBasePathMapping
extends CfnResource
implements IInspectable

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

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 class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnBasePathMapping(software.constructs.Construct scope, 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
String	getBasePath() `AWS::ApiGateway::BasePathMapping.BasePath`.
protected Map<String,Object>	getCfnProperties()
String	getDomainName() `AWS::ApiGateway::BasePathMapping.DomainName`.
String	getRestApiId() `AWS::ApiGateway::BasePathMapping.RestApiId`.
String	getStage() `AWS::ApiGateway::BasePathMapping.Stage`.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setBasePath(String value) `AWS::ApiGateway::BasePathMapping.BasePath`.
void	setDomainName(String value) `AWS::ApiGateway::BasePathMapping.DomainName`.
void	setRestApiId(String value) `AWS::ApiGateway::BasePathMapping.RestApiId`.
void	setStage(String value) `AWS::ApiGateway::BasePathMapping.Stage`.

Methods inherited from class software.amazon.awscdk.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.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

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.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final 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

@Stability(value=Stable)
public CfnBasePathMapping(@NotNull
                                                   software.constructs.Construct scope,
                                                   @NotNull
                                                   String id,
                                                   @NotNull
                                                   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

@Stability(value=Stable)
public void inspect(@NotNull
                                             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

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getDomainName

@Stability(value=Stable)
 @NotNull
public String getDomainName()

`AWS::ApiGateway::BasePathMapping.DomainName`.

setDomainName

@Stability(value=Stable)
public void setDomainName(@NotNull
                                                   String value)

`AWS::ApiGateway::BasePathMapping.DomainName`.

getBasePath

@Stability(value=Stable)
 @Nullable
public String getBasePath()

`AWS::ApiGateway::BasePathMapping.BasePath`.

setBasePath

@Stability(value=Stable)
public void setBasePath(@Nullable
                                                 String value)

`AWS::ApiGateway::BasePathMapping.BasePath`.

getRestApiId

@Stability(value=Stable)
 @Nullable
public String getRestApiId()

`AWS::ApiGateway::BasePathMapping.RestApiId`.

setRestApiId

@Stability(value=Stable)
public void setRestApiId(@Nullable
                                                  String value)

`AWS::ApiGateway::BasePathMapping.RestApiId`.

getStage

@Stability(value=Stable)
 @Nullable
public String getStage()

`AWS::ApiGateway::BasePathMapping.Stage`.

setStage

@Stability(value=Stable)
public void setStage(@Nullable
                                              String value)

`AWS::ApiGateway::BasePathMapping.Stage`.