interface CfnHttpApiProps

Language	Type name
.NET	`Amazon.CDK.AWS.SAM.CfnHttpApiProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awssam#CfnHttpApiProps`
Java	`software.amazon.awscdk.services.sam.CfnHttpApiProps`
Python	`aws_cdk.aws_sam.CfnHttpApiProps`
TypeScript	`aws-cdk-lib` » `aws_sam` » `CfnHttpApiProps`

Properties for defining a CfnHttpApi.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-httpapi.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_sam as sam } from 'aws-cdk-lib';

declare const authorizers: any;
declare const definitionBody: any;
const cfnHttpApiProps: sam.CfnHttpApiProps = {
  accessLogSetting: {
    destinationArn: 'destinationArn',
    format: 'format',
  },
  auth: {
    authorizers: authorizers,
    defaultAuthorizer: 'defaultAuthorizer',
  },
  corsConfiguration: false,
  defaultRouteSettings: {
    dataTraceEnabled: false,
    detailedMetricsEnabled: false,
    loggingLevel: 'loggingLevel',
    throttlingBurstLimit: 123,
    throttlingRateLimit: 123,
  },
  definitionBody: definitionBody,
  definitionUri: 'definitionUri',
  description: 'description',
  disableExecuteApiEndpoint: false,
  domain: {
    certificateArn: 'certificateArn',
    domainName: 'domainName',

    // the properties below are optional
    basePath: 'basePath',
    endpointConfiguration: 'endpointConfiguration',
    mutualTlsAuthentication: {
      truststoreUri: 'truststoreUri',
      truststoreVersion: false,
    },
    route53: {
      distributedDomainName: 'distributedDomainName',
      evaluateTargetHealth: false,
      hostedZoneId: 'hostedZoneId',
      hostedZoneName: 'hostedZoneName',
      ipV6: false,
    },
    securityPolicy: 'securityPolicy',
  },
  failOnWarnings: false,
  routeSettings: {
    dataTraceEnabled: false,
    detailedMetricsEnabled: false,
    loggingLevel: 'loggingLevel',
    throttlingBurstLimit: 123,
    throttlingRateLimit: 123,
  },
  stageName: 'stageName',
  stageVariables: {
    stageVariablesKey: 'stageVariables',
  },
  tags: {
    tagsKey: 'tags',
  },
};

Properties

Name	Type	Description
accessLogSetting?	`IResolvable` `\|` `AccessLogSettingProperty`
auth?	`IResolvable` `\|` `HttpApiAuthProperty`
corsConfiguration?	`boolean \|` `IResolvable` `\|` `CorsConfigurationObjectProperty`
defaultRouteSettings?	`IResolvable` `\|` `RouteSettingsProperty`
definitionBody?	`any`
definitionUri?	`string \|` `IResolvable` `\|` `S3LocationProperty`
description?	`string`
disableExecuteApiEndpoint?	`boolean \|` `IResolvable`
domain?	`IResolvable` `\|` `HttpApiDomainConfigurationProperty`
failOnWarnings?	`boolean \|` `IResolvable`
routeSettings?	`IResolvable` `\|` `RouteSettingsProperty`
stageName?	`string`
stageVariables?	`{ [string]: string } \|` `IResolvable`
tags?	`{ [string]: string }`