# CfnHttpApiProps

Properties for defining a `CfnHttpApi`.

Extends: CfnHttpApiProps
Used as props by: CfnHttpApi

- Source: Generated code

## Example

```ts
// 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

- `accessLogSetting`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnHttpApi.AccessLogSettingProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_sam.CfnHttpApi.AccessLogSettingProperty.html)

- `auth`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnHttpApi.HttpApiAuthProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_sam.CfnHttpApi.HttpApiAuthProperty.html)

- `corsConfiguration`: boolean | [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnHttpApi.CorsConfigurationObjectProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_sam.CfnHttpApi.CorsConfigurationObjectProperty.html)

- `defaultRouteSettings`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnHttpApi.RouteSettingsProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_sam.CfnHttpApi.RouteSettingsProperty.html)

- `definitionBody`: any

- `definitionUri`: string | [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnHttpApi.S3LocationProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_sam.CfnHttpApi.S3LocationProperty.html)

- `description`: string

- `disableExecuteApiEndpoint`: boolean | [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html)

- `domain`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnHttpApi.HttpApiDomainConfigurationProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_sam.CfnHttpApi.HttpApiDomainConfigurationProperty.html)

- `failOnWarnings`: boolean | [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html)

- `routeSettings`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnHttpApi.RouteSettingsProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_sam.CfnHttpApi.RouteSettingsProperty.html)

- `stageName`: string

- `stageVariables`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | { [key: string]: string }

- `tags`: { [key: string]: string }