Class ApiMapping

Create a new API mapping for API Gateway API endpoint.

Inheritance
object
Resource
ApiMapping
Implements
IConstruct
IDependable
Inherited Members
Namespace: Amazon.CDK.AWS.Apigatewayv2
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class ApiMapping : Resource, IApiMapping, IResource, IConstruct, IDependable, IEnvironmentAware
Syntax (vb)
Public Class ApiMapping Inherits Resource Implements IApiMapping, IResource, IConstruct, IDependable, IEnvironmentAware
Remarks

Resource: 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;

             IApi api;
             DomainName domainName;
             IStage stage;

             var apiMapping = new ApiMapping(this, "MyApiMapping", new ApiMappingProps {
                 Api = api,
                 DomainName = domainName,

                 // the properties below are optional
                 ApiMappingKey = "apiMappingKey",
                 Stage = stage
             });

Synopsis

Constructors

ApiMapping(Construct, string, IApiMappingProps)

Create a new API mapping for API Gateway API endpoint.

Properties

ApiMappingId

ID of the API Mapping.
DomainName

API domain name.
MappingKey

API Mapping key.
PROPERTY_INJECTION_ID

Uniquely identifies this class.

Methods

FromApiMappingAttributes(Construct, string, IApiMappingAttributes)

import from API ID.

Constructors

ApiMapping(Construct, string, IApiMappingProps)

Create a new API mapping for API Gateway API endpoint.

public ApiMapping(Construct scope, string id, IApiMappingProps props)
Parameters
scope Construct
id string
props IApiMappingProps
Remarks

Resource: 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;

             IApi api;
             DomainName domainName;
             IStage stage;

             var apiMapping = new ApiMapping(this, "MyApiMapping", new ApiMappingProps {
                 Api = api,
                 DomainName = domainName,

                 // the properties below are optional
                 ApiMappingKey = "apiMappingKey",
                 Stage = stage
             });

Properties

ApiMappingId

ID of the API Mapping.

public virtual string ApiMappingId { get; }
Property Value

string

Remarks

Resource: AWS::ApiGatewayV2::ApiMapping

ExampleMetadata: fixture=_generated

DomainName

API domain name.

public virtual IDomainName DomainName { get; }
Property Value

IDomainName

Remarks

Resource: AWS::ApiGatewayV2::ApiMapping

ExampleMetadata: fixture=_generated

MappingKey

API Mapping key.

public virtual string? MappingKey { get; }
Property Value

string

Remarks

Resource: AWS::ApiGatewayV2::ApiMapping

ExampleMetadata: fixture=_generated

PROPERTY_INJECTION_ID

Uniquely identifies this class.

public static string PROPERTY_INJECTION_ID { get; }
Property Value

string

Remarks

Resource: AWS::ApiGatewayV2::ApiMapping

ExampleMetadata: fixture=_generated

Methods

FromApiMappingAttributes(Construct, string, IApiMappingAttributes)

import from API ID.

public static IApiMapping FromApiMappingAttributes(Construct scope, string id, IApiMappingAttributes attrs)
Parameters
scope Construct
id string
attrs IApiMappingAttributes
Returns

IApiMapping

Remarks

Resource: AWS::ApiGatewayV2::ApiMapping

ExampleMetadata: fixture=_generated

Implements

Constructs.IConstruct
Constructs.IDependable