Skip to main content

Function: createApiTemplate()

createApiTemplate(__namedParameters): CloudFormationTemplate

Defined in: createApiTemplate.ts:35

Parameters​

__namedParameters​

additionalAuthenticationProviders?​

AuthenticationType[]

authenticationType?​

AuthenticationType = 'AMAZON_COGNITO_USER_POOLS'

customDomain?​

{ certificateArn: string | { Ref: string; }; domainName: string | { Ref: string; }; hostedZoneName?: string; }

customDomain.certificateArn​

string | { Ref: string; }

customDomain.domainName​

string | { Ref: string; }

customDomain.hostedZoneName?​

string

dataSource​

{ roleArn: CloudFormationValue<string>; }

dataSource.roleArn​

CloudFormationValue<string>

lambdaFunction​

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

lambdaFunction.environment?​

{ variables: Record<string, CloudFormationValue<string>>; }

lambdaFunction.environment.variables​

Record<string, CloudFormationValue<string>>

lambdaFunction.layers?​

any

lambdaFunction.roleArn​

CloudFormationValue<string>

schemaComposer​

SchemaComposer<any>

userPoolConfig?​

{ appIdClientRegex: CloudFormationValue<string>; awsRegion: CloudFormationValue<string>; defaultAction: "ALLOW" | "DENY"; userPoolId: CloudFormationValue<string>; }

userPoolConfig.appIdClientRegex​

CloudFormationValue<string>

userPoolConfig.awsRegion​

CloudFormationValue<string>

userPoolConfig.defaultAction​

"ALLOW" | "DENY"

userPoolConfig.userPoolId​

CloudFormationValue<string>

Returns​

CloudFormationTemplate