Class CfnApiMapping
The AWS::ApiGatewayV2::ApiMapping
resource contains an API mapping.
Implements
Inherited Members
Namespace: Amazon.CDK.AWS.Apigatewayv2
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnApiMapping : CfnResource, IInspectable
Syntax (vb)
Public Class CfnApiMapping
Inherits CfnResource
Implements IInspectable
Remarks
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 .
CloudformationResource: AWS::ApiGatewayV2::ApiMapping
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Apigatewayv2;
var cfnApiMapping = new CfnApiMapping(this, "MyCfnApiMapping", new CfnApiMappingProps {
ApiId = "apiId",
DomainName = "domainName",
Stage = "stage",
// the properties below are optional
ApiMappingKey = "apiMappingKey"
});
Synopsis
Constructors
CfnApiMapping(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnApiMapping(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnApiMapping(Construct, String, ICfnApiMappingProps) |
Properties
ApiId | The API identifier. |
ApiMappingKey | The API mapping key. |
AttrApiMappingId | The API mapping resource ID. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
DomainName | The domain name. |
Stage | The API stage. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnApiMapping(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnApiMapping(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnApiMapping(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnApiMapping(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnApiMapping(Construct, String, ICfnApiMappingProps)
public CfnApiMapping(Construct scope, string id, ICfnApiMappingProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnApiMappingProps
Resource properties.
Properties
ApiId
The API identifier.
public virtual string ApiId { get; set; }
Property Value
System.String
ApiMappingKey
The API mapping key.
public virtual string ApiMappingKey { get; set; }
Property Value
System.String
AttrApiMappingId
The API mapping resource ID.
public virtual string AttrApiMappingId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: ApiMappingId
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
DomainName
The domain name.
public virtual string DomainName { get; set; }
Property Value
System.String
Stage
The API stage.
public virtual string Stage { get; set; }
Property Value
System.String
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>