aws-cdk-lib.aws_sam.CfnHttpApiProps

CfnHttpApiProps Struct

Properties for defining a CfnHttpApi.

Source

Generated code

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

accessLogSettingIResolvable | CfnHttpApi.AccessLogSettingPropertyaccess_log_settingtyping.Union[IResolvable, AccessLogSettingProperty]accessLogSettingIResolvableAccessLogSettingIResolvableAccessLogSettinginterface{}#

authIResolvable | CfnHttpApi.HttpApiAuthPropertyauthtyping.Union[IResolvable, HttpApiAuthProperty]authIResolvableAuthIResolvableAuthinterface{}#

corsConfigurationboolean | IResolvable | CfnHttpApi.CorsConfigurationObjectPropertycors_configurationtyping.Union[bool, IResolvable, CorsConfigurationObjectProperty]corsConfigurationBooleanCorsConfigurationboolCorsConfigurationinterface{}#

defaultRouteSettingsIResolvable | CfnHttpApi.RouteSettingsPropertydefault_route_settingstyping.Union[IResolvable, RouteSettingsProperty]defaultRouteSettingsIResolvableDefaultRouteSettingsIResolvableDefaultRouteSettingsinterface{}#

definitionBodyanydefinition_bodyAnydefinitionBodyObjectDefinitionBodyobjectDefinitionBodyinterface{}#

definitionUristring | IResolvable | CfnHttpApi.S3LocationPropertydefinition_urityping.Union[str, IResolvable, S3LocationProperty]definitionUriStringDefinitionUristringDefinitionUriinterface{}#

descriptionstringdescriptionstrdescriptionStringDescriptionstringDescription*string#

disableExecuteApiEndpointboolean | IResolvabledisable_execute_api_endpointtyping.Union[bool, IResolvable]disableExecuteApiEndpointBooleanDisableExecuteApiEndpointboolDisableExecuteApiEndpointinterface{}#

domainIResolvable | CfnHttpApi.HttpApiDomainConfigurationPropertydomaintyping.Union[IResolvable, HttpApiDomainConfigurationProperty]domainIResolvableDomainIResolvableDomaininterface{}#

failOnWarningsboolean | IResolvablefail_on_warningstyping.Union[bool, IResolvable]failOnWarningsBooleanFailOnWarningsboolFailOnWarningsinterface{}#

routeSettingsIResolvable | CfnHttpApi.RouteSettingsPropertyroute_settingstyping.Union[IResolvable, RouteSettingsProperty]routeSettingsIResolvableRouteSettingsIResolvableRouteSettingsinterface{}#

stageNamestringstage_namestrstageNameStringStageNamestringStageName*string#

stageVariablesIResolvable | { [key: string]: string }stage_variablestyping.Union[IResolvable, typing.Mapping[str, str]]stageVariablesIResolvableStageVariablesIResolvableStageVariablesinterface{}#

tags{ [key: string]: string }tagstyping.Mapping[str, str]tagsMap<String, String>TagsIDictionary<string, string>Tags*map[string]*string#

Used as props by

• CfnHttpApi