Package software.amazon.awscdk.services.location.alpha

Class ApiKey

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.Resource
software.amazon.awscdk.services.location.alpha.ApiKey
All Implemented Interfaces:
IEnvironmentAware, IResource, IApiKey, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.118.0 (build 02eec31)", date="2025-11-10T13:40:18.311Z") @Stability(Experimental) public class ApiKey extends Resource implements IApiKey
(experimental) An API Key.

Example: 

 ApiKey.Builder.create(this, "APIKeyAny")
         // specify allowed actions
         .allowMapsActions(List.of(AllowMapsAction.GET_STATIC_MAP))
         .allowPlacesActions(List.of(AllowPlacesAction.GET_PLACE))
         .allowRoutesActions(List.of(AllowRoutesAction.CALCULATE_ISOLINES))
         .build();

See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    ApiKey.Builder
    (experimental) A fluent builder for ApiKey.

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

    software.amazon.jsii.JsiiObject.InitializationMode

    Nested classes/interfaces inherited from interface software.amazon.awscdk.services.location.alpha.IApiKey

    IApiKey.Jsii$Default, IApiKey.Jsii$Proxy

    Nested classes/interfaces inherited from interface software.constructs.IConstruct

    software.constructs.IConstruct.Jsii$Default

    Nested classes/interfaces inherited from interface software.amazon.awscdk.IResource

    IResource.Jsii$Default

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    PROPERTY_INJECTION_ID
    (experimental) Uniquely identifies this class.

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    ApiKey(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
     
    protected
    ApiKey(software.amazon.jsii.JsiiObjectRef objRef)
     
     
    ApiKey(software.constructs.Construct scope, String id)
     
     
    ApiKey(software.constructs.Construct scope, String id, ApiKeyProps props)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    static IApiKey
    fromApiKeyArn(software.constructs.Construct scope, String id, String apiKeyArn)
    (experimental) Use an existing api key by ARN.
    static IApiKey
    fromApiKeyName(software.constructs.Construct scope, String id, String apiKeyName)
    (experimental) Use an existing api key by name.
    String
    getApiKeyArn()
    (experimental) The Amazon Resource Name (ARN) of the api key resource.
    String
    getApiKeyCreateTime()
    (experimental) The timestamp for when the api key resource was created in ISO 8601 format.
    String
    getApiKeyName()
    (experimental) The name of the api key.
    String
    getApiKeyUpdateTime()
    (experimental) The timestamp for when the api key resource was last updated in ISO 8601 format.

    Methods inherited from class software.amazon.awscdk.Resource

    applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isOwnedResource, isResource

    Methods inherited from class software.constructs.Construct

    getNode, isConstruct, toString

    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, wait, wait, wait

    Methods inherited from interface software.constructs.IConstruct

    getNode

    Methods inherited from interface software.amazon.awscdk.IEnvironmentAware

    getEnv

    Methods inherited from interface software.amazon.awscdk.IResource

    applyRemovalPolicy, getStack

    Methods inherited from interface software.amazon.jsii.JsiiSerializable

    $jsii$toJson

  • Field Details

    • PROPERTY_INJECTION_ID

      @Stability(Experimental) public static final String PROPERTY_INJECTION_ID
      (experimental) Uniquely identifies this class.

  • Constructor Details

    • ApiKey

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

    • ApiKey

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

    • ApiKey

      @Stability(Experimental) public ApiKey(@NotNull software.constructs.Construct scope, @NotNull String id, @Nullable ApiKeyProps props)
      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      props -

    • ApiKey

      @Stability(Experimental) public ApiKey(@NotNull software.constructs.Construct scope, @NotNull String id)
      Parameters:
      scope - This parameter is required.
      id - This parameter is required.

  • Method Details

    • fromApiKeyArn

      @Stability(Experimental) @NotNull public static IApiKey fromApiKeyArn(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String apiKeyArn)
      (experimental) Use an existing api key by ARN.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      apiKeyArn - This parameter is required.

    • fromApiKeyName

      @Stability(Experimental) @NotNull public static IApiKey fromApiKeyName(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String apiKeyName)
      (experimental) Use an existing api key by name.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      apiKeyName - This parameter is required.

    • getApiKeyArn

      @Stability(Experimental) @NotNull public String getApiKeyArn()
      (experimental) The Amazon Resource Name (ARN) of the api key resource.
      Specified by:
      getApiKeyArn in interface IApiKey

    • getApiKeyCreateTime

      @Stability(Experimental) @NotNull public String getApiKeyCreateTime()
      (experimental) The timestamp for when the api key resource was created in ISO 8601 format.

    • getApiKeyName

      @Stability(Experimental) @NotNull public String getApiKeyName()
      (experimental) The name of the api key.
      Specified by:
      getApiKeyName in interface IApiKey

    • getApiKeyUpdateTime

      @Stability(Experimental) @NotNull public String getApiKeyUpdateTime()
      (experimental) The timestamp for when the api key resource was last updated in ISO 8601 format.