@aws-cdk_aws-apigatewayv2-alpha.DomainMappingOptions

interface DomainMappingOptions ๐Ÿ”น

LanguageType name
.NETAmazon.CDK.AWS.Apigatewayv2.Alpha.DomainMappingOptions
Gogithub.com/aws/aws-cdk-go/awscdkapigatewayv2alpha/v2#DomainMappingOptions
Javasoftware.amazon.awscdk.services.apigatewayv2.alpha.DomainMappingOptions
Pythonaws_cdk.aws_apigatewayv2_alpha.DomainMappingOptions
TypeScript (source)@aws-cdk/aws-apigatewayv2-alpha ยป DomainMappingOptions

Options for DomainMapping.

Example

import { HttpLambdaIntegration } from '@aws-cdk/aws-apigatewayv2-integrations-alpha';

declare const handler: lambda.Function;
declare const dn: apigwv2.DomainName;

const apiDemo = new apigwv2.HttpApi(this, 'DemoApi', {
  defaultIntegration: new HttpLambdaIntegration('DefaultIntegration', handler),
  // https://${dn.domainName}/demo goes to apiDemo $default stage
  defaultDomainMapping: {
    domainName: dn,
    mappingKey: 'demo',
  },
});

Properties

NameTypeDescription
domainName๐Ÿ”นIDomainNameThe domain name for the mapping.
mappingKey?๐Ÿ”นstringThe API mapping key.

domainName๐Ÿ”น

Type: IDomainName

The domain name for the mapping.


mappingKey?๐Ÿ”น

Type: string (optional, default: empty key for the root path mapping)

The API mapping key.

Leave it undefined for the root path mapping.