Class DomainMappingOptions
Options for DomainMapping.
Inheritance
System.Object
DomainMappingOptions
Implements
Namespace: Amazon.CDK.AWS.Apigatewayv2
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class DomainMappingOptions : Object, IDomainMappingOptions
Syntax (vb)
Public Class DomainMappingOptions
Inherits Object
Implements IDomainMappingOptions
Remarks
ExampleMetadata: infused
Examples
using Amazon.CDK.HttpLambdaIntegration;
Function handler;
DomainName dn;
var apiDemo = new HttpApi(this, "DemoApi", new HttpApiProps {
DefaultIntegration = new HttpLambdaIntegration("DefaultIntegration", handler),
// https://${dn.domainName}/demo goes to apiDemo $default stage
DefaultDomainMapping = new DomainMappingOptions {
DomainName = dn,
MappingKey = "demo"
}
});
Synopsis
Constructors
DomainMappingOptions() |
Properties
DomainName | The domain name for the mapping. |
MappingKey | The API mapping key. |
Constructors
DomainMappingOptions()
public DomainMappingOptions()
Properties
DomainName
The domain name for the mapping.
public IDomainName DomainName { get; set; }
Property Value
MappingKey
The API mapping key.
public string MappingKey { get; set; }
Property Value
System.String
Remarks
Leave it undefined for the root path mapping.
Default: - empty key for the root path mapping