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.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:36.095Z")
 @Stability(value=Stable)
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 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() The base path name that callers of the API must provide in the URL after the domain name.
protected Map<String,Object>	getCfnProperties()
String	getDomainName() The `DomainName` of an [AWS::ApiGateway::DomainName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html) resource.
String	getId() `AWS::ApiGateway::BasePathMapping.Id`.
String	getRestApiId() The ID of the API.
String	getStage() The name of the API's 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) The base path name that callers of the API must provide in the URL after the domain name.
void	setDomainName(String value) The `DomainName` of an [AWS::ApiGateway::DomainName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html) resource.
void	setId(String value) `AWS::ApiGateway::BasePathMapping.Id`.
void	setRestApiId(String value) The ID of the API.
void	setStage(String value) The name of the API's stage.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, 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()

The `DomainName` of an [AWS::ApiGateway::DomainName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html) resource.

setDomainName

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

The `DomainName` of an [AWS::ApiGateway::DomainName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html) resource.

getBasePath

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

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

setBasePath

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

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

getId

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

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

setId

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

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

getRestApiId

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

The ID of the API.

setRestApiId

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

The ID of the API.

getStage

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

The name of the API's stage.

setStage

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

The name of the API's stage.