Class ApiMappingProps

Properties used to create the ApiMapping resource.

Inheritance
System.Object
ApiMappingProps
Implements
Namespace: Amazon.CDK.AWS.Apigatewayv2
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class ApiMappingProps : Object, IApiMappingProps
Syntax (vb)
Public Class ApiMappingProps
    Inherits Object
    Implements IApiMappingProps
Remarks

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 apiMappingProps = new ApiMappingProps {
    Api = api,
    DomainName = domainName,

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

Synopsis

Constructors

ApiMappingProps()

Properties

Api

The Api to which this mapping is applied.
ApiMappingKey

Api mapping key.
DomainName

custom domain name of the mapping target.
Stage

stage for the ApiMapping resource required for WebSocket API defaults to default stage of an HTTP API.

Constructors

ApiMappingProps()

public ApiMappingProps()

Properties

Api

The Api to which this mapping is applied.

public IApi Api { get; set; }
Property Value

IApi

ApiMappingKey

Api mapping key.

public string ApiMappingKey { get; set; }
Property Value

System.String

Remarks

The path where this stage should be mapped to on the domain

Default: - undefined for the root path mapping.

DomainName

custom domain name of the mapping target.

public IDomainName DomainName { get; set; }
Property Value

IDomainName

Stage

stage for the ApiMapping resource required for WebSocket API defaults to default stage of an HTTP API.

public IStage Stage { get; set; }
Property Value

IStage

Remarks

Default: - Default stage of the passed API for HTTP API, required for WebSocket API

Implements