Package software.amazon.awscdk.services.apigateway

Class ApiKeyGrants

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.services.apigateway.ApiKeyGrants
All Implemented Interfaces:
software.amazon.jsii.JsiiSerializable
@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)", date="2026-04-02T21:55:03.483Z") @Stability(Stable) public class ApiKeyGrants extends software.amazon.jsii.JsiiObject
Collection of grant methods for a IApiKeyRef.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.apigateway.*;
 import software.amazon.awscdk.interfaces.apigateway.*;
 IApiKeyRef apiKeyRef;
 ApiKeyGrants apiKeyGrants = ApiKeyGrants.fromApiKey(apiKeyRef);

  • Nested Class Summary

    Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

    software.amazon.jsii.JsiiObject.InitializationMode

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    ApiKeyGrants(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
     
    protected
    ApiKeyGrants(software.amazon.jsii.JsiiObjectRef objRef)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    Grant
    actions(IGrantable grantee, List<String> actions)
    Grant the given identity custom permissions.
    Grant
    actions(IGrantable grantee, List<String> actions, PermissionsOptions options)
    Grant the given identity custom permissions.
    static ApiKeyGrants
    fromApiKey(IApiKeyRef resource)
    Creates grants for ApiKeyGrants.
    protected IApiKeyRef
    getResource()
     
    Grant
    read(IGrantable grantee)
    Permits the IAM principal all read operations through this key.
    Grant
    readWrite(IGrantable grantee)
    Permits the IAM principal all read and write operations through this key.
    Grant
    write(IGrantable grantee)
    Permits the IAM principal all write operations through this key.

    Methods inherited from class software.amazon.jsii.JsiiObject

    jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface software.amazon.jsii.JsiiSerializable

    $jsii$toJson

  • Constructor Details

    • ApiKeyGrants

      protected ApiKeyGrants(software.amazon.jsii.JsiiObjectRef objRef)

    • ApiKeyGrants

      protected ApiKeyGrants(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

  • Method Details

    • fromApiKey

      @Stability(Stable) @NotNull public static ApiKeyGrants fromApiKey(@NotNull IApiKeyRef resource)
      Creates grants for ApiKeyGrants.

      Parameters:
      resource - This parameter is required.

    • actions

      @Stability(Stable) @NotNull public Grant actions(@NotNull IGrantable grantee, @NotNull List<String> actions, @Nullable PermissionsOptions options)
      Grant the given identity custom permissions.

      Parameters:
      grantee - This parameter is required.
      actions - This parameter is required.
      options -

    • actions

      @Stability(Stable) @NotNull public Grant actions(@NotNull IGrantable grantee, @NotNull List<String> actions)
      Grant the given identity custom permissions.

      Parameters:
      grantee - This parameter is required.
      actions - This parameter is required.

    • read

      @Stability(Stable) @NotNull public Grant read(@NotNull IGrantable grantee)
      Permits the IAM principal all read operations through this key.

      Parameters:
      grantee - This parameter is required.

    • readWrite

      @Stability(Stable) @NotNull public Grant readWrite(@NotNull IGrantable grantee)
      Permits the IAM principal all read and write operations through this key.

      Parameters:
      grantee - This parameter is required.

    • write

      @Stability(Stable) @NotNull public Grant write(@NotNull IGrantable grantee)
      Permits the IAM principal all write operations through this key.

      Parameters:
      grantee - This parameter is required.

    • getResource

      @Stability(Stable) @NotNull protected IApiKeyRef getResource()