Function: createApiTemplate()
createApiTemplate(
__namedParameters):CloudFormationTemplate
Defined in: createApiTemplate.ts:79
Parameters
| Parameter | Type | Description |
|---|---|---|
__namedParameters | { additionalAuthenticationProviders?: AuthenticationType[]; authenticationType?: AuthenticationType; customDomain?: { certificateArn: string | { Ref: string; }; domainName: string | { Ref: string; }; hostedZoneName?: string; }; dataSource: { roleArn: CloudFormationValue<string>; }; lambdaFunction: { environment?: { variables: Record<string, CloudFormationValue<string>>; }; layers?: any; roleArn: CloudFormationValue<string>; }; noneDataSourceResolvers?: object[]; schemaComposer: SchemaComposer<any>; userPoolConfig?: { appIdClientRegex: CloudFormationValue<string>; awsRegion: CloudFormationValue<string>; defaultAction: "ALLOW" | "DENY"; userPoolId: CloudFormationValue<string>; }; } | - |
__namedParameters.additionalAuthenticationProviders? | AuthenticationType[] | - |
__namedParameters.authenticationType? | AuthenticationType | - |
__namedParameters.customDomain? | { certificateArn: string | { Ref: string; }; domainName: string | { Ref: string; }; hostedZoneName?: string; } | - |
__namedParameters.customDomain.certificateArn | string | { Ref: string; } | - |
__namedParameters.customDomain.domainName | string | { Ref: string; } | - |
__namedParameters.customDomain.hostedZoneName? | string | - |
__namedParameters.dataSource | { roleArn: CloudFormationValue<string>; } | - |
__namedParameters.dataSource.roleArn | CloudFormationValue<string> | - |
__namedParameters.lambdaFunction | { environment?: { variables: Record<string, CloudFormationValue<string>>; }; layers?: any; roleArn: CloudFormationValue<string>; } | - |
__namedParameters.lambdaFunction.environment? | { variables: Record<string, CloudFormationValue<string>>; } | - |
__namedParameters.lambdaFunction.environment.variables | Record<string, CloudFormationValue<string>> | - |
__namedParameters.lambdaFunction.layers? | any | - |
__namedParameters.lambdaFunction.roleArn | CloudFormationValue<string> | - |
__namedParameters.noneDataSourceResolvers? | object[] | Resolvers that use the NONE data source. These are typically mutations used to trigger AppSync subscriptions from the backend without any business logic — AppSync passes the arguments directly through to subscribers via @aws_subscribe. |
__namedParameters.schemaComposer | SchemaComposer<any> | - |
__namedParameters.userPoolConfig? | { appIdClientRegex: CloudFormationValue<string>; awsRegion: CloudFormationValue<string>; defaultAction: "ALLOW" | "DENY"; userPoolId: CloudFormationValue<string>; } | - |
__namedParameters.userPoolConfig.appIdClientRegex | CloudFormationValue<string> | - |
__namedParameters.userPoolConfig.awsRegion | CloudFormationValue<string> | - |
__namedParameters.userPoolConfig.defaultAction | "ALLOW" | "DENY" | - |
__namedParameters.userPoolConfig.userPoolId | CloudFormationValue<string> | - |
Returns
CloudFormationTemplate