Interface IApiMappingProps
(experimental) Properties used to create the ApiMapping resource.
Namespace: Amazon.CDK.AWS.APIGatewayv2
Assembly: Amazon.CDK.AWS.APIGatewayv2.dll
Syntax (csharp)
public interface IApiMappingProps
Syntax (vb)
Public Interface IApiMappingProps
Remarks
Stability: Experimental
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
Properties
Api | (experimental) The Api to which this mapping is applied. |
ApiMappingKey | (experimental) Api mapping key. |
DomainName | (experimental) custom domain name of the mapping target. |
Stage | (experimental) stage for the ApiMapping resource required for WebSocket API defaults to default stage of an HTTP API. |
Properties
Api
(experimental) The Api to which this mapping is applied.
IApi Api { get; }
Property Value
Remarks
Stability: Experimental
ApiMappingKey
(experimental) Api mapping key.
virtual string ApiMappingKey { get; }
Property Value
System.String
Remarks
The path where this stage should be mapped to on the domain
Default: - undefined for the root path mapping.
Stability: Experimental
DomainName
(experimental) custom domain name of the mapping target.
IDomainName DomainName { get; }
Property Value
Remarks
Stability: Experimental
Stage
(experimental) stage for the ApiMapping resource required for WebSocket API defaults to default stage of an HTTP API.
virtual IStage Stage { get; }
Property Value
Remarks
Default: - Default stage of the passed API for HTTP API, required for WebSocket API
Stability: Experimental