AppSyncApiKeyConfig Struct
Configuration for API Key authorization in AppSync.
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cdk from 'aws-cdk-lib';
import { aws_appsync as appsync } from 'aws-cdk-lib';
declare const expiration: cdk.Expiration;
const appSyncApiKeyConfig: appsync.AppSyncApiKeyConfig = {
description: 'description',
expires: expiration,
name: 'name',
};
Properties
descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#Description of API key.
Default: 'Default API Key created by CDK'
expiresoptionalExpirationexpiresoptionalExpirationexpiresoptionalExpirationExpiresoptionalExpirationExpiresoptionalExpiration#The time from creation time after which the API key expires.
Default: 7 days rounded down to nearest hour
It must be a minimum of 1 day and a maximum of 365 days from date of creation. Rounded down to the nearest hour.
nameoptionalstringnameoptionalstrnameoptionalStringNameoptionalstringNameoptional*string= 'DefaultAPIKey'#Unique name of the API Key.