Interface IDomainMappingOptions

Options for DomainMapping.

Namespace: Amazon.CDK.AWS.Apigatewayv2

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface IDomainMappingOptions

Syntax (vb)

Public Interface IDomainMappingOptions

Remarks

ExampleMetadata: infused

Examples

using Amazon.CDK.AwsApigatewayv2Integrations;

            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

Properties

DomainName	The domain name for the mapping.
MappingKey	The API mapping key.

Properties

DomainName

The domain name for the mapping.

IDomainNameRef DomainName { get; }

Property Value

IDomainNameRef

Remarks

ExampleMetadata: infused

MappingKey

The API mapping key.

string? MappingKey { get; }

Property Value

string

Remarks

Leave it undefined for the root path mapping.

Default: - empty key for the root path mapping