ApiKeyConfig¶
-
class
aws_cdk.aws_appsync.ApiKeyConfig(*, description=None, expires=None, name=None)¶ Bases:
object(experimental) Configuration for API Key authorization in AppSync.
- Parameters
description (
Optional[str]) – (experimental) Description of API key. Default: - ‘Default API Key created by CDK’expires (
Optional[Expiration]) – (experimental) 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 hourname (
Optional[str]) – (experimental) Unique name of the API Key. Default: - ‘DefaultAPIKey’
- Stability
experimental
Attributes
-
description¶ (experimental) Description of API key.
- Default
‘Default API Key created by CDK’
- Stability
experimental
- Return type
Optional[str]
-
expires¶ (experimental) 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
- Stability
experimental
- Return type
Optional[Expiration]
-
name¶ (experimental) Unique name of the API Key.
- Default
‘DefaultAPIKey’
- Stability
experimental
- Return type
Optional[str]