agent-claw: automated task changes

cdk/node_modules/aws-cdk-lib/aws-apigatewayv2/lib/websocket/usage-plan.d.ts

@@ -0,0 +1,164 @@
+import type { Construct } from 'constructs';
+import type { IWebSocketApi } from './api';
+import type { IWebSocketStage } from './stage';
+import type { IApiKeyRef, IUsagePlanRef, UsagePlanReference } from '../../../aws-apigateway/lib';
+import type { IResource } from '../../../core';
+import { Resource } from '../../../core';
+import type { ThrottleSettings } from '../common';
+/**
+ * Time period for which quota settings apply.
+ */
+export declare enum Period {
+    /**
+     * The quota resets every day.
+     */
+    DAY = "DAY",
+    /**
+     * The quota resets every week.
+     */
+    WEEK = "WEEK",
+    /**
+     * The quota resets every month.
+     */
+    MONTH = "MONTH"
+}
+/**
+ * Specifies the maximum number of requests that clients can make to API Gateway APIs.
+ */
+export interface QuotaSettings {
+    /**
+     * The maximum number of requests that users can make within the specified time period.
+     * @default none
+     */
+    readonly limit?: number;
+    /**
+     * For the initial time period, the number of requests to subtract from the specified limit.
+     * @default none
+     */
+    readonly offset?: number;
+    /**
+     * The time period for which the maximum limit of requests applies.
+     * @default none
+     */
+    readonly period?: Period;
+}
+/**
+ * Represents the API stages that a usage plan applies to.
+ */
+export interface UsagePlanPerApiStage {
+    /**
+     * The WebSocket API to associate with the usage plan.
+     * @default none
+     */
+    readonly api?: IWebSocketApi;
+    /**
+     *
+     * [disable-awslint:ref-via-interface]
+     * @default none
+     */
+    readonly stage?: IWebSocketStage;
+}
+/**
+ * Properties for defining an API Gateway Usage Plan for WebSocket APIs.
+ */
+export interface UsagePlanProps {
+    /**
+     * API Stages to be associated with the usage plan.
+     * @default none
+     */
+    readonly apiStages?: UsagePlanPerApiStage[];
+    /**
+     * Represents usage plan purpose.
+     * @default none
+     */
+    readonly description?: string;
+    /**
+     * Number of requests clients can make in a given time period.
+     * @default none
+     */
+    readonly quota?: QuotaSettings;
+    /**
+     * Overall throttle settings for the API.
+     * @default none
+     */
+    readonly throttle?: ThrottleSettings;
+    /**
+     * Name for this usage plan.
+     * @default none
+     */
+    readonly usagePlanName?: string;
+}
+/**
+ * Options to the UsagePlan.addApiKey() method
+ */
+export interface AddApiKeyOptions {
+    /**
+     * Override the CloudFormation logical id of the AWS::ApiGateway::UsagePlanKey resource
+     * @default - autogenerated by the CDK
+     */
+    readonly overrideLogicalId?: string;
+}
+/**
+ * A UsagePlan, either managed by this CDK app, or imported.
+ */
+export interface IUsagePlan extends IResource, IUsagePlanRef {
+    /**
+     * Id of the usage plan
+     * @attribute
+     */
+    readonly usagePlanId: string;
+    /**
+     * Adds an ApiKey.
+     *
+     * @param apiKey the api key to associate with this usage plan
+     * @param options options that control the behaviour of this method
+     */
+    addApiKey(apiKey: IApiKeyRef, options?: AddApiKeyOptions): void;
+}
+declare abstract class UsagePlanBase extends Resource implements IUsagePlan {
+    /**
+     * Id of the usage plan
+     * @attribute
+     */
+    abstract readonly usagePlanId: string;
+    /**
+     * Adds an ApiKey.
+     *
+     * @param apiKey the api key to associate with this usage plan
+     * @param options options that control the behaviour of this method
+     */
+    addApiKey(apiKey: IApiKeyRef, options?: AddApiKeyOptions): void;
+    get usagePlanRef(): UsagePlanReference;
+}
+/**
+ * A UsagePlan.
+ *
+ * @resource AWS::ApiGateway::UsagePlan
+ */
+export declare class UsagePlan extends UsagePlanBase {
+    /** Uniquely identifies this class. */
+    static readonly PROPERTY_INJECTION_ID: string;
+    /**
+     * Import an externally defined usage plan using its ARN.
+     *
+     * @param scope  the construct that will "own" the imported usage plan.
+     * @param id     the id of the imported usage plan in the construct tree.
+     * @param usagePlanId the id of an existing usage plan.
+     */
+    static fromUsagePlanId(scope: Construct, id: string, usagePlanId: string): IUsagePlan;
+    /**
+     * @attribute
+     */
+    readonly usagePlanId: string;
+    private readonly apiStages;
+    constructor(scope: Construct, id: string, props?: UsagePlanProps);
+    /**
+     * Adds an apiStage.
+     */
+    addApiStage(apiStage: UsagePlanPerApiStage): void;
+    private renderApiStages;
+    private createStage;
+    private renderQuota;
+    private renderThrottle;
+}
+export {};