Package software.amazon.awscdk.services.apigatewayv2

Class CfnApiMapping

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.apigatewayv2.CfnApiMapping

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
           date="2024-10-05T03:43:38.074Z")
@Stability(Stable)
public class CfnApiMapping
extends CfnResource
implements IInspectable

The AWS::ApiGatewayV2::ApiMapping resource contains an API mapping.

An API mapping relates a path of your custom domain name to a stage of your API. A custom domain name can have multiple API mappings, but the paths can't overlap. A custom domain can map only to APIs of the same protocol type. For more information, see CreateApiMapping in the Amazon API Gateway V2 API Reference .

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.apigatewayv2.*;
 CfnApiMapping cfnApiMapping = CfnApiMapping.Builder.create(this, "MyCfnApiMapping")
         .apiId("apiId")
         .domainName("domainName")
         .stage("stage")
         // the properties below are optional
         .apiMappingKey("apiMappingKey")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-apimapping.html

Nested Class Summary

Nested Classes

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

Nested 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.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnApiMapping(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnApiMapping(software.amazon.jsii.JsiiObjectRef objRef)
	CfnApiMapping(software.constructs.Construct scope, String id, CfnApiMappingProps props)

Method Summary

Modifier and Type	Method	Description
String	getApiId()	The API identifier.
String	getApiMappingKey()	The API mapping key.
String	getAttrApiMappingId()	The API mapping resource ID.
protected Map<String,Object>	getCfnProperties()
String	getDomainName()	The domain name.
String	getStage()	The API stage.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setApiId(String value)	The API identifier.
void	setApiMappingKey(String value)	The API mapping key.
void	setDomainName(String value)	The domain name.
void	setStage(String value)	The API stage.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, 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 Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnApiMapping

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

CfnApiMapping

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

CfnApiMapping

@Stability(Stable)
public CfnApiMapping(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnApiMappingProps props)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

props - Resource properties. This parameter is required.

Method Details

inspect

@Stability(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(Stable)
@NotNull
protected Map<String,Object> renderProperties(@NotNull
 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrApiMappingId

@Stability(Stable)
@NotNull
public String getAttrApiMappingId()

The API mapping resource ID.

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getApiId

@Stability(Stable)
@NotNull
public String getApiId()

The API identifier.

setApiId

@Stability(Stable)
public void setApiId(@NotNull
 String value)

The API identifier.

getDomainName

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

The domain name.

setDomainName

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

The domain name.

getStage

@Stability(Stable)
@NotNull
public String getStage()

The API stage.

setStage

@Stability(Stable)
public void setStage(@NotNull
 String value)

The API stage.

getApiMappingKey

@Stability(Stable)
@Nullable
public String getApiMappingKey()

The API mapping key.

setApiMappingKey

@Stability(Stable)
public void setApiMappingKey(@Nullable
 String value)

The API mapping key.