Skip to content

Commit

Permalink
adds @default docs to optional interface members
Browse files Browse the repository at this point in the history
  • Loading branch information
SachinShekhar committed May 9, 2020
1 parent ac07103 commit 5889805
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions packages/@aws-cdk/aws-appsync/lib/graphqlapi.ts
Original file line number Diff line number Diff line change
Expand Up @@ -55,15 +55,18 @@ export interface AuthorizationMode {
readonly authorizationType: AuthorizationType;
/**
* If authorizationType is `AuthorizationType.USER_POOL`, this option is required.
* @default - none
*/
readonly userPoolConfig?: UserPoolConfig;
/**
* If authorizationType is `AuthorizationType.API_KEY`, this option can be configured.
* If AuthorizationType.API_KEY` is in `additionalAuthorizationModes`, this option is required.
* @default - none
*/
readonly apiKeyConfig?: ApiKeyConfig;
/**
* If authorizationType is `AuthorizationType.OIDC`, this option is required.
* @default - none
*/
readonly openIdConnectConfig?: OpenIdConnectConfig;
}
Expand Down Expand Up @@ -114,6 +117,7 @@ export interface ApiKeyConfig {
readonly name: string;
/**
* Description of API key
* @default - none
*/
readonly description?: string;

Expand All @@ -132,15 +136,19 @@ export interface ApiKeyConfig {
export interface OpenIdConnectConfig {
/**
* The number of milliseconds an OIDC token is valid after being authenticated
* @default - none (no auth caching)
*/
readonly authExpiry?: number;
/**
* The number of milliseconds an OIDC token is valid after being issued to a user
* @default - none (expiry determined from token validation)
*/
readonly tokenExpiry?: number;
/**
* The client identifier of the Relying party at the OpenID identity provider.
* A regular expression can be specified so AppSync can validate against multiple client identifiers at a time.
* @example - 'ABCD|CDEF' where ABCD and CDEF are two different clientId
* @default - * (All)
*/
readonly clientId?: string;
/**
Expand Down

0 comments on commit 5889805

Please sign in to comment.