Interface ApiKeyConfig

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
ApiKeyConfig.Jsii$Proxy

@Generated(value="jsii-pacmak/1.99.0 (build 8f757e4)", date="2024-06-13T18:49:14.582Z") @Stability(Stable) public interface ApiKeyConfig extends software.amazon.jsii.JsiiSerializable
Configuration for API Key authorization in AppSync.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.*;
 import software.amazon.awscdk.services.appsync.*;
 Expiration expiration;
 ApiKeyConfig apiKeyConfig = ApiKeyConfig.builder()
         .description("description")
         .expires(expiration)
         .name("name")
         .build();
 
  • Method Details

    • getDescription

      @Stability(Stable) @Nullable default String getDescription()
      Description of API key.

      Default: - 'Default API Key created by CDK'

    • getExpires

      @Stability(Stable) @Nullable default Expiration getExpires()
      The time from creation time after which the API key expires.

      It must be a minimum of 1 day and a maximum of 365 days from date of creation. Rounded down to the nearest hour.

      Default: - 7 days rounded down to nearest hour

    • getName

      @Stability(Stable) @Nullable default String getName()
      Unique name of the API Key.

      Default: - 'DefaultAPIKey'

    • builder

      @Stability(Stable) static ApiKeyConfig.Builder builder()
      Returns:
      a ApiKeyConfig.Builder of ApiKeyConfig