Skip to main content

CloudFormation Template Reference

This inventory describes the released 1.19.2 templates, including every nested template reached from the Core and generic commercial roots and the published support templates. It is a versioned snapshot, not the configuration of a running account. Conditional resources and outputs depend on the chosen parameters. Licensed customer packages can differ; inspect the exact supplied template before deploying.

Use the root installation template for normal installation. Nested stacks are implementation components managed by their parent; do not deploy or edit a child independently just because its parameters are listed here. Optional support, legacy, distribution, email, backup, and upgrade templates are catalogued for identification, not enabled by this reference. Confirm applicability before using them.

Read deployed settings​

aws cloudformation describe-stacks --stack-name YOUR_STACK \
--query 'Stacks[0].{Parameters:Parameters,Outputs:Outputs}'

Treat outputs and parameter exports as operational data. Do not publish credentials or presigned links. A required input has no template default; a blank-string default is shown explicitly. NoEcho defaults are omitted. Output values are resolved by CloudFormation, so this reference lists names and descriptions rather than copying one account's values.

For installation, use Core Quick Start or Commercial Deployment Notes. For token lifetimes and ConsoleWafACLId coverage, see authentication and edge security. For removal, see Uninstall.

Template index​

The paths below use resource logical IDs under each Main root. Shared content is rendered once per SHA-256; expand the matching entry to inspect its parameters and outputs. The snapshot includes 84 template instances.

Core: Main

Source: https://formkiq-core-distribution-us-east-1.s3.us-east-1.amazonaws.com/1.19.2/template.yaml

SHA-256: 4b96c7474d1dff8f88d900b24f49d78eddab926e43b2e6b896ace3340875fa7e

Parameters​

NameType / defaultConstraints and purpose
ConsoleWafACLIdString; Default (empty string)ARN of the Console WAF WebACL to associate with the CloudFront distribution
AdminEmailString; RequiredAdministrator Email (required) Pattern: .+.
AppEnvironmentString; Default prodUnique Application Environment Identifier, IE dev/staging/prod Pattern: [a-zA-Z0-9_.-/]+.
EnablePublicUrlsString; Default falseWhether to enable "/public" endpoints, defaults to false. Public endpoints allow external users to submit documents, such as through a web form. As with any publicly-available functionality, there is a risk of abuse if enabled. Values: ["true","false"].
PasswordMinimumLengthNumber; Default 8Set the Amazon Cognito password policies, minimum password length requirement for all users Min: 6. Max: 99.
PasswordRequireLowercaseString; Default falseSet the Amazon Cognito password policies, to require one lowercase letter in all passwords. Values: ["true","false"].
PasswordRequireNumbersString; Default falseSet the Amazon Cognito password policies, to require one number in all passwords. Values: ["true","false"].
PasswordRequireSymbolsString; Default falseSet the Amazon Cognito password policies, to require one symbol in all passwords. Values: ["true","false"].
PasswordRequireUppercaseString; Default falseSet the Amazon Cognito password policies, to require one uppercase letter in all passwords. Values: ["true","false"].
TokenAccessIdValidityMinutesNumber; Default 1440The time limit in minutes, after which the access and ID tokens are no longer valid and cannot be used. Min: 5. Max: 1440.
TokenRefreshValidityMinutesNumber; Default 43200The time limit in minutes, after which the refresh token is no longer valid and cannot be used. Min: 60. Max: 5256000.
VpcStackNameString; Default (empty string)The name of the CloudFormation VPC stack that can be created after the initial FormKiQ install, using the add-on CloudFormation template for VPC (see the relevant deployment guide) Some services such as Typesense, and OpenSearch require a VPC. Only required if you are using any of these services; otherwise, this can remain empty.
TypesenseApiKeySecretArnString; Default (empty string)ARN of a Secrets Manager secret in this account and Region whose plaintext SecretString is the Typesense API key. Leave empty to disable Typesense. Pattern: ^$|^arn:[a-z0-9-]+:secretsmanager:[a-z0-9-]+:[0-9]{12}:secret:.+$.
TypesenseMemoryString; Default 1024The amount of memory used by Typesense (GB). (Suggested to be 2-3 times the size of your data) Values: ["1024","2048","3072","4096","5120","6144","7168","8192","16384","32768"].
CapacityProviderString; Default FARGATE_SPOTAWS Fargate capacity provider to use, either the FARGATE or FARGATE_SPOT Values: ["FARGATE_SPOT","FARGATE"].
LogRetentionInDaysNumber; Default 90The number of days to retain the log events Values: [1,3,5,7,14,30,60,90,120,150,180,365,400,545,731,1096,1827,2192,2557,2922,3288,3653].
LogFormatString; Default TextThe format in which the application and system logs are stored. Values: ["Text","JSON"].
LogLevelApplicationString; Default INFOThe level of logging for the FormKiQ Application logs. Only used when LogFormat is JSON Values: ["TRACE","DEBUG","INFO","ERROR"].
LogLevelSystemString; Default INFOThe level of logging for the AWS Platform System logs. Only used when LogFormat is JSON Values: ["DEBUG","INFO","WARN"].
EnableDeletionProtectionString; Default falseEnable deletion protection on AWS Services that support the feature Values: ["true","false"].
UserPoolTierString; Default LITECognito User Pool feature plan (tier). Determines the set of capabilities and limits available for the pool. Valid values: - LITE: Basic authentication and user management features at the lowest cost. - ESSENTIALS: Standard tier with advanced authentication features (default). - PLUS: Includes all ESSENTIALS features plus premium capabilities such as advanced security protections, WebAuthn/passkey support, and additional customization. The default is ESSENTIALS if not otherwise specified. Values: ["LITE","ESSENTIALS","PLUS"].

Outputs​

NamePurpose
AppEnvironmentUnique Application Environment Identifier, IE dev/staging/prod
IamApiUrlThe URL for the API endpoint that uses IAM authorization
KeyApiUrlThe URL for the API endpoint that uses API Key authorization
HttpApiUrlThe URL for the API endpoint that uses Cognito authorization
AuthApiUrlThe endpoint url for the User Auth API
ConsoleUrlThe URL for the FormKiQ Console
ConsoleS3BucketThe Console S3 Bucket
CognitoUserPoolIdThe Cognito User Pool Id
CognitoUserPoolArnThe Cognito User Pool Arn
CognitoClientIdThe Cognito Client Id
CognitoDomainThe Cognito Domain Url
FormKiQVersionThe FormKiQ Version
SnsDocumentEventArnSNS Topic for Document Events
DocumentsTableNameDocument DynamoDb Table Name
DocumentsTableArnDocument DynamoDb Table Arn
DocumentsS3BucketsDocuments Bucket.
DocumentsStageS3BucketDocuments Staging Bucket.
TypesenseApiEndpointTypesense API endpoint
Core: Main/Config

Source: https://s3.us-east-1.amazonaws.com/formkiq-core-distribution-us-east-1/1.19.2/36b37b612348c2c7eab117bdffe63e61.template

SHA-256: 6577e45893a9e24781d07693ad93a1b9b81582143856efe2596f3e6b0f36916c

Parameters​

NameType / defaultConstraints and purpose
FormKiQTypeString; RequiredThe formkiq type of installation Pattern: .+.
FormKiQVersionString; RequiredThe formkiq version Pattern: .+.
LambdaArchitectureString; RequiredLambda instruction set architecture for this build artifact Values: ["x86_64","arm64"].
VpcStackNameString; RequiredThe name of the CloudFormation VPC stack that can be created after the initial FormKiQ install, using the add-on CloudFormation template for VPC (see the relevant deployment guide) Some services such as Typesense, and OpenSearch require a VPC. Only required if you are using any of these services; otherwise, this can remain empty.

Outputs​

NamePurpose
FormKiQTypeThe FormKiQ type of installation
FormKiQVersionThe FormKiQ version
LambdaArchitectureLambda instruction set architecture for this build artifact
Core: Main/CoreStorage

Source: https://s3.us-east-1.amazonaws.com/formkiq-core-distribution-us-east-1/1.19.2/d478a397848c84e1de2b20c4e0950028.template

SHA-256: 76066dd057212fd8c4196aadee75068af0b191898e10cb9f84c96baf073f74ab

Parameters​

NameType / defaultConstraints and purpose
S3AccessLogsBucketNameString; Default (empty string)Optional existing S3 bucket for server access logs, in the same account and Region. Must use SSE-S3 and allow S3 log delivery. Leave empty to disable.
EnableS3TransferAccelerationString; Default falseEnable opt-in S3 Transfer Acceleration for documents bucket URLs (additional transfer charges apply) Values: ["true","false"].
AppEnvironmentString; RequiredThe Application Environment Pattern: .+.
LambdaMemoryNumber; Default 1024The amount of memory used by lambda function (MB) Min: 128. Max: 3008.
LambdaTimeoutString; Default 60The maximum amount of seconds lambda function will run for (seconds)
LambdaArchitectureString; RequiredLambda instruction set architecture Values: ["x86_64","arm64"].
FormKiQTypeString; RequiredThe type of FormKiQ installation
VpcStackNameString; RequiredFormKiQ VPC Stack Name
TypesenseApiKeySecretArnString; Default (empty string)ARN of a Secrets Manager secret in this account and Region whose plaintext SecretString is the Typesense API key. Leave empty to disable Typesense. Pattern: ^$|^arn:[a-z0-9-]+:secretsmanager:[a-z0-9-]+:[0-9]{12}:secret:.+$.
DocumentEventsBusString; Default (empty string)Name EventBridge Event Bus
LogRetentionInDaysNumber; RequiredThe number of days to retain the log events
LogFormatString; RequiredThe format in which the application and system logs are stored.
LogLevelApplicationString; RequiredThe level of logging for the FormKiQ Application logs.
LogLevelSystemString; RequiredThe level of logging for the AWS Platform System logs.
EnableDeletionProtectionString; RequiredEnable deletion protection on AWS Services that support the feature
OperationalModeString; Default ACTIVEControls the runtime operational behavior of the FormKiQ environment.

Outputs​

NamePurpose
DocumentsTableNameDocuments DynamoDb Table Name.
DocumentsTableArnDocuments DynamoDb Table Arn.
DocumentsStreamArnDocuments DynamoDb Table Stream Arn.
DocumentSyncsTableNameInspect the deployed output and owning template.
CacheTableNameInspect the deployed output and owning template.
DocumentsS3BucketsDocuments Bucket.
DocumentsStageS3BucketDocuments Staging Bucket.
DocumentsUpdateQueueUrlDocuments Update Documents Queue Url
DocumentsUpdateQueueArnDocuments S3 Update Documents Queue Arn
DocumentsDeadLetterQueueArnDocuments Dead Letter Queue Arn
DocumentsDeadLetterQueueNameDocuments Dead Letter Queue Name
SnsDocumentEventArnSNS Topic for Document Events
DocumentsS3UpdateDocuments MetaData Object Lambda
StagingCreateObjectDocuments Staging Create Object Lambda
DocumentsUpdateObjectDocuments Update Object Lambda
DocumentActionsProcessorDocument Actions Processor Lambda
Core: Main/CoreConsole

Source: https://s3.us-east-1.amazonaws.com/formkiq-core-distribution-us-east-1/1.19.2/cd67b190c8163bdca3f28c7d61177bd7.template

SHA-256: 513eb5dae448d379ca80a92906f6eb34b712fbe9220c2ca784d5863bd3d4be14

Parameters​

NameType / defaultConstraints and purpose
CloudFrontAccessLogsBucketNameString; Default (empty string)Optional existing S3 bucket name for CloudFront standard access logs (legacy). Must have ACLs enabled and permit CloudFront log delivery. The deployment role needs s3:GetBucketAcl and s3:PutBucketAcl. Leave empty to disable.
S3AccessLogsBucketNameString; Default (empty string)Optional existing S3 bucket for server access logs, in the same account and Region. Must use SSE-S3 and allow S3 log delivery. Leave empty to disable.
WAFWebACLIdString; Default (empty string)(Optional) ARN of the AWS WAF WebACL to associate with the CloudFront distribution. Leave empty to disable.
AdminEmailString; RequiredAdministrator Email Pattern: .+.
AppEnvironmentString; RequiredThe Document Stack Environment Pattern: .+.
DomainString; RequiredAmazon Cognito domain to use (include full domain if CertificateArn used)
ConsoleVersionString; Default v4.3.8Version of FormKiQ console to deploy
CognitoConfigBucketString; RequiredCognito Config S3 Bucket
FormKiQTypeString; RequiredThe type of FormKiQ installation
CertificateStackNameString; Default (empty string)The name of the FormKiQ Certificate Stack Name
CertificateStackNameDomainNameString; Default _The name of the FormKiQ Certificate Stack Name Domain Name
IsGovCloudString; RequiredIs Installation AWS Region gov cloud Values: ["true","false"].
ApiUrlString; RequiredJWT API URL
IamApiUrlString; RequiredIAM API URL
KeyApiUrlString; RequiredKey API URL
AuthApiUrlString; RequiredAuth Api URL
DocumentsTableNameString; RequiredDocument DynamoDb Table Name
BrandString; Default formkiqConsole Installer Brand
AllowAdminCreateUserOnlyString; RequiredWhen true only Cognito Admin can create users, false users can register themselves Pattern: .+.
CognitoHostedUiString; RequiredAmazon Cognito Hosted UI Url Pattern: .+.
DriveAuthorizeUrlString; Default (empty string)The Cognito OAuth2 authorization URL for the Drive app client
DriveCognitoUserPoolClientIdString; Default (empty string)The Cognito User Pool Client Id for the Drive app client
CognitoUserPoolIdString; RequiredThe Cognito User Pool Id Pattern: .+.
CognitoUserPoolClientIdString; RequiredThe Cognito User Pool Client Id Pattern: .+.
UserAuthenticationString; Default cognitoHow are the users authenticating Pattern: .+.
LogFormatString; RequiredThe format in which the application and system logs are stored.
LogLevelApplicationString; RequiredThe level of logging for the FormKiQ Application logs. Only used when LogFormat is JSON
LogLevelSystemString; RequiredThe level of logging for the AWS Platform System logs. Only used when LogFormat is JSON
LogRetentionInDaysNumber; RequiredThe number of days to retain the log events
LambdaArchitectureString; RequiredLambda instruction set architecture Values: ["x86_64","arm64"].

Outputs​

NamePurpose
ConsoleUrlConsole URL
ConsoleBucketInspect the deployed output and owning template.
ConsoleVersionInspect the deployed output and owning template.
HostedZoneIdInspect the deployed output and owning template.
CloudFrontDistributionDomainNameInspect the deployed output and owning template.
Core: Main/CoreConsoleInstall · Commercial: Main/CoreConsoleInstall · Commercial: template-upgrade/CoreConsoleInstall

Source: https://s3.us-east-1.amazonaws.com/formkiq-core-distribution-us-east-1/1.19.2/577d3a0a1962efd993e96a37d0041a9c.template

SHA-256: 37dcd0bdd2e9f78ca8ec0caab710dd37b5b9c03fb6d1355a8880dcf7494a57f5

Parameters​

NameType / defaultConstraints and purpose
CertificateStackNameString; Default (empty string)The name of the FormKiQ Certificate Stack Name
HostedZoneIdString; Default (empty string)Route53 Hosted Zone Id in which to add A record
CloudFrontDistributionDomainNameString; Default (empty string)The cloudfront domain name of the resource

No declared outputs.

Core: Main/Cognito

Source: https://s3.us-east-1.amazonaws.com/formkiq-core-distribution-us-east-1/1.19.2/512e174357294f4aab0e1ea1a611d0fd.template

SHA-256: d6467bedd140007a2fd5665f89afdd1577ee9cf225f0c4856093f316ee2633ba

Parameters​

NameType / defaultConstraints and purpose
S3AccessLogsBucketNameString; Default (empty string)Optional existing S3 bucket for server access logs, in the same account and Region. Must use SSE-S3 and allow S3 log delivery. Leave empty to disable.
AppEnvironmentString; Default (empty string)Unique Application Environment Identifier, IE dev/staging/prod
UserPoolTierString; Default LITEUser pool feature plan (tier). Values: ["LITE","ESSENTIALS","PLUS"].
UserPoolNameString; RequiredName of the User Pool. Pattern: .+.
AllowAdminCreateUserOnlyString; Default falseValues: ["true","false"].
PasswordMinimumLengthNumber; Default 8The minimum password length. Min: 6. Max: 99.
PasswordRequireLowercaseString; Default truePassword requires at least one lowercase letter. Values: ["true","false"].
PasswordRequireNumbersString; Default truePassword requires at least one number. Values: ["true","false"].
PasswordRequireSymbolsString; Default truePassword requires at least one symbol. Values: ["true","false"].
PasswordRequireUppercaseString; Default truePassword requires at least one uppercase letter. Values: ["true","false"].
DomainString; RequiredAmazon Cognito domain to use (include full domain if CertificateArn used) Pattern: .+.
DomainCertificateArnString; Default (empty string)Amazon Cognito Certificate ARN to use
SesSourceArnString; Default (empty string)The Amazon Resource Name (ARN) of a verified email address in Amazon SES
ReplyToEmailAddressString; Default (empty string)The destination to which the receiver of the email should reply to
AccessTokenValidityNumber; Default 1440The time limit in minutes, after which the access token is no longer valid and cannot be used. Min: 5. Max: 1440.
IdTokenValidityNumber; Default 1440The time limit in minutes, after which the ID token is no longer valid and cannot be used. Min: 5. Max: 1440.
RefreshTokenValidityNumber; Default 43200The time limit in minutes, after which the refresh token is no longer valid and cannot be used. Min: 60. Max: 5256000.
LogRetentionInDaysNumber; Default 90The number of days to retain the log events Values: [1,3,5,7,14,30,60,90,120,150,180,365,400,545,731,1096,1827,2192,2557,2922,3288,3653].
LogFormatString; Default TextThe format in which the application and system logs are stored. Values: ["Text","JSON"].
LogLevelApplicationString; Default INFOThe level of logging for the FormKiQ Application logs. Only used when LogFormat is JSON Values: ["TRACE","DEBUG","INFO","ERROR"].
LogLevelSystemString; Default INFOThe level of logging for the AWS Platform System logs. Only used when LogFormat is JSON Values: ["DEBUG","INFO","WARN"].
EnableDeletionProtectionString; Default falseEnable deletion protection on AWS Services that support the feature Values: ["true","false"].
LambdaArchitectureString; RequiredLambda instruction set architecture Values: ["x86_64","arm64"].

Outputs​

NamePurpose
CognitoConfigBucketThe Cognito Config Bucket
CognitoUserPoolIdThe Cognito User Pool Id
CognitoUserPoolProviderNameThe Cognito User Pool Provider Name
CognitoUserPoolProviderURLThe Cognito User Pool Provider URL
CognitoUserPoolArnThe Cognito User Pool Arn
CognitoUserPoolClientIdThe Cognito User Pool Client Id
CognitoIdentityPoolIdCognito Identity Pool
DomainAmazon Cognito domain to use (include full domain if CertificateArn used)
CognitoHostedUiAmazon Cognito Hosted UI Url
CognitoDomainAmazon Cognito Domain
Core: Main/SsmProperties · Commercial: Main/SsmProperties · Commercial: template-upgrade/SsmProperties

Source: https://s3.us-east-1.amazonaws.com/formkiq-core-distribution-us-east-1/1.19.2/c77f7060a40c20d2d672de761f22bd6e.template

SHA-256: 6b9e9143dbae349dc58e7620ab45833d50edf38de497d87bfd385930cc4d8fd8

Parameters​

NameType / defaultConstraints and purpose
AppEnvironmentString; RequiredUnique Application Environment Identifier, IE dev/staging/prod Pattern: .+.
CognitoUserPoolString; RequiredThe Cognito User Pool Id Pattern: .+.
CognitoUserPoolArnString; RequiredThe Cognito User Pool Arn Pattern: .+.
CognitoUserPoolClientString; RequiredThe Cognito User Pool Client Id Pattern: .+.
CognitoIdentityPoolString; RequiredThe Cognito Identity Pool Id Pattern: .+.
DomainString; RequiredAmazon Cognito domain to use (include full domain if CertificateArn used) Pattern: .+.

No declared outputs.

Core: Main/CoreApi

Source: https://s3.us-east-1.amazonaws.com/formkiq-core-distribution-us-east-1/1.19.2/6b14647ac16ebd91b65eb926eb920dc3.template

SHA-256: 5886b0cb8a4174e8fc3d17dfe0e4afbd5def5a7e6b251fc1d76d24cbcf633f4f

Parameters​

NameType / defaultConstraints and purpose
EnableS3TransferAccelerationString; Default falseEnable opt-in S3 Transfer Acceleration for documents bucket URLs (additional transfer charges apply) Values: ["true","false"].
AppEnvironmentString; RequiredThe FormKiQ Environment Pattern: .+.
FormKiQTypeString; RequiredThe type of FormKiQ installation Pattern: .+.
FormKiQVersionString; RequiredThe formkiq version Pattern: .+.
LambdaMemoryNumber; Default 1024The amount of memory used by lambda function (MB) Min: 128. Max: 3008.
LambdaTimeoutString; Default 60The maximum amount of seconds lambda function will run for (seconds)
LambdaArchitectureString; RequiredLambda instruction set architecture Values: ["x86_64","arm64"].
EnablePublicUrlsString; Default falseWhether to enable public urls Values: ["true","false"].
AllowAdminCreateUserOnlyString; Default trueValues: ["true","false"].
PasswordMinimumLengthNumber; Default 8The minimum password length. Min: 6. Max: 99.
PasswordRequireLowercaseString; Default falsePassword requires at least one lowercase letter. Values: ["true","false"].
PasswordRequireNumbersString; Default falsePassword requires at least one number. Values: ["true","false"].
PasswordRequireSymbolsString; Default falsePassword requires at least one symbol. Values: ["true","false"].
PasswordRequireUppercaseString; Default falsePassword requires at least one uppercase letter. Values: ["true","false"].
CognitoUserPoolString; RequiredThe Cognito User Pool Id Pattern: .+.
CognitoUserPoolClientString; RequiredThe Cognito User Pool Client Id Pattern: .+.
UserAuthenticationString; Default cognitoHow are the users authenticating Pattern: .+.
TypesenseApiKeySecretArnString; Default (empty string)ARN of a Secrets Manager secret in this account and Region whose plaintext SecretString is the Typesense API key. Leave empty to disable Typesense. Pattern: ^$|^arn:[a-z0-9-]+:secretsmanager:[a-z0-9-]+:[0-9]{12}:secret:.+$.
TypesenseApiEndpointString; RequiredTypeSense API Endpoint
DocumentsTableNameString; RequiredDocuments DynamoDB Table Name
CacheTableNameString; RequiredCache DynamoDB Table Name
DocumentSyncsTableNameString; RequiredDocument Syncs DynamoDB Table Name
DocumentsS3BucketString; RequiredDocuments S3 Bucket Name
DocumentsStageS3BucketString; RequiredDocuments Stage S3 Bucket Name
SnsDocumentEventArnString; RequiredSNS Topic for Document Events
DocumentsDeadLetterQueueArnString; RequiredDocuments Dead Letter Queue Arn
VpcStackNameString; RequiredFormKiQ VPC Stack Name
CertificateStackNameString; Default (empty string)The name of the FormKiQ Certificate Stack Name
HttpsSecurityGroupString; Default (empty string)VPC Https Security Group
LogRetentionInDaysNumber; RequiredThe number of days to retain the log events
LogFormatString; RequiredThe format in which the application and system logs are stored.
LogLevelApplicationString; RequiredThe level of logging for the FormKiQ Application logs.
LogLevelSystemString; RequiredThe level of logging for the AWS Platform System logs.
CertificateStackNameShortlinksApiDomainString; Default (empty string)Certificate Shortlinks Api Domain
CertificateStackNameHttpApiDomainString; Default (empty string)Certificate Http Api Domain
CertificateStackNameIamApiDomainString; Default (empty string)Certificate IAM Api Domain
CertificateStackNameKeyApiDomainString; Default (empty string)Certificate Key Api Domain
OperationalModeString; Default ACTIVEControls the runtime operational behavior of the FormKiQ environment.
CertificateStackNameUserAuthApiDomainString; Default (empty string)Certificate User Auth API Domain
CertificateStackNameUserAuthCertificateArnString; Default (empty string)Certificate User Auth API ACM Certificate ARN
CertificateStackNameHostedZoneIdString; Default (empty string)Optional Route53 hosted zone for the User Auth API domain
S3AccessLogsBucketNameString; Default (empty string)Optional existing S3 bucket for server access logs, in the same account and Region. Must use SSE-S3 and allow S3 log delivery. Leave empty to disable.

Outputs​

NamePurpose
ApiGatewayInvokeRoleAPI Gateway Role that allows invoking of endpoints
ApiGatewayInvokeRoleArnAPI Gateway Role Arn that allows invoking of endpoints
DocumentsApiRequestsFormKiQ Api Request Handler
DocumentsHttpApiHTTP API
DocumentsIamApiIAM API
DocumentsIamApiUrlThe endpoint url for the IAM API
DocumentsKeyApiUrlThe endpoint url for the Key API
DocumentsHttpApiUrlThe endpoint url for the Http API
AuthApiUrlThe endpoint url for the Auth API
OcrBucketInspect the deployed output and owning template.
OcrQueueInspect the deployed output and owning template.
OcrQueueUrlInspect the deployed output and owning template.
OcrQueueArnInspect the deployed output and owning template.
Core: Main/CoreApi/ApiLambda

Source: https://s3.us-east-1.amazonaws.com/formkiq-core-distribution-us-east-1/1.19.2/48287d14db966fe3a9a2807787a5179d.template

SHA-256: dae86dd4f0d53640c750cf6f6557e7d9030c9e588bb1d391e3b3b5d46a17d87a

Parameters​

NameType / defaultConstraints and purpose
EnableS3TransferAccelerationString; Default falseEnable opt-in S3 Transfer Acceleration for documents bucket URLs (additional transfer charges apply) Values: ["true","false"].
AppEnvironmentString; RequiredThe FormKiQ Environment Pattern: .+.
FormKiQTypeString; RequiredThe type of FormKiQ installation Pattern: .+.
FormKiQVersionString; RequiredThe formkiq version Pattern: .+.
LambdaMemoryNumber; Default 1024The amount of memory used by lambda function (MB) Min: 128. Max: 3008.
LambdaTimeoutString; Default 60The maximum amount of seconds lambda function will run for (seconds)
LambdaArchitectureString; RequiredLambda instruction set architecture Values: ["x86_64","arm64"].
CognitoUserPoolString; RequiredThe Cognito User Pool Id Pattern: .+.
CognitoUserPoolClientString; RequiredThe Cognito User Pool Client Id Pattern: .+.
UserAuthenticationString; Default cognitoHow are the users authenticating Pattern: .+.
TypesenseApiKeySecretArnString; Default (empty string)ARN of a Secrets Manager secret in this account and Region whose plaintext SecretString is the Typesense API key. Leave empty to disable Typesense. Pattern: ^$|^arn:[a-z0-9-]+:secretsmanager:[a-z0-9-]+:[0-9]{12}:secret:.+$.
TypesenseApiEndpointString; RequiredTypeSense API Endpoint
DocumentsTableNameString; RequiredDocuments DynamoDB Table Name
CacheTableNameString; RequiredCache DynamoDB Table Name
DocumentSyncsTableNameString; RequiredDocument Syncs DynamoDB Table Name
DocumentsS3BucketString; RequiredDocuments S3 Bucket Name
DocumentsStageS3BucketString; RequiredDocuments Stage S3 Bucket Name
SnsDocumentEventArnString; RequiredSNS Topic for Document Events
OcrBucketString; RequiredName of OCR Bucket
OcrQueueUrlString; RequiredName of OCR Queue Url
OcrQueueArnString; RequiredName of OCR Queue Arn
VpcStackNameString; RequiredFormKiQ VPC Stack Name
EnablePublicUrlsString; RequiredWhether to enable public urls
LogRetentionInDaysNumber; RequiredThe number of days to retain the log events
LogFormatString; RequiredThe format in which the application and system logs are stored.
LogLevelApplicationString; RequiredThe level of logging for the FormKiQ Application logs.
LogLevelSystemString; RequiredThe level of logging for the AWS Platform System logs.
OperationalModeString; Default ACTIVEControls the runtime operational behavior of the FormKiQ environment.
HttpsSecurityGroupString; RequiredVPC Https Security Group

Outputs​

NamePurpose
DocumentsApiRequestsFormKiQ Api Request Handler
DocumentsApiRequestsArnFormKiQ Api Request Handler Arn
Core: Main/CoreApi/HttpApi

Source: https://s3.us-east-1.amazonaws.com/formkiq-core-distribution-us-east-1/1.19.2/d51bddd59fc1abd562decd7a3fbb6fd8.template

SHA-256: 0c76327c7ea49db1c117cecc18b93854f8d5c89dc99d899d151c9423b8a6109d

Parameters​

NameType / defaultConstraints and purpose
AppEnvironmentString; RequiredThe FormKiQ Environment Pattern: .+.
DocumentsApiRequestsArnString; RequiredLambda to invoke
OcrApiRequestsArnString; RequiredLambda to invoke for Object examine endpoints
CognitoUserPoolString; RequiredThe Cognito User Pool Id
CognitoUserPoolClientString; RequiredThe Cognito User Pool Client Id
CertificateStackNameHttpApiDomainString; RequiredCertificate Http Api Domain

Outputs​

NamePurpose
DocumentsHttpApiHTTP API
DocumentsHttpApiUrlThe endpoint url for the HTTP API
Core: Main/CoreApi/IamApi

Source: https://s3.us-east-1.amazonaws.com/formkiq-core-distribution-us-east-1/1.19.2/1139555fbdb15298d91f768f3ea1fcf1.template

SHA-256: ea108a3717edd2ae2b0fab59d2c961dc536c0b4a6d16b3aa4a727e293a3c553d

Parameters​

NameType / defaultConstraints and purpose
AppEnvironmentString; RequiredThe FormKiQ Environment Pattern: .+.
DocumentsApiRequestsArnString; RequiredLambda to invoke
OcrApiRequestsArnString; RequiredLambda to invoke for Object examine endpoints
CertificateStackNameIamApiDomainString; RequiredCertificate IAM Api Domain

Outputs​

NamePurpose
DocumentsIamApiIAM API
DocumentsIamApiUrlThe endpoint url for the IAM API
Core: Main/CoreApi/KeyApi

Source: https://s3.us-east-1.amazonaws.com/formkiq-core-distribution-us-east-1/1.19.2/a1ba6dc3550597866e3a7abc8fdaac6d.template

SHA-256: 150c4c317d2034921bacf2db8fe5dca04844a541b63f2586e691438b50fd000c

Parameters​

NameType / defaultConstraints and purpose
AppEnvironmentString; RequiredThe FormKiQ Environment Pattern: .+.
DocumentsApiRequestsArnString; RequiredLambda to invoke
OcrApiRequestsArnString; RequiredLambda to invoke for Object examine endpoints
FormKiQTypeString; RequiredThe type of FormKiQ installation
DocumentsTableNameString; RequiredDocuments DynamoDB Table Name
LambdaMemoryNumber; Default 1024The amount of memory used by lambda function (MB) Min: 128. Max: 3008.
LambdaTimeoutString; Default 60The maximum amount of seconds lambda function will run for (seconds)
LambdaArchitectureString; RequiredLambda instruction set architecture Values: ["x86_64","arm64"].
LogRetentionInDaysNumber; RequiredThe number of days to retain the log events
LogFormatString; RequiredThe format in which the application and system logs are stored.
LogLevelApplicationString; RequiredThe level of logging for the FormKiQ Application logs.
LogLevelSystemString; RequiredThe level of logging for the AWS Platform System logs.
VpcStackNameString; RequiredFormKiQ VPC Stack Name
CertificateStackNameKeyApiDomainString; RequiredCertificate Key Api Domain

Outputs​

NamePurpose
DocumentsKeyApiKey API
DocumentsKeyApiUrlThe endpoint url for the Key API
Core: Main/CoreApi/UserAuthApi · Commercial: Main/CoreApi/UserAuthApi · Commercial: template-upgrade/CoreApi/UserAuthApi

Source: https://s3.us-east-1.amazonaws.com/formkiq-core-distribution-us-east-1/1.19.2/c7a01a3a64b0620f164f5c75cc2bd842.template

SHA-256: 81ff0cd131774d1febb8f62c4074f34ce055f8ef4d87abb3514e11d08e5d2bce

Parameters​

NameType / defaultConstraints and purpose
AppEnvironmentString; RequiredThe FormKiQ Environment Pattern: .+.
DocumentsApiRequestsArnString; RequiredLambda to invoke
CognitoUserPoolString; RequiredThe Cognito User Pool Id
CognitoUserPoolClientString; RequiredThe Cognito User Pool Client Id
CertificateStackNameUserAuthApiDomainString; RequiredCertificate User Auth Api Domain
CertificateStackNameUserAuthCertificateArnString; Default (empty string)Certificate User Auth API ACM Certificate ARN
CertificateStackNameHostedZoneIdString; Default (empty string)Optional Route53 hosted zone for the User Auth API domain

Outputs​

NamePurpose
AuthApiUser Auth API
AuthApiUrlThe endpoint url for the User Auth API
Core: Main/CoreApi/Ocr

Source: https://s3.us-east-1.amazonaws.com/formkiq-core-distribution-us-east-1/1.19.2/acaed2631dc48c88349c993294021a21.template

SHA-256: 381b08ff324d0a53be17a58147c1bc1a338fffa1291c55a09f2adc4c56af6d9e

Parameters​

NameType / defaultConstraints and purpose
AppEnvironmentString; RequiredThe Application Environment Pattern: .+.
VpcStackNameString; RequiredFormKiQ VPC Stack Name
LambdaMemoryNumber; Default 2048The amount of memory used by lambda function (MB) Min: 128. Max: 3008.
LambdaTimeoutString; Default 600The maximum amount of seconds lambda function will run for (seconds)
FormKiQTypeString; RequiredThe type of FormKiQ installation
OcrQueueArnString; RequiredThe Ocr Queue Arn
DocumentsTableNameString; RequiredDocuments DynamoDB Table Name
DocumentsS3BucketString; RequiredDocuments S3 Bucket Name
DocumentsStageS3BucketString; RequiredDocuments Stage S3 Bucket Name
OcrBucketString; RequiredOCR S3 Bucket Name
SnsDocumentEventArnString; RequiredSNS Topic for Document Events
LogRetentionInDaysNumber; RequiredThe number of days to retain the log events
LogFormatString; RequiredThe format in which the application and system logs are stored.
LogLevelApplicationString; RequiredThe level of logging for the FormKiQ Application logs.
LogLevelSystemString; RequiredThe level of logging for the AWS Platform System logs.

Outputs​

NamePurpose
OcrProcessorInspect the deployed output and owning template.
OcrProcessorArnInspect the deployed output and owning template.
Core: Main/CoreConsoleUsers

Source: https://s3.us-east-1.amazonaws.com/formkiq-core-distribution-us-east-1/1.19.2/5b4109854fb760a8816d0822afa7f3c5.template

SHA-256: f8020f9c624cd1e229ee88c716441d7f87b1a65700b97411e09973e640d50133

Parameters​

NameType / defaultConstraints and purpose
AdminEmailString; RequiredAdministrator Email Pattern: .+.
AppEnvironmentString; RequiredThe Document Stack Environment Pattern: .+.
CognitoUserPoolString; RequiredThe Cognito User Pool Id Pattern: .+.
CognitoUserPoolArnString; RequiredThe Cognito User Pool Arn Pattern: .+.
CognitoIdentityPoolString; RequiredCognito Identity Pool Id Pattern: .+.
CognitoUserPoolClientString; RequiredCognito User Pool Client Pattern: .+.
IsGovCloudString; RequiredIs Installation AWS Region gov cloud Values: ["true","false"].

Outputs​

NamePurpose
AdminGroupRoleArnInspect the deployed output and owning template.
Core: Main/EcsCluster · Commercial: Main/EcsCluster · Commercial: template-upgrade/EcsCluster

Source: https://s3.us-east-1.amazonaws.com/formkiq-core-distribution-us-east-1/1.19.2/634546e41e9c4e040f0e82970db97278.template

SHA-256: bfa2baf43e4d91d214cc00f95d0fb7f6ab121a191bb251264c06533141630c2a

Parameters​

NameType / defaultConstraints and purpose
AppEnvironmentString; RequiredThe Application Environment Pattern: .+.
TypesenseApiKeySecretArnString; Default (empty string)ARN of a Secrets Manager secret in this account and Region whose plaintext SecretString is the Typesense API key. Leave empty to disable Typesense. Pattern: ^$|^arn:[a-z0-9-]+:secretsmanager:[a-z0-9-]+:[0-9]{12}:secret:.+$.
VpcStackNameString; RequiredFormKiQ VPC Stack Name
CapacityProviderString; RequiredAWS Fargate capacity provider to use, either the FARGATE or FARGATE_SPOT

Outputs​

NamePurpose
ECSClusterECS Cluster
Core: Main/TypeSenseService

Source: https://s3.us-east-1.amazonaws.com/formkiq-core-distribution-us-east-1/1.19.2/b06eb7d07f464b25cc8b153cf13a25a2.template

SHA-256: ccd95d25609e81d795c5c760dd5e81a3d93a5db1b7960ac6fbfcac04a8f26b2c

Parameters​

NameType / defaultConstraints and purpose
ImageString; Default typesense/typesense:0.25.1Version of Typesense to deploy
AppEnvironmentString; RequiredThe Application Environment Pattern: .+.
LambdaMemoryNumber; Default 1024The amount of memory used by lambda function (MB) Min: 128. Max: 3008.
LambdaTimeoutString; Default 60The maximum amount of seconds lambda function will run for (seconds)
LambdaArchitectureString; RequiredLambda instruction set architecture Values: ["x86_64","arm64"].
FormKiQTypeString; RequiredThe type of FormKiQ installation
TypesenseApiKeySecretArnString; Default (empty string)ARN of a Secrets Manager secret in this account and Region whose plaintext SecretString is the Typesense API key. Leave empty to disable Typesense. Pattern: ^$|^arn:[a-z0-9-]+:secretsmanager:[a-z0-9-]+:[0-9]{12}:secret:.+$.
TypesenseMemoryString; Default 1024The amount of memory used by Typesense Fargate Container function (GB) Values: ["1024","2048","3072","4096","5120","6144","7168","8192","16384","32768"].
VpcStackNameString; RequiredFormKiQ VPC Stack Name
ECSClusterString; RequiredReference to the ECSCluster
DocumentsTableNameString; RequiredDocuments DynamoDB Table Name
DocumentSyncsTableNameString; RequiredDocument Syncs DynamoDB Table Name
DocumentsStreamArnString; RequiredDocuments DynamoDB Stream Arn
LogRetentionInDaysNumber; RequiredThe number of days to retain the log events
LogFormatString; RequiredThe format in which the application and system logs are stored.
LogLevelApplicationString; RequiredThe level of logging for the FormKiQ Application logs.
LogLevelSystemString; RequiredThe level of logging for the AWS Platform System logs.

Outputs​

NamePurpose
CloudMapServiceArnCloud Map Service
TypesenseApiEndpointTypesense API Endpoint
Core: Main/Monitoring

Source: https://s3.us-east-1.amazonaws.com/formkiq-core-distribution-us-east-1/1.19.2/ff7ccaf3a48d2a070565c361b7995ea6.template

SHA-256: 69eeca13fede00e6c116340bbd3430d33dcf11600a0b7723d9449c52086c9186

Parameters​

NameType / defaultConstraints and purpose
AppEnvironmentString; RequiredUnique Application Environment Identifier, IE dev/staging/prod Pattern: .+.
DocumentsApiRequestsString; RequiredDocuments API Lambda Function Name
DocumentsUpdateObjectString; RequiredDocuments Update Object Lambda Function Name
StagingCreateObjectString; RequiredStaging Create Object Lambda Function Name
DocumentActionsProcessorString; RequiredDocument Actions Processor Lambda Function Name
DocumentsHttpApiString; RequiredDocuments HTTP API Id
DocumentsIamApiString; RequiredDocuments IAM API Id
UserAuthApiUrlString; RequiredUser Auth API Url
DocumentsDeadLetterQueueNameString; RequiredDocuments Dead Letter Queue Name

Outputs​

NamePurpose
DashboardURLDashboard URL
Commercial: Main

Source: Licensed 1.19.2 distribution: Licensed FormKiQ 1.19.2 template

SHA-256: 10901c3e27ea7f75f42e1b7d82cfa3aee45332ac4eff44da0dea585e1edbfc49

Parameters​

NameType / defaultConstraints and purpose
ConsoleWafACLIdString; Default (empty string)ARN of the Console WAF WebACL to associate with the CloudFront distribution
AdminEmailString; RequiredAdministrator Email (required) Pattern: .+.
AppEnvironmentString; Default prodUnique Application Environment Identifier, IE dev/staging/prod Pattern: [a-zA-Z0-9_.-/]+.
EnablePublicUrlsString; Default falseWhether to enable "/public" endpoints, defaults to false. Public endpoints allow external users to submit documents, such as through a web form. As with any publicly-available functionality, there is a risk of abuse if enabled. Values: ["true","false"].
PasswordMinimumLengthNumber; Default 8Set the Amazon Cognito password policies, minimum password length requirement for all users Min: 6. Max: 99.
PasswordRequireLowercaseString; Default falseSet the Amazon Cognito password policies, to require one lowercase letter in all passwords. Values: ["true","false"].
PasswordRequireNumbersString; Default falseSet the Amazon Cognito password policies, to require one number in all passwords. Values: ["true","false"].
PasswordRequireSymbolsString; Default falseSet the Amazon Cognito password policies, to require one symbol in all passwords. Values: ["true","false"].
PasswordRequireUppercaseString; Default falseSet the Amazon Cognito password policies, to require one uppercase letter in all passwords. Values: ["true","false"].
TokenAccessIdValidityMinutesNumber; Default 1440The time limit in minutes, after which the access and ID tokens are no longer valid and cannot be used. Min: 5. Max: 1440.
TokenRefreshValidityMinutesNumber; Default 43200The time limit in minutes, after which the refresh token is no longer valid and cannot be used. Min: 60. Max: 5256000.
VpcStackNameString; Default (empty string)The name of the FormKiQ VPC Stack Name
CapacityProviderString; Default FARGATE_SPOTAWS Fargate capacity provider to use, either the FARGATE or FARGATE_SPOT Values: ["FARGATE_SPOT","FARGATE"].
LogRetentionInDaysNumber; Default 90The number of days to retain the log events Values: [1,3,5,7,14,30,60,90,120,150,180,365,400,545,731,1096,1827,2192,2557,2922,3288,3653].
LogFormatString; Default TextThe format in which the application and system logs are stored. Values: ["Text","JSON"].
LogLevelApplicationString; Default INFOThe level of logging for the FormKiQ Application logs. Only used when LogFormat is JSON Values: ["TRACE","DEBUG","INFO","ERROR"].
LogLevelSystemString; Default INFOThe level of logging for the AWS Platform System logs. Only used when LogFormat is JSON Values: ["DEBUG","INFO","WARN"].
EnableDeletionProtectionString; Default falseEnable deletion protection on AWS Services that support the feature Values: ["true","false"].
UserPoolTierString; Default LITECognito User Pool feature plan (tier). Determines the set of capabilities and limits available for the pool. Valid values: - LITE: Basic authentication and user management features at the lowest cost. - ESSENTIALS: Standard tier with advanced authentication features (default). - PLUS: Includes all ESSENTIALS features plus premium capabilities such as advanced security protections, WebAuthn/passkey support, and additional customization. The default is ESSENTIALS if not otherwise specified. Values: ["LITE","ESSENTIALS","PLUS"].
EnableCloudFrontAccessLogsString; Default falseEnable console CloudFront access logs and create a dedicated logging bucket. The deployment role needs s3:GetBucketAcl and s3:PutBucketAcl on the bucket. Values: ["true","false"].
EnableS3AccessLogsString; Default falseEnable server access logs for console, Cognito configuration, documents, staging, and OCR buckets, and create a dedicated logging bucket. Values: ["true","false"].
CertificateStackNameString; Default (empty string)The name of the FormKiQ Certificate Stack Name
EnableS3TransferAccelerationString; Default falseEnable opt-in S3 Transfer Acceleration for documents bucket URLs (additional transfer charges apply) Values: ["true","false"].
OpenSearchStackNameString; Default (empty string)The name of the FormKiQ Open Search Stack Name
OpenSearchIndexPrefixString; Default formkiq_The string appended to the beginning of the OpenSearch Index Name
ProvisionedConcurrencyDocumentGenerationNumber; Default 0The amount of provisioned concurrency to allocate for Document Generation Lambda Min: 0.
CognitoSingleSignOnUrlString; Default (empty string)The Cognito Hosted UI URL to allow Single Sign-On
SitePermissionsString; Default automaticThe site permission scheme to use. Automatic - will auto-create sites based on the roles attached to the user. Defined - Sites need to be defined using the Sites API. Cognito needs to be upgraded to Essentials or Plus. Values: ["automatic","defined"].
SamlProviderString; Default (empty string)The SAML identity provider to integrate with this Cognito User Pool. Valid values: - None: No SAML provider integration. - Entra: Microsoft Entra ID (Azure AD). - Okta: Okta Identity Provider. Values: ["","Entra","Okta"].
OperationalModeString; Default ACTIVEControls the runtime operational behavior of the FormKiQ environment. ACTIVE: - Full operation. - API, Console, and authentication endpoints are available. - Background and event-driven processing is enabled (SQS, EventBridge, scheduled jobs, indexing, OCR, notifications, etc.). PASSIVE: - API and Console continue to serve traffic. - Background and event-driven processing is disabled. - Queues and scheduled jobs will not execute until mode is switched back to ACTIVE. - Useful for migrations, controlled maintenance windows, or disaster recovery staging. Note: Switching modes may enable or disable background processing resources such as Lambda event source mappings, scheduled rules, and queue consumers. Values: ["ACTIVE","PASSIVE"].
PermissionsBoundaryArnString; Default (empty string)(Optional) ARN of the IAM Permissions Boundary to attach to every created role. Leave empty to create the role without a permissions boundary.

Outputs​

NamePurpose
AppEnvironmentUnique Application Environment Identifier, IE dev/staging/prod
IamApiUrlThe URL for the API endpoint that uses IAM authorization
KeyApiUrlThe URL for the API endpoint that uses API Key authorization
HttpApiUrlThe URL for the API endpoint that uses Cognito authorization
AuthApiUrlThe endpoint url for the User Auth API
ConsoleUrlThe URL for the FormKiQ Console
ConsoleS3BucketThe Console S3 Bucket
CognitoUserPoolIdThe Cognito User Pool Id
CognitoUserPoolArnThe Cognito User Pool Arn
CognitoClientIdThe Cognito Client Id
CognitoDomainThe Cognito Domain Url
FormKiQVersionThe FormKiQ Version
SnsDocumentEventArnSNS Topic for Document Events
DocumentsTableNameDocument DynamoDb Table Name
DocumentsTableArnDocument DynamoDb Table Arn
DocumentsS3BucketsDocuments Bucket.
DocumentsStageS3BucketDocuments Staging Bucket.
ShortlinksApiUrlThe endpoint url for the Shortlinks API
DriveCognitoClientIdThe Cognito Client Id for the Drive app client
DriveAuthorizeUrlThe Cognito OAuth2 authorization URL for the Drive app client
DriveLoginUrlThe URL for the Drive login page
Commercial: Main/Config · Commercial: template-upgrade/Config

Source: Licensed 1.19.2 distribution: 91fed32479af3b8d9ca01b60037704c2.template

SHA-256: d100a970c56f7f60a017d674144f9a4226c2a0b53014aa1f859ac5c115da7427

Parameters​

NameType / defaultConstraints and purpose
FormKiQTypeString; RequiredThe formkiq type of installation Pattern: .+.
FormKiQVersionString; RequiredThe formkiq version Pattern: .+.
LambdaArchitectureString; RequiredLambda instruction set architecture for this build artifact Values: ["x86_64","arm64"].
VpcStackNameString; RequiredThe name of the CloudFormation VPC stack that can be created after the initial FormKiQ install, using the add-on CloudFormation template for VPC (see the relevant deployment guide) Some services such as Typesense, and OpenSearch require a VPC. Only required if you are using any of these services; otherwise, this can remain empty.

Outputs​

NamePurpose
FormKiQTypeThe FormKiQ type of installation
FormKiQVersionThe FormKiQ version
LambdaArchitectureLambda instruction set architecture for this build artifact
HttpsSecurityGroupVPC Https Security Group
Commercial: Main/CoreStorage · Commercial: template-upgrade/CoreStorage

Source: Licensed 1.19.2 distribution: a02d1a4144dbc1506cea3451e4d0af36.template

SHA-256: c6226603eb2979c98caec5ebbc780d960ac253ac0bc9ac3eb6b7829077ec4abc

Parameters​

NameType / defaultConstraints and purpose
S3AccessLogsBucketNameString; Default (empty string)Optional existing S3 bucket for server access logs, in the same account and Region. Must use SSE-S3 and allow S3 log delivery. Leave empty to disable.
EnableS3TransferAccelerationString; Default falseEnable opt-in S3 Transfer Acceleration for documents bucket URLs (additional transfer charges apply) Values: ["true","false"].
AppEnvironmentString; RequiredThe Application Environment Pattern: .+.
LambdaMemoryNumber; Default 1024The amount of memory used by lambda function (MB) Min: 128. Max: 3008.
LambdaTimeoutString; Default 60The maximum amount of seconds lambda function will run for (seconds)
LambdaArchitectureString; RequiredLambda instruction set architecture Values: ["x86_64","arm64"].
FormKiQTypeString; RequiredThe type of FormKiQ installation
VpcStackNameString; RequiredFormKiQ VPC Stack Name
TypesenseApiKeySecretArnString; Default (empty string)ARN of a Secrets Manager secret in this account and Region whose plaintext SecretString is the Typesense API key. Leave empty to disable Typesense. Pattern: ^$|^arn:[a-z0-9-]+:secretsmanager:[a-z0-9-]+:[0-9]{12}:secret:.+$.
DocumentEventsBusString; Default (empty string)Name EventBridge Event Bus
LogRetentionInDaysNumber; RequiredThe number of days to retain the log events
LogFormatString; RequiredThe format in which the application and system logs are stored.
LogLevelApplicationString; RequiredThe level of logging for the FormKiQ Application logs.
LogLevelSystemString; RequiredThe level of logging for the AWS Platform System logs.
EnableDeletionProtectionString; RequiredEnable deletion protection on AWS Services that support the feature
OperationalModeString; Default ACTIVEControls the runtime operational behavior of the FormKiQ environment.
OpenSearchStackNameString; Default (empty string)The name of the FormKiQ Open Search Stack Name
KmsKeyArnString; RequiredKMS Key Arn Pattern: .+.
PermissionsBoundaryArnString; Default (empty string)

Outputs​

NamePurpose
DocumentsTableNameDocuments DynamoDb Table Name.
DocumentsTableArnDocuments DynamoDb Table Arn.
DocumentsStreamArnDocuments DynamoDb Table Stream Arn.
DocumentSyncsTableNameInspect the deployed output and owning template.
CacheTableNameInspect the deployed output and owning template.
DocumentsS3BucketsDocuments Bucket.
DocumentsStageS3BucketDocuments Staging Bucket.
DocumentsUpdateQueueUrlDocuments Update Documents Queue Url
DocumentsUpdateQueueArnDocuments S3 Update Documents Queue Arn
DocumentsDeadLetterQueueArnDocuments Dead Letter Queue Arn
DocumentsDeadLetterQueueNameDocuments Dead Letter Queue Name
SnsDocumentEventArnSNS Topic for Document Events
DocumentsS3UpdateDocuments MetaData Object Lambda
StagingCreateObjectDocuments Staging Create Object Lambda
DocumentsUpdateObjectDocuments Update Object Lambda
DocumentActionsProcessorDocument Actions Processor Lambda
DocumentVersionsTableNameInspect the deployed output and owning template.
DocumentAuditsTableNameInspect the deployed output and owning template.
Commercial: Main/CoreConsole · Commercial: template-upgrade/CoreConsole

Source: Licensed 1.19.2 distribution: b6581f3808079fd4905865ffca57d32c.template

SHA-256: a03d5be49b60372b3b7f14d33f71730946b96e7a67fcbfa6933ab6de32b42b6e

Parameters​

NameType / defaultConstraints and purpose
CloudFrontAccessLogsBucketNameString; Default (empty string)Optional existing S3 bucket name for CloudFront standard access logs (legacy). Must have ACLs enabled and permit CloudFront log delivery. The deployment role needs s3:GetBucketAcl and s3:PutBucketAcl. Leave empty to disable.
S3AccessLogsBucketNameString; Default (empty string)Optional existing S3 bucket for server access logs, in the same account and Region. Must use SSE-S3 and allow S3 log delivery. Leave empty to disable.
WAFWebACLIdString; Default (empty string)(Optional) ARN of the AWS WAF WebACL to associate with the CloudFront distribution. Leave empty to disable.
AdminEmailString; RequiredAdministrator Email Pattern: .+.
AppEnvironmentString; RequiredThe Document Stack Environment Pattern: .+.
DomainString; RequiredAmazon Cognito domain to use (include full domain if CertificateArn used)
ConsoleVersionString; Default v4.3.7Version of FormKiQ console to deploy
CognitoConfigBucketString; RequiredCognito Config S3 Bucket
FormKiQTypeString; RequiredThe type of FormKiQ installation
CertificateStackNameString; Default (empty string)The name of the FormKiQ Certificate Stack Name
CertificateStackNameDomainNameString; Default _The name of the FormKiQ Certificate Stack Name Domain Name
IsGovCloudString; RequiredIs Installation AWS Region gov cloud Values: ["true","false"].
ApiUrlString; RequiredJWT API URL
IamApiUrlString; RequiredIAM API URL
KeyApiUrlString; RequiredKey API URL
AuthApiUrlString; RequiredAuth Api URL
DocumentsTableNameString; RequiredDocument DynamoDb Table Name
BrandString; Default formkiqConsole Installer Brand
AllowAdminCreateUserOnlyString; RequiredWhen true only Cognito Admin can create users, false users can register themselves Pattern: .+.
CognitoHostedUiString; RequiredAmazon Cognito Hosted UI Url Pattern: .+.
DriveAuthorizeUrlString; Default (empty string)The Cognito OAuth2 authorization URL for the Drive app client
DriveCognitoUserPoolClientIdString; Default (empty string)The Cognito User Pool Client Id for the Drive app client
CognitoUserPoolIdString; RequiredThe Cognito User Pool Id Pattern: .+.
CognitoUserPoolClientIdString; RequiredThe Cognito User Pool Client Id Pattern: .+.
UserAuthenticationString; Default cognitoHow are the users authenticating Pattern: .+.
LogFormatString; RequiredThe format in which the application and system logs are stored.
LogLevelApplicationString; RequiredThe level of logging for the FormKiQ Application logs. Only used when LogFormat is JSON
LogLevelSystemString; RequiredThe level of logging for the AWS Platform System logs. Only used when LogFormat is JSON
LogRetentionInDaysNumber; RequiredThe number of days to retain the log events
LambdaArchitectureString; RequiredLambda instruction set architecture Values: ["x86_64","arm64"].
CognitoSingleSignOnUrlString; Default (empty string)The Cognito Hosted UI URL to allow Single Sign-On

Outputs​

NamePurpose
ConsoleUrlConsole URL
ConsoleBucketInspect the deployed output and owning template.
ConsoleVersionInspect the deployed output and owning template.
HostedZoneIdInspect the deployed output and owning template.
CloudFrontDistributionDomainNameInspect the deployed output and owning template.
Commercial: Main/Cognito · Commercial: template-upgrade/Cognito

Source: Licensed 1.19.2 distribution: 8f061b8ae02b12880e3e0587f632e401.template

SHA-256: da6b3d84188707dae5ee7dc9796bdc9fac516e54a37ddc320f3f9d6e61063283

Parameters​

NameType / defaultConstraints and purpose
S3AccessLogsBucketNameString; Default (empty string)Optional existing S3 bucket for server access logs, in the same account and Region. Must use SSE-S3 and allow S3 log delivery. Leave empty to disable.
AppEnvironmentString; Default (empty string)Unique Application Environment Identifier, IE dev/staging/prod
UserPoolTierString; Default LITEUser pool feature plan (tier). Values: ["LITE","ESSENTIALS","PLUS"].
UserPoolNameString; RequiredName of the User Pool. Pattern: .+.
AllowAdminCreateUserOnlyString; Default falseValues: ["true","false"].
PasswordMinimumLengthNumber; Default 8The minimum password length. Min: 6. Max: 99.
PasswordRequireLowercaseString; Default truePassword requires at least one lowercase letter. Values: ["true","false"].
PasswordRequireNumbersString; Default truePassword requires at least one number. Values: ["true","false"].
PasswordRequireSymbolsString; Default truePassword requires at least one symbol. Values: ["true","false"].
PasswordRequireUppercaseString; Default truePassword requires at least one uppercase letter. Values: ["true","false"].
DomainString; RequiredAmazon Cognito domain to use (include full domain if CertificateArn used) Pattern: .+.
DomainCertificateArnString; Default (empty string)Amazon Cognito Certificate ARN to use
SesSourceArnString; Default (empty string)The Amazon Resource Name (ARN) of a verified email address in Amazon SES
ReplyToEmailAddressString; Default (empty string)The destination to which the receiver of the email should reply to
AccessTokenValidityNumber; Default 1440The time limit in minutes, after which the access token is no longer valid and cannot be used. Min: 5. Max: 1440.
IdTokenValidityNumber; Default 1440The time limit in minutes, after which the ID token is no longer valid and cannot be used. Min: 5. Max: 1440.
RefreshTokenValidityNumber; Default 43200The time limit in minutes, after which the refresh token is no longer valid and cannot be used. Min: 60. Max: 5256000.
LogRetentionInDaysNumber; Default 90The number of days to retain the log events Values: [1,3,5,7,14,30,60,90,120,150,180,365,400,545,731,1096,1827,2192,2557,2922,3288,3653].
LogFormatString; Default TextThe format in which the application and system logs are stored. Values: ["Text","JSON"].
LogLevelApplicationString; Default INFOThe level of logging for the FormKiQ Application logs. Only used when LogFormat is JSON Values: ["TRACE","DEBUG","INFO","ERROR"].
LogLevelSystemString; Default INFOThe level of logging for the AWS Platform System logs. Only used when LogFormat is JSON Values: ["DEBUG","INFO","WARN"].
EnableDeletionProtectionString; Default falseEnable deletion protection on AWS Services that support the feature Values: ["true","false"].
LambdaArchitectureString; RequiredLambda instruction set architecture Values: ["x86_64","arm64"].
DriveCognitoUserPoolClientNameString; Default FormKiQ DriveName of the Drive Cognito User Pool App Client.
DriveCognitoCallbackUrlsCommaDelimitedList; Default com.formkiq.drive://oauth2/callbackComma-delimited callback URLs for the Drive Cognito OAuth2 app client.
SitePermissionsString; RequiredThe site permission scheme to use. Automatic - will auto-create sites based on the roles attached to the user. Defined - Sites need to be defined using the Sites API.
SamlProviderString; Required
DocumentsTableNameString; RequiredDocuments DynamoDB Table Name
DocumentAuditsTableNameString; RequiredDocument Audits DynamoDB Table Name
KmsKeyArnString; RequiredKMS Key Arn Pattern: .+.
PermissionsBoundaryArnString; Default (empty string)
OperationalModeString; RequiredControls the runtime operational behavior of the FormKiQ environment

Outputs​

NamePurpose
CognitoConfigBucketThe Cognito Config Bucket
CognitoUserPoolIdThe Cognito User Pool Id
CognitoUserPoolProviderNameThe Cognito User Pool Provider Name
CognitoUserPoolProviderURLThe Cognito User Pool Provider URL
CognitoUserPoolArnThe Cognito User Pool Arn
CognitoUserPoolClientIdThe Cognito User Pool Client Id
CognitoIdentityPoolIdCognito Identity Pool
DomainAmazon Cognito domain to use (include full domain if CertificateArn used)
CognitoHostedUiAmazon Cognito Hosted UI Url
CognitoDomainAmazon Cognito Domain
DriveCognitoUserPoolClientIdThe Cognito User Pool Client Id for the Drive app client
Commercial: Main/CoreApi · Commercial: template-upgrade/CoreApi

Source: Licensed 1.19.2 distribution: 1c56ababf1dcb4cbaf0bf681e965f211.template

SHA-256: a3d8bfd24368cc732bf755b181f7ffbd606df32a5a4bef8a3b5079a695552ad7

Parameters​

NameType / defaultConstraints and purpose
EnableS3TransferAccelerationString; Default falseEnable opt-in S3 Transfer Acceleration for documents bucket URLs (additional transfer charges apply) Values: ["true","false"].
AppEnvironmentString; RequiredThe FormKiQ Environment Pattern: .+.
FormKiQTypeString; RequiredThe type of FormKiQ installation Pattern: .+.
FormKiQVersionString; RequiredThe formkiq version Pattern: .+.
LambdaMemoryNumber; Default 1024The amount of memory used by lambda function (MB) Min: 128. Max: 3008.
LambdaTimeoutString; Default 60The maximum amount of seconds lambda function will run for (seconds)
LambdaArchitectureString; RequiredLambda instruction set architecture Values: ["x86_64","arm64"].
EnablePublicUrlsString; Default falseWhether to enable public urls Values: ["true","false"].
AllowAdminCreateUserOnlyString; Default trueValues: ["true","false"].
PasswordMinimumLengthNumber; Default 8The minimum password length. Min: 6. Max: 99.
PasswordRequireLowercaseString; Default falsePassword requires at least one lowercase letter. Values: ["true","false"].
PasswordRequireNumbersString; Default falsePassword requires at least one number. Values: ["true","false"].
PasswordRequireSymbolsString; Default falsePassword requires at least one symbol. Values: ["true","false"].
PasswordRequireUppercaseString; Default falsePassword requires at least one uppercase letter. Values: ["true","false"].
CognitoUserPoolString; RequiredThe Cognito User Pool Id Pattern: .+.
CognitoUserPoolClientString; RequiredThe Cognito User Pool Client Id Pattern: .+.
UserAuthenticationString; Default cognitoHow are the users authenticating Pattern: .+.
TypesenseApiKeySecretArnString; Default (empty string)ARN of a Secrets Manager secret in this account and Region whose plaintext SecretString is the Typesense API key. Leave empty to disable Typesense. Pattern: ^$|^arn:[a-z0-9-]+:secretsmanager:[a-z0-9-]+:[0-9]{12}:secret:.+$.
TypesenseApiEndpointString; RequiredTypeSense API Endpoint
DocumentsTableNameString; RequiredDocuments DynamoDB Table Name
CacheTableNameString; RequiredCache DynamoDB Table Name
DocumentSyncsTableNameString; RequiredDocument Syncs DynamoDB Table Name
DocumentsS3BucketString; RequiredDocuments S3 Bucket Name
DocumentsStageS3BucketString; RequiredDocuments Stage S3 Bucket Name
SnsDocumentEventArnString; RequiredSNS Topic for Document Events
DocumentsDeadLetterQueueArnString; RequiredDocuments Dead Letter Queue Arn
VpcStackNameString; RequiredFormKiQ VPC Stack Name
CertificateStackNameString; Default (empty string)The name of the FormKiQ Certificate Stack Name
HttpsSecurityGroupString; Default (empty string)VPC Https Security Group
LogRetentionInDaysNumber; RequiredThe number of days to retain the log events
LogFormatString; RequiredThe format in which the application and system logs are stored.
LogLevelApplicationString; RequiredThe level of logging for the FormKiQ Application logs.
LogLevelSystemString; RequiredThe level of logging for the AWS Platform System logs.
CertificateStackNameShortlinksApiDomainString; Default (empty string)Certificate Shortlinks Api Domain
CertificateStackNameHttpApiDomainString; Default (empty string)Certificate Http Api Domain
CertificateStackNameIamApiDomainString; Default (empty string)Certificate IAM Api Domain
CertificateStackNameKeyApiDomainString; Default (empty string)Certificate Key Api Domain
OperationalModeString; Default ACTIVEControls the runtime operational behavior of the FormKiQ environment
CertificateStackNameUserAuthApiDomainString; Default (empty string)Certificate User Auth API Domain
CertificateStackNameUserAuthCertificateArnString; Default (empty string)Certificate User Auth API ACM Certificate ARN
CertificateStackNameHostedZoneIdString; Default (empty string)Optional Route53 hosted zone for the User Auth API domain
S3AccessLogsBucketNameString; Default (empty string)Optional existing S3 bucket for server access logs, in the same account and Region. Must use SSE-S3 and allow S3 log delivery. Leave empty to disable.
DocumentVersionsTableNameString; RequiredDocument Versions DynamoDB Table Name
DocumentAuditsTableNameString; RequiredDocument Audits DynamoDB Table Name
SitePermissionsString; Default automaticThe site permission scheme to use. Automatic - will auto-create sites based on the roles attached to the user. Defined - Sites need to be defined using the Sites API. Values: ["automatic","defined"].
OpenSearchStackNameString; RequiredThe name of the FormKiQ Open Search Stack Name
OpenSearchIndexPrefixString; RequiredThe string appended to the beginning of the OpenSearch Index Name
DocumentsStreamArnString; RequiredDocuments DynamoDB Stream Arn
DriveCognitoUserPoolClientString; RequiredThe Drive Cognito User Pool Client Id
ProvisionedConcurrencyDocumentGenerationNumber; Default 0The amount of provisioned concurrency to allocate for Document Generation Lambda Min: 0.
KmsKeyArnString; RequiredKMS Key Arn Pattern: .+.
PermissionsBoundaryArnString; Default (empty string)

Outputs​

NamePurpose
ApiGatewayInvokeRoleAPI Gateway Role that allows invoking of endpoints
ApiGatewayInvokeRoleArnAPI Gateway Role Arn that allows invoking of endpoints
DocumentsApiRequestsFormKiQ Api Request Handler
DocumentsHttpApiHTTP API
DocumentsIamApiIAM API
DocumentsIamApiUrlThe endpoint url for the IAM API
DocumentsKeyApiUrlThe endpoint url for the Key API
DocumentsHttpApiUrlThe endpoint url for the Http API
AuthApiUrlThe endpoint url for the Auth API
OcrBucketInspect the deployed output and owning template.
OcrQueueInspect the deployed output and owning template.
OcrQueueUrlInspect the deployed output and owning template.
OcrQueueArnInspect the deployed output and owning template.
ShortlinksApiUrlThe endpoint url for the Shortlinks API
AmazonTextractInspect the deployed output and owning template.
OcrLambdaLambdaInspect the deployed output and owning template.
FulltextLambdaInspect the deployed output and owning template.
FulltextLambdaArnInspect the deployed output and owning template.
FulltextLambdaRoleArnInspect the deployed output and owning template.
FulltextDynamodbStreamsLambdaRoleArnInspect the deployed output and owning template. Conditional.
Commercial: Main/CoreApi/ApiLambda · Commercial: template-upgrade/CoreApi/ApiLambda

Source: Licensed 1.19.2 distribution: 95bf35498e673ba75e1bb4ebb0971bed.template

SHA-256: f2c647a8e28d52912b2383ce20364999945e72d083990a297c35593876cc9ebf

Parameters​

NameType / defaultConstraints and purpose
EnableS3TransferAccelerationString; Default falseEnable opt-in S3 Transfer Acceleration for documents bucket URLs (additional transfer charges apply) Values: ["true","false"].
AppEnvironmentString; RequiredThe FormKiQ Environment Pattern: .+.
FormKiQTypeString; RequiredThe type of FormKiQ installation Pattern: .+.
FormKiQVersionString; RequiredThe formkiq version Pattern: .+.
LambdaMemoryNumber; Default 1024The amount of memory used by lambda function (MB) Min: 128. Max: 3008.
LambdaTimeoutString; Default 60The maximum amount of seconds lambda function will run for (seconds)
LambdaArchitectureString; RequiredLambda instruction set architecture Values: ["x86_64","arm64"].
CognitoUserPoolString; RequiredThe Cognito User Pool Id Pattern: .+.
CognitoUserPoolClientString; RequiredThe Cognito User Pool Client Id Pattern: .+.
UserAuthenticationString; Default cognitoHow are the users authenticating Pattern: .+.
TypesenseApiKeySecretArnString; Default (empty string)ARN of a Secrets Manager secret in this account and Region whose plaintext SecretString is the Typesense API key. Leave empty to disable Typesense. Pattern: ^$|^arn:[a-z0-9-]+:secretsmanager:[a-z0-9-]+:[0-9]{12}:secret:.+$.
TypesenseApiEndpointString; RequiredTypeSense API Endpoint
DocumentsTableNameString; RequiredDocuments DynamoDB Table Name
CacheTableNameString; RequiredCache DynamoDB Table Name
DocumentSyncsTableNameString; RequiredDocument Syncs DynamoDB Table Name
DocumentsS3BucketString; RequiredDocuments S3 Bucket Name
DocumentsStageS3BucketString; RequiredDocuments Stage S3 Bucket Name
SnsDocumentEventArnString; RequiredSNS Topic for Document Events
OcrBucketString; RequiredName of OCR Bucket
OcrQueueUrlString; RequiredName of OCR Queue Url
OcrQueueArnString; RequiredName of OCR Queue Arn
VpcStackNameString; RequiredFormKiQ VPC Stack Name
EnablePublicUrlsString; RequiredWhether to enable public urls
LogRetentionInDaysNumber; RequiredThe number of days to retain the log events
LogFormatString; RequiredThe format in which the application and system logs are stored.
LogLevelApplicationString; RequiredThe level of logging for the FormKiQ Application logs.
LogLevelSystemString; RequiredThe level of logging for the AWS Platform System logs.
OperationalModeString; Default ACTIVEControls the runtime operational behavior of the FormKiQ environment
HttpsSecurityGroupString; RequiredVPC Https Security Group
DocumentsDeadLetterQueueArnString; RequiredDocuments Dead Letter Queue Arn
DocumentVersionsTableNameString; RequiredDocument Versions DynamoDB Table Name
DocumentAuditsTableNameString; RequiredDocument Audits DynamoDB Table Name
SitePermissionsString; Default automaticThe site permission scheme to use. Automatic - will auto-create sites based on the roles attached to the user. Defined - Sites need to be defined using the Sites API. Values: ["automatic","defined"].
OpenSearchStackNameString; RequiredThe name of the FormKiQ Open Search Stack Name
OpenSearchDomainTypeString; RequiredOpen Search Service Domain Type
OpenSearchIndexPrefixString; RequiredThe string appended to the beginning of the OpenSearch Index Name
KmsKeyArnString; RequiredKMS Key Arn Pattern: .+.
PermissionsBoundaryArnString; Default (empty string)

Outputs​

NamePurpose
DocumentsApiRequestsFormKiQ Api Request Handler
DocumentsApiRequestsArnFormKiQ Api Request Handler Arn
FulltextLambdaFormKiQ Fulltext Request Handler
FulltextLambdaArnFormKiQ Fulltext Request Handler Arn
FulltextLambdaRoleArnFormKiQ Fulltext Lambda Role Arn
IntelligentDataClassificationArnIntelligent Data Classification Request Handler Arn
Commercial: Main/CoreApi/ApiLambda/ModuleS3Object · Commercial: template-upgrade/CoreApi/ApiLambda/ModuleS3Object

Source: Licensed 1.19.2 distribution: 29591d0470cf07144197500d601b0417.template

SHA-256: fddd07bd82ae284cc8dc55524097b31ca23cc9196bf596c369be05200b5d9fe2

Parameters​

NameType / defaultConstraints and purpose
AppEnvironmentString; RequiredThe FormKiQ Environment Pattern: .+.
DocumentsTableNameString; RequiredDocuments DynamoDB Table Name
DocumentSyncsTableNameString; RequiredDocument Syncs DynamoDB Table Name
DocumentsS3BucketString; RequiredDocuments S3 Bucket Name
DocumentsStageS3BucketString; RequiredDocuments Stage S3 Bucket Name
LambdaMemoryNumber; Default 1024The amount of memory used by lambda function (MB) Min: 128. Max: 3008.
LambdaTimeoutString; Default 180The maximum amount of seconds lambda function will run for (seconds)
LogRetentionInDaysNumber; RequiredThe number of days to retain the log events
LogFormatString; RequiredThe format in which the application and system logs are stored.
LogLevelApplicationString; RequiredThe level of logging for the FormKiQ Application logs.
LogLevelSystemString; RequiredThe level of logging for the AWS Platform System logs.
KmsKeyArnString; RequiredKMS Key Arn Pattern: .+.
PermissionsBoundaryArnString; Default (empty string)
OperationalModeString; RequiredControls the runtime operational behavior of the FormKiQ environment

Outputs​

NamePurpose
WatermarkFunctionArnInspect the deployed output and owning template.
WatermarkFunctionUrlInspect the deployed output and owning template.
S3ObjectRequestsArnInspect the deployed output and owning template.
Commercial: Main/CoreApi/ApiLambda/ModuleIntelligentDataClassification · Commercial: template-upgrade/CoreApi/ApiLambda/ModuleIntelligentDataClassification

Source: Licensed 1.19.2 distribution: 7cf7a55d0e8c01e83d4cb58003f3a289.template

SHA-256: be935ad052dff9d09d2b6fe631aeab77009b9e75c97931e7fa70f07e7e31848d

Parameters​

NameType / defaultConstraints and purpose
AppEnvironmentString; RequiredThe Application Environment Pattern: .+.
DocumentsTableNameString; RequiredDocuments DynamoDB Table Name
DocumentsS3BucketString; RequiredDocuments S3 Bucket Name
SnsDocumentEventArnString; RequiredSNS Topic for Document Events
LambdaMemoryNumber; Default 1024The amount of memory used by lambda function (MB) Min: 128. Max: 3008.
LambdaTimeoutString; Default 60The maximum amount of seconds lambda function will run for (seconds)
FormKiQTypeString; RequiredThe type of FormKiQ installation
LogRetentionInDaysNumber; RequiredThe number of days to retain the log events
LogFormatString; RequiredThe format in which the application and system logs are stored.
LogLevelApplicationString; RequiredThe level of logging for the FormKiQ Application logs.
LogLevelSystemString; RequiredThe level of logging for the AWS Platform System logs.
KmsKeyArnString; RequiredKMS Key Arn Pattern: .+.
PermissionsBoundaryArnString; Default (empty string)
OperationalModeString; RequiredControls the runtime operational behavior of the FormKiQ environment

Outputs​

NamePurpose
IntelligentDataClassificationArnInspect the deployed output and owning template.
Commercial: Main/CoreApi/HttpApi · Commercial: template-upgrade/CoreApi/HttpApi

Source: Licensed 1.19.2 distribution: 9b6c08b1ada63e5d20c557e5a7cea6f0.template

SHA-256: 45d0617a38b31923cffb38967893d45565b12444769b8d94d573f1548a951df2

Parameters​

NameType / defaultConstraints and purpose
AppEnvironmentString; RequiredThe FormKiQ Environment Pattern: .+.
DocumentsApiRequestsArnString; RequiredLambda to invoke
OcrApiRequestsArnString; RequiredLambda to invoke for Object examine endpoints
CognitoUserPoolString; RequiredThe Cognito User Pool Id
CognitoUserPoolClientString; RequiredThe Cognito User Pool Client Id
CertificateStackNameHttpApiDomainString; RequiredCertificate Http Api Domain
OcrLambdaArnString; RequiredLambda to invoke for OCR endpoints
ClamAvScanLambdaArnString; RequiredLambda to invoke for ClamAv
EsignatureLambdaArnString; RequiredLambda to invoke for Esignature
FulltextLambdaArnString; RequiredLambda to invoke for Fulltext endpoints
DriveCognitoUserPoolClientString; RequiredThe Drive Cognito User Pool Client Id
DocumentGenerationLambdaArnString; RequiredLambda to invoke for Document Generation endpoints
DocumentCertificationsLambdaArnString; RequiredLambda to invoke for Document Certifications endpoints
IntelligentDataClassificationArnString; RequiredLambda to invoke for Idc endpoints

Outputs​

NamePurpose
DocumentsHttpApiHTTP API
DocumentsHttpApiUrlThe endpoint url for the HTTP API
Commercial: Main/CoreApi/IamApi · Commercial: template-upgrade/CoreApi/IamApi

Source: Licensed 1.19.2 distribution: 289b15e5a8bbe0fe9b068238ba64a4d6.template

SHA-256: 2362780dc26bbd8df11aad0265ad78e27135b6bc9bde140be3f4bf10f01baab2

Parameters​

NameType / defaultConstraints and purpose
AppEnvironmentString; RequiredThe FormKiQ Environment Pattern: .+.
DocumentsApiRequestsArnString; RequiredLambda to invoke
OcrApiRequestsArnString; RequiredLambda to invoke for Object examine endpoints
CertificateStackNameIamApiDomainString; RequiredCertificate IAM Api Domain
OcrLambdaArnString; RequiredLambda to invoke for OCR endpoints
ClamAvScanLambdaArnString; RequiredLambda to invoke for ClamAv endpoints
EsignatureLambdaArnString; RequiredLambda to invoke for Esignature endpoints
FulltextLambdaArnString; RequiredLambda to invoke for Fulltext endpoints
DocumentGenerationLambdaArnString; RequiredLambda to invoke for Document Generation endpoints
DocumentCertificationsLambdaArnString; RequiredLambda to invoke for Document Certifications endpoints
IntelligentDataClassificationArnString; RequiredLambda to invoke for Intelligent Data ClassificationArn endpoints

Outputs​

NamePurpose
DocumentsIamApiIAM API
DocumentsIamApiUrlThe endpoint url for the IAM API
Commercial: Main/CoreApi/KeyApi · Commercial: template-upgrade/CoreApi/KeyApi

Source: Licensed 1.19.2 distribution: 0be96f86cccc63a1ef89d7f176d94e82.template

SHA-256: c5631cf963cba59f374fa27fe5f135b31f5b9563f830d32ded444af404c6a0d0

Parameters​

NameType / defaultConstraints and purpose
AppEnvironmentString; RequiredThe FormKiQ Environment Pattern: .+.
DocumentsApiRequestsArnString; RequiredLambda to invoke
OcrApiRequestsArnString; RequiredLambda to invoke for Object examine endpoints
FormKiQTypeString; RequiredThe type of FormKiQ installation
DocumentsTableNameString; RequiredDocuments DynamoDB Table Name
LambdaMemoryNumber; Default 1024The amount of memory used by lambda function (MB) Min: 128. Max: 3008.
LambdaTimeoutString; Default 60The maximum amount of seconds lambda function will run for (seconds)
LambdaArchitectureString; RequiredLambda instruction set architecture Values: ["x86_64","arm64"].
LogRetentionInDaysNumber; RequiredThe number of days to retain the log events
LogFormatString; RequiredThe format in which the application and system logs are stored.
LogLevelApplicationString; RequiredThe level of logging for the FormKiQ Application logs.
LogLevelSystemString; RequiredThe level of logging for the AWS Platform System logs.
VpcStackNameString; RequiredFormKiQ VPC Stack Name
CertificateStackNameKeyApiDomainString; RequiredCertificate Key Api Domain
OcrLambdaArnString; RequiredLambda to invoke for OCR endpoints
ClamAvScanLambdaArnString; RequiredLambda to invoke for ClamAv endpoints
EsignatureLambdaArnString; RequiredLambda to invoke for Esignature endpoints
FulltextLambdaArnString; RequiredLambda to invoke for Fulltext endpoints
DocumentGenerationLambdaArnString; RequiredLambda to invoke for Document Generation endpoints
DocumentCertificationsLambdaArnString; RequiredLambda to invoke for Document Certifications endpoints
IntelligentDataClassificationArnString; RequiredLambda to invoke for Idc endpoints
KmsKeyArnString; RequiredKMS Key Arn Pattern: .+.
PermissionsBoundaryArnString; Default (empty string)
OperationalModeString; RequiredControls the runtime operational behavior of the FormKiQ environment

Outputs​

NamePurpose
DocumentsKeyApiKey API
DocumentsKeyApiUrlThe endpoint url for the Key API
Commercial: Main/CoreApi/Ocr · Commercial: template-upgrade/CoreApi/Ocr

Source: Licensed 1.19.2 distribution: 8288b10ef41ea33760a32f2578cd4d39.template

SHA-256: f5c001778f322142885ac03fc9079359ad50c47bd17cdac7353ef0212ca3d7b5

Parameters​

NameType / defaultConstraints and purpose
AppEnvironmentString; RequiredThe Application Environment Pattern: .+.
VpcStackNameString; RequiredFormKiQ VPC Stack Name
LambdaMemoryNumber; Default 2048The amount of memory used by lambda function (MB) Min: 128. Max: 3008.
LambdaTimeoutString; Default 600The maximum amount of seconds lambda function will run for (seconds)
FormKiQTypeString; RequiredThe type of FormKiQ installation
OcrQueueArnString; RequiredThe Ocr Queue Arn
DocumentsTableNameString; RequiredDocuments DynamoDB Table Name
DocumentsS3BucketString; RequiredDocuments S3 Bucket Name
DocumentsStageS3BucketString; RequiredDocuments Stage S3 Bucket Name
OcrBucketString; RequiredOCR S3 Bucket Name
SnsDocumentEventArnString; RequiredSNS Topic for Document Events
LogRetentionInDaysNumber; RequiredThe number of days to retain the log events
LogFormatString; RequiredThe format in which the application and system logs are stored.
LogLevelApplicationString; RequiredThe level of logging for the FormKiQ Application logs.
LogLevelSystemString; RequiredThe level of logging for the AWS Platform System logs.
TextractRoleArnString; RequiredThe Textract IAM Role Arn
AmazonTextractArnString; RequiredSNS Topic for Textract Events
DocumentSyncsTableNameString; RequiredDocument Syncs DynamoDB Table Name
KmsKeyArnString; RequiredKMS Key Arn Pattern: .+.
PermissionsBoundaryArnString; Default (empty string)
OperationalModeString; RequiredControls the runtime operational behavior of the FormKiQ environment

Outputs​

NamePurpose
OcrProcessorInspect the deployed output and owning template.
OcrProcessorArnInspect the deployed output and owning template.
Commercial: Main/CoreApi/ShortlinksApi · Commercial: template-upgrade/CoreApi/ShortlinksApi

Source: Licensed 1.19.2 distribution: ffcd31a604652f5139efdef04db1c111.template

SHA-256: a19e06aa046c0493936cba6f393165d750f21712156afe772ed5e09037f6833d

Parameters​

NameType / defaultConstraints and purpose
AppEnvironmentString; RequiredThe FormKiQ Environment Pattern: .+.
DocumentsApiRequestsArnString; RequiredLambda to invoke
CertificateStackNameShortlinksApiDomainString; Default (empty string)Certificate Shortlinks Api Domain
LogRetentionInDaysNumber; RequiredThe number of days to retain the log events

Outputs​

NamePurpose
ShortlinksApiShortlinks API
ShortlinksApiUrlThe endpoint url for the Shortlinks API
Commercial: Main/CoreApi/AntivirusClamAvModule · Commercial: template-upgrade/CoreApi/AntivirusClamAvModule

Source: Licensed 1.19.2 distribution: c8ffa5a851d3b4f7ccd7df494202073f.template

SHA-256: c2d0d0311969e371ac3bd58226072fbdb262801d2473e83140164e747b18e6cc

Parameters​

NameType / defaultConstraints and purpose
OperationalModeString; RequiredControls the runtime operational behavior of the FormKiQ environment
AppEnvironmentString; RequiredThe FormKiQ Environment Pattern: .+.
DocumentsTableNameString; RequiredDocuments DynamoDB Table Name
DocumentSyncsTableNameString; RequiredDocument Syncs DynamoDB Table Name
DocumentVersionsTableNameString; RequiredDocument Versions DynamoDB Table Name
DocumentsS3BucketString; RequiredDocuments S3 Bucket Name
SnsDocumentEventArnString; RequiredSNS Topic for Document Events
DocumentsDeadLetterQueueArnString; RequiredDocuments Dead Letter Queue Arn
LambdaMemoryForClamAvNumber; Default 3008Memory (in MB) of the ClamAv Lambda - 1536 MB is recommended Min: 1024. Max: 10240.
LambdaTimeoutForClamAvString; Default 300The maximum amount of seconds ClamAv Lambda will run for
VirusDefinitionsUpdateRateString; Default rate(1 day)The schedule for updating ClamAv Virus Definitions. Values: ["rate(1 day)","rate(6 hours)","rate(1 hour)"].
LogRetentionInDaysNumber; RequiredThe number of days to retain the log events
LogFormatString; RequiredThe format in which the application and system logs are stored.
LogLevelApplicationString; RequiredThe level of logging for the FormKiQ Application logs.
LogLevelSystemString; RequiredThe level of logging for the AWS Platform System logs.
KmsKeyArnString; RequiredKMS Key Arn Pattern: .+.
PermissionsBoundaryArnString; Default (empty string)

Outputs​

NamePurpose
ClamAvDefinitionsS3BucketInspect the deployed output and owning template.
ClamAvScanLambdaInspect the deployed output and owning template.
ClamAvScanLambdaArnInspect the deployed output and owning template.
ClamAvScanLambdaRoleArnInspect the deployed output and owning template.
Commercial: Main/CoreApi/EsignatureModule · Commercial: template-upgrade/CoreApi/EsignatureModule

Source: Licensed 1.19.2 distribution: cda23ec45d752f68444d6172413ad9d8.template

SHA-256: 5e33c066afdb441c3f3033543821411f831f4bbe3cc30021b082b14358862ccc

Parameters​

NameType / defaultConstraints and purpose
AppEnvironmentString; RequiredThe FormKiQ Environment Pattern: .+.
DocumentsTableNameString; RequiredDocuments DynamoDB Table Name
CacheTableNameString; RequiredCache DynamoDB Table Name
DocumentSyncsTableNameString; RequiredDocument Syncs DynamoDB Table Name
DocumentVersionsTableNameString; RequiredDocument Versions DynamoDB Table Name
DocumentsS3BucketString; RequiredDocuments S3 Bucket Name
DocumentsStageS3BucketString; RequiredDocuments Stage S3 Bucket Name
SnsDocumentEventArnString; RequiredSNS Topic for Document Events
FormKiQTypeString; RequiredThe type of FormKiQ installation Pattern: .+.
LambdaMemoryNumber; Default 1024The amount of memory used by lambda function (MB) Min: 128. Max: 3008.
LambdaTimeoutString; Default 60The maximum amount of seconds lambda function will run for (seconds)
LogRetentionInDaysNumber; RequiredThe number of days to retain the log events
LogFormatString; RequiredThe format in which the application and system logs are stored.
LogLevelApplicationString; RequiredThe level of logging for the FormKiQ Application logs.
LogLevelSystemString; RequiredThe level of logging for the AWS Platform System logs.
KmsKeyArnString; RequiredKMS Key Arn Pattern: .+.
PermissionsBoundaryArnString; Default (empty string)
OperationalModeString; RequiredControls the runtime operational behavior of the FormKiQ environment

Outputs​

NamePurpose
EsignatureLambdaArnInspect the deployed output and owning template.
Commercial: Main/CoreApi/FulltextDynamodbStreams · Commercial: template-upgrade/CoreApi/FulltextDynamodbStreams

Source: Licensed 1.19.2 distribution: d4467d952363b4ea5a8662c0f4470620.template

SHA-256: f095841f02b4dd42b4105b2c04b640b84bd40d9c0a0135d0e7fc4d26e4ccd5d8

Parameters​

NameType / defaultConstraints and purpose
AppEnvironmentString; RequiredThe Application Environment Pattern: .+.
DocumentsTableNameString; RequiredDocuments DynamoDB Table Name
DocumentSyncsTableNameString; RequiredDocument Syncs DynamoDB Table Name
DocumentsStreamArnString; RequiredDocuments DynamoDB Stream Arn
DocumentsDeadLetterQueueArnString; RequiredDocuments Dead Letter Queue Arn
LambdaMemoryNumber; Default 1024The amount of memory used by lambda function (MB) Min: 128. Max: 3008.
LambdaTimeoutString; Default 60The maximum amount of seconds lambda function will run for (seconds)
OpenSearchStackNameString; RequiredThe name of the FormKiQ Open Search Stack Name
OpenSearchDomainTypeString; RequiredOpen Search Service Domain Type
OpenSearchIndexPrefixString; RequiredThe string appended to the beginning of the OpenSearch Index Name
VpcStackNameString; RequiredFormKiQ VPC Stack Name
LogRetentionInDaysNumber; RequiredThe number of days to retain the log events
LogFormatString; RequiredThe format in which the application and system logs are stored.
LogLevelApplicationString; RequiredThe level of logging for the FormKiQ Application logs.
LogLevelSystemString; RequiredThe level of logging for the AWS Platform System logs.
HttpsSecurityGroupString; RequiredVPC Https Security Group
KmsKeyArnString; RequiredKMS Key Arn Pattern: .+.
PermissionsBoundaryArnString; Default (empty string)
OperationalModeString; RequiredControls the runtime operational behavior of the FormKiQ environment

Outputs​

NamePurpose
FulltextDynamodbStreamsLambdaRoleArnInspect the deployed output and owning template.
Commercial: Main/CoreApi/DocumentGenerationModule · Commercial: template-upgrade/CoreApi/DocumentGenerationModule

Source: Licensed 1.19.2 distribution: 863a33f9a59efad3c07cc14b8f37e418.template

SHA-256: a66d879ac8c8208790f0a9f1e52257635c6a5b01b6e72d48e32b28ba014464c7

Parameters​

NameType / defaultConstraints and purpose
AppEnvironmentString; RequiredThe FormKiQ Environment Pattern: .+.
DocumentsTableNameString; RequiredDocuments DynamoDB Table Name
DocumentSyncsTableNameString; RequiredDocument Syncs DynamoDB Table Name
DocumentVersionsTableNameString; RequiredDocument Versions DynamoDB Table Name
DocumentsS3BucketString; RequiredDocuments S3 Bucket Name
DocumentsStageS3BucketString; RequiredDocuments Stage S3 Bucket Name
LambdaMemoryNumber; Default 3008The amount of memory used by lambda function (MB) Min: 128. Max: 10240.
LambdaTimeoutString; Default 60The maximum amount of seconds lambda function will run for (seconds)
FormKiQTypeString; RequiredThe type of FormKiQ installation Pattern: .+.
DocumentGenerationEcrRepositoryString; Default formkiq-prodThe ECR repository containing the Document Generation Lambda image Values: ["formkiq-prod","formkiq-dev"].
ProvisionedConcurrencyNumber; Default 0The amount of provisioned concurrency to allocate for Document Generation Lambda Min: 0.
LogRetentionInDaysNumber; RequiredThe number of days to retain the log events
LogFormatString; RequiredThe format in which the application and system logs are stored.
LogLevelApplicationString; RequiredThe level of logging for the FormKiQ Application logs.
LogLevelSystemString; RequiredThe level of logging for the AWS Platform System logs.
KmsKeyArnString; RequiredKMS Key Arn Pattern: .+.
PermissionsBoundaryArnString; Default (empty string)
OperationalModeString; RequiredControls the runtime operational behavior of the FormKiQ environment

Outputs​

NamePurpose
DocumentGenerationLambdaArnInspect the deployed output and owning template.
DocumentCertificationsLambdaArnInspect the deployed output and owning template.
Commercial: Main/CoreConsoleUsers · Commercial: template-upgrade/CoreConsoleUsers

Source: Licensed 1.19.2 distribution: 01d8db485243c0ced1bbee62aecf8169.template

SHA-256: 340562d47537d3d6200c1f7cecc3374cae7b4af4cc91b1b7e0517a4eaa52290c

Parameters​

NameType / defaultConstraints and purpose
AdminEmailString; RequiredAdministrator Email Pattern: .+.
AppEnvironmentString; RequiredThe Document Stack Environment Pattern: .+.
CognitoUserPoolString; RequiredThe Cognito User Pool Id Pattern: .+.
CognitoUserPoolArnString; RequiredThe Cognito User Pool Arn Pattern: .+.
CognitoIdentityPoolString; RequiredCognito Identity Pool Id Pattern: .+.
CognitoUserPoolClientString; RequiredCognito User Pool Client Pattern: .+.
IsGovCloudString; RequiredIs Installation AWS Region gov cloud Values: ["true","false"].

Outputs​

NamePurpose
AdminGroupRoleArnInspect the deployed output and owning template.
Commercial: Main/Monitoring · Commercial: template-upgrade/Monitoring

Source: Licensed 1.19.2 distribution: 7dd48d32e813ae889a36c9a2e1285bda.template

SHA-256: 99b2a1db26dcfe3d4cf9b7427915d54c1c4b5d8afc24c80efa418c2d3573e015

Parameters​

NameType / defaultConstraints and purpose
AppEnvironmentString; RequiredUnique Application Environment Identifier, IE dev/staging/prod Pattern: .+.
DocumentsApiRequestsString; RequiredDocuments API Lambda Function Name
DocumentsUpdateObjectString; RequiredDocuments Update Object Lambda Function Name
StagingCreateObjectString; RequiredStaging Create Object Lambda Function Name
DocumentActionsProcessorString; RequiredDocument Actions Processor Lambda Function Name
DocumentsHttpApiString; RequiredDocuments HTTP API Id
DocumentsIamApiString; RequiredDocuments IAM API Id
UserAuthApiUrlString; RequiredUser Auth API Url
DocumentsDeadLetterQueueNameString; RequiredDocuments Dead Letter Queue Name
KmsKeyArnString; RequiredKMS Key Arn Pattern: .+.

Outputs​

NamePurpose
DashboardURLDashboard URL
Commercial: Main/AccessLogs · Commercial: template-upgrade/AccessLogs

Source: Licensed 1.19.2 distribution: 905c69fc50b81b125f7fbfb34c19a05a.template

SHA-256: 1801db95c6d39be40394f59e47b8fc1daaacad2b73e5477bbdc0de9b5f2fc8d5

Parameters​

NameType / defaultConstraints and purpose
AppEnvironmentString; RequiredThe Application Environment
KmsKeyArnString; RequiredExisting shared KMS key ARN Pattern: .+.
EnableCloudFrontAccessLogsString; Default falseCreate the destination for CloudFront standard access logs (legacy) Values: ["true","false"].
EnableS3AccessLogsString; Default falseCreate the destination for S3 server access logs Values: ["true","false"].

Outputs​

NamePurpose
CloudFrontAccessLogsBucketNameCloudFront access log destination bucket Conditional.
S3AccessLogsBucketNameS3 server access log destination bucket Conditional.
Commercial: Main/EventMessages · Commercial: template-upgrade/EventMessages

Source: Licensed 1.19.2 distribution: 2ae52aa095b5ef0aa3df98a1a9f3f593.template

SHA-256: 1108263f6e91cfeec31111b344a6ab6f3c0589ca4ad17452baaa2a07a9a6f809

Parameters​

NameType / defaultConstraints and purpose
AppEnvironmentString; RequiredUnique Application Environment Identifier, IE dev/staging/prod Pattern: .+.

Outputs​

NamePurpose
DocumentEventsBusName EventBridge Event Bus
Commercial: Main/FulltextCognitoInstall · Commercial: template-upgrade/FulltextCognitoInstall

Source: Licensed 1.19.2 distribution: da366d456a9cd2c6cd4a8ff9561b37e2.template

SHA-256: 3375d773c7af373ab1cdde871d7768da32afaecd0b489bdb90ec78e530b71903

Parameters​

NameType / defaultConstraints and purpose
AppEnvironmentString; RequiredThe Document Stack Environment Pattern: .+.
CognitoAdminGroupArnString; RequiredThe ARN of the Cognito Admin Group Pattern: .+.
UserPoolClientIdString; RequiredThe Cognito User Pool Client Id
UserPoolIdString; RequiredThe Cognito User Pool Id
IdentityPoolIdString; RequiredThe Cognito Identity Pool Id
FormKiQTypeString; Default enterpriseThe type of FormKiQ installation Values: ["core","enterprise"].
LogRetentionInDaysNumber; RequiredThe number of days to retain the log events

No declared outputs.

Core: opensearch-bastion

Source: https://formkiq-core-distribution-us-east-1.s3.us-east-1.amazonaws.com/1.19.2/opensearch-bastion.yaml

SHA-256: e22ba9c0c1ccfb550691108acf9be1ea00498c29c434a926dbc181af7ed7c3c8

Parameters​

NameType / defaultConstraints and purpose
KeyPairNameAWS::EC2::KeyPair::KeyName; RequiredName of an existing public/private key pair, which allows you to securely connect to your instance after it launches.
LatestAmiIdAWS::SSM::Parameter::Value<AWS::EC2::Image::Id>; Default /aws/service/ami-amazon-linux-latest/amzn2-ami-hvm-x86_64-gp2
VpcStackNameString; RequiredThe name of the FormKiQ VPC Stack Name Pattern: .+.

Outputs​

NamePurpose
BastionHostIdBastion Host Id
BastionPublicDnsNameBastion Public Dns
BastionPublicIpBastion Public Ip
Core: vpc

Source: https://formkiq-core-distribution-us-east-1.s3.us-east-1.amazonaws.com/1.19.2/vpc.yaml

SHA-256: 4f7c40f98e4a7e688dc0570a2132a6a3656cd25d17c11e411582712c144c2a40

Parameters​

NameType / defaultConstraints and purpose
EnableNatGatewayString; Default falseEnable a NAT Gateway for private subnets outbound internet access (requires public subnets) Values: ["false","true"].
EnableNetworkAclsString; Default trueEnable custom ACLs on all subnets for HTTP/HTTPS, VPC DNS, TCP/UDP return traffic, and outbound SMTP (TCP 25/465/587). Other outbound ports below 1024 and non-TCP/UDP protocols are blocked. Public SSH/RDP ingress is blocked. Disable for bastion SSH or custom protocols; security groups still apply. Values: ["false","true"].
VpcLabelString; Default formkiqA Label for the VPC Pattern: .+.
VpcCidrString; Default 10.1.0.0/16VPC CIDR block Pattern: ^[0-9./\s]*.
PublicSubnet1CidrString; Default 10.1.1.0/24Public Subnet1 CIDR block (optional leave empty to skip)
PublicSubnet2CidrString; Default 10.1.2.0/24Public Subnet2 CIDR block (optional leave empty to skip)
PublicSubnet3CidrString; Default 10.1.3.0/24Public Subnet3 CIDR block (optional leave empty to skip)
PrivateSubnet1CidrString; Default 10.1.10.0/24Private Subnet1 CIDR block Pattern: ^[0-9./\s]*.
PrivateSubnet2CidrString; Default 10.1.20.0/24Private Subnet2 CIDR block Pattern: ^[0-9./\s]*.
PrivateSubnet3CidrString; Default 10.1.30.0/24Public Subnet3 CIDR block Pattern: ^[0-9./\s]*.
EnableVpcEndpointsString; Default falseEnable VPC Endpoints (S3, Dynamodb, SNS, SMS, Execute-Api) set to 'true' if using Opensearch Values: ["false","true"].
EnableVpcLinksString; Default falseEnable VPC Links (needed for Typesense) Values: ["false","true"].
EnableVpcFlowLogsString; Default falseEnable VPC Flow Logs (set to 'true' to enable) Values: ["false","true"].
VpcFlowLogsDestinationString; Default s3Destination for VPC Flow Logs. Options: s3, cloud-watch-logs Values: ["s3","cloud-watch-logs"].
FlowLogsRetentionInDaysNumber; Default 30Retention period in days for CloudWatch Logs. Allowed values: 1,3,5,7,14,30,60,90,120,150,180,365,400,545,731,1827,3653 Values: [1,3,5,7,14,30,60,90,120,150,180,365,400,545,731,1827,3653].

Outputs​

NamePurpose
VpcFlowLogsBucketVpc Flow Logs S3 Bucket Conditional.
VpcVPC Id
VpcCidrVPC Cidr
PublicSubnet1Public Subnet 1 Conditional.
PublicSubnet2Public Subnet 2 Conditional.
PublicSubnet3Public Subnet 3 Conditional.
PrivateSubnet1Private Subnet 1
PrivateSubnet2Private Subnet 2
PrivateSubnet3Private Subnet 3
PublicSubnetsVPC Public Subnets Conditional.
PrivateSubnetsVPC Private Subnets
CloudMapNamespaceCloud Map Name Space Conditional.
VpcLinkApiGatewayV2 VPC Link Conditional.
VpcLinkSecurityGroupVPC Link Security Group Conditional.
NatGatewayIdNAT Gateway Id Conditional.
NatEipAllocationIdNAT Gateway Elastic IP Allocation Id Conditional.
Core: vpc-import

Source: https://formkiq-core-distribution-us-east-1.s3.us-east-1.amazonaws.com/1.19.2/vpc-import.yaml

SHA-256: cc975e72fff8be47394c2a285fb2260f4bc2b97ddd7fe7d01120b4adfa896faf

Parameters​

NameType / defaultConstraints and purpose
VpcIdString; RequiredThe ID of the existing VPC (leave blank to create new vpc)
VpcCidrString; RequiredVPC CIDR block
NumberOfSubnetsNumber; Default 3Number of private subnets and, when provided, public subnets to use Values: [2,3].
PublicSubnet1IdString; Default (empty string)Public Subnet 1 (optional) ID (starts with 'subnet-')
PublicSubnet2IdString; Default (empty string)Public Subnet 2 (optional) ID (starts with 'subnet-')
PublicSubnet3IdString; Default (empty string)Public Subnet 3 ID (only used with 3 subnets; optional when no public subnets are provided)
PrivateSubnet1IdString; RequiredPrivate Subnet 1 ID (starts with 'subnet-')
PrivateSubnet2IdString; RequiredPrivate Subnet 2 ID (starts with 'subnet-')
PrivateSubnet3IdString; Default (empty string)Private Subnet 3 ID (starts with 'subnet-'; required when NumberOfSubnets is 3)
EnableVpcEndpointsString; Default falseEnable VPC Endpoints (S3, Dynamodb, SNS, SMS, Execute-Api) set to 'true' if using Opensearch Values: ["false","true"].
EnableVpcLinksString; Default falseEnable VPC Links (needed for Typesense) Values: ["false","true"].
PrivateRouteTableIdCommaDelimitedList; RequiredPrivate Route Table ID (starts with 'rtb-')

Outputs​

NamePurpose
VpcVPC Id
VpcCidrVPC Cidr
PublicSubnet1Public Subnet 1 Conditional.
PublicSubnet2Public Subnet 2 Conditional.
PublicSubnet3Public Subnet 3 Conditional.
PrivateSubnet1Private Subnet 1
PrivateSubnet2Private Subnet 2
PrivateSubnet3Private Subnet 3 Conditional.
PublicSubnetsVPC Public Subnets Conditional.
PrivateSubnetsVPC Private Subnets
CloudMapNamespaceCloud Map Name Space Conditional.
VpcLinkApiGatewayV2 VPC Link Conditional.
VpcLinkSecurityGroupVPC Link Security Group Conditional.
Commercial: backup

Source: Licensed 1.19.2 distribution: backup.yaml

SHA-256: b89650da3bddc3ace2b25f8e016e76277bea3239b32008bd16309c48aa16320f

Parameters​

NameType / defaultConstraints and purpose
AppEnvironmentString; Default <appenvironment>Environment identifier to protect (for example, dev, test, or prod). This value must exactly match the AppEnvironment tag on each resource selected for backup.
BackupVaultNameString; Default formkiq-backup-<appenvironment>Name of the new AWS Backup vault that will store recovery points in this account and Region. The name must be unique in the account and Region.
BackupScheduleExpressionString; Default cron(0 5 * * ? *)AWS cron expression that schedules backup jobs. The default runs every day at 05:00 UTC.
BackupStartWindowMinutesNumber; Default 120Number of minutes after the scheduled time during which AWS Backup may start the job. AWS Backup requires a start window of at least 60 minutes. Min: 60.
BackupCompletionWindowMinutesNumber; Default 480Number of minutes after a backup job starts in which it must finish. AWS Backup cancels a job that does not finish within this window. Min: 1.
BackupMoveToColdStorageAfterDaysNumber; Default 30Number of days to keep recovery points in warm storage before moving supported resource types to cold storage. Set to 0 to disable the transition. Min: 0.
BackupDeleteAfterDaysNumber; Default 120Total number of days to retain source recovery points. When cold storage is enabled, this must be at least 90 days greater than BackupMoveToColdStorageAfterDays. Min: 1.
DestinationBackupVaultArnString; Default (empty string)ARN of an existing destination backup vault in another Region. Leave empty to disable cross-Region copies. The destination vault and its permissions must be configured before this stack is deployed.
DestinationCopyDeleteAfterDaysNumber; Default 120Number of days to retain copied recovery points in the destination Region. This value is used only when DestinationBackupVaultArn is specified. Min: 1.

Outputs​

NamePurpose
BackupVaultNameName of the AWS Backup vault storing recovery points.
BackupPlanIdID of the AWS Backup plan created by this template.
BackupSelectionIdID of the AWS Backup selection that targets tagged resources.
Commercial: certificates

Source: Licensed 1.19.2 distribution: certificates.yaml

SHA-256: 5bfdffdf36fd0bcb8c59840eb12320ed8d172b0d1e4f1cd24007e30613a4eb83

Parameters​

NameType / defaultConstraints and purpose
ConsoleDomainString; Default (empty string)Domain for FormKiQ Console (eg: console.<domain>)
HttpApiDomainString; Default (empty string)Domain for FormKiQ HTTP API (eg: api.<domain>)
ShortlinksApiDomainString; Default (empty string)Domain for FormKiQ Shortlinks API (eg: api.<domain>)
IamApiDomainString; Default (empty string)Domain for FormKiQ IAM API (eg: iamapi.<domain>)
KeyApiDomainString; Default (empty string)Domain for FormKiQ Key API (eg: keyapi.<domain>)
AuthApiDomainString; Default (empty string)Domain for FormKiQ Auth API (eg: auth.<domain>)
HostedZoneIdString; Default (empty string)(optional) Route53 Hosted Zone Id in which to add A record
ConsoleCertificateArnString; Default (empty string)FormKiQ Console ACM Certificate ARN
HttpCertificateArnString; Default (empty string)FormKiQ HTTP API ACM Certificate ARN
IamCertificateArnString; Default (empty string)FormKiQ IAM API ACM Certificate ARN
KeyCertificateArnString; Default (empty string)FormKiQ Key API ACM Certificate ARN
AuthCertificateArnString; Default (empty string)FormKiQ Auth ACM Certificate ARN
ShortlinksCertificateArnString; Default (empty string)FormKiQ Shortlinks ACM Certificate ARN

Outputs​

NamePurpose
HttpApiDomainDomain for FormKiQ HTTP API
IamApiDomainDomain for FormKiQ IAM API
KeyApiDomainDomain for FormKiQ Key API
AuthApiDomainDomain for FormKiQ Auth API (eg: auth.<domain>)
ShortlinksApiDomainDomain for FormKiQ Shortlinks API
ConsoleDomainDomain for FormKiQ Console
ConsoleCertificateArnFormKiQ Console ACM Certificate ARN
HttpCertificateArnFormKiQ HTTP API ACM Certificate ARN
IamCertificateArnFormKiQ IAM API ACM Certificate ARN
KeyCertificateArnFormKiQ Key API ACM Certificate ARN
AuthCertificateArnFormKiQ Auth ACM Certificate ARN
ShortlinksCertificateArnFormKiQ Shortlinks API ACM Certificate ARN
HostedZoneId(optional) Route53 Hosted Zone Id in which to add A record
HttpApiDomainAliasTargetRoute53The Domain 'A' record AliasTarget for the HTTP Api endpoint to be used in Route53
IamApiDomainAliasTargetRoute53The Domain 'A' record AliasTarget for the IAM Api endpoint to be used in Route53
KeyApiDomainAliasTargetRoute53The Domain 'A' record AliasTarget for the Key Api endpoint to be used in Route53
ShortlinksApiDomainAliasTargetRoute53The Domain 'A' record AliasTarget for the Shortlinks Api endpoint to be used in Route53
Commercial: ecr-distribution

Source: Licensed 1.19.2 distribution: ecr-distribution.yaml

SHA-256: b987e4a33ff8bb0729c418fa8428743e831d200d6ecbd7702f66bb13a14cacb9

Parameters​

NameType / defaultConstraints and purpose
SourceAccountIdString; Default 622653865277The AWS account ID of the source account that will replicate images Pattern: [0-9]{12}.
SourceRepositoryNameString; Default formkiq-prodThe name of the source ECR repository that will replicate images into this repository
RepositoryNameString; Default formkiq-prodThe name of the ECR repository that will be replicated into
ImageTagMutabilityString; Default IMMUTABLEUse IMMUTABLE to prevent image tags from being overwritten, or MUTABLE to allow tag updates. Values: ["IMMUTABLE","MUTABLE"].

Outputs​

NamePurpose
ECRRepositoryURIThe URI of the newly created ECR repository
Commercial: filesync

Source: Licensed 1.19.2 distribution: filesync.yaml

SHA-256: aa3242060517dcb4b6b59f95e53de5326caefe8f2ea5b10e931664343e23956e

Parameters​

NameType / defaultConstraints and purpose
S3ReadOnlyArnsString; RequiredComma delimited list of S3 bucket ARNs. For example: arn:aws:s3:::my-bucket,arn:aws:s3:::my-bucket2
DynamoDbTableNamesString; RequiredComma delimited list of DynamoDb table ARNS(s). For example: arn:aws:dynamodb:<region>:<aws_account_id>:table/<table_name>

Outputs​

NamePurpose
AccessKeyFormKiQ Sync AWSAccessKeyId
SecretKeyFormKiQ Sync AWSSecretAccessKey
Commercial: formkiq-module-email/template

Source: Licensed 1.19.2 distribution: formkiq-module-email/template.yaml

SHA-256: 9107bba4d230ce7230778109a2f7750e5c4a21c2541e8490f26da0bd8cccb88e

Parameters​

NameType / defaultConstraints and purpose
S3BucketDestinationString; RequiredFormKiQ Staging S3 Bucket to move attachments to Pattern: .+.

Outputs​

NamePurpose
EmailBucketNameInspect the deployed output and owning template.
Commercial: opensearch-legacy

Source: Licensed 1.19.2 distribution: opensearch-legacy.yaml

SHA-256: e39cf728ae19f8752882c9f0e4c31a5b727544a3d9a4737c38d066e32bea73aa

Parameters​

NameType / defaultConstraints and purpose
VpcStackNameString; RequiredThe name of the FormKiQ VPC Stack Name Pattern: .+.
NameString; Default formkiq-enterprise-prodA name for the OpenSearch Service domain Pattern: .+.
EnableMultiAZStandbyString; Default falseIndicates whether Multi-AZ with Standby deployment option is enabled. Values: ["false","true"].
OpenSearchVersionString; Default OpenSearch_2.17The version of OpenSearch to use Values: ["OpenSearch_2.17","OpenSearch_2.15","OpenSearch_2.13","OpenSearch_2.11","OpenSearch_2.9","OpenSearch_2.7","OpenSearch_2.5","OpenSearch_2.3","OpenSearch_1.3","OpenSearch_1.2"].
AppEnvironmentString; Default prodUnique Application Environment Identifier, IE dev/staging/prod (MUST match FormKiQ installation AppEnvironment) Pattern: [a-zA-Z0-9_.-/]+.
DataInstanceTypeString; Default t3.small.searchThe instance type for your data nodes Values: ["t3.small.search","t3.medium.search","r6g.large.search","r6g.xlarge.search","r6g.2xlarge.search","m6g.large.search","m6g.xlarge.search","m6g.2xlarge.search","c6g.large.search","c6g.xlarge.search","c6g.2xlarge.search"]. Pattern: ^[a-z1-9]+\.[a-z1-9]+\.search$.
DataInstanceCountNumber; Default 1The number of data nodes (instances) to use in the OpenSearch Service domain. Min: 1. Max: 100.
DataNodeVolumeSizeNumber; Default 10The size (in GiB) of the EBS volume for each data node. Min: 10. Max: 2048.
DedicatedMasterTypeString; Default (empty string)The hardware configuration of the computer that hosts the dedicated master node Values: ["","t3.small.search","m6g.large.search","c6g.2xlarge.search","r6g.xlarge.search","r6g.2xlarge.search","r6g.4xlarge.search"].
DedicatedMasterCountNumber; Default 0The number of dediction master node(s) Values: [0,1,3,5].

Outputs​

NamePurpose
OpenSearchDomainTypeOpen Search Service Domain Type
OpenSearchDomainEndpointOpen Search Service Domain Endpoint
Commercial: opensearch-serverless

Source: Licensed 1.19.2 distribution: opensearch-serverless.yaml

SHA-256: 16606b78e70d992947a37179ae45fbbd38966d9ae85194f63804d105f0db6f28

Parameters​

NameType / defaultConstraints and purpose
VpcStackNameString; Default formkiq-vpcThe name of the FormKiQ VPC Stack Name Pattern: .+.
SourceVPCEString; Default (empty string)(Optional) The VPC Endpoint ID to allow. If this is not provided, the network security policy will not be created.
CollectionNameString; Default formkiq-prodThe name of the OpenSearch Serverless collection.
StandbyReplicasString; Default ENABLEDThe default configuration has active replicas enabled, which is optimal for production workloads. Clear this option if you want to reduce costs by disabling redundant active replicas. Availability will be compromised in the event of an infrastructure failure while new replicas are activated. Values: ["ENABLED","DISABLED"].
EnableVpcEndpointString; Default trueEnable Opensearch VPC Endpoint Values: ["false","true"].

Outputs​

NamePurpose
HttpsSecurityGroupSecurity Group which allows HTTPS access
VpcEndpointThe VPC Endpoint ID used for the security policy. Conditional.
OpenSearchDomainTypeOpen Search Service Domain Type
CollectionNameOpen Search Collection Name
OpenSearchDomainEndpointOpen Search Service Domain Endpoint
OpenSearchDashboardsEndpointOpenSearch Dashboards endpoint for the collection
Commercial: opensearch

Source: Licensed 1.19.2 distribution: opensearch.yaml

SHA-256: 7a6bffac82f26c8ee7cc402da8fb92b4e74694d3b0b90e844bde8eb44c5ba2e7

Parameters​

NameType / defaultConstraints and purpose
VpcStackNameString; RequiredThe name of the FormKiQ VPC Stack Name Pattern: .+.
NameString; Default formkiq-prodA name for the OpenSearch Service domain (must be lower-case, numbers, and hyphens only) Pattern: .+.
EnableMultiAZStandbyString; Default falseIndicates whether Multi-AZ with Standby deployment option is enabled. Values: ["false","true"].
OpenSearchVersionString; Default OpenSearch_3.5The version of OpenSearch to use Values: ["OpenSearch_3.5","OpenSearch_3.3","OpenSearch_3.1","OpenSearch_2.19","OpenSearch_2.17","OpenSearch_2.15","OpenSearch_2.13","OpenSearch_2.11","OpenSearch_2.9","OpenSearch_2.7","OpenSearch_2.5","OpenSearch_2.3","OpenSearch_1.3","OpenSearch_1.2"].
DataInstanceTypeString; Default t3.small.searchThe instance type for your data nodes Pattern: ^[a-z1-9]+\.[a-z1-9]+\.search$.
DataInstanceCountNumber; Default 1The number of data nodes (instances) to use in the OpenSearch Service domain. Min: 1. Max: 100.
DataNodeVolumeSizeNumber; Default 10The size (in GiB) of the EBS volume for each data node. Min: 10. Max: 2048.
FreeStorageSpaceAlarmThresholdPercentNumber; Default 25Alert when a data node's free storage is at or below this percentage of its provisioned EBS volume. Min: 1. Max: 100.
DedicatedMasterTypeString; Default (empty string)The hardware configuration of the computer that hosts the dedicated master node Values: ["","t3.small.search","m6g.large.search","c6g.2xlarge.search","r6g.xlarge.search","r6g.2xlarge.search","r6g.4xlarge.search"].
DedicatedMasterCountNumber; Default 0The number of dediction master node(s) Values: [0,1,3,5].
AlarmEmailString; Default (empty string)Optional email address to subscribe for alarm notifications. Leave empty if not needed.
RetentionInDaysNumber; Default 90Number of days to retain the logs in each log group. Values: [1,3,5,7,14,30,60,90,120,150,180,365,400,545,731,1096,1827,2192,2557,2922,3288,3653].
LogsSearchSlowEnabledString; Default falseSet to "true" to enable Search slow logs. Values: ["true","false"].
LogsIndexSlowEnabledString; Default falseSet to "true" to enable Index slow logs. Values: ["true","false"].
LogsErrorEnabledString; Default falseSet to "true" to enable Error logs. Values: ["true","false"].

Outputs​

NamePurpose
OpenSearchDomainTypeOpen Search Service Domain Type
CognitoUserPoolArnOpen Search Service Cognito User Pool
OpenSearchDomainEndpointOpen Search Service Domain Endpoint
OpenSearchSnapshotBucketName of the S3 bucket for OpenSearch snapshots
OpenSearchSnapshotRoleArnDeprecated OpenSearch snapshot role ARN. Use OpenSearchSnapshotServiceRoleArn instead.
OpenSearchSnapshotServiceRoleArnOpenSearch snapshot service role ARN
Commercial: support

Source: Licensed 1.19.2 distribution: support.yaml

SHA-256: 370e74f1d40085d6d8cc39e11321dbc89118f0def400c77a4710c3336254b436

Parameters​

NameType / defaultConstraints and purpose
MasterAccountNumberNumber; Default 622653865277The account where the AWS Trusted Advisor Explorer solution will be deployed
CrossAccountRoleNameString; Default FormKiQSupportYour Role Name (ex: OrganizationAccountAccessRole); This will need to be the same across all of the Member Accounts

Outputs​

NamePurpose
SupportRoleInspect the deployed output and owning template.
AwsAccountIdInspect the deployed output and owning template.
Commercial: template-upgrade

Source: Licensed 1.19.2 distribution: template-upgrade.yaml

SHA-256: 1abe19f9f0ae27d4536cac11fa186a0f44a049a1cdbc87ca08598cf723bba8be

Parameters​

NameType / defaultConstraints and purpose
ConsoleWafACLIdString; Default (empty string)ARN of the Console WAF WebACL to associate with the CloudFront distribution
AdminEmailString; RequiredAdministrator Email (required) Pattern: .+.
AppEnvironmentString; Default prodUnique Application Environment Identifier, IE dev/staging/prod Pattern: [a-zA-Z0-9_.-/]+.
EnablePublicUrlsString; Default falseWhether to enable "/public" endpoints, defaults to false. Public endpoints allow external users to submit documents, such as through a web form. As with any publicly-available functionality, there is a risk of abuse if enabled. Values: ["true","false"].
PasswordMinimumLengthNumber; Default 8Set the Amazon Cognito password policies, minimum password length requirement for all users Min: 6. Max: 99.
PasswordRequireLowercaseString; Default falseSet the Amazon Cognito password policies, to require one lowercase letter in all passwords. Values: ["true","false"].
PasswordRequireNumbersString; Default falseSet the Amazon Cognito password policies, to require one number in all passwords. Values: ["true","false"].
PasswordRequireSymbolsString; Default falseSet the Amazon Cognito password policies, to require one symbol in all passwords. Values: ["true","false"].
PasswordRequireUppercaseString; Default falseSet the Amazon Cognito password policies, to require one uppercase letter in all passwords. Values: ["true","false"].
TokenAccessIdValidityMinutesNumber; Default 1440The time limit in minutes, after which the access and ID tokens are no longer valid and cannot be used. Min: 5. Max: 1440.
TokenRefreshValidityMinutesNumber; Default 43200The time limit in minutes, after which the refresh token is no longer valid and cannot be used. Min: 60. Max: 5256000.
VpcStackNameString; Default (empty string)The name of the FormKiQ VPC Stack Name
CapacityProviderString; Default FARGATE_SPOTAWS Fargate capacity provider to use, either the FARGATE or FARGATE_SPOT Values: ["FARGATE_SPOT","FARGATE"].
LogRetentionInDaysNumber; Default 90The number of days to retain the log events Values: [1,3,5,7,14,30,60,90,120,150,180,365,400,545,731,1096,1827,2192,2557,2922,3288,3653].
LogFormatString; Default TextThe format in which the application and system logs are stored. Values: ["Text","JSON"].
LogLevelApplicationString; Default INFOThe level of logging for the FormKiQ Application logs. Only used when LogFormat is JSON Values: ["TRACE","DEBUG","INFO","ERROR"].
LogLevelSystemString; Default INFOThe level of logging for the AWS Platform System logs. Only used when LogFormat is JSON Values: ["DEBUG","INFO","WARN"].
EnableDeletionProtectionString; Default falseEnable deletion protection on AWS Services that support the feature Values: ["true","false"].
UserPoolTierString; Default LITECognito User Pool feature plan (tier). Determines the set of capabilities and limits available for the pool. Valid values: - LITE: Basic authentication and user management features at the lowest cost. - ESSENTIALS: Standard tier with advanced authentication features (default). - PLUS: Includes all ESSENTIALS features plus premium capabilities such as advanced security protections, WebAuthn/passkey support, and additional customization. The default is ESSENTIALS if not otherwise specified. Values: ["LITE","ESSENTIALS","PLUS"].
EnableCloudFrontAccessLogsString; Default falseEnable console CloudFront access logs and create a dedicated logging bucket. The deployment role needs s3:GetBucketAcl and s3:PutBucketAcl on the bucket. Values: ["true","false"].
EnableS3AccessLogsString; Default falseEnable server access logs for console, Cognito configuration, documents, staging, and OCR buckets, and create a dedicated logging bucket. Values: ["true","false"].
CertificateStackNameString; Default (empty string)The name of the FormKiQ Certificate Stack Name
EnableS3TransferAccelerationString; Default falseEnable opt-in S3 Transfer Acceleration for documents bucket URLs (additional transfer charges apply) Values: ["true","false"].
OpenSearchStackNameString; Default (empty string)The name of the FormKiQ Open Search Stack Name
OpenSearchIndexPrefixString; Default formkiq_The string appended to the beginning of the OpenSearch Index Name
ProvisionedConcurrencyDocumentGenerationNumber; Default 0The amount of provisioned concurrency to allocate for Document Generation Lambda Min: 0.
CognitoSingleSignOnUrlString; Default (empty string)The Cognito Hosted UI URL to allow Single Sign-On
SitePermissionsString; Default automaticThe site permission scheme to use. Automatic - will auto-create sites based on the roles attached to the user. Defined - Sites need to be defined using the Sites API. Cognito needs to be upgraded to Essentials or Plus. Values: ["automatic","defined"].
SamlProviderString; Default (empty string)The SAML identity provider to integrate with this Cognito User Pool. Valid values: - None: No SAML provider integration. - Entra: Microsoft Entra ID (Azure AD). - Okta: Okta Identity Provider. Values: ["","Entra","Okta"].
OperationalModeString; Default ACTIVEControls the runtime operational behavior of the FormKiQ environment. ACTIVE: - Full operation. - API, Console, and authentication endpoints are available. - Background and event-driven processing is enabled (SQS, EventBridge, scheduled jobs, indexing, OCR, notifications, etc.). PASSIVE: - API and Console continue to serve traffic. - Background and event-driven processing is disabled. - Queues and scheduled jobs will not execute until mode is switched back to ACTIVE. - Useful for migrations, controlled maintenance windows, or disaster recovery staging. Note: Switching modes may enable or disable background processing resources such as Lambda event source mappings, scheduled rules, and queue consumers. Values: ["ACTIVE","PASSIVE"].
PermissionsBoundaryArnString; Default (empty string)(Optional) ARN of the IAM Permissions Boundary to attach to every created role. Leave empty to create the role without a permissions boundary.

Outputs​

NamePurpose
AppEnvironmentUnique Application Environment Identifier, IE dev/staging/prod
IamApiUrlThe URL for the API endpoint that uses IAM authorization
KeyApiUrlThe URL for the API endpoint that uses API Key authorization
HttpApiUrlThe URL for the API endpoint that uses Cognito authorization
AuthApiUrlThe endpoint url for the User Auth API
ConsoleUrlThe URL for the FormKiQ Console
ConsoleS3BucketThe Console S3 Bucket
CognitoUserPoolIdThe Cognito User Pool Id
CognitoUserPoolArnThe Cognito User Pool Arn
CognitoClientIdThe Cognito Client Id
CognitoDomainThe Cognito Domain Url
FormKiQVersionThe FormKiQ Version
SnsDocumentEventArnSNS Topic for Document Events
DocumentsTableNameDocument DynamoDb Table Name
DocumentsTableArnDocument DynamoDb Table Arn
DocumentsS3BucketsDocuments Bucket.
DocumentsStageS3BucketDocuments Staging Bucket.
ShortlinksApiUrlThe endpoint url for the Shortlinks API
DriveCognitoClientIdThe Cognito Client Id for the Drive app client
DriveAuthorizeUrlThe Cognito OAuth2 authorization URL for the Drive app client
DriveLoginUrlThe URL for the Drive login page