Skip to main content

Function: createApiTemplate()

createApiTemplate(__namedParameters): CloudFormationTemplate

Defined in: createApiTemplate.ts:38

Parameters​

__namedParameters​

additionalAuthenticationProviders​

AuthenticationType[]

authenticationType​

AuthenticationType = 'AMAZON_COGNITO_USER_POOLS'

customDomain​

{ certificateArn: string; domainName: string; hostedZoneName: string; }

customDomain.certificateArn​

string

customDomain.domainName​

string

customDomain.hostedZoneName​

string

dataSource​

{ roleArn: StringOrImport; }

dataSource.roleArn​

StringOrImport

lambdaFunction​

{ environment: { variables: Record<string, string>; }; layers: any; roleArn: StringOrImport; }

lambdaFunction.environment​

{ variables: Record<string, string>; }

lambdaFunction.environment.variables​

Record<string, string>

lambdaFunction.layers​

any

lambdaFunction.roleArn​

StringOrImport

schemaComposer​

SchemaComposer

userPoolConfig​

{ appIdClientRegex: StringOrImport; awsRegion: StringOrImport; defaultAction: "ALLOW" | "DENY"; userPoolId: StringOrImport; }

userPoolConfig.appIdClientRegex​

StringOrImport

userPoolConfig.awsRegion​

StringOrImport

userPoolConfig.defaultAction​

"ALLOW" | "DENY"

userPoolConfig.userPoolId​

StringOrImport

Returns​

CloudFormationTemplate