aws-cdk-lib

import type { Construct } from 'constructs'; import type { IGatewayAuthorizerConfig } from './inbound-auth/authorizer'; import type { IGatewayProtocolConfig } from './protocol'; import type { GatewayReference, IGatewayRef } from '../../../aws-bedrockagentcore'; import type { MetricOptions } from '../../../aws-cloudwatch'; import { Metric } from '../../../aws-cloudwatch'; import * as iam from '../../../aws-iam'; import type * as kms from '../../../aws-kms'; import { Resource } from '../../../core'; import type { IResource, ResourceProps } from '../../../core'; /****************************************************************************** * Enums *****************************************************************************/ /** * Exception levels for gateway */ export declare class GatewayExceptionLevel { /** * Debug mode for granular exception messages. Allows the return of * specific error messages related to the gateway target configuration * to help you with debugging. */ static readonly DEBUG: GatewayExceptionLevel; /** * Use a custom exception level not yet defined in this class. * @param value The exception level string value */ static of(value: string): GatewayExceptionLevel; /** The exception level string value. */ readonly value: string; private constructor(); /** Returns the string value. */ toString(): string; } /****************************************************************************** * Interface *****************************************************************************/ /** * Interface for Gateway resources */ export interface IGateway extends IResource, IGatewayRef { /** * The ARN of the gateway resource * @attribute */ readonly gatewayArn: string; /** * The id of the gateway * @attribute */ readonly gatewayId: string; /** * The name of the gateway */ readonly gatewayName: string; /** * The IAM role that provides permissions for the gateway to access AWS services */ readonly role: iam.IRole; /** * The description of the gateway */ readonly description?: string; /** * The protocol configuration for the gateway */ readonly protocolConfiguration: IGatewayProtocolConfig; /** * The authorizer configuration for the gateway */ readonly authorizerConfiguration: IGatewayAuthorizerConfig; /** * The exception level for the gateway */ readonly exceptionLevel?: GatewayExceptionLevel; /** * The KMS key used for encryption */ readonly kmsKey?: kms.IKey; /** * The URL endpoint for the gateway * @attribute */ readonly gatewayUrl?: string; /** * The status of the gateway * @attribute */ readonly status?: string; /** * The status reasons for the gateway. * @attribute */ readonly statusReason?: string[]; /** * Timestamp when the gateway was created * @attribute */ readonly createdAt?: string; /** * Timestamp when the gateway was last updated * @attribute */ readonly updatedAt?: string; /** * Grants IAM actions to the IAM Principal */ grant(grantee: iam.IGrantable, ...actions: string[]): iam.Grant; /** * Grants `Get` and `List` actions on the Gateway */ grantRead(grantee: iam.IGrantable): iam.Grant; /** * Grants `Create`, `Update`, and `Delete` actions on the Gateway */ grantManage(grantee: iam.IGrantable): iam.Grant; /** * Grants permission to invoke this Gateway */ grantInvoke(grantee: iam.IGrantable): iam.Grant; /** * Return the given named metric for this gateway. * * @param metricName The name of the metric * @param props Optional metric configuration */ metric(metricName: string, props?: MetricOptions): Metric; /** * Return a metric containing the total number of invocations for this gateway. * * This metric tracks all successful invocations of the gateway. * * @param props Optional metric configuration * @default - Sum statistic over 5 minutes */ metricInvocations(props?: MetricOptions): Metric; /** * Return a metric containing the number of throttled requests (429 status code) for this gateway. * * This metric helps identify when the gateway is rate limiting requests. * * @param props Optional metric configuration * @default - Sum statistic over 5 minutes */ metricThrottles(props?: MetricOptions): Metric; /** * Return a metric containing the number of system errors (5xx status code) for this gateway. * * This metric tracks internal server errors and system failures. * * @param props Optional metric configuration * @default - Sum statistic over 5 minutes */ metricSystemErrors(props?: MetricOptions): Metric; /** * Return a metric containing the number of user errors (4xx status code, excluding 429) for this gateway. * * This metric tracks client errors like bad requests, unauthorized access, etc. * * @param props Optional metric configuration * @default - Sum statistic over 5 minutes */ metricUserErrors(props?: MetricOptions): Metric; /** * Return a metric measuring the latency of requests for this gateway. * * The latency metric represents the time elapsed between when the service receives * the request and when it begins sending the first response token. * * @param props Optional metric configuration * @default - Average statistic over 5 minutes */ metricLatency(props?: MetricOptions): Metric; /** * Return a metric measuring the duration of requests for this gateway. * * The duration metric represents the total time elapsed between receiving the request * and sending the final response token, representing complete end-to-end processing time. * * @param props Optional metric configuration * @default - Average statistic over 5 minutes */ metricDuration(props?: MetricOptions): Metric; /** * Return a metric measuring the target execution time for this gateway. * * This metric helps determine the contribution of the target (Lambda, OpenAPI, etc.) * to the total latency. * * @param props Optional metric configuration * @default - Average statistic over 5 minutes */ metricTargetExecutionTime(props?: MetricOptions): Metric; /** * Return a metric containing the number of requests served by each target type for this gateway. * * @param targetType The type of target (e.g., 'Lambda', 'OpenAPI', 'Smithy') * @param props Optional metric configuration * @default - Sum statistic over 5 minutes */ metricTargetType(targetType: string, props?: MetricOptions): Metric; } /****************************************************************************** * Base Class *****************************************************************************/ export declare abstract class GatewayBase extends Resource implements IGateway { abstract readonly gatewayArn: string; abstract readonly gatewayId: string; abstract readonly gatewayName: string; abstract readonly description?: string; abstract readonly protocolConfiguration: IGatewayProtocolConfig; abstract readonly authorizerConfiguration: IGatewayAuthorizerConfig; abstract readonly exceptionLevel?: GatewayExceptionLevel; abstract readonly kmsKey?: kms.IKey; abstract readonly role: iam.IRole; abstract readonly gatewayUrl?: string; abstract readonly status?: string; abstract readonly statusReason?: string[]; abstract readonly createdAt?: string; abstract readonly updatedAt?: string; /** * A reference to a Gateway resource. */ get gatewayRef(): GatewayReference; constructor(scope: Construct, id: string, props?: ResourceProps); /** * Grants IAM actions to the IAM Principal * * [disable-awslint:no-grants] * * @param grantee The principal to grant permissions to * @param actions The actions to grant */ grant(grantee: iam.IGrantable, ...actions: string[]): iam.Grant; /** * Grants `Get` and `List` actions on the Gateway * * [disable-awslint:no-grants] * * @param grantee The principal to grant read permissions to */ grantRead(grantee: iam.IGrantable): iam.Grant; /** * Grants `Create`, `Update`, and `Delete` actions on the Gateway * * [disable-awslint:no-grants] * * @param grantee The principal to grant manage permissions to */ grantManage(grantee: iam.IGrantable): iam.Grant; /** * Grants permission to invoke this Gateway * * [disable-awslint:no-grants] * * @param grantee The principal to grant invoke permissions to */ grantInvoke(grantee: iam.IGrantable): iam.Grant; /** * Return the given named metric for this gateway. * * By default, the metric will be calculated as a sum over a period of 5 minutes. * You can customize this by using the `statistic` and `period` properties. * * @param metricName The name of the metric * @param props Optional metric configuration */ metric(metricName: string, props?: MetricOptions): Metric; /** * Return a metric containing the total number of invocations for this gateway. */ metricInvocations(props?: MetricOptions): Metric; /** * Return a metric containing the number of throttled requests (429 status code) for this gateway. */ metricThrottles(props?: MetricOptions): Metric; /** * Return a metric containing the number of system errors (5xx status code) for this gateway. */ metricSystemErrors(props?: MetricOptions): Metric; /** * Return a metric containing the number of user errors (4xx status code, excluding 429) for this gateway. */ metricUserErrors(props?: MetricOptions): Metric; /** * Return a metric measuring the latency of requests for this gateway. * * The latency metric represents the time elapsed between when the service receives * the request and when it begins sending the first response token. */ metricLatency(props?: MetricOptions): Metric; /** * Return a metric measuring the duration of requests for this gateway. * * The duration metric represents the total time elapsed between receiving the request * and sending the final response token, representing complete end-to-end processing time. */ metricDuration(props?: MetricOptions): Metric; /** * Return a metric measuring the target execution time for this gateway. * * This metric helps determine the contribution of the target (Lambda, OpenAPI, etc.) * to the total latency. */ metricTargetExecutionTime(props?: MetricOptions): Metric; /** * Return a metric containing the number of requests served by each target type for this gateway. */ metricTargetType(targetType: string, props?: MetricOptions): Metric; /** * Internal method to create a metric. * @internal */ private configureMetric; }