Interface ApiKeyOptions

All Superinterfaces:
software.amazon.jsii.JsiiSerializable, ResourceOptions
All Known Subinterfaces:
ApiKeyProps, RateLimitedApiKeyProps
All Known Implementing Classes:
ApiKeyOptions.Jsii$Proxy, ApiKeyProps.Jsii$Proxy, RateLimitedApiKeyProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.94.0 (build b380f01)", date="2024-02-23T02:06:27.387Z") @Stability(Stable) public interface ApiKeyOptions extends software.amazon.jsii.JsiiSerializable, ResourceOptions
The options for creating an API Key.

Example:

 RestApi api;
 IApiKey key = api.addApiKey("ApiKey", ApiKeyOptions.builder()
         .apiKeyName("myApiKey1")
         .value("MyApiKeyThatIsAtLeast20Characters")
         .build());
 
  • Method Details

    • getApiKeyName

      @Stability(Stable) @Nullable default String getApiKeyName()
      A name for the API key.

      If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the API key name.

      Default: automically generated name

    • getDescription

      @Stability(Stable) @Nullable default String getDescription()
      A description of the purpose of the API key.

      Default: none

    • getValue

      @Stability(Stable) @Nullable default String getValue()
      The value of the API key.

      Must be at least 20 characters long.

      Default: none

    • builder

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