Class ApiMappingProps

Properties used to create the ApiMapping resource.

Inheritance

object

ApiMappingProps

Implements

IApiMappingProps

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.Apigatewayv2

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class ApiMappingProps : IApiMappingProps

Syntax (vb)

Public Class ApiMappingProps 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 used to create the ApiMapping resource.

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

Properties used to create the ApiMapping resource.

public ApiMappingProps()

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
            };

Properties

Api

The Api to which this mapping is applied.

public IApi Api { get; set; }

Property Value

IApi

Remarks

ExampleMetadata: fixture=_generated

ApiMappingKey

Api mapping key.

public string? ApiMappingKey { get; set; }

Property Value

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

Remarks

ExampleMetadata: fixture=_generated

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

IApiMappingProps