aws-cdk-lib/aws-apigateway/lib/apigateway-grants.generated.d.ts

Version 2 of the AWS Cloud Development Kit library

import * as apigateway from "./apigateway.generated";
import * as iam from "../../aws-iam";
import * as cdk from "../../core/lib";
/**
 * Collection of grant methods for a IApiKeyRef
 */
export declare class ApiKeyGrants {
    /**
     * Creates grants for ApiKeyGrants
     */
    static fromApiKey(resource: apigateway.IApiKeyRef): ApiKeyGrants;
    protected readonly resource: apigateway.IApiKeyRef;
    private constructor();
    /**
     * Grant the given identity custom permissions
     */
    actions(grantee: iam.IGrantable, actions: Array<string>, options?: cdk.PermissionsOptions): iam.Grant;
    /**
     * Permits the IAM principal all read operations through this key
     */
    read(grantee: iam.IGrantable): iam.Grant;
    /**
     * Permits the IAM principal all write operations through this key
     */
    write(grantee: iam.IGrantable): iam.Grant;
    /**
     * Permits the IAM principal all read and write operations through this key
     */
    readWrite(grantee: iam.IGrantable): iam.Grant;
}