Package software.amazon.awscdk.services.apigateway

Interface IApiKey

All Superinterfaces:
software.constructs.IConstruct, software.constructs.IDependable, 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.113.0 (build fc68b25)", date="2025-09-02T11:25:25.393Z") @Stability(Stable) public interface IApiKey extends software.amazon.jsii.JsiiSerializable, IResource
API keys are alphanumeric string values that you distribute to app developer customers to grant access to your API.

  • 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.constructs.IConstruct

    getNode

    Methods inherited from interface software.amazon.awscdk.IResource

    applyRemovalPolicy, getEnv, 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.