stacktape 3.1.2 → 3.2.0-beta.11

package/types.d.ts

@@ -84,6 +84,21 @@ import type {
   LambdaEfsMountProps,
   CognitoAuthorizerProperties,
   LambdaAuthorizerProperties,
+  ApplicationLoadBalancerCustomTriggerProps,
+  ApplicationLoadBalancerErrorRateTriggerProps,
+  ApplicationLoadBalancerUnhealthyTargetsTriggerProps,
+  HttpApiGatewayErrorRateTriggerProps,
+  HttpApiGatewayLatencyTriggerProps,
+  RelationalDatabaseReadLatencyTriggerProps,
+  RelationalDatabaseWriteLatencyTriggerProps,
+  RelationalDatabaseCPUUtilizationTriggerProps,
+  RelationalDatabaseFreeStorageTriggerProps,
+  RelationalDatabaseFreeMemoryTriggerProps,
+  RelationalDatabaseConnectionCountTriggerProps,
+  SqsQueueReceivedMessagesCountTriggerProps,
+  SqsQueueNotEmptyTrigger,
+  LambdaErrorRateTriggerProps,
+  LambdaDurationTriggerProps,
   CustomResourceDefinitionProps,
   CustomResourceInstanceProps,
   DeploymentScriptProps,
@@ -98,6 +113,7 @@ declare const getTransformsSymbol: unique symbol;
 declare const setResourceNameSymbol: unique symbol;
 declare const resourceParamRefSymbol: unique symbol;
 declare const baseTypePropertiesSymbol: unique symbol;
+declare const alarmSymbol: unique symbol;
 /**
  * A reference to a resource parameter that will be resolved at runtime.
  * Stores a reference to the resource for lazy name resolution.
@@ -105,6 +121,25 @@ declare const baseTypePropertiesSymbol: unique symbol;
 /**
  * Base class for type/properties structures (engines, packaging, events, etc.)
  */
+/**
+ * Base class for type-only structures (no properties field, just type discriminator)
+ */
+/**
+ * Defines a CloudWatch alarm that monitors a metric and triggers notifications when thresholds are breached.
+ *
+ * Alarms can be attached to resources like Lambda functions, databases, load balancers, SQS queues, and HTTP API Gateways.
+ * When the alarm condition is met (e.g., error rate exceeds 5%), notifications are sent to configured targets (Slack, email, MS Teams).
+ *
+ * @example
+ * ```ts
+ * new Alarm({
+ *   trigger: new LambdaErrorRateTrigger({ thresholdPercent: 5 }),
+ *   evaluation: { period: 60, evaluationPeriods: 3, breachedPeriods: 2 },
+ *   notificationTargets: [{ slack: { url: $Secret('slack-webhook-url') } }],
+ *   description: 'Lambda error rate exceeded 5%'
+ * })
+ * ```
+ */
 /**
  * Base resource class that provides common functionality
  */
@@ -131,6 +166,10 @@ declare const getPropertiesSymbol: unique symbol;
 
 declare const getOverridesSymbol: unique symbol;
 
+/**
+ * A reference to a resource parameter that will be resolved at runtime.
+ * Stores a reference to the resource for lazy name resolution.
+ */
 export declare class ResourceParamReference {
     private __resource;
     private __param;
@@ -141,6 +180,22 @@ export declare class ResourceParamReference {
     valueOf(): string;
 }
 
+/**
+ * A reference to a resource parameter that will be resolved at runtime.
+ * Stores a reference to the resource for lazy name resolution.
+ */
+export declare class ResourceParamReference {
+    private __resource;
+    private __param;
+    readonly [resourceParamRefSymbol] = true;
+    constructor(resource: BaseResource, param: string);
+    toString(): string;
+    toJSON(): string;
+    valueOf(): string;
+}
+/**
+ * Base class for type/properties structures (engines, packaging, events, etc.)
+ */
 export declare class BaseTypeProperties {
     readonly type: string;
     readonly properties: any;
@@ -148,6 +203,78 @@ export declare class BaseTypeProperties {
     constructor(type: string, properties: any);
 }
 
+/**
+ * A reference to a resource parameter that will be resolved at runtime.
+ * Stores a reference to the resource for lazy name resolution.
+ */
+export declare class ResourceParamReference {
+    private __resource;
+    private __param;
+    readonly [resourceParamRefSymbol] = true;
+    constructor(resource: BaseResource, param: string);
+    toString(): string;
+    toJSON(): string;
+    valueOf(): string;
+}
+/**
+ * Base class for type/properties structures (engines, packaging, events, etc.)
+ */
+export declare class BaseTypeProperties {
+    readonly type: string;
+    readonly properties: any;
+    readonly [baseTypePropertiesSymbol] = true;
+    constructor(type: string, properties: any);
+}
+/**
+ * Base class for type-only structures (no properties field, just type discriminator)
+ */
+export declare class BaseTypeOnly {
+    readonly type: string;
+    readonly [baseTypePropertiesSymbol] = true;
+    constructor(type: string);
+}
+
+/**
+ * Base class for type-only structures (no properties field, just type discriminator)
+ */
+export declare class BaseTypeOnly {
+    readonly type: string;
+    readonly [baseTypePropertiesSymbol] = true;
+    constructor(type: string);
+}
+/**
+ * Defines a CloudWatch alarm that monitors a metric and triggers notifications when thresholds are breached.
+ *
+ * Alarms can be attached to resources like Lambda functions, databases, load balancers, SQS queues, and HTTP API Gateways.
+ * When the alarm condition is met (e.g., error rate exceeds 5%), notifications are sent to configured targets (Slack, email, MS Teams).
+ *
+ * @example
+ * ```ts
+ * new Alarm({
+ *   trigger: new LambdaErrorRateTrigger({ thresholdPercent: 5 }),
+ *   evaluation: { period: 60, evaluationPeriods: 3, breachedPeriods: 2 },
+ *   notificationTargets: [{ slack: { url: $Secret('slack-webhook-url') } }],
+ *   description: 'Lambda error rate exceeded 5%'
+ * })
+ * ```
+ */
+export declare class Alarm {
+    readonly [alarmSymbol] = true;
+    readonly trigger: any;
+    readonly evaluation?: any;
+    readonly notificationTargets?: any[];
+    readonly description?: string;
+    constructor(props: {
+        trigger: any;
+        evaluation?: any;
+        notificationTargets?: any[];
+        description?: string;
+    });
+}
+
+/**
+ * Base resource class that provides common functionality
+ */
 export declare class BaseResource {
     private readonly _type;
     private _properties;
@@ -219,7 +346,7 @@ export type GetConfigParams = {
 type WebServiceConnectTo = RelationalDatabase | Bucket | HostingBucket | DynamoDbTable | EventBus | RedisCluster | MongoDbAtlasCluster | UpstashRedis | SqsQueue | SnsTopic | OpenSearchDomain | EfsFilesystem | PrivateService | GlobalAwsServiceConstant;
 type PrivateServiceConnectTo = RelationalDatabase | Bucket | HostingBucket | DynamoDbTable | EventBus | RedisCluster | MongoDbAtlasCluster | UpstashRedis | SqsQueue | SnsTopic | OpenSearchDomain | EfsFilesystem | GlobalAwsServiceConstant;
 type WorkerServiceConnectTo = RelationalDatabase | Bucket | HostingBucket | DynamoDbTable | EventBus | RedisCluster | MongoDbAtlasCluster | UpstashRedis | SqsQueue | SnsTopic | OpenSearchDomain | EfsFilesystem | GlobalAwsServiceConstant;
-type MultiContainerWorkloadConnectTo = RelationalDatabase | Bucket | HostingBucket | DynamoDbTable | EventBus | RedisCluster | MongoDbAtlasCluster | UpstashRedis | SqsQueue | SnsTopic | OpenSearchDomain | EfsFilesystem | GlobalAwsServiceConstant;
+type MultiContainerWorkloadConnectTo = RelationalDatabase | Bucket | HostingBucket | DynamoDbTable | EventBus | RedisCluster | MongoDbAtlasCluster | UpstashRedis | SqsQueue | SnsTopic | OpenSearchDomain | EfsFilesystem | LambdaFunction | GlobalAwsServiceConstant;
 type LambdaFunctionConnectTo = RelationalDatabase | Bucket | HostingBucket | DynamoDbTable | EventBus | RedisCluster | MongoDbAtlasCluster | UpstashRedis | SqsQueue | SnsTopic | OpenSearchDomain | EfsFilesystem | PrivateService | WebService | GlobalAwsServiceConstant;
 type BatchJobConnectTo = RelationalDatabase | Bucket | HostingBucket | DynamoDbTable | EventBus | RedisCluster | MongoDbAtlasCluster | UpstashRedis | SqsQueue | SnsTopic | OpenSearchDomain | EfsFilesystem | GlobalAwsServiceConstant;
 type StateMachineConnectTo = Function | BatchJob | GlobalAwsServiceConstant;
@@ -239,6 +366,18 @@ export type ContainerWithObjectEnv = Omit<import('./sdk').ContainerWorkloadConta
   environment?: { [envVarName: string]: string | number | boolean };
 };
 
+/**
+ * Batch job container configuration with object-style environment variables.
+ * Environment is specified as { KEY: 'value' } for better developer experience.
+ */
+export type BatchJobContainerWithObjectEnv = Omit<import('./sdk').BatchJobContainer, 'environment'> & {
+  /**
+   * Environment variables to inject into the batch job container.
+   * Specified as key-value pairs: { PORT: '3000', NODE_ENV: 'production' }
+   */
+  environment?: { [envVarName: string]: string | number | boolean };
+};
+
 // Augmented props types with connectTo, environment, overrides, and transforms
 
 export type WebServiceProps = Omit<SdkWebServiceProps, 'connectTo' | 'environment'> & {
@@ -366,7 +505,7 @@ export type LambdaFunctionProps = Omit<SdkLambdaFunctionProps, 'connectTo' | 'en
   transforms?: LambdaFunctionTransforms;
 };
 
-export type BatchJobProps = Omit<SdkBatchJobProps, 'connectTo' | 'environment'> & {
+export type BatchJobProps = Omit<SdkBatchJobProps, 'connectTo' | 'environment' | 'container'> & {
   /**
    * List of resources or AWS services to which this resource receives permissions.
    * Automatically grants necessary IAM permissions for accessing the connected resources.
@@ -377,6 +516,10 @@ export type BatchJobProps = Omit<SdkBatchJobProps, 'connectTo' | 'environment'>
    * You can reference resource parameters using directive syntax: $ResourceParam('resourceName', 'paramName')
    */
   environment?: { [envVarName: string]: string | number | boolean };
+  /**
+   * Container configuration for the batch job.
+   */
+  container: BatchJobContainerWithObjectEnv;
   /**
    * Override properties of underlying CloudFormation resources.
    * Allows fine-grained control over the generated infrastructure.
@@ -507,7 +650,13 @@ export type BucketPropsWithOverrides = BucketProps & {
   transforms?: BucketTransforms;
 };
 
-export type HostingBucketPropsWithOverrides = HostingBucketProps & {
+export type HostingBucketPropsWithOverrides = Omit<HostingBucketProps, 'injectEnvironment'> & {
+  /**
+   * Injects referenced parameters into all HTML files in the uploadDirectoryPath.
+   * These parameters can be accessed by any JavaScript script using window.STP_INJECTED_ENV.VARIABLE_NAME.
+   * This is useful for automatically referencing parameters that are only known after deployment, such as the URL of an API Gateway.
+   */
+  injectEnvironment?: { [envVarName: string]: string | number | boolean };
   /**
    * Override properties of underlying CloudFormation resources.
    * Allows fine-grained control over the generated infrastructure.
@@ -1806,6 +1955,12 @@ export declare class SqsQueue extends BaseResource {
    */
   constructor(properties: SqsQueuePropsWithOverrides);
   constructor(name: string, properties: SqsQueuePropsWithOverrides);
+  /** Queue ARN */
+  readonly arn: string;
+  /** Queue URL */
+  readonly url: string;
+  /** Queue name */
+  readonly name: string;
 }
 export declare class SnsTopic extends BaseResource {
   /**
@@ -1817,6 +1972,10 @@ export declare class SnsTopic extends BaseResource {
    */
   constructor(properties: SnsTopicPropsWithOverrides);
   constructor(name: string, properties: SnsTopicPropsWithOverrides);
+  /** Topic ARN */
+  readonly arn: string;
+  /** Topic name */
+  readonly name: string;
 }
 export declare class WebAppFirewall extends BaseResource {
   /**
@@ -2145,7 +2304,7 @@ export declare class StacktapeLambdaBuildpackPackaging extends BaseTypePropertie
    * 
    * **Supported languages:** JavaScript, TypeScript, Python, Java, and Go.
    * 
-   * For JS/TS, your code is bundled into a single file using esbuild. Source maps are automatically generated.
+   * For JS/TS, your code is bundled into a single file. Source maps are automatically generated.
    * Packages are cached based on a checksum, so unchanged code is not re-packaged.
    */
   constructor(properties: StpBuildpackLambdaPackagingProps);
@@ -2238,7 +2397,7 @@ export declare class StacktapeImageBuildpackPackaging extends BaseTypeProperties
    * 
    * **Supported languages:** JavaScript, TypeScript, Python, Java, and Go.
    * 
-   * For JS/TS, your code is bundled into a single file using esbuild with source maps.
+   * For JS/TS, your code is bundled into a single file with source maps.
    * The resulting image is uploaded to a managed ECR repository.
    */
   constructor(properties: StpBuildpackCwImagePackagingProps);
@@ -2642,6 +2801,126 @@ export declare class LambdaAuthorizer extends BaseTypeProperties {
   readonly type: 'lambda';
 }
 
+export declare class ApplicationLoadBalancerCustomTrigger extends BaseTypeProperties {
+  /**
+   * Triggers an alarm based on any Application Load Balancer CloudWatch metric (e.g., connection counts, request counts, target response times).
+   */
+  constructor(properties: ApplicationLoadBalancerCustomTriggerProps);
+  readonly type: 'application-load-balancer-custom';
+}
+
+export declare class ApplicationLoadBalancerErrorRateTrigger extends BaseTypeProperties {
+  /**
+   * Triggers an alarm when the Application Load Balancer error rate (percentage of 4xx/5xx responses) exceeds the threshold.
+   */
+  constructor(properties: ApplicationLoadBalancerErrorRateTriggerProps);
+  readonly type: 'application-load-balancer-error-rate';
+}
+
+export declare class ApplicationLoadBalancerUnhealthyTargetsTrigger extends BaseTypeProperties {
+  /**
+   * Triggers an alarm when the percentage of unhealthy targets behind the Application Load Balancer exceeds the threshold.
+   */
+  constructor(properties: ApplicationLoadBalancerUnhealthyTargetsTriggerProps);
+  readonly type: 'application-load-balancer-unhealthy-targets';
+}
+
+export declare class HttpApiGatewayErrorRateTrigger extends BaseTypeProperties {
+  /**
+   * Triggers an alarm when the HTTP API Gateway error rate (percentage of 4xx/5xx responses) exceeds the threshold.
+   */
+  constructor(properties: HttpApiGatewayErrorRateTriggerProps);
+  readonly type: 'http-api-gateway-error-rate';
+}
+
+export declare class HttpApiGatewayLatencyTrigger extends BaseTypeProperties {
+  /**
+   * Triggers an alarm when HTTP API Gateway latency exceeds the threshold. Latency is measured from request receipt to response sent.
+   */
+  constructor(properties: HttpApiGatewayLatencyTriggerProps);
+  readonly type: 'http-api-gateway-latency';
+}
+
+export declare class RelationalDatabaseReadLatencyTrigger extends BaseTypeProperties {
+  /**
+   * Triggers an alarm when database read latency (average time for read I/O operations) exceeds the threshold.
+   */
+  constructor(properties: RelationalDatabaseReadLatencyTriggerProps);
+  readonly type: 'database-read-latency';
+}
+
+export declare class RelationalDatabaseWriteLatencyTrigger extends BaseTypeProperties {
+  /**
+   * Triggers an alarm when database write latency (average time for write I/O operations) exceeds the threshold.
+   */
+  constructor(properties: RelationalDatabaseWriteLatencyTriggerProps);
+  readonly type: 'database-write-latency';
+}
+
+export declare class RelationalDatabaseCPUUtilizationTrigger extends BaseTypeProperties {
+  /**
+   * Triggers an alarm when database CPU utilization exceeds the threshold percentage.
+   */
+  constructor(properties: RelationalDatabaseCPUUtilizationTriggerProps);
+  readonly type: 'database-cpu-utilization';
+}
+
+export declare class RelationalDatabaseFreeStorageTrigger extends BaseTypeProperties {
+  /**
+   * Triggers an alarm when available database storage falls below the threshold (in MB).
+   */
+  constructor(properties: RelationalDatabaseFreeStorageTriggerProps);
+  readonly type: 'database-free-storage';
+}
+
+export declare class RelationalDatabaseFreeMemoryTrigger extends BaseTypeProperties {
+  /**
+   * Triggers an alarm when available database memory falls below the threshold (in MB).
+   */
+  constructor(properties: RelationalDatabaseFreeMemoryTriggerProps);
+  readonly type: 'database-free-memory';
+}
+
+export declare class RelationalDatabaseConnectionCountTrigger extends BaseTypeProperties {
+  /**
+   * Triggers an alarm when the number of database connections exceeds the threshold.
+   */
+  constructor(properties: RelationalDatabaseConnectionCountTriggerProps);
+  readonly type: 'database-connection-count';
+}
+
+export declare class SqsQueueReceivedMessagesCountTrigger extends BaseTypeProperties {
+  /**
+   * Triggers an alarm when the number of messages received from an SQS queue crosses the threshold.
+   */
+  constructor(properties: SqsQueueReceivedMessagesCountTriggerProps);
+  readonly type: 'sqs-queue-received-messages-count';
+}
+
+export declare class SqsQueueNotEmptyTrigger extends BaseTypeOnly {
+  /**
+   * Triggers an alarm if the SQS queue is not empty. Useful for monitoring dead-letter queues.
+   */
+  constructor();
+  readonly type: 'sqs-queue-not-empty';
+}
+
+export declare class LambdaErrorRateTrigger extends BaseTypeProperties {
+  /**
+   * Triggers an alarm when the Lambda function error rate (percentage of failed invocations) exceeds the threshold.
+   */
+  constructor(properties: LambdaErrorRateTriggerProps);
+  readonly type: 'lambda-error-rate';
+}
+
+export declare class LambdaDurationTrigger extends BaseTypeProperties {
+  /**
+   * Triggers an alarm when Lambda function execution duration exceeds the threshold (in milliseconds).
+   */
+  constructor(properties: LambdaDurationTriggerProps);
+  readonly type: 'lambda-duration';
+}
+
 export declare class CustomResourceDefinition extends BaseTypeProperties {
   /**
    * #### Custom resource definition