Package software.amazon.awscdk.services.apigateway

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.120.0 (build 192dc88)", date="2025-12-05T10:47:11.499Z") @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.

  • 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
    ResourceEnvironment
    getEnv()
    The environment this resource belongs to.
    String
    getKeyArn()
    The API key ARN.
    String
    getKeyId()
    The API key ID.
    software.constructs.Node
    getNode()
    The tree node.

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

    getApiKeyRef

    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.

    • getNode

      @Stability(Stable) @NotNull software.constructs.Node getNode()
      The tree node.
      Specified by:
      getNode in interface software.constructs.IConstruct

    • getEnv

      @Stability(Stable) @NotNull ResourceEnvironment getEnv()
      The environment this resource belongs to.

      For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

      For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

      Specified by:
      getEnv in interface IEnvironmentAware