agent-claw: automated task changes

cdk/node_modules/aws-cdk-lib/aws-apigateway/lib/api-key.d.ts

@@ -0,0 +1,182 @@
+import type { Construct } from 'constructs';
+import { ApiKeyGrants } from './apigateway-grants.generated';
+import type { ApiKeyReference, IApiKeyRef } from './apigateway.generated';
+import type { ResourceOptions } from './resource';
+import type { IRestApi } from './restapi';
+import type { IStage } from './stage';
+import type { QuotaSettings, ThrottleSettings, UsagePlanPerApiStage } from './usage-plan';
+import type * as iam from '../../aws-iam';
+import type { IResource as IResourceBase } from '../../core';
+import { Resource } from '../../core';
+/**
+ * API keys are alphanumeric string values that you distribute to
+ * app developer customers to grant access to your API
+ */
+export interface IApiKey extends IResourceBase, IApiKeyRef {
+    /**
+     * The API key ID.
+     * @attribute
+     */
+    readonly keyId: string;
+    /**
+     * The API key ARN.
+     */
+    readonly keyArn: string;
+}
+/**
+ * The options for creating an API Key.
+ */
+export interface ApiKeyOptions extends ResourceOptions {
+    /**
+     * A name for the API key. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the API key name.
+     * @link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-name
+     * @default automically generated name
+     */
+    readonly apiKeyName?: string;
+    /**
+     * The value of the API key. Must be at least 20 characters long.
+     * @link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-value
+     * @default none
+     */
+    readonly value?: string;
+    /**
+     * A description of the purpose of the API key.
+     * @link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-description
+     * @default none
+     */
+    readonly description?: string;
+}
+/**
+ * ApiKey Properties.
+ */
+export interface ApiKeyProps extends ApiKeyOptions {
+    /**
+     * A list of resources this api key is associated with.
+     * @default none
+     * @deprecated - use `stages` instead
+     */
+    readonly resources?: IRestApi[];
+    /**
+     * A list of Stages this api key is associated with.
+     *
+     * @default - the api key is not associated with any stages
+     */
+    readonly stages?: IStage[];
+    /**
+     * An AWS Marketplace customer identifier to use when integrating with the AWS SaaS Marketplace.
+     * @link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-customerid
+     * @default none
+     */
+    readonly customerId?: string;
+    /**
+     * Indicates whether the API key can be used by clients.
+     * @link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-enabled
+     * @default true
+     */
+    readonly enabled?: boolean;
+    /**
+     * Specifies whether the key identifier is distinct from the created API key value.
+     * @link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-generatedistinctid
+     * @default false
+     */
+    readonly generateDistinctId?: boolean;
+}
+/**
+ * Base implementation that is common to the various implementations of IApiKey
+ */
+declare abstract class ApiKeyBase extends Resource implements IApiKey {
+    abstract readonly keyId: string;
+    abstract readonly keyArn: string;
+    /**
+     * Collection of grant methods for an ApiKey
+     */
+    readonly grants: ApiKeyGrants;
+    /**
+     * Permits the IAM principal all read operations through this key
+     *
+     * The use of this method is discouraged. Please use `grants.read()` instead.
+     *
+     * [disable-awslint:no-grants]
+     *
+     * @param grantee The principal to grant access to
+     */
+    grantRead(grantee: iam.IGrantable): iam.Grant;
+    /**
+     * Permits the IAM principal all write operations through this key
+     *
+     * The use of this method is discouraged. Please use `grants.write()` instead.
+     *
+     * [disable-awslint:no-grants]
+     *
+     * @param grantee The principal to grant access to
+     */
+    grantWrite(grantee: iam.IGrantable): iam.Grant;
+    /**
+     * Permits the IAM principal all read and write operations through this key
+     *
+     * The use of this method is discouraged. Please use `grants.readWrite()` instead.
+     *
+     * [disable-awslint:no-grants]
+     *
+     * @param grantee The principal to grant access to
+     */
+    grantReadWrite(grantee: iam.IGrantable): iam.Grant;
+    get apiKeyRef(): ApiKeyReference;
+}
+/**
+ * An API Gateway ApiKey.
+ *
+ * An ApiKey can be distributed to API clients that are executing requests
+ * for Method resources that require an Api Key.
+ */
+export declare class ApiKey extends ApiKeyBase {
+    /**
+     * Uniquely identifies this class.
+     */
+    static readonly PROPERTY_INJECTION_ID: string;
+    /**
+     * Import an ApiKey by its Id
+     */
+    static fromApiKeyId(scope: Construct, id: string, apiKeyId: string): IApiKey;
+    readonly keyId: string;
+    readonly keyArn: string;
+    constructor(scope: Construct, id: string, props?: ApiKeyProps);
+    private renderStageKeys;
+}
+/**
+ * RateLimitedApiKey properties.
+ */
+export interface RateLimitedApiKeyProps extends ApiKeyProps {
+    /**
+     * API Stages to be associated with the RateLimitedApiKey.
+     * If you already prepared UsagePlan resource explicitly, you should use `stages` property.
+     * If you prefer to prepare UsagePlan resource implicitly via RateLimitedApiKey,
+     * or you should specify throttle settings at each stage individually, you should use `apiStages` property.
+     *
+     * @default none
+     */
+    readonly apiStages?: UsagePlanPerApiStage[];
+    /**
+     * 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;
+}
+/**
+ * An API Gateway ApiKey, for which a rate limiting configuration can be specified.
+ *
+ * @resource AWS::ApiGateway::ApiKey
+ */
+export declare class RateLimitedApiKey extends ApiKeyBase {
+    /** Uniquely identifies this class. */
+    static readonly PROPERTY_INJECTION_ID: string;
+    readonly keyId: string;
+    readonly keyArn: string;
+    constructor(scope: Construct, id: string, props?: RateLimitedApiKeyProps);
+}
+export {};