Class ApiMapping

Create a new API mapping for API Gateway API endpoint.

Inheritance
System.Object
Resource
ApiMapping
Implements
Constructs.IConstruct
Constructs.IDependable
Inherited Members
Namespace: Amazon.CDK.AWS.Apigatewayv2
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class ApiMapping : Resource, IApiMapping, IResource
Syntax (vb)
Public Class ApiMapping
    Inherits Resource
    Implements IApiMapping, IResource
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(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference
ApiMapping(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps
ApiMapping(Construct, String, IApiMappingProps)

Properties

ApiMappingId

ID of the API Mapping.
DomainName

API domain name.
MappingKey

API Mapping key.

Methods

FromApiMappingAttributes(Construct, String, IApiMappingAttributes)

import from API ID.

Constructors

ApiMapping(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected ApiMapping(ByRefValue reference)
Parameters
reference Amazon.JSII.Runtime.Deputy.ByRefValue

The Javascript-owned object reference

ApiMapping(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected ApiMapping(DeputyBase.DeputyProps props)
Parameters
props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps

The deputy props

ApiMapping(Construct, String, IApiMappingProps)

public ApiMapping(Construct scope, string id, IApiMappingProps props)
Parameters
scope Constructs.Construct
id System.String
props IApiMappingProps

Properties

ApiMappingId

ID of the API Mapping.

public virtual string ApiMappingId { get; }
Property Value

System.String

DomainName

API domain name.

public virtual IDomainName DomainName { get; }
Property Value

IDomainName

MappingKey

API Mapping key.

public virtual string MappingKey { get; }
Property Value

System.String

Methods

FromApiMappingAttributes(Construct, String, IApiMappingAttributes)

import from API ID.

public static IApiMapping FromApiMappingAttributes(Construct scope, string id, IApiMappingAttributes attrs)
Parameters
scope Constructs.Construct
id System.String
attrs IApiMappingAttributes
Returns

IApiMapping

Implements

Constructs.IConstruct
Constructs.IDependable