software.amazon.awscdk.services.apigatewayv2

Class CfnApiMapping

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

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:46.153Z")
public class CfnApiMapping
extends CfnResource
implements IInspectable

A CloudFormation `AWS::ApiGatewayV2::ApiMapping`.

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

Nested Class Summary

Nested Classes

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

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
	CfnApiMapping(Construct scope, java.lang.String id, CfnApiMappingProps props) Create a new `AWS::ApiGatewayV2::ApiMapping`.
protected	CfnApiMapping(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnApiMapping(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getApiId() The identifier of the API.
java.lang.String	getApiMappingKey() The API mapping key.
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.String	getDomainName() The domain name.
java.lang.String	getStage() The API 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	setApiId(java.lang.String value) The identifier of the API.
void	setApiMappingKey(java.lang.String value) The API mapping key.
void	setDomainName(java.lang.String value) The domain name.
void	setStage(java.lang.String value) The API 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

CfnApiMapping

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

CfnApiMapping

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

CfnApiMapping

public CfnApiMapping(Construct scope,
                     java.lang.String id,
                     CfnApiMappingProps props)

Create a new `AWS::ApiGatewayV2::ApiMapping`.

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

getApiId

public java.lang.String getApiId()

The identifier of the API.

setApiId

public void setApiId(java.lang.String value)

The identifier of the API.

getDomainName

public java.lang.String getDomainName()

The domain name.

setDomainName

public void setDomainName(java.lang.String value)

The domain name.

getStage

public java.lang.String getStage()

The API stage.

setStage

public void setStage(java.lang.String value)

The API stage.

getApiMappingKey

public java.lang.String getApiMappingKey()

The API mapping key.

setApiMappingKey

public void setApiMappingKey(java.lang.String value)

The API mapping key.