AtfHttpApiProps

Defined in: packages/constructs/src/api/http-api.ts:79

Extends

• Omit<apigatewayv2.HttpApiProps, "apiName" | "corsPreflight" | "createDefaultStage" | "defaultAuthorizer">

Properties

corsAllowedOrigins?

optional corsAllowedOrigins?: string[]

Defined in: packages/constructs/src/api/http-api.ts:92

CORS allowed origins — Axis wires the preflight automatically.

---

defaultAuthorizationScopes?

readonly optional defaultAuthorizationScopes?: string[]

Defined in: node_modules/.pnpm/aws-cdk-lib@2.261.0_constructs@10.7.0/node_modules/aws-cdk-lib/aws-apigatewayv2/lib/http/api.d.ts:165

Default OIDC scopes attached to all routes in the gateway, unless explicitly configured on the route. The scopes are used with a COGNITO_USER_POOLS authorizer to authorize the method invocation.

Default

- no default authorization scopes

Inherited from

Omit.defaultAuthorizationScopes

---

defaultDomainMapping?

readonly optional defaultDomainMapping?: DomainMappingOptions

Defined in: node_modules/.pnpm/aws-cdk-lib@2.261.0_constructs@10.7.0/node_modules/aws-cdk-lib/aws-apigatewayv2/lib/http/api.d.ts:144

Configure a custom domain with the API mapping resource to the HTTP API

Default

• no default domain mapping configured. meaningless if createDefaultStage is false.

Inherited from

Omit.defaultDomainMapping

---

defaultIntegration?

readonly optional defaultIntegration?: HttpRouteIntegration

Defined in: node_modules/.pnpm/aws-cdk-lib@2.261.0_constructs@10.7.0/node_modules/aws-cdk-lib/aws-apigatewayv2/lib/http/api.d.ts:127

An integration that will be configured on the catch-all route ($default).

Default

- none

Inherited from

Omit.defaultIntegration

---

description?

readonly optional description?: string

Defined in: node_modules/.pnpm/aws-cdk-lib@2.261.0_constructs@10.7.0/node_modules/aws-cdk-lib/aws-apigatewayv2/lib/http/api.d.ts:122

The description of the API.

Default

- none

Inherited from

Omit.description

---

disableExecuteApiEndpoint?

readonly optional disableExecuteApiEndpoint?: boolean

Defined in: node_modules/.pnpm/aws-cdk-lib@2.261.0_constructs@10.7.0/node_modules/aws-cdk-lib/aws-apigatewayv2/lib/http/api.d.ts:152

Specifies whether clients can invoke your API using the default endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. Set this to true if you would like clients to use your custom domain name.

Default

false execute-api endpoint enabled.

Inherited from

Omit.disableExecuteApiEndpoint

---

domain?

optional domain?: HttpApiDomainConfig

Defined in: packages/constructs/src/api/http-api.ts:100

Optional custom domain.

---

envConfig

envConfig: BaseEnvConfig

Defined in: packages/constructs/src/api/http-api.ts:86

---

ipAddressType?

readonly optional ipAddressType?: IpAddressType

Defined in: node_modules/.pnpm/aws-cdk-lib@2.261.0_constructs@10.7.0/node_modules/aws-cdk-lib/aws-apigatewayv2/lib/http/api.d.ts:181

The IP address types that can invoke the API.

See

https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-ip-address-type.html

Default

undefined - AWS default is IPV4

Inherited from

Omit.ipAddressType

---

lambdaAuthorizer?

optional lambdaAuthorizer?: AtfLambdaAuthorizerConfig

Defined in: packages/constructs/src/api/http-api.ts:102

Optional Lambda (REQUEST) authorizer for routes with authorizer:“lambda”.

---

lambdaConfigs

lambdaConfigs: HttpApiLambdaConfig[]

Defined in: packages/constructs/src/api/http-api.ts:94

HTTP API route configs.

---

projectRoot

projectRoot: string

Defined in: packages/constructs/src/api/http-api.ts:98

Project root for entry-path resolution.

---

registry

registry: ResourceRegistry

Defined in: packages/constructs/src/api/http-api.ts:96

Resource registry for token resolution.

---

routeSelectionExpression?

readonly optional routeSelectionExpression?: boolean

Defined in: node_modules/.pnpm/aws-cdk-lib@2.261.0_constructs@10.7.0/node_modules/aws-cdk-lib/aws-apigatewayv2/lib/http/api.d.ts:173

Whether to set the default route selection expression for the API.

When enabled, ”${request.method} ${request.path}” is set as the default route selection expression.

Default

false

Inherited from

Omit.routeSelectionExpression

---

userPool?

optional userPool?: IUserPool

Defined in: packages/constructs/src/api/http-api.ts:88

Cognito User Pool for the JWT authorizer.

---

userPoolClient?

optional userPoolClient?: IUserPoolClient

Defined in: packages/constructs/src/api/http-api.ts:90

Cognito User Pool client — the JWT audience. Required for the authorizer.