Package software.amazon.awscdk.services.apigatewayv2

Interface IApiKey

All Superinterfaces:
IApiKeyRef, software.constructs.IConstruct, software.constructs.IDependable, IEnvironmentAware, IResource, software.amazon.jsii.JsiiSerializable
All Known Subinterfaces:
IApiKey.Jsii$Default
All Known Implementing Classes:
ApiKey, IApiKey.Jsii$Proxy, RateLimitedApiKey
@Generated(value="jsii-pacmak/1.126.0 (build 206d44b)", date="2026-02-09T14:39:02.583Z") @Stability(Stable) public interface IApiKey extends software.amazon.jsii.JsiiSerializable, IResource, IApiKeyRef
API keys are alphanumeric string values that you distribute to app developer customers to grant access to your API.

API Keys are an API Gateway V1 concept.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static interface 
    IApiKey.Jsii$Default
    Internal default implementation for IApiKey.
    static final class 
    IApiKey.Jsii$Proxy
    A proxy class which represents a concrete javascript instance of this type.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getKeyArn()
    The API key ARN.
    String
    getKeyId()
    The API key ID.

    Methods inherited from interface software.amazon.awscdk.interfaces.apigateway.IApiKeyRef

    getApiKeyRef

    Methods inherited from interface software.constructs.IConstruct

    getNode

    Methods inherited from interface software.amazon.awscdk.interfaces.IEnvironmentAware

    getEnv

    Methods inherited from interface software.amazon.awscdk.IResource

    applyRemovalPolicy, getStack

    Methods inherited from interface software.amazon.jsii.JsiiSerializable

    $jsii$toJson

  • Method Details

    • getKeyArn

      @Stability(Stable) @NotNull String getKeyArn()
      The API key ARN.

    • getKeyId

      @Stability(Stable) @NotNull String getKeyId()
      The API key ID.