ApiKeyConfig

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

Bases: object

__init__(*, description=None, expires=None, name=None)

Configuration for API Key authorization in AppSync.

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

  • expires (Optional[str]) – The time from creation time after which the API key expires, using RFC3339 representation. 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 from creation time

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

stability :stability: experimental

Return type

None

Attributes

description

Description of API key.

default :default: - ‘Default API Key created by CDK’

stability :stability: experimental

Return type

Optional[str]

expires

The time from creation time after which the API key expires, using RFC3339 representation.

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 :default: - 7 days from creation time

stability :stability: experimental

Return type

Optional[str]

name

Unique name of the API Key.

default :default: - ‘DefaultAPIKey’

stability :stability: experimental

Return type

Optional[str]