ApiStackProps

Open in ChatGPT Open in Claude

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

Extends

BaseStackProps<T>.Omit<AtfRestApiProps, "envConfig" | "lambdaConfigs" | "registry" | "userPool" | "projectRoot">

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

apiKeySourceType?

readonly optional apiKeySourceType?: ApiKeySourceType

Defined in: node_modules/.pnpm/aws-cdk-lib@2.261.0_constructs@10.7.0/node_modules/aws-cdk-lib/aws-apigateway/lib/restapi.d.ts:244

The source of the API key for metering requests according to a usage plan.

Default

- Metering is disabled.

Inherited from

Omit.apiKeySourceType

binaryMediaTypes?

readonly optional binaryMediaTypes?: string[]

Defined in: node_modules/.pnpm/aws-cdk-lib@2.261.0_constructs@10.7.0/node_modules/aws-cdk-lib/aws-apigateway/lib/restapi.d.ts:208

The list of binary media mime-types that are supported by the RestApi resource, such as “image/png” or “application/octet-stream”

Default

- RestApi supports only UTF-8-encoded text payloads.

Inherited from

Omit.binaryMediaTypes

cloneFrom?

readonly optional cloneFrom?: IRestApi

Defined in: node_modules/.pnpm/aws-cdk-lib@2.261.0_constructs@10.7.0/node_modules/aws-cdk-lib/aws-apigateway/lib/restapi.d.ts:237

The ID of the API Gateway RestApi resource that you want to clone.

Default

- None.

Inherited from

Omit.cloneFrom

cloudWatchRole?

readonly optional cloudWatchRole?: boolean

Defined in: node_modules/.pnpm/aws-cdk-lib@2.261.0_constructs@10.7.0/node_modules/aws-cdk-lib/aws-apigateway/lib/restapi.d.ts:153

Automatically configure an AWS CloudWatch role for API Gateway.

Default

false if @aws-cdk/aws-apigateway:disableCloudWatchRole is enabled, true otherwise

Inherited from

Omit.cloudWatchRole

cloudWatchRoleRemovalPolicy?

readonly optional cloudWatchRoleRemovalPolicy?: RemovalPolicy

Defined in: node_modules/.pnpm/aws-cdk-lib@2.261.0_constructs@10.7.0/node_modules/aws-cdk-lib/aws-apigateway/lib/restapi.d.ts:161

The removal policy applied to the AWS CloudWatch role when this resource is removed from the application. Requires cloudWatchRole to be enabled.

Default

- RemovalPolicy.RETAIN

Inherited from

Omit.cloudWatchRoleRemovalPolicy

corsAllowedOrigins?

optional corsAllowedOrigins?: string[]

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

CORS allowed origins — Axis wires preflight automatically

Overrides

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

defaultIntegration?

readonly optional defaultIntegration?: Integration

Defined in: node_modules/.pnpm/aws-cdk-lib@2.261.0_constructs@10.7.0/node_modules/aws-cdk-lib/aws-apigateway/lib/resource.d.ts:109

An integration to use as a default for all methods created within this API unless an integration is specified.

Default

- Inherited from parent.

Inherited from

Omit.defaultIntegration

defaultMethodOptions?

readonly optional defaultMethodOptions?: MethodOptions

Defined in: node_modules/.pnpm/aws-cdk-lib@2.261.0_constructs@10.7.0/node_modules/aws-cdk-lib/aws-apigateway/lib/resource.d.ts:116

Method options to use as a default for all methods created within this API unless custom options are specified.

Default

- Inherited from parent.

Inherited from

Omit.defaultMethodOptions

deploy?

readonly optional deploy?: boolean

Defined in: node_modules/.pnpm/aws-cdk-lib@2.261.0_constructs@10.7.0/node_modules/aws-cdk-lib/aws-apigateway/lib/restapi.d.ts:97

Indicates if a Deployment should be automatically created for this API, and recreated when the API model (resources, methods) changes.

Since API Gateway deployments are immutable, When this option is enabled (by default), an AWS::ApiGateway::Deployment resource will automatically created with a logical ID that hashes the API model (methods, resources and options). This means that when the model changes, the logical ID of this CloudFormation resource will change, and a new deployment will be created.

If this is set, latestDeployment will refer to the Deployment object and deploymentStage will refer to a Stage that points to this deployment. To customize the stage options, use the deployOptions property.

A CloudFormation Output will also be defined with the root URL endpoint of this REST API.

Default

true

Inherited from

Omit.deploy

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-apigateway/lib/restapi.d.ts:190

Specifies whether clients can invoke the API using the default execute-api endpoint. To require that clients use a custom domain name to invoke the API, disable the default endpoint.

See

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html

Default

false

Inherited from

Omit.disableExecuteApiEndpoint

domainName?

readonly optional domainName?: DomainNameOptions

Defined in: node_modules/.pnpm/aws-cdk-lib@2.261.0_constructs@10.7.0/node_modules/aws-cdk-lib/aws-apigateway/lib/restapi.d.ts:147

Configure a custom domain name and map it to this API.

Default

no domain name is defined, use addDomainName or directly define a DomainName.

Inherited from

Omit.domainName

endpointConfiguration?

readonly optional endpointConfiguration?: EndpointConfiguration

Defined in: node_modules/.pnpm/aws-cdk-lib@2.261.0_constructs@10.7.0/node_modules/aws-cdk-lib/aws-apigateway/lib/restapi.d.ts:181

The EndpointConfiguration property type specifies the endpoint types of a REST API

See

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-restapi-endpointconfiguration.html

Default

EndpointType.EDGE

Inherited from

Omit.endpointConfiguration

endpointExportName?

readonly optional endpointExportName?: string

Defined in: node_modules/.pnpm/aws-cdk-lib@2.261.0_constructs@10.7.0/node_modules/aws-cdk-lib/aws-apigateway/lib/restapi.d.ts:167

Export name for the CfnOutput containing the API endpoint

Default

- when no export name is given, output will be created without export

Inherited from

Omit.endpointExportName

endpointTypes?

readonly optional endpointTypes?: EndpointType[]

Defined in: node_modules/.pnpm/aws-cdk-lib@2.261.0_constructs@10.7.0/node_modules/aws-cdk-lib/aws-apigateway/lib/restapi.d.ts:174

A list of the endpoint types of the API. Use this property when creating an API.

Default

EndpointType.EDGE

Inherited from

Omit.endpointTypes

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

failOnWarnings?

readonly optional failOnWarnings?: boolean

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

Indicates whether to roll back the resource if a warning occurs while API Gateway is creating the RestApi resource.

Default

false

Inherited from

Omit.failOnWarnings

lambdaAuthorizer?

optional lambdaAuthorizer?: AtfLambdaAuthorizerConfig

Defined in: packages/constructs/src/api/rest-api.ts:56

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

Inherited from

AtfRestApiProps.lambdaAuthorizer

minCompressionSize?

readonly optional minCompressionSize?: Size

Defined in: node_modules/.pnpm/aws-cdk-lib@2.261.0_constructs@10.7.0/node_modules/aws-cdk-lib/aws-apigateway/lib/restapi.d.ts:231

A Size(in bytes, kibibytes, mebibytes etc) that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (when undefined) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.

Default

- Compression is disabled.

Inherited from

Omit.minCompressionSize

minimumCompressionSize?

readonly optional minimumCompressionSize?: number

Defined in: node_modules/.pnpm/aws-cdk-lib@2.261.0_constructs@10.7.0/node_modules/aws-cdk-lib/aws-apigateway/lib/restapi.d.ts:220

A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (when undefined) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.

Default

- Compression is disabled.

Inherited from

Omit.minimumCompressionSize

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

parameters?

readonly optional parameters?: object

Defined in: node_modules/.pnpm/aws-cdk-lib@2.261.0_constructs@10.7.0/node_modules/aws-cdk-lib/aws-apigateway/lib/restapi.d.ts:126

Custom header parameters for the request.

Index Signature

[key: string]: string

See

https://docs.aws.amazon.com/cli/latest/reference/apigateway/import-rest-api.html

Default

- No parameters.

Inherited from

Omit.parameters

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

policy?

readonly optional policy?: PolicyDocument

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

A policy document that contains the permissions for this RestApi

Default

- No policy.

Inherited from

Omit.policy

projectRoot

projectRoot: string

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

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

retainDeployments?

readonly optional retainDeployments?: boolean

Defined in: node_modules/.pnpm/aws-cdk-lib@2.261.0_constructs@10.7.0/node_modules/aws-cdk-lib/aws-apigateway/lib/restapi.d.ts:113

Retains old deployment resources when the API changes. This allows manually reverting stages to point to old deployments via the AWS Console.

Default

false

Inherited from

Omit.retainDeployments

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