HttpApiStackProps

Open in ChatGPT Open in Claude

Defined in: packages/stacks/src/http-api-stack.ts:36

Extends

BaseStackProps<T>.Omit<AtfHttpApiProps, "envConfig" | "lambdaConfigs" | "registry" | "userPool" | "userPoolClient" | "projectRoot" | "domain">

Type Parameters

T

T extends BaseEnvConfig

Properties

analyticsReporting?

readonly optional analyticsReporting?: boolean

Defined in: node_modules/.pnpm/aws-cdk-lib@2.261.0_constructs@10.7.0/node_modules/aws-cdk-lib/core/lib/stack.d.ts:141

Include runtime versioning information in this Stack

Default

analyticsReporting setting of containing App, or value of ‘aws:cdk:version-reporting’ context key

Inherited from

BaseStackProps.analyticsReporting

corsAllowedOrigins?

optional corsAllowedOrigins?: string[]

Defined in: packages/stacks/src/http-api-stack.ts:50

CORS allowed origins — Axis wires the preflight automatically.

Overrides

AtfHttpApiProps.corsAllowedOrigins

crossRegionReferences?

readonly optional crossRegionReferences?: boolean

Defined in: node_modules/.pnpm/aws-cdk-lib@2.261.0_constructs@10.7.0/node_modules/aws-cdk-lib/core/lib/stack.d.ts:152

Enable this flag to allow native cross region stack references.

Enabling this will create a CloudFormation custom resource in both the producing stack and consuming stack in order to perform the export/import

This feature is currently experimental

Default

false

Inherited from

BaseStackProps.crossRegionReferences

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/core/lib/stack.d.ts:19

A description of the stack.

Default

- No description.

Inherited from

BaseStackProps.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/stacks/src/http-api-stack.ts:51

env?

readonly optional env?: Environment

Defined in: node_modules/.pnpm/aws-cdk-lib@2.261.0_constructs@10.7.0/node_modules/aws-cdk-lib/core/lib/stack.d.ts:84

The AWS environment (account/region) where this stack will be deployed.

Set the region/account fields of env to either a concrete value to select the indicated environment (recommended for production stacks), or to the values of environment variables CDK_DEFAULT_REGION/CDK_DEFAULT_ACCOUNT to let the target environment depend on the AWS credentials/configuration that the CDK CLI is executed under (recommended for development stacks).

If the Stack is instantiated inside a Stage, any undefined region/account fields from env will default to the same field on the encompassing Stage, if configured there.

If either region or account are not set nor inherited from Stage, the Stack will be considered “environment-agnostic"". Environment-agnostic stacks can be deployed to any environment but may not be able to take advantage of all features of the CDK. For example, they will not be able to use environmental context lookups such as ec2.Vpc.fromLookup and will not automatically translate Service Principals to the right format based on the environment’s AWS partition, and other such enhancements.

Example

// Use a concrete account and region to deploy this stack to:
// `.account` and `.region` will simply return these values.
new Stack(app, 'Stack1', {
  env: {
    account: '123456789012',
    region: 'us-east-1'
  },
});

// Use the CLI's current credentials to determine the target environment:
// `.account` and `.region` will reflect the account+region the CLI
// is configured to use (based on the user CLI credentials)
new Stack(app, 'Stack2', {
  env: {
    account: process.env.CDK_DEFAULT_ACCOUNT,
    region: process.env.CDK_DEFAULT_REGION
  },
});

// Define multiple stacks stage associated with an environment
const myStage = new Stage(app, 'MyStage', {
  env: {
    account: '123456789012',
    region: 'us-east-1'
  }
});

// both of these stacks will use the stage's account/region:
// `.account` and `.region` will resolve to the concrete values as above
new MyStack(myStage, 'Stack1');
new YourStack(myStage, 'Stack2');

// Define an environment-agnostic stack:
// `.account` and `.region` will resolve to `{ "Ref": "AWS::AccountId" }` and `{ "Ref": "AWS::Region" }` respectively.
// which will only resolve to actual values by CloudFormation during deployment.
new MyStack(app, 'Stack1');

Default

The environment of the containing Stage if available, otherwise create the stack will be environment-agnostic.

Inherited from

BaseStackProps.env

envConfig

envConfig: T

Defined in: packages/stacks/src/base-stack.ts:15

Inherited from

BaseStackProps.envConfig

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”.

Inherited from

AtfHttpApiProps.lambdaAuthorizer

notificationArns?

readonly optional notificationArns?: string[]

Defined in: node_modules/.pnpm/aws-cdk-lib@2.261.0_constructs@10.7.0/node_modules/aws-cdk-lib/core/lib/stack.d.ts:112

SNS Topic ARNs that will receive stack events.

Default

- no notification arns.

Inherited from

BaseStackProps.notificationArns

permissionsBoundary?

readonly optional permissionsBoundary?: PermissionsBoundary

Defined in: node_modules/.pnpm/aws-cdk-lib@2.261.0_constructs@10.7.0/node_modules/aws-cdk-lib/core/lib/stack.d.ts:159

Options for applying a permissions boundary to all IAM Roles and Users created within this Stage

Default

- no permissions boundary is applied

Inherited from

BaseStackProps.permissionsBoundary

projectRoot

projectRoot: string

Defined in: packages/stacks/src/http-api-stack.ts:49

propertyInjectors?

readonly optional propertyInjectors?: IPropertyInjector[]

Defined in: node_modules/.pnpm/aws-cdk-lib@2.261.0_constructs@10.7.0/node_modules/aws-cdk-lib/core/lib/stack.d.ts:175

A list of IPropertyInjector attached to this Stack.

Default

- no PropertyInjectors

Inherited from

BaseStackProps.propertyInjectors

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

stackName?

readonly optional stackName?: string

Defined in: node_modules/.pnpm/aws-cdk-lib@2.261.0_constructs@10.7.0/node_modules/aws-cdk-lib/core/lib/stack.d.ts:90

Name to deploy the stack with

Default

- Derived from construct path.

Inherited from

BaseStackProps.stackName

suppressTemplateIndentation?

readonly optional suppressTemplateIndentation?: boolean

Defined in: node_modules/.pnpm/aws-cdk-lib@2.261.0_constructs@10.7.0/node_modules/aws-cdk-lib/core/lib/stack.d.ts:170

Enable this flag to suppress indentation in generated CloudFormation templates.

If not specified, the value of the @aws-cdk/core:suppressTemplateIndentation context key will be used. If that is not specified, then the default value false will be used.

Default

the value of @aws-cdk/core:suppressTemplateIndentation, or false if that is not set.

Inherited from

BaseStackProps.suppressTemplateIndentation

synthesizer?

readonly optional synthesizer?: IStackSynthesizer

Defined in: node_modules/.pnpm/aws-cdk-lib@2.261.0_constructs@10.7.0/node_modules/aws-cdk-lib/core/lib/stack.d.ts:128

Synthesis method to use while deploying this stack

The Stack Synthesizer controls aspects of synthesis and deployment, like how assets are referenced and what IAM roles to use. For more information, see the README of the main CDK package.

If not specified, the defaultStackSynthesizer from App will be used. If that is not specified, DefaultStackSynthesizer is used if @aws-cdk/core:newStyleStackSynthesis is set to true or the CDK major version is v2. In CDK v1 LegacyStackSynthesizer is the default if no other synthesizer is specified.

Default

The synthesizer specified on App, or DefaultStackSynthesizer otherwise.

Inherited from

BaseStackProps.synthesizer

tags?

readonly optional tags?: object

Defined in: node_modules/.pnpm/aws-cdk-lib@2.261.0_constructs@10.7.0/node_modules/aws-cdk-lib/core/lib/stack.d.ts:104

Tags that will be applied to the Stack

These tags are applied to the CloudFormation Stack itself. They will not appear in the CloudFormation template.

However, at deployment time, CloudFormation will apply these tags to all resources in the stack that support tagging. You will not be able to exempt resources from tagging (using the excludeResourceTypes property of Tags.of(...).add()) for tags applied in this way.

Index Signature

[key: string]: string

Default

{}

Inherited from

BaseStackProps.tags

terminationProtection?

readonly optional terminationProtection?: boolean

Defined in: node_modules/.pnpm/aws-cdk-lib@2.261.0_constructs@10.7.0/node_modules/aws-cdk-lib/core/lib/stack.d.ts:134

Whether to enable termination protection for this stack.

Default

false

Inherited from

BaseStackProps.terminationProtection