@Generated(value="jsii-pacmak/1.29.0 (build 41df200)", date="2021-06-02T09:54:56.815Z") @Stability(value=Experimental) public interface ApiKeyProps extends software.amazon.jsii.JsiiSerializable, ApiKeyOptions
| Modifier and Type | Interface and Description |
|---|---|
static class |
ApiKeyProps.Builder
A builder for
ApiKeyProps |
static class |
ApiKeyProps.Jsii$Proxy
An implementation for
ApiKeyProps |
| Modifier and Type | Method and Description |
|---|---|
static ApiKeyProps.Builder |
builder() |
default String |
getCustomerId()
(experimental) An AWS Marketplace customer identifier to use when integrating with the AWS SaaS Marketplace.
|
default String |
getDescription()
(experimental) A description of the purpose of the API key.
|
default Boolean |
getEnabled()
(experimental) Indicates whether the API key can be used by clients.
|
default Boolean |
getGenerateDistinctId()
(experimental) Specifies whether the key identifier is distinct from the created API key value.
|
default List<IRestApi> |
getResources()
(experimental) A list of resources this api key is associated with.
|
getApiKeyName, getValuegetDefaultCorsPreflightOptions, getDefaultIntegration, getDefaultMethodOptions@Stability(value=Experimental) @Nullable default String getCustomerId()
Default: none
@Stability(value=Experimental) @Nullable default String getDescription()
Default: none
@Stability(value=Experimental) @Nullable default Boolean getEnabled()
Default: true
@Stability(value=Experimental) @Nullable default Boolean getGenerateDistinctId()
Default: false
@Stability(value=Experimental) @Nullable default List<IRestApi> getResources()
Default: none
@Stability(value=Experimental) static ApiKeyProps.Builder builder()
builder in interface ApiKeyOptionsbuilder in interface ResourceOptionsApiKeyProps.Builder of ApiKeyPropsCopyright © 2021. All rights reserved.