interface CfnHttpApiProps
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.SAM.CfnHttpApiProps |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awssam#CfnHttpApiProps |
![]() | software.amazon.awscdk.services.sam.CfnHttpApiProps |
![]() | aws_cdk.aws_sam.CfnHttpApiProps |
![]() | 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 |
---|---|---|
access | IResolvable | Access | |
auth? | IResolvable | Http | |
cors | boolean | IResolvable | Cors | |
default | IResolvable | Route | |
definition | any | |
definition | string | IResolvable | S3 | |
description? | string | |
disable | boolean | IResolvable | |
domain? | IResolvable | Http | |
fail | boolean | IResolvable | |
route | IResolvable | Route | |
stage | string | |
stage | { [string]: string } | IResolvable | |
tags? | { [string]: string } |
accessLogSetting?
Type:
IResolvable
|
Access
(optional)
auth?
Type:
IResolvable
|
Http
(optional)
corsConfiguration?
Type:
boolean |
IResolvable
|
Cors
(optional)
defaultRouteSettings?
Type:
IResolvable
|
Route
(optional)
definitionBody?
Type:
any
(optional)
definitionUri?
Type:
string |
IResolvable
|
S3
(optional)
description?
Type:
string
(optional)
disableExecuteApiEndpoint?
Type:
boolean |
IResolvable
(optional)
domain?
Type:
IResolvable
|
Http
(optional)
failOnWarnings?
Type:
boolean |
IResolvable
(optional)
routeSettings?
Type:
IResolvable
|
Route
(optional)
stageName?
Type:
string
(optional)
stageVariables?
Type:
{ [string]: string } |
IResolvable
(optional)
tags?
Type:
{ [string]: string }
(optional)