ApiKeyConfig

class aws_cdk.aws_appsync.ApiKeyConfig(*, description=None, expires=None, name=None)

Bases: object

Configuration for API Key authorization in AppSync.

Parameters:

  • description (Optional[str]) – Description of API key. Default: - ‘Default API Key created by CDK’

  • expires (Optional[Expiration]) – 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

  • name (Optional[str]) – Unique name of the API Key. Default: - ‘DefaultAPIKey’

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk as cdk
from aws_cdk import aws_appsync as appsync

# expiration: cdk.Expiration

api_key_config = appsync.ApiKeyConfig(
    description="description",
    expires=expiration,
    name="name"
)

Attributes

description

Description of API key.

Default:

  • ‘Default API Key created by CDK’

expires

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

name

Unique name of the API Key.

Default:

  • ‘DefaultAPIKey’