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
| Name | Type / default | Constraints and purpose |
|---|---|---|
ConsoleWafACLId | String; Default (empty string) | ARN of the Console WAF WebACL to associate with the CloudFront distribution |
AdminEmail | String; Required | Administrator Email (required) Pattern: .+. |
AppEnvironment | String; Default prod | Unique Application Environment Identifier, IE dev/staging/prod Pattern: [a-zA-Z0-9_.-/]+. |
EnablePublicUrls | String; Default false | Whether 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"]. |
PasswordMinimumLength | Number; Default 8 | Set the Amazon Cognito password policies, minimum password length requirement for all users Min: 6. Max: 99. |
PasswordRequireLowercase | String; Default false | Set the Amazon Cognito password policies, to require one lowercase letter in all passwords. Values: ["true","false"]. |
PasswordRequireNumbers | String; Default false | Set the Amazon Cognito password policies, to require one number in all passwords. Values: ["true","false"]. |
PasswordRequireSymbols | String; Default false | Set the Amazon Cognito password policies, to require one symbol in all passwords. Values: ["true","false"]. |
PasswordRequireUppercase | String; Default false | Set the Amazon Cognito password policies, to require one uppercase letter in all passwords. Values: ["true","false"]. |
TokenAccessIdValidityMinutes | Number; Default 1440 | The time limit in minutes, after which the access and ID tokens are no longer valid and cannot be used. Min: 5. Max: 1440. |
TokenRefreshValidityMinutes | Number; Default 43200 | The time limit in minutes, after which the refresh token is no longer valid and cannot be used. Min: 60. Max: 5256000. |
VpcStackName | String; 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. |
TypesenseApiKeySecretArn | String; 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:.+$. |
TypesenseMemory | String; Default 1024 | The 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"]. |
CapacityProvider | String; Default FARGATE_SPOT | AWS Fargate capacity provider to use, either the FARGATE or FARGATE_SPOT Values: ["FARGATE_SPOT","FARGATE"]. |
LogRetentionInDays | Number; Default 90 | The 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]. |
LogFormat | String; Default Text | The format in which the application and system logs are stored. Values: ["Text","JSON"]. |
LogLevelApplication | String; Default INFO | The level of logging for the FormKiQ Application logs. Only used when LogFormat is JSON Values: ["TRACE","DEBUG","INFO","ERROR"]. |
LogLevelSystem | String; Default INFO | The level of logging for the AWS Platform System logs. Only used when LogFormat is JSON Values: ["DEBUG","INFO","WARN"]. |
EnableDeletionProtection | String; Default false | Enable deletion protection on AWS Services that support the feature Values: ["true","false"]. |
UserPoolTier | String; Default LITE | Cognito 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
| Name | Purpose |
|---|---|
AppEnvironment | Unique Application Environment Identifier, IE dev/staging/prod |
IamApiUrl | The URL for the API endpoint that uses IAM authorization |
KeyApiUrl | The URL for the API endpoint that uses API Key authorization |
HttpApiUrl | The URL for the API endpoint that uses Cognito authorization |
AuthApiUrl | The endpoint url for the User Auth API |
ConsoleUrl | The URL for the FormKiQ Console |
ConsoleS3Bucket | The Console S3 Bucket |
CognitoUserPoolId | The Cognito User Pool Id |
CognitoUserPoolArn | The Cognito User Pool Arn |
CognitoClientId | The Cognito Client Id |
CognitoDomain | The Cognito Domain Url |
FormKiQVersion | The FormKiQ Version |
SnsDocumentEventArn | SNS Topic for Document Events |
DocumentsTableName | Document DynamoDb Table Name |
DocumentsTableArn | Document DynamoDb Table Arn |
DocumentsS3Buckets | Documents Bucket. |
DocumentsStageS3Bucket | Documents Staging Bucket. |
TypesenseApiEndpoint | Typesense 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
| Name | Type / default | Constraints and purpose |
|---|---|---|
FormKiQType | String; Required | The formkiq type of installation Pattern: .+. |
FormKiQVersion | String; Required | The formkiq version Pattern: .+. |
LambdaArchitecture | String; Required | Lambda instruction set architecture for this build artifact Values: ["x86_64","arm64"]. |
VpcStackName | String; Required | 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. |
Outputs
| Name | Purpose |
|---|---|
FormKiQType | The FormKiQ type of installation |
FormKiQVersion | The FormKiQ version |
LambdaArchitecture | Lambda 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
| Name | Type / default | Constraints and purpose |
|---|---|---|
S3AccessLogsBucketName | String; 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. |
EnableS3TransferAcceleration | String; Default false | Enable opt-in S3 Transfer Acceleration for documents bucket URLs (additional transfer charges apply) Values: ["true","false"]. |
AppEnvironment | String; Required | The Application Environment Pattern: .+. |
LambdaMemory | Number; Default 1024 | The amount of memory used by lambda function (MB) Min: 128. Max: 3008. |
LambdaTimeout | String; Default 60 | The maximum amount of seconds lambda function will run for (seconds) |
LambdaArchitecture | String; Required | Lambda instruction set architecture Values: ["x86_64","arm64"]. |
FormKiQType | String; Required | The type of FormKiQ installation |
VpcStackName | String; Required | FormKiQ VPC Stack Name |
TypesenseApiKeySecretArn | String; 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:.+$. |
DocumentEventsBus | String; Default (empty string) | Name EventBridge Event Bus |
LogRetentionInDays | Number; Required | The number of days to retain the log events |
LogFormat | String; Required | The format in which the application and system logs are stored. |
LogLevelApplication | String; Required | The level of logging for the FormKiQ Application logs. |
LogLevelSystem | String; Required | The level of logging for the AWS Platform System logs. |
EnableDeletionProtection | String; Required | Enable deletion protection on AWS Services that support the feature |
OperationalMode | String; Default ACTIVE | Controls the runtime operational behavior of the FormKiQ environment. |
Outputs
| Name | Purpose |
|---|---|
DocumentsTableName | Documents DynamoDb Table Name. |
DocumentsTableArn | Documents DynamoDb Table Arn. |
DocumentsStreamArn | Documents DynamoDb Table Stream Arn. |
DocumentSyncsTableName | Inspect the deployed output and owning template. |
CacheTableName | Inspect the deployed output and owning template. |
DocumentsS3Buckets | Documents Bucket. |
DocumentsStageS3Bucket | Documents Staging Bucket. |
DocumentsUpdateQueueUrl | Documents Update Documents Queue Url |
DocumentsUpdateQueueArn | Documents S3 Update Documents Queue Arn |
DocumentsDeadLetterQueueArn | Documents Dead Letter Queue Arn |
DocumentsDeadLetterQueueName | Documents Dead Letter Queue Name |
SnsDocumentEventArn | SNS Topic for Document Events |
DocumentsS3Update | Documents MetaData Object Lambda |
StagingCreateObject | Documents Staging Create Object Lambda |
DocumentsUpdateObject | Documents Update Object Lambda |
DocumentActionsProcessor | Document 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
| Name | Type / default | Constraints and purpose |
|---|---|---|
CloudFrontAccessLogsBucketName | String; 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. |
S3AccessLogsBucketName | String; 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. |
WAFWebACLId | String; Default (empty string) | (Optional) ARN of the AWS WAF WebACL to associate with the CloudFront distribution. Leave empty to disable. |
AdminEmail | String; Required | Administrator Email Pattern: .+. |
AppEnvironment | String; Required | The Document Stack Environment Pattern: .+. |
Domain | String; Required | Amazon Cognito domain to use (include full domain if CertificateArn used) |
ConsoleVersion | String; Default v4.3.8 | Version of FormKiQ console to deploy |
CognitoConfigBucket | String; Required | Cognito Config S3 Bucket |
FormKiQType | String; Required | The type of FormKiQ installation |
CertificateStackName | String; Default (empty string) | The name of the FormKiQ Certificate Stack Name |
CertificateStackNameDomainName | String; Default _ | The name of the FormKiQ Certificate Stack Name Domain Name |
IsGovCloud | String; Required | Is Installation AWS Region gov cloud Values: ["true","false"]. |
ApiUrl | String; Required | JWT API URL |
IamApiUrl | String; Required | IAM API URL |
KeyApiUrl | String; Required | Key API URL |
AuthApiUrl | String; Required | Auth Api URL |
DocumentsTableName | String; Required | Document DynamoDb Table Name |
Brand | String; Default formkiq | Console Installer Brand |
AllowAdminCreateUserOnly | String; Required | When true only Cognito Admin can create users, false users can register themselves Pattern: .+. |
CognitoHostedUi | String; Required | Amazon Cognito Hosted UI Url Pattern: .+. |
DriveAuthorizeUrl | String; Default (empty string) | The Cognito OAuth2 authorization URL for the Drive app client |
DriveCognitoUserPoolClientId | String; Default (empty string) | The Cognito User Pool Client Id for the Drive app client |
CognitoUserPoolId | String; Required | The Cognito User Pool Id Pattern: .+. |
CognitoUserPoolClientId | String; Required | The Cognito User Pool Client Id Pattern: .+. |
UserAuthentication | String; Default cognito | How are the users authenticating Pattern: .+. |
LogFormat | String; Required | The format in which the application and system logs are stored. |
LogLevelApplication | String; Required | The level of logging for the FormKiQ Application logs. Only used when LogFormat is JSON |
LogLevelSystem | String; Required | The level of logging for the AWS Platform System logs. Only used when LogFormat is JSON |
LogRetentionInDays | Number; Required | The number of days to retain the log events |
LambdaArchitecture | String; Required | Lambda instruction set architecture Values: ["x86_64","arm64"]. |
Outputs
| Name | Purpose |
|---|---|
ConsoleUrl | Console URL |
ConsoleBucket | Inspect the deployed output and owning template. |
ConsoleVersion | Inspect the deployed output and owning template. |
HostedZoneId | Inspect the deployed output and owning template. |
CloudFrontDistributionDomainName | Inspect 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
| Name | Type / default | Constraints and purpose |
|---|---|---|
CertificateStackName | String; Default (empty string) | The name of the FormKiQ Certificate Stack Name |
HostedZoneId | String; Default (empty string) | Route53 Hosted Zone Id in which to add A record |
CloudFrontDistributionDomainName | String; 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
| Name | Type / default | Constraints and purpose |
|---|---|---|
S3AccessLogsBucketName | String; 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. |
AppEnvironment | String; Default (empty string) | Unique Application Environment Identifier, IE dev/staging/prod |
UserPoolTier | String; Default LITE | User pool feature plan (tier). Values: ["LITE","ESSENTIALS","PLUS"]. |
UserPoolName | String; Required | Name of the User Pool. Pattern: .+. |
AllowAdminCreateUserOnly | String; Default false | Values: ["true","false"]. |
PasswordMinimumLength | Number; Default 8 | The minimum password length. Min: 6. Max: 99. |
PasswordRequireLowercase | String; Default true | Password requires at least one lowercase letter. Values: ["true","false"]. |
PasswordRequireNumbers | String; Default true | Password requires at least one number. Values: ["true","false"]. |
PasswordRequireSymbols | String; Default true | Password requires at least one symbol. Values: ["true","false"]. |
PasswordRequireUppercase | String; Default true | Password requires at least one uppercase letter. Values: ["true","false"]. |
Domain | String; Required | Amazon Cognito domain to use (include full domain if CertificateArn used) Pattern: .+. |
DomainCertificateArn | String; Default (empty string) | Amazon Cognito Certificate ARN to use |
SesSourceArn | String; Default (empty string) | The Amazon Resource Name (ARN) of a verified email address in Amazon SES |
ReplyToEmailAddress | String; Default (empty string) | The destination to which the receiver of the email should reply to |
AccessTokenValidity | Number; Default 1440 | The time limit in minutes, after which the access token is no longer valid and cannot be used. Min: 5. Max: 1440. |
IdTokenValidity | Number; Default 1440 | The time limit in minutes, after which the ID token is no longer valid and cannot be used. Min: 5. Max: 1440. |
RefreshTokenValidity | Number; Default 43200 | The time limit in minutes, after which the refresh token is no longer valid and cannot be used. Min: 60. Max: 5256000. |
LogRetentionInDays | Number; Default 90 | The 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]. |
LogFormat | String; Default Text | The format in which the application and system logs are stored. Values: ["Text","JSON"]. |
LogLevelApplication | String; Default INFO | The level of logging for the FormKiQ Application logs. Only used when LogFormat is JSON Values: ["TRACE","DEBUG","INFO","ERROR"]. |
LogLevelSystem | String; Default INFO | The level of logging for the AWS Platform System logs. Only used when LogFormat is JSON Values: ["DEBUG","INFO","WARN"]. |
EnableDeletionProtection | String; Default false | Enable deletion protection on AWS Services that support the feature Values: ["true","false"]. |
LambdaArchitecture | String; Required | Lambda instruction set architecture Values: ["x86_64","arm64"]. |
Outputs
| Name | Purpose |
|---|---|
CognitoConfigBucket | The Cognito Config Bucket |
CognitoUserPoolId | The Cognito User Pool Id |
CognitoUserPoolProviderName | The Cognito User Pool Provider Name |
CognitoUserPoolProviderURL | The Cognito User Pool Provider URL |
CognitoUserPoolArn | The Cognito User Pool Arn |
CognitoUserPoolClientId | The Cognito User Pool Client Id |
CognitoIdentityPoolId | Cognito Identity Pool |
Domain | Amazon Cognito domain to use (include full domain if CertificateArn used) |
CognitoHostedUi | Amazon Cognito Hosted UI Url |
CognitoDomain | Amazon 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
| Name | Type / default | Constraints and purpose |
|---|---|---|
AppEnvironment | String; Required | Unique Application Environment Identifier, IE dev/staging/prod Pattern: .+. |
CognitoUserPool | String; Required | The Cognito User Pool Id Pattern: .+. |
CognitoUserPoolArn | String; Required | The Cognito User Pool Arn Pattern: .+. |
CognitoUserPoolClient | String; Required | The Cognito User Pool Client Id Pattern: .+. |
CognitoIdentityPool | String; Required | The Cognito Identity Pool Id Pattern: .+. |
Domain | String; Required | Amazon 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
| Name | Type / default | Constraints and purpose |
|---|---|---|
EnableS3TransferAcceleration | String; Default false | Enable opt-in S3 Transfer Acceleration for documents bucket URLs (additional transfer charges apply) Values: ["true","false"]. |
AppEnvironment | String; Required | The FormKiQ Environment Pattern: .+. |
FormKiQType | String; Required | The type of FormKiQ installation Pattern: .+. |
FormKiQVersion | String; Required | The formkiq version Pattern: .+. |
LambdaMemory | Number; Default 1024 | The amount of memory used by lambda function (MB) Min: 128. Max: 3008. |
LambdaTimeout | String; Default 60 | The maximum amount of seconds lambda function will run for (seconds) |
LambdaArchitecture | String; Required | Lambda instruction set architecture Values: ["x86_64","arm64"]. |
EnablePublicUrls | String; Default false | Whether to enable public urls Values: ["true","false"]. |
AllowAdminCreateUserOnly | String; Default true | Values: ["true","false"]. |
PasswordMinimumLength | Number; Default 8 | The minimum password length. Min: 6. Max: 99. |
PasswordRequireLowercase | String; Default false | Password requires at least one lowercase letter. Values: ["true","false"]. |
PasswordRequireNumbers | String; Default false | Password requires at least one number. Values: ["true","false"]. |
PasswordRequireSymbols | String; Default false | Password requires at least one symbol. Values: ["true","false"]. |
PasswordRequireUppercase | String; Default false | Password requires at least one uppercase letter. Values: ["true","false"]. |
CognitoUserPool | String; Required | The Cognito User Pool Id Pattern: .+. |
CognitoUserPoolClient | String; Required | The Cognito User Pool Client Id Pattern: .+. |
UserAuthentication | String; Default cognito | How are the users authenticating Pattern: .+. |
TypesenseApiKeySecretArn | String; 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:.+$. |
TypesenseApiEndpoint | String; Required | TypeSense API Endpoint |
DocumentsTableName | String; Required | Documents DynamoDB Table Name |
CacheTableName | String; Required | Cache DynamoDB Table Name |
DocumentSyncsTableName | String; Required | Document Syncs DynamoDB Table Name |
DocumentsS3Bucket | String; Required | Documents S3 Bucket Name |
DocumentsStageS3Bucket | String; Required | Documents Stage S3 Bucket Name |
SnsDocumentEventArn | String; Required | SNS Topic for Document Events |
DocumentsDeadLetterQueueArn | String; Required | Documents Dead Letter Queue Arn |
VpcStackName | String; Required | FormKiQ VPC Stack Name |
CertificateStackName | String; Default (empty string) | The name of the FormKiQ Certificate Stack Name |
HttpsSecurityGroup | String; Default (empty string) | VPC Https Security Group |
LogRetentionInDays | Number; Required | The number of days to retain the log events |
LogFormat | String; Required | The format in which the application and system logs are stored. |
LogLevelApplication | String; Required | The level of logging for the FormKiQ Application logs. |
LogLevelSystem | String; Required | The level of logging for the AWS Platform System logs. |
CertificateStackNameShortlinksApiDomain | String; Default (empty string) | Certificate Shortlinks Api Domain |
CertificateStackNameHttpApiDomain | String; Default (empty string) | Certificate Http Api Domain |
CertificateStackNameIamApiDomain | String; Default (empty string) | Certificate IAM Api Domain |
CertificateStackNameKeyApiDomain | String; Default (empty string) | Certificate Key Api Domain |
OperationalMode | String; Default ACTIVE | Controls the runtime operational behavior of the FormKiQ environment. |
CertificateStackNameUserAuthApiDomain | String; Default (empty string) | Certificate User Auth API Domain |
CertificateStackNameUserAuthCertificateArn | String; Default (empty string) | Certificate User Auth API ACM Certificate ARN |
CertificateStackNameHostedZoneId | String; Default (empty string) | Optional Route53 hosted zone for the User Auth API domain |
S3AccessLogsBucketName | String; 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
| Name | Purpose |
|---|---|
ApiGatewayInvokeRole | API Gateway Role that allows invoking of endpoints |
ApiGatewayInvokeRoleArn | API Gateway Role Arn that allows invoking of endpoints |
DocumentsApiRequests | FormKiQ Api Request Handler |
DocumentsHttpApi | HTTP API |
DocumentsIamApi | IAM API |
DocumentsIamApiUrl | The endpoint url for the IAM API |
DocumentsKeyApiUrl | The endpoint url for the Key API |
DocumentsHttpApiUrl | The endpoint url for the Http API |
AuthApiUrl | The endpoint url for the Auth API |
OcrBucket | Inspect the deployed output and owning template. |
OcrQueue | Inspect the deployed output and owning template. |
OcrQueueUrl | Inspect the deployed output and owning template. |
OcrQueueArn | Inspect 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
| Name | Type / default | Constraints and purpose |
|---|---|---|
EnableS3TransferAcceleration | String; Default false | Enable opt-in S3 Transfer Acceleration for documents bucket URLs (additional transfer charges apply) Values: ["true","false"]. |
AppEnvironment | String; Required | The FormKiQ Environment Pattern: .+. |
FormKiQType | String; Required | The type of FormKiQ installation Pattern: .+. |
FormKiQVersion | String; Required | The formkiq version Pattern: .+. |
LambdaMemory | Number; Default 1024 | The amount of memory used by lambda function (MB) Min: 128. Max: 3008. |
LambdaTimeout | String; Default 60 | The maximum amount of seconds lambda function will run for (seconds) |
LambdaArchitecture | String; Required | Lambda instruction set architecture Values: ["x86_64","arm64"]. |
CognitoUserPool | String; Required | The Cognito User Pool Id Pattern: .+. |
CognitoUserPoolClient | String; Required | The Cognito User Pool Client Id Pattern: .+. |
UserAuthentication | String; Default cognito | How are the users authenticating Pattern: .+. |
TypesenseApiKeySecretArn | String; 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:.+$. |
TypesenseApiEndpoint | String; Required | TypeSense API Endpoint |
DocumentsTableName | String; Required | Documents DynamoDB Table Name |
CacheTableName | String; Required | Cache DynamoDB Table Name |
DocumentSyncsTableName | String; Required | Document Syncs DynamoDB Table Name |
DocumentsS3Bucket | String; Required | Documents S3 Bucket Name |
DocumentsStageS3Bucket | String; Required | Documents Stage S3 Bucket Name |
SnsDocumentEventArn | String; Required | SNS Topic for Document Events |
OcrBucket | String; Required | Name of OCR Bucket |
OcrQueueUrl | String; Required | Name of OCR Queue Url |
OcrQueueArn | String; Required | Name of OCR Queue Arn |
VpcStackName | String; Required | FormKiQ VPC Stack Name |
EnablePublicUrls | String; Required | Whether to enable public urls |
LogRetentionInDays | Number; Required | The number of days to retain the log events |
LogFormat | String; Required | The format in which the application and system logs are stored. |
LogLevelApplication | String; Required | The level of logging for the FormKiQ Application logs. |
LogLevelSystem | String; Required | The level of logging for the AWS Platform System logs. |
OperationalMode | String; Default ACTIVE | Controls the runtime operational behavior of the FormKiQ environment. |
HttpsSecurityGroup | String; Required | VPC Https Security Group |
Outputs
| Name | Purpose |
|---|---|
DocumentsApiRequests | FormKiQ Api Request Handler |
DocumentsApiRequestsArn | FormKiQ 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
| Name | Type / default | Constraints and purpose |
|---|---|---|
AppEnvironment | String; Required | The FormKiQ Environment Pattern: .+. |
DocumentsApiRequestsArn | String; Required | Lambda to invoke |
OcrApiRequestsArn | String; Required | Lambda to invoke for Object examine endpoints |
CognitoUserPool | String; Required | The Cognito User Pool Id |
CognitoUserPoolClient | String; Required | The Cognito User Pool Client Id |
CertificateStackNameHttpApiDomain | String; Required | Certificate Http Api Domain |
Outputs
| Name | Purpose |
|---|---|
DocumentsHttpApi | HTTP API |
DocumentsHttpApiUrl | The 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
| Name | Type / default | Constraints and purpose |
|---|---|---|
AppEnvironment | String; Required | The FormKiQ Environment Pattern: .+. |
DocumentsApiRequestsArn | String; Required | Lambda to invoke |
OcrApiRequestsArn | String; Required | Lambda to invoke for Object examine endpoints |
CertificateStackNameIamApiDomain | String; Required | Certificate IAM Api Domain |
Outputs
| Name | Purpose |
|---|---|
DocumentsIamApi | IAM API |
DocumentsIamApiUrl | The 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
| Name | Type / default | Constraints and purpose |
|---|---|---|
AppEnvironment | String; Required | The FormKiQ Environment Pattern: .+. |
DocumentsApiRequestsArn | String; Required | Lambda to invoke |
OcrApiRequestsArn | String; Required | Lambda to invoke for Object examine endpoints |
FormKiQType | String; Required | The type of FormKiQ installation |
DocumentsTableName | String; Required | Documents DynamoDB Table Name |
LambdaMemory | Number; Default 1024 | The amount of memory used by lambda function (MB) Min: 128. Max: 3008. |
LambdaTimeout | String; Default 60 | The maximum amount of seconds lambda function will run for (seconds) |
LambdaArchitecture | String; Required | Lambda instruction set architecture Values: ["x86_64","arm64"]. |
LogRetentionInDays | Number; Required | The number of days to retain the log events |
LogFormat | String; Required | The format in which the application and system logs are stored. |
LogLevelApplication | String; Required | The level of logging for the FormKiQ Application logs. |
LogLevelSystem | String; Required | The level of logging for the AWS Platform System logs. |
VpcStackName | String; Required | FormKiQ VPC Stack Name |
CertificateStackNameKeyApiDomain | String; Required | Certificate Key Api Domain |
Outputs
| Name | Purpose |
|---|---|
DocumentsKeyApi | Key API |
DocumentsKeyApiUrl | The 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
| Name | Type / default | Constraints and purpose |
|---|---|---|
AppEnvironment | String; Required | The FormKiQ Environment Pattern: .+. |
DocumentsApiRequestsArn | String; Required | Lambda to invoke |
CognitoUserPool | String; Required | The Cognito User Pool Id |
CognitoUserPoolClient | String; Required | The Cognito User Pool Client Id |
CertificateStackNameUserAuthApiDomain | String; Required | Certificate User Auth Api Domain |
CertificateStackNameUserAuthCertificateArn | String; Default (empty string) | Certificate User Auth API ACM Certificate ARN |
CertificateStackNameHostedZoneId | String; Default (empty string) | Optional Route53 hosted zone for the User Auth API domain |
Outputs
| Name | Purpose |
|---|---|
AuthApi | User Auth API |
AuthApiUrl | The 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
| Name | Type / default | Constraints and purpose |
|---|---|---|
AppEnvironment | String; Required | The Application Environment Pattern: .+. |
VpcStackName | String; Required | FormKiQ VPC Stack Name |
LambdaMemory | Number; Default 2048 | The amount of memory used by lambda function (MB) Min: 128. Max: 3008. |
LambdaTimeout | String; Default 600 | The maximum amount of seconds lambda function will run for (seconds) |
FormKiQType | String; Required | The type of FormKiQ installation |
OcrQueueArn | String; Required | The Ocr Queue Arn |
DocumentsTableName | String; Required | Documents DynamoDB Table Name |
DocumentsS3Bucket | String; Required | Documents S3 Bucket Name |
DocumentsStageS3Bucket | String; Required | Documents Stage S3 Bucket Name |
OcrBucket | String; Required | OCR S3 Bucket Name |
SnsDocumentEventArn | String; Required | SNS Topic for Document Events |
LogRetentionInDays | Number; Required | The number of days to retain the log events |
LogFormat | String; Required | The format in which the application and system logs are stored. |
LogLevelApplication | String; Required | The level of logging for the FormKiQ Application logs. |
LogLevelSystem | String; Required | The level of logging for the AWS Platform System logs. |
Outputs
| Name | Purpose |
|---|---|
OcrProcessor | Inspect the deployed output and owning template. |
OcrProcessorArn | Inspect 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
| Name | Type / default | Constraints and purpose |
|---|---|---|
AdminEmail | String; Required | Administrator Email Pattern: .+. |
AppEnvironment | String; Required | The Document Stack Environment Pattern: .+. |
CognitoUserPool | String; Required | The Cognito User Pool Id Pattern: .+. |
CognitoUserPoolArn | String; Required | The Cognito User Pool Arn Pattern: .+. |
CognitoIdentityPool | String; Required | Cognito Identity Pool Id Pattern: .+. |
CognitoUserPoolClient | String; Required | Cognito User Pool Client Pattern: .+. |
IsGovCloud | String; Required | Is Installation AWS Region gov cloud Values: ["true","false"]. |
Outputs
| Name | Purpose |
|---|---|
AdminGroupRoleArn | Inspect 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
| Name | Type / default | Constraints and purpose |
|---|---|---|
AppEnvironment | String; Required | The Application Environment Pattern: .+. |
TypesenseApiKeySecretArn | String; 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:.+$. |
VpcStackName | String; Required | FormKiQ VPC Stack Name |
CapacityProvider | String; Required | AWS Fargate capacity provider to use, either the FARGATE or FARGATE_SPOT |
Outputs
| Name | Purpose |
|---|---|
ECSCluster | ECS 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
| Name | Type / default | Constraints and purpose |
|---|---|---|
Image | String; Default typesense/typesense:0.25.1 | Version of Typesense to deploy |
AppEnvironment | String; Required | The Application Environment Pattern: .+. |
LambdaMemory | Number; Default 1024 | The amount of memory used by lambda function (MB) Min: 128. Max: 3008. |
LambdaTimeout | String; Default 60 | The maximum amount of seconds lambda function will run for (seconds) |
LambdaArchitecture | String; Required | Lambda instruction set architecture Values: ["x86_64","arm64"]. |
FormKiQType | String; Required | The type of FormKiQ installation |
TypesenseApiKeySecretArn | String; 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:.+$. |
TypesenseMemory | String; Default 1024 | The amount of memory used by Typesense Fargate Container function (GB) Values: ["1024","2048","3072","4096","5120","6144","7168","8192","16384","32768"]. |
VpcStackName | String; Required | FormKiQ VPC Stack Name |
ECSCluster | String; Required | Reference to the ECSCluster |
DocumentsTableName | String; Required | Documents DynamoDB Table Name |
DocumentSyncsTableName | String; Required | Document Syncs DynamoDB Table Name |
DocumentsStreamArn | String; Required | Documents DynamoDB Stream Arn |
LogRetentionInDays | Number; Required | The number of days to retain the log events |
LogFormat | String; Required | The format in which the application and system logs are stored. |
LogLevelApplication | String; Required | The level of logging for the FormKiQ Application logs. |
LogLevelSystem | String; Required | The level of logging for the AWS Platform System logs. |
Outputs
| Name | Purpose |
|---|---|
CloudMapServiceArn | Cloud Map Service |
TypesenseApiEndpoint | Typesense 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
| Name | Type / default | Constraints and purpose |
|---|---|---|
AppEnvironment | String; Required | Unique Application Environment Identifier, IE dev/staging/prod Pattern: .+. |
DocumentsApiRequests | String; Required | Documents API Lambda Function Name |
DocumentsUpdateObject | String; Required | Documents Update Object Lambda Function Name |
StagingCreateObject | String; Required | Staging Create Object Lambda Function Name |
DocumentActionsProcessor | String; Required | Document Actions Processor Lambda Function Name |
DocumentsHttpApi | String; Required | Documents HTTP API Id |
DocumentsIamApi | String; Required | Documents IAM API Id |
UserAuthApiUrl | String; Required | User Auth API Url |
DocumentsDeadLetterQueueName | String; Required | Documents Dead Letter Queue Name |
Outputs
| Name | Purpose |
|---|---|
DashboardURL | Dashboard URL |
Commercial: Main
Source: Licensed 1.19.2 distribution: Licensed FormKiQ 1.19.2 template
SHA-256: 10901c3e27ea7f75f42e1b7d82cfa3aee45332ac4eff44da0dea585e1edbfc49
Parameters
| Name | Type / default | Constraints and purpose |
|---|---|---|
ConsoleWafACLId | String; Default (empty string) | ARN of the Console WAF WebACL to associate with the CloudFront distribution |
AdminEmail | String; Required | Administrator Email (required) Pattern: .+. |
AppEnvironment | String; Default prod | Unique Application Environment Identifier, IE dev/staging/prod Pattern: [a-zA-Z0-9_.-/]+. |
EnablePublicUrls | String; Default false | Whether 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"]. |
PasswordMinimumLength | Number; Default 8 | Set the Amazon Cognito password policies, minimum password length requirement for all users Min: 6. Max: 99. |
PasswordRequireLowercase | String; Default false | Set the Amazon Cognito password policies, to require one lowercase letter in all passwords. Values: ["true","false"]. |
PasswordRequireNumbers | String; Default false | Set the Amazon Cognito password policies, to require one number in all passwords. Values: ["true","false"]. |
PasswordRequireSymbols | String; Default false | Set the Amazon Cognito password policies, to require one symbol in all passwords. Values: ["true","false"]. |
PasswordRequireUppercase | String; Default false | Set the Amazon Cognito password policies, to require one uppercase letter in all passwords. Values: ["true","false"]. |
TokenAccessIdValidityMinutes | Number; Default 1440 | The time limit in minutes, after which the access and ID tokens are no longer valid and cannot be used. Min: 5. Max: 1440. |
TokenRefreshValidityMinutes | Number; Default 43200 | The time limit in minutes, after which the refresh token is no longer valid and cannot be used. Min: 60. Max: 5256000. |
VpcStackName | String; Default (empty string) | The name of the FormKiQ VPC Stack Name |
CapacityProvider | String; Default FARGATE_SPOT | AWS Fargate capacity provider to use, either the FARGATE or FARGATE_SPOT Values: ["FARGATE_SPOT","FARGATE"]. |
LogRetentionInDays | Number; Default 90 | The 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]. |
LogFormat | String; Default Text | The format in which the application and system logs are stored. Values: ["Text","JSON"]. |
LogLevelApplication | String; Default INFO | The level of logging for the FormKiQ Application logs. Only used when LogFormat is JSON Values: ["TRACE","DEBUG","INFO","ERROR"]. |
LogLevelSystem | String; Default INFO | The level of logging for the AWS Platform System logs. Only used when LogFormat is JSON Values: ["DEBUG","INFO","WARN"]. |
EnableDeletionProtection | String; Default false | Enable deletion protection on AWS Services that support the feature Values: ["true","false"]. |
UserPoolTier | String; Default LITE | Cognito 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"]. |
EnableCloudFrontAccessLogs | String; Default false | Enable 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"]. |
EnableS3AccessLogs | String; Default false | Enable server access logs for console, Cognito configuration, documents, staging, and OCR buckets, and create a dedicated logging bucket. Values: ["true","false"]. |
CertificateStackName | String; Default (empty string) | The name of the FormKiQ Certificate Stack Name |
EnableS3TransferAcceleration | String; Default false | Enable opt-in S3 Transfer Acceleration for documents bucket URLs (additional transfer charges apply) Values: ["true","false"]. |
OpenSearchStackName | String; Default (empty string) | The name of the FormKiQ Open Search Stack Name |
OpenSearchIndexPrefix | String; Default formkiq_ | The string appended to the beginning of the OpenSearch Index Name |
ProvisionedConcurrencyDocumentGeneration | Number; Default 0 | The amount of provisioned concurrency to allocate for Document Generation Lambda Min: 0. |
CognitoSingleSignOnUrl | String; Default (empty string) | The Cognito Hosted UI URL to allow Single Sign-On |
SitePermissions | String; Default automatic | The 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"]. |
SamlProvider | String; 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"]. |
OperationalMode | String; Default ACTIVE | Controls 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"]. |
PermissionsBoundaryArn | String; 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
| Name | Purpose |
|---|---|
AppEnvironment | Unique Application Environment Identifier, IE dev/staging/prod |
IamApiUrl | The URL for the API endpoint that uses IAM authorization |
KeyApiUrl | The URL for the API endpoint that uses API Key authorization |
HttpApiUrl | The URL for the API endpoint that uses Cognito authorization |
AuthApiUrl | The endpoint url for the User Auth API |
ConsoleUrl | The URL for the FormKiQ Console |
ConsoleS3Bucket | The Console S3 Bucket |
CognitoUserPoolId | The Cognito User Pool Id |
CognitoUserPoolArn | The Cognito User Pool Arn |
CognitoClientId | The Cognito Client Id |
CognitoDomain | The Cognito Domain Url |
FormKiQVersion | The FormKiQ Version |
SnsDocumentEventArn | SNS Topic for Document Events |
DocumentsTableName | Document DynamoDb Table Name |
DocumentsTableArn | Document DynamoDb Table Arn |
DocumentsS3Buckets | Documents Bucket. |
DocumentsStageS3Bucket | Documents Staging Bucket. |
ShortlinksApiUrl | The endpoint url for the Shortlinks API |
DriveCognitoClientId | The Cognito Client Id for the Drive app client |
DriveAuthorizeUrl | The Cognito OAuth2 authorization URL for the Drive app client |
DriveLoginUrl | The 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
| Name | Type / default | Constraints and purpose |
|---|---|---|
FormKiQType | String; Required | The formkiq type of installation Pattern: .+. |
FormKiQVersion | String; Required | The formkiq version Pattern: .+. |
LambdaArchitecture | String; Required | Lambda instruction set architecture for this build artifact Values: ["x86_64","arm64"]. |
VpcStackName | String; Required | 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. |
Outputs
| Name | Purpose |
|---|---|
FormKiQType | The FormKiQ type of installation |
FormKiQVersion | The FormKiQ version |
LambdaArchitecture | Lambda instruction set architecture for this build artifact |
HttpsSecurityGroup | VPC Https Security Group |
Commercial: Main/CoreStorage · Commercial: template-upgrade/CoreStorage
Source: Licensed 1.19.2 distribution: a02d1a4144dbc1506cea3451e4d0af36.template
SHA-256: c6226603eb2979c98caec5ebbc780d960ac253ac0bc9ac3eb6b7829077ec4abc
Parameters
| Name | Type / default | Constraints and purpose |
|---|---|---|
S3AccessLogsBucketName | String; 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. |
EnableS3TransferAcceleration | String; Default false | Enable opt-in S3 Transfer Acceleration for documents bucket URLs (additional transfer charges apply) Values: ["true","false"]. |
AppEnvironment | String; Required | The Application Environment Pattern: .+. |
LambdaMemory | Number; Default 1024 | The amount of memory used by lambda function (MB) Min: 128. Max: 3008. |
LambdaTimeout | String; Default 60 | The maximum amount of seconds lambda function will run for (seconds) |
LambdaArchitecture | String; Required | Lambda instruction set architecture Values: ["x86_64","arm64"]. |
FormKiQType | String; Required | The type of FormKiQ installation |
VpcStackName | String; Required | FormKiQ VPC Stack Name |
TypesenseApiKeySecretArn | String; 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:.+$. |
DocumentEventsBus | String; Default (empty string) | Name EventBridge Event Bus |
LogRetentionInDays | Number; Required | The number of days to retain the log events |
LogFormat | String; Required | The format in which the application and system logs are stored. |
LogLevelApplication | String; Required | The level of logging for the FormKiQ Application logs. |
LogLevelSystem | String; Required | The level of logging for the AWS Platform System logs. |
EnableDeletionProtection | String; Required | Enable deletion protection on AWS Services that support the feature |
OperationalMode | String; Default ACTIVE | Controls the runtime operational behavior of the FormKiQ environment. |
OpenSearchStackName | String; Default (empty string) | The name of the FormKiQ Open Search Stack Name |
KmsKeyArn | String; Required | KMS Key Arn Pattern: .+. |
PermissionsBoundaryArn | String; Default (empty string) |
Outputs
| Name | Purpose |
|---|---|
DocumentsTableName | Documents DynamoDb Table Name. |
DocumentsTableArn | Documents DynamoDb Table Arn. |
DocumentsStreamArn | Documents DynamoDb Table Stream Arn. |
DocumentSyncsTableName | Inspect the deployed output and owning template. |
CacheTableName | Inspect the deployed output and owning template. |
DocumentsS3Buckets | Documents Bucket. |
DocumentsStageS3Bucket | Documents Staging Bucket. |
DocumentsUpdateQueueUrl | Documents Update Documents Queue Url |
DocumentsUpdateQueueArn | Documents S3 Update Documents Queue Arn |
DocumentsDeadLetterQueueArn | Documents Dead Letter Queue Arn |
DocumentsDeadLetterQueueName | Documents Dead Letter Queue Name |
SnsDocumentEventArn | SNS Topic for Document Events |
DocumentsS3Update | Documents MetaData Object Lambda |
StagingCreateObject | Documents Staging Create Object Lambda |
DocumentsUpdateObject | Documents Update Object Lambda |
DocumentActionsProcessor | Document Actions Processor Lambda |
DocumentVersionsTableName | Inspect the deployed output and owning template. |
DocumentAuditsTableName | Inspect 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
| Name | Type / default | Constraints and purpose |
|---|---|---|
CloudFrontAccessLogsBucketName | String; 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. |
S3AccessLogsBucketName | String; 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. |
WAFWebACLId | String; Default (empty string) | (Optional) ARN of the AWS WAF WebACL to associate with the CloudFront distribution. Leave empty to disable. |
AdminEmail | String; Required | Administrator Email Pattern: .+. |
AppEnvironment | String; Required | The Document Stack Environment Pattern: .+. |
Domain | String; Required | Amazon Cognito domain to use (include full domain if CertificateArn used) |
ConsoleVersion | String; Default v4.3.7 | Version of FormKiQ console to deploy |
CognitoConfigBucket | String; Required | Cognito Config S3 Bucket |
FormKiQType | String; Required | The type of FormKiQ installation |
CertificateStackName | String; Default (empty string) | The name of the FormKiQ Certificate Stack Name |
CertificateStackNameDomainName | String; Default _ | The name of the FormKiQ Certificate Stack Name Domain Name |
IsGovCloud | String; Required | Is Installation AWS Region gov cloud Values: ["true","false"]. |
ApiUrl | String; Required | JWT API URL |
IamApiUrl | String; Required | IAM API URL |
KeyApiUrl | String; Required | Key API URL |
AuthApiUrl | String; Required | Auth Api URL |
DocumentsTableName | String; Required | Document DynamoDb Table Name |
Brand | String; Default formkiq | Console Installer Brand |
AllowAdminCreateUserOnly | String; Required | When true only Cognito Admin can create users, false users can register themselves Pattern: .+. |
CognitoHostedUi | String; Required | Amazon Cognito Hosted UI Url Pattern: .+. |
DriveAuthorizeUrl | String; Default (empty string) | The Cognito OAuth2 authorization URL for the Drive app client |
DriveCognitoUserPoolClientId | String; Default (empty string) | The Cognito User Pool Client Id for the Drive app client |
CognitoUserPoolId | String; Required | The Cognito User Pool Id Pattern: .+. |
CognitoUserPoolClientId | String; Required | The Cognito User Pool Client Id Pattern: .+. |
UserAuthentication | String; Default cognito | How are the users authenticating Pattern: .+. |
LogFormat | String; Required | The format in which the application and system logs are stored. |
LogLevelApplication | String; Required | The level of logging for the FormKiQ Application logs. Only used when LogFormat is JSON |
LogLevelSystem | String; Required | The level of logging for the AWS Platform System logs. Only used when LogFormat is JSON |
LogRetentionInDays | Number; Required | The number of days to retain the log events |
LambdaArchitecture | String; Required | Lambda instruction set architecture Values: ["x86_64","arm64"]. |
CognitoSingleSignOnUrl | String; Default (empty string) | The Cognito Hosted UI URL to allow Single Sign-On |
Outputs
| Name | Purpose |
|---|---|
ConsoleUrl | Console URL |
ConsoleBucket | Inspect the deployed output and owning template. |
ConsoleVersion | Inspect the deployed output and owning template. |
HostedZoneId | Inspect the deployed output and owning template. |
CloudFrontDistributionDomainName | Inspect 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
| Name | Type / default | Constraints and purpose |
|---|---|---|
S3AccessLogsBucketName | String; 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. |
AppEnvironment | String; Default (empty string) | Unique Application Environment Identifier, IE dev/staging/prod |
UserPoolTier | String; Default LITE | User pool feature plan (tier). Values: ["LITE","ESSENTIALS","PLUS"]. |
UserPoolName | String; Required | Name of the User Pool. Pattern: .+. |
AllowAdminCreateUserOnly | String; Default false | Values: ["true","false"]. |
PasswordMinimumLength | Number; Default 8 | The minimum password length. Min: 6. Max: 99. |
PasswordRequireLowercase | String; Default true | Password requires at least one lowercase letter. Values: ["true","false"]. |
PasswordRequireNumbers | String; Default true | Password requires at least one number. Values: ["true","false"]. |
PasswordRequireSymbols | String; Default true | Password requires at least one symbol. Values: ["true","false"]. |
PasswordRequireUppercase | String; Default true | Password requires at least one uppercase letter. Values: ["true","false"]. |
Domain | String; Required | Amazon Cognito domain to use (include full domain if CertificateArn used) Pattern: .+. |
DomainCertificateArn | String; Default (empty string) | Amazon Cognito Certificate ARN to use |
SesSourceArn | String; Default (empty string) | The Amazon Resource Name (ARN) of a verified email address in Amazon SES |
ReplyToEmailAddress | String; Default (empty string) | The destination to which the receiver of the email should reply to |
AccessTokenValidity | Number; Default 1440 | The time limit in minutes, after which the access token is no longer valid and cannot be used. Min: 5. Max: 1440. |
IdTokenValidity | Number; Default 1440 | The time limit in minutes, after which the ID token is no longer valid and cannot be used. Min: 5. Max: 1440. |
RefreshTokenValidity | Number; Default 43200 | The time limit in minutes, after which the refresh token is no longer valid and cannot be used. Min: 60. Max: 5256000. |
LogRetentionInDays | Number; Default 90 | The 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]. |
LogFormat | String; Default Text | The format in which the application and system logs are stored. Values: ["Text","JSON"]. |
LogLevelApplication | String; Default INFO | The level of logging for the FormKiQ Application logs. Only used when LogFormat is JSON Values: ["TRACE","DEBUG","INFO","ERROR"]. |
LogLevelSystem | String; Default INFO | The level of logging for the AWS Platform System logs. Only used when LogFormat is JSON Values: ["DEBUG","INFO","WARN"]. |
EnableDeletionProtection | String; Default false | Enable deletion protection on AWS Services that support the feature Values: ["true","false"]. |
LambdaArchitecture | String; Required | Lambda instruction set architecture Values: ["x86_64","arm64"]. |
DriveCognitoUserPoolClientName | String; Default FormKiQ Drive | Name of the Drive Cognito User Pool App Client. |
DriveCognitoCallbackUrls | CommaDelimitedList; Default com.formkiq.drive://oauth2/callback | Comma-delimited callback URLs for the Drive Cognito OAuth2 app client. |
SitePermissions | String; Required | The 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. |
SamlProvider | String; Required | |
DocumentsTableName | String; Required | Documents DynamoDB Table Name |
DocumentAuditsTableName | String; Required | Document Audits DynamoDB Table Name |
KmsKeyArn | String; Required | KMS Key Arn Pattern: .+. |
PermissionsBoundaryArn | String; Default (empty string) | |
OperationalMode | String; Required | Controls the runtime operational behavior of the FormKiQ environment |
Outputs
| Name | Purpose |
|---|---|
CognitoConfigBucket | The Cognito Config Bucket |
CognitoUserPoolId | The Cognito User Pool Id |
CognitoUserPoolProviderName | The Cognito User Pool Provider Name |
CognitoUserPoolProviderURL | The Cognito User Pool Provider URL |
CognitoUserPoolArn | The Cognito User Pool Arn |
CognitoUserPoolClientId | The Cognito User Pool Client Id |
CognitoIdentityPoolId | Cognito Identity Pool |
Domain | Amazon Cognito domain to use (include full domain if CertificateArn used) |
CognitoHostedUi | Amazon Cognito Hosted UI Url |
CognitoDomain | Amazon Cognito Domain |
DriveCognitoUserPoolClientId | The 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
| Name | Type / default | Constraints and purpose |
|---|---|---|
EnableS3TransferAcceleration | String; Default false | Enable opt-in S3 Transfer Acceleration for documents bucket URLs (additional transfer charges apply) Values: ["true","false"]. |
AppEnvironment | String; Required | The FormKiQ Environment Pattern: .+. |
FormKiQType | String; Required | The type of FormKiQ installation Pattern: .+. |
FormKiQVersion | String; Required | The formkiq version Pattern: .+. |
LambdaMemory | Number; Default 1024 | The amount of memory used by lambda function (MB) Min: 128. Max: 3008. |
LambdaTimeout | String; Default 60 | The maximum amount of seconds lambda function will run for (seconds) |
LambdaArchitecture | String; Required | Lambda instruction set architecture Values: ["x86_64","arm64"]. |
EnablePublicUrls | String; Default false | Whether to enable public urls Values: ["true","false"]. |
AllowAdminCreateUserOnly | String; Default true | Values: ["true","false"]. |
PasswordMinimumLength | Number; Default 8 | The minimum password length. Min: 6. Max: 99. |
PasswordRequireLowercase | String; Default false | Password requires at least one lowercase letter. Values: ["true","false"]. |
PasswordRequireNumbers | String; Default false | Password requires at least one number. Values: ["true","false"]. |
PasswordRequireSymbols | String; Default false | Password requires at least one symbol. Values: ["true","false"]. |
PasswordRequireUppercase | String; Default false | Password requires at least one uppercase letter. Values: ["true","false"]. |
CognitoUserPool | String; Required | The Cognito User Pool Id Pattern: .+. |
CognitoUserPoolClient | String; Required | The Cognito User Pool Client Id Pattern: .+. |
UserAuthentication | String; Default cognito | How are the users authenticating Pattern: .+. |
TypesenseApiKeySecretArn | String; 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:.+$. |
TypesenseApiEndpoint | String; Required | TypeSense API Endpoint |
DocumentsTableName | String; Required | Documents DynamoDB Table Name |
CacheTableName | String; Required | Cache DynamoDB Table Name |
DocumentSyncsTableName | String; Required | Document Syncs DynamoDB Table Name |
DocumentsS3Bucket | String; Required | Documents S3 Bucket Name |
DocumentsStageS3Bucket | String; Required | Documents Stage S3 Bucket Name |
SnsDocumentEventArn | String; Required | SNS Topic for Document Events |
DocumentsDeadLetterQueueArn | String; Required | Documents Dead Letter Queue Arn |
VpcStackName | String; Required | FormKiQ VPC Stack Name |
CertificateStackName | String; Default (empty string) | The name of the FormKiQ Certificate Stack Name |
HttpsSecurityGroup | String; Default (empty string) | VPC Https Security Group |
LogRetentionInDays | Number; Required | The number of days to retain the log events |
LogFormat | String; Required | The format in which the application and system logs are stored. |
LogLevelApplication | String; Required | The level of logging for the FormKiQ Application logs. |
LogLevelSystem | String; Required | The level of logging for the AWS Platform System logs. |
CertificateStackNameShortlinksApiDomain | String; Default (empty string) | Certificate Shortlinks Api Domain |
CertificateStackNameHttpApiDomain | String; Default (empty string) | Certificate Http Api Domain |
CertificateStackNameIamApiDomain | String; Default (empty string) | Certificate IAM Api Domain |
CertificateStackNameKeyApiDomain | String; Default (empty string) | Certificate Key Api Domain |
OperationalMode | String; Default ACTIVE | Controls the runtime operational behavior of the FormKiQ environment |
CertificateStackNameUserAuthApiDomain | String; Default (empty string) | Certificate User Auth API Domain |
CertificateStackNameUserAuthCertificateArn | String; Default (empty string) | Certificate User Auth API ACM Certificate ARN |
CertificateStackNameHostedZoneId | String; Default (empty string) | Optional Route53 hosted zone for the User Auth API domain |
S3AccessLogsBucketName | String; 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. |
DocumentVersionsTableName | String; Required | Document Versions DynamoDB Table Name |
DocumentAuditsTableName | String; Required | Document Audits DynamoDB Table Name |
SitePermissions | String; Default automatic | The 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"]. |
OpenSearchStackName | String; Required | The name of the FormKiQ Open Search Stack Name |
OpenSearchIndexPrefix | String; Required | The string appended to the beginning of the OpenSearch Index Name |
DocumentsStreamArn | String; Required | Documents DynamoDB Stream Arn |
DriveCognitoUserPoolClient | String; Required | The Drive Cognito User Pool Client Id |
ProvisionedConcurrencyDocumentGeneration | Number; Default 0 | The amount of provisioned concurrency to allocate for Document Generation Lambda Min: 0. |
KmsKeyArn | String; Required | KMS Key Arn Pattern: .+. |
PermissionsBoundaryArn | String; Default (empty string) |
Outputs
| Name | Purpose |
|---|---|
ApiGatewayInvokeRole | API Gateway Role that allows invoking of endpoints |
ApiGatewayInvokeRoleArn | API Gateway Role Arn that allows invoking of endpoints |
DocumentsApiRequests | FormKiQ Api Request Handler |
DocumentsHttpApi | HTTP API |
DocumentsIamApi | IAM API |
DocumentsIamApiUrl | The endpoint url for the IAM API |
DocumentsKeyApiUrl | The endpoint url for the Key API |
DocumentsHttpApiUrl | The endpoint url for the Http API |
AuthApiUrl | The endpoint url for the Auth API |
OcrBucket | Inspect the deployed output and owning template. |
OcrQueue | Inspect the deployed output and owning template. |
OcrQueueUrl | Inspect the deployed output and owning template. |
OcrQueueArn | Inspect the deployed output and owning template. |
ShortlinksApiUrl | The endpoint url for the Shortlinks API |
AmazonTextract | Inspect the deployed output and owning template. |
OcrLambdaLambda | Inspect the deployed output and owning template. |
FulltextLambda | Inspect the deployed output and owning template. |
FulltextLambdaArn | Inspect the deployed output and owning template. |
FulltextLambdaRoleArn | Inspect the deployed output and owning template. |
FulltextDynamodbStreamsLambdaRoleArn | Inspect 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
| Name | Type / default | Constraints and purpose |
|---|---|---|
EnableS3TransferAcceleration | String; Default false | Enable opt-in S3 Transfer Acceleration for documents bucket URLs (additional transfer charges apply) Values: ["true","false"]. |
AppEnvironment | String; Required | The FormKiQ Environment Pattern: .+. |
FormKiQType | String; Required | The type of FormKiQ installation Pattern: .+. |
FormKiQVersion | String; Required | The formkiq version Pattern: .+. |
LambdaMemory | Number; Default 1024 | The amount of memory used by lambda function (MB) Min: 128. Max: 3008. |
LambdaTimeout | String; Default 60 | The maximum amount of seconds lambda function will run for (seconds) |
LambdaArchitecture | String; Required | Lambda instruction set architecture Values: ["x86_64","arm64"]. |
CognitoUserPool | String; Required | The Cognito User Pool Id Pattern: .+. |
CognitoUserPoolClient | String; Required | The Cognito User Pool Client Id Pattern: .+. |
UserAuthentication | String; Default cognito | How are the users authenticating Pattern: .+. |
TypesenseApiKeySecretArn | String; 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:.+$. |
TypesenseApiEndpoint | String; Required | TypeSense API Endpoint |
DocumentsTableName | String; Required | Documents DynamoDB Table Name |
CacheTableName | String; Required | Cache DynamoDB Table Name |
DocumentSyncsTableName | String; Required | Document Syncs DynamoDB Table Name |
DocumentsS3Bucket | String; Required | Documents S3 Bucket Name |
DocumentsStageS3Bucket | String; Required | Documents Stage S3 Bucket Name |
SnsDocumentEventArn | String; Required | SNS Topic for Document Events |
OcrBucket | String; Required | Name of OCR Bucket |
OcrQueueUrl | String; Required | Name of OCR Queue Url |
OcrQueueArn | String; Required | Name of OCR Queue Arn |
VpcStackName | String; Required | FormKiQ VPC Stack Name |
EnablePublicUrls | String; Required | Whether to enable public urls |
LogRetentionInDays | Number; Required | The number of days to retain the log events |
LogFormat | String; Required | The format in which the application and system logs are stored. |
LogLevelApplication | String; Required | The level of logging for the FormKiQ Application logs. |
LogLevelSystem | String; Required | The level of logging for the AWS Platform System logs. |
OperationalMode | String; Default ACTIVE | Controls the runtime operational behavior of the FormKiQ environment |
HttpsSecurityGroup | String; Required | VPC Https Security Group |
DocumentsDeadLetterQueueArn | String; Required | Documents Dead Letter Queue Arn |
DocumentVersionsTableName | String; Required | Document Versions DynamoDB Table Name |
DocumentAuditsTableName | String; Required | Document Audits DynamoDB Table Name |
SitePermissions | String; Default automatic | The 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"]. |
OpenSearchStackName | String; Required | The name of the FormKiQ Open Search Stack Name |
OpenSearchDomainType | String; Required | Open Search Service Domain Type |
OpenSearchIndexPrefix | String; Required | The string appended to the beginning of the OpenSearch Index Name |
KmsKeyArn | String; Required | KMS Key Arn Pattern: .+. |
PermissionsBoundaryArn | String; Default (empty string) |
Outputs
| Name | Purpose |
|---|---|
DocumentsApiRequests | FormKiQ Api Request Handler |
DocumentsApiRequestsArn | FormKiQ Api Request Handler Arn |
FulltextLambda | FormKiQ Fulltext Request Handler |
FulltextLambdaArn | FormKiQ Fulltext Request Handler Arn |
FulltextLambdaRoleArn | FormKiQ Fulltext Lambda Role Arn |
IntelligentDataClassificationArn | Intelligent 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
| Name | Type / default | Constraints and purpose |
|---|---|---|
AppEnvironment | String; Required | The FormKiQ Environment Pattern: .+. |
DocumentsTableName | String; Required | Documents DynamoDB Table Name |
DocumentSyncsTableName | String; Required | Document Syncs DynamoDB Table Name |
DocumentsS3Bucket | String; Required | Documents S3 Bucket Name |
DocumentsStageS3Bucket | String; Required | Documents Stage S3 Bucket Name |
LambdaMemory | Number; Default 1024 | The amount of memory used by lambda function (MB) Min: 128. Max: 3008. |
LambdaTimeout | String; Default 180 | The maximum amount of seconds lambda function will run for (seconds) |
LogRetentionInDays | Number; Required | The number of days to retain the log events |
LogFormat | String; Required | The format in which the application and system logs are stored. |
LogLevelApplication | String; Required | The level of logging for the FormKiQ Application logs. |
LogLevelSystem | String; Required | The level of logging for the AWS Platform System logs. |
KmsKeyArn | String; Required | KMS Key Arn Pattern: .+. |
PermissionsBoundaryArn | String; Default (empty string) | |
OperationalMode | String; Required | Controls the runtime operational behavior of the FormKiQ environment |
Outputs
| Name | Purpose |
|---|---|
WatermarkFunctionArn | Inspect the deployed output and owning template. |
WatermarkFunctionUrl | Inspect the deployed output and owning template. |
S3ObjectRequestsArn | Inspect 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
| Name | Type / default | Constraints and purpose |
|---|---|---|
AppEnvironment | String; Required | The Application Environment Pattern: .+. |
DocumentsTableName | String; Required | Documents DynamoDB Table Name |
DocumentsS3Bucket | String; Required | Documents S3 Bucket Name |
SnsDocumentEventArn | String; Required | SNS Topic for Document Events |
LambdaMemory | Number; Default 1024 | The amount of memory used by lambda function (MB) Min: 128. Max: 3008. |
LambdaTimeout | String; Default 60 | The maximum amount of seconds lambda function will run for (seconds) |
FormKiQType | String; Required | The type of FormKiQ installation |
LogRetentionInDays | Number; Required | The number of days to retain the log events |
LogFormat | String; Required | The format in which the application and system logs are stored. |
LogLevelApplication | String; Required | The level of logging for the FormKiQ Application logs. |
LogLevelSystem | String; Required | The level of logging for the AWS Platform System logs. |
KmsKeyArn | String; Required | KMS Key Arn Pattern: .+. |
PermissionsBoundaryArn | String; Default (empty string) | |
OperationalMode | String; Required | Controls the runtime operational behavior of the FormKiQ environment |
Outputs
| Name | Purpose |
|---|---|
IntelligentDataClassificationArn | Inspect 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
| Name | Type / default | Constraints and purpose |
|---|---|---|
AppEnvironment | String; Required | The FormKiQ Environment Pattern: .+. |
DocumentsApiRequestsArn | String; Required | Lambda to invoke |
OcrApiRequestsArn | String; Required | Lambda to invoke for Object examine endpoints |
CognitoUserPool | String; Required | The Cognito User Pool Id |
CognitoUserPoolClient | String; Required | The Cognito User Pool Client Id |
CertificateStackNameHttpApiDomain | String; Required | Certificate Http Api Domain |
OcrLambdaArn | String; Required | Lambda to invoke for OCR endpoints |
ClamAvScanLambdaArn | String; Required | Lambda to invoke for ClamAv |
EsignatureLambdaArn | String; Required | Lambda to invoke for Esignature |
FulltextLambdaArn | String; Required | Lambda to invoke for Fulltext endpoints |
DriveCognitoUserPoolClient | String; Required | The Drive Cognito User Pool Client Id |
DocumentGenerationLambdaArn | String; Required | Lambda to invoke for Document Generation endpoints |
DocumentCertificationsLambdaArn | String; Required | Lambda to invoke for Document Certifications endpoints |
IntelligentDataClassificationArn | String; Required | Lambda to invoke for Idc endpoints |
Outputs
| Name | Purpose |
|---|---|
DocumentsHttpApi | HTTP API |
DocumentsHttpApiUrl | The 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
| Name | Type / default | Constraints and purpose |
|---|---|---|
AppEnvironment | String; Required | The FormKiQ Environment Pattern: .+. |
DocumentsApiRequestsArn | String; Required | Lambda to invoke |
OcrApiRequestsArn | String; Required | Lambda to invoke for Object examine endpoints |
CertificateStackNameIamApiDomain | String; Required | Certificate IAM Api Domain |
OcrLambdaArn | String; Required | Lambda to invoke for OCR endpoints |
ClamAvScanLambdaArn | String; Required | Lambda to invoke for ClamAv endpoints |
EsignatureLambdaArn | String; Required | Lambda to invoke for Esignature endpoints |
FulltextLambdaArn | String; Required | Lambda to invoke for Fulltext endpoints |
DocumentGenerationLambdaArn | String; Required | Lambda to invoke for Document Generation endpoints |
DocumentCertificationsLambdaArn | String; Required | Lambda to invoke for Document Certifications endpoints |
IntelligentDataClassificationArn | String; Required | Lambda to invoke for Intelligent Data ClassificationArn endpoints |
Outputs
| Name | Purpose |
|---|---|
DocumentsIamApi | IAM API |
DocumentsIamApiUrl | The 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
| Name | Type / default | Constraints and purpose |
|---|---|---|
AppEnvironment | String; Required | The FormKiQ Environment Pattern: .+. |
DocumentsApiRequestsArn | String; Required | Lambda to invoke |
OcrApiRequestsArn | String; Required | Lambda to invoke for Object examine endpoints |
FormKiQType | String; Required | The type of FormKiQ installation |
DocumentsTableName | String; Required | Documents DynamoDB Table Name |
LambdaMemory | Number; Default 1024 | The amount of memory used by lambda function (MB) Min: 128. Max: 3008. |
LambdaTimeout | String; Default 60 | The maximum amount of seconds lambda function will run for (seconds) |
LambdaArchitecture | String; Required | Lambda instruction set architecture Values: ["x86_64","arm64"]. |
LogRetentionInDays | Number; Required | The number of days to retain the log events |
LogFormat | String; Required | The format in which the application and system logs are stored. |
LogLevelApplication | String; Required | The level of logging for the FormKiQ Application logs. |
LogLevelSystem | String; Required | The level of logging for the AWS Platform System logs. |
VpcStackName | String; Required | FormKiQ VPC Stack Name |
CertificateStackNameKeyApiDomain | String; Required | Certificate Key Api Domain |
OcrLambdaArn | String; Required | Lambda to invoke for OCR endpoints |
ClamAvScanLambdaArn | String; Required | Lambda to invoke for ClamAv endpoints |
EsignatureLambdaArn | String; Required | Lambda to invoke for Esignature endpoints |
FulltextLambdaArn | String; Required | Lambda to invoke for Fulltext endpoints |
DocumentGenerationLambdaArn | String; Required | Lambda to invoke for Document Generation endpoints |
DocumentCertificationsLambdaArn | String; Required | Lambda to invoke for Document Certifications endpoints |
IntelligentDataClassificationArn | String; Required | Lambda to invoke for Idc endpoints |
KmsKeyArn | String; Required | KMS Key Arn Pattern: .+. |
PermissionsBoundaryArn | String; Default (empty string) | |
OperationalMode | String; Required | Controls the runtime operational behavior of the FormKiQ environment |
Outputs
| Name | Purpose |
|---|---|
DocumentsKeyApi | Key API |
DocumentsKeyApiUrl | The 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
| Name | Type / default | Constraints and purpose |
|---|---|---|
AppEnvironment | String; Required | The Application Environment Pattern: .+. |
VpcStackName | String; Required | FormKiQ VPC Stack Name |
LambdaMemory | Number; Default 2048 | The amount of memory used by lambda function (MB) Min: 128. Max: 3008. |
LambdaTimeout | String; Default 600 | The maximum amount of seconds lambda function will run for (seconds) |
FormKiQType | String; Required | The type of FormKiQ installation |
OcrQueueArn | String; Required | The Ocr Queue Arn |
DocumentsTableName | String; Required | Documents DynamoDB Table Name |
DocumentsS3Bucket | String; Required | Documents S3 Bucket Name |
DocumentsStageS3Bucket | String; Required | Documents Stage S3 Bucket Name |
OcrBucket | String; Required | OCR S3 Bucket Name |
SnsDocumentEventArn | String; Required | SNS Topic for Document Events |
LogRetentionInDays | Number; Required | The number of days to retain the log events |
LogFormat | String; Required | The format in which the application and system logs are stored. |
LogLevelApplication | String; Required | The level of logging for the FormKiQ Application logs. |
LogLevelSystem | String; Required | The level of logging for the AWS Platform System logs. |
TextractRoleArn | String; Required | The Textract IAM Role Arn |
AmazonTextractArn | String; Required | SNS Topic for Textract Events |
DocumentSyncsTableName | String; Required | Document Syncs DynamoDB Table Name |
KmsKeyArn | String; Required | KMS Key Arn Pattern: .+. |
PermissionsBoundaryArn | String; Default (empty string) | |
OperationalMode | String; Required | Controls the runtime operational behavior of the FormKiQ environment |
Outputs
| Name | Purpose |
|---|---|
OcrProcessor | Inspect the deployed output and owning template. |
OcrProcessorArn | Inspect 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
| Name | Type / default | Constraints and purpose |
|---|---|---|
AppEnvironment | String; Required | The FormKiQ Environment Pattern: .+. |
DocumentsApiRequestsArn | String; Required | Lambda to invoke |
CertificateStackNameShortlinksApiDomain | String; Default (empty string) | Certificate Shortlinks Api Domain |
LogRetentionInDays | Number; Required | The number of days to retain the log events |
Outputs
| Name | Purpose |
|---|---|
ShortlinksApi | Shortlinks API |
ShortlinksApiUrl | The 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
| Name | Type / default | Constraints and purpose |
|---|---|---|
OperationalMode | String; Required | Controls the runtime operational behavior of the FormKiQ environment |
AppEnvironment | String; Required | The FormKiQ Environment Pattern: .+. |
DocumentsTableName | String; Required | Documents DynamoDB Table Name |
DocumentSyncsTableName | String; Required | Document Syncs DynamoDB Table Name |
DocumentVersionsTableName | String; Required | Document Versions DynamoDB Table Name |
DocumentsS3Bucket | String; Required | Documents S3 Bucket Name |
SnsDocumentEventArn | String; Required | SNS Topic for Document Events |
DocumentsDeadLetterQueueArn | String; Required | Documents Dead Letter Queue Arn |
LambdaMemoryForClamAv | Number; Default 3008 | Memory (in MB) of the ClamAv Lambda - 1536 MB is recommended Min: 1024. Max: 10240. |
LambdaTimeoutForClamAv | String; Default 300 | The maximum amount of seconds ClamAv Lambda will run for |
VirusDefinitionsUpdateRate | String; Default rate(1 day) | The schedule for updating ClamAv Virus Definitions. Values: ["rate(1 day)","rate(6 hours)","rate(1 hour)"]. |
LogRetentionInDays | Number; Required | The number of days to retain the log events |
LogFormat | String; Required | The format in which the application and system logs are stored. |
LogLevelApplication | String; Required | The level of logging for the FormKiQ Application logs. |
LogLevelSystem | String; Required | The level of logging for the AWS Platform System logs. |
KmsKeyArn | String; Required | KMS Key Arn Pattern: .+. |
PermissionsBoundaryArn | String; Default (empty string) |
Outputs
| Name | Purpose |
|---|---|
ClamAvDefinitionsS3Bucket | Inspect the deployed output and owning template. |
ClamAvScanLambda | Inspect the deployed output and owning template. |
ClamAvScanLambdaArn | Inspect the deployed output and owning template. |
ClamAvScanLambdaRoleArn | Inspect 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
| Name | Type / default | Constraints and purpose |
|---|---|---|
AppEnvironment | String; Required | The FormKiQ Environment Pattern: .+. |
DocumentsTableName | String; Required | Documents DynamoDB Table Name |
CacheTableName | String; Required | Cache DynamoDB Table Name |
DocumentSyncsTableName | String; Required | Document Syncs DynamoDB Table Name |
DocumentVersionsTableName | String; Required | Document Versions DynamoDB Table Name |
DocumentsS3Bucket | String; Required | Documents S3 Bucket Name |
DocumentsStageS3Bucket | String; Required | Documents Stage S3 Bucket Name |
SnsDocumentEventArn | String; Required | SNS Topic for Document Events |
FormKiQType | String; Required | The type of FormKiQ installation Pattern: .+. |
LambdaMemory | Number; Default 1024 | The amount of memory used by lambda function (MB) Min: 128. Max: 3008. |
LambdaTimeout | String; Default 60 | The maximum amount of seconds lambda function will run for (seconds) |
LogRetentionInDays | Number; Required | The number of days to retain the log events |
LogFormat | String; Required | The format in which the application and system logs are stored. |
LogLevelApplication | String; Required | The level of logging for the FormKiQ Application logs. |
LogLevelSystem | String; Required | The level of logging for the AWS Platform System logs. |
KmsKeyArn | String; Required | KMS Key Arn Pattern: .+. |
PermissionsBoundaryArn | String; Default (empty string) | |
OperationalMode | String; Required | Controls the runtime operational behavior of the FormKiQ environment |
Outputs
| Name | Purpose |
|---|---|
EsignatureLambdaArn | Inspect 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
| Name | Type / default | Constraints and purpose |
|---|---|---|
AppEnvironment | String; Required | The Application Environment Pattern: .+. |
DocumentsTableName | String; Required | Documents DynamoDB Table Name |
DocumentSyncsTableName | String; Required | Document Syncs DynamoDB Table Name |
DocumentsStreamArn | String; Required | Documents DynamoDB Stream Arn |
DocumentsDeadLetterQueueArn | String; Required | Documents Dead Letter Queue Arn |
LambdaMemory | Number; Default 1024 | The amount of memory used by lambda function (MB) Min: 128. Max: 3008. |
LambdaTimeout | String; Default 60 | The maximum amount of seconds lambda function will run for (seconds) |
OpenSearchStackName | String; Required | The name of the FormKiQ Open Search Stack Name |
OpenSearchDomainType | String; Required | Open Search Service Domain Type |
OpenSearchIndexPrefix | String; Required | The string appended to the beginning of the OpenSearch Index Name |
VpcStackName | String; Required | FormKiQ VPC Stack Name |
LogRetentionInDays | Number; Required | The number of days to retain the log events |
LogFormat | String; Required | The format in which the application and system logs are stored. |
LogLevelApplication | String; Required | The level of logging for the FormKiQ Application logs. |
LogLevelSystem | String; Required | The level of logging for the AWS Platform System logs. |
HttpsSecurityGroup | String; Required | VPC Https Security Group |
KmsKeyArn | String; Required | KMS Key Arn Pattern: .+. |
PermissionsBoundaryArn | String; Default (empty string) | |
OperationalMode | String; Required | Controls the runtime operational behavior of the FormKiQ environment |
Outputs
| Name | Purpose |
|---|---|
FulltextDynamodbStreamsLambdaRoleArn | Inspect 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
| Name | Type / default | Constraints and purpose |
|---|---|---|
AppEnvironment | String; Required | The FormKiQ Environment Pattern: .+. |
DocumentsTableName | String; Required | Documents DynamoDB Table Name |
DocumentSyncsTableName | String; Required | Document Syncs DynamoDB Table Name |
DocumentVersionsTableName | String; Required | Document Versions DynamoDB Table Name |
DocumentsS3Bucket | String; Required | Documents S3 Bucket Name |
DocumentsStageS3Bucket | String; Required | Documents Stage S3 Bucket Name |
LambdaMemory | Number; Default 3008 | The amount of memory used by lambda function (MB) Min: 128. Max: 10240. |
LambdaTimeout | String; Default 60 | The maximum amount of seconds lambda function will run for (seconds) |
FormKiQType | String; Required | The type of FormKiQ installation Pattern: .+. |
DocumentGenerationEcrRepository | String; Default formkiq-prod | The ECR repository containing the Document Generation Lambda image Values: ["formkiq-prod","formkiq-dev"]. |
ProvisionedConcurrency | Number; Default 0 | The amount of provisioned concurrency to allocate for Document Generation Lambda Min: 0. |
LogRetentionInDays | Number; Required | The number of days to retain the log events |
LogFormat | String; Required | The format in which the application and system logs are stored. |
LogLevelApplication | String; Required | The level of logging for the FormKiQ Application logs. |
LogLevelSystem | String; Required | The level of logging for the AWS Platform System logs. |
KmsKeyArn | String; Required | KMS Key Arn Pattern: .+. |
PermissionsBoundaryArn | String; Default (empty string) | |
OperationalMode | String; Required | Controls the runtime operational behavior of the FormKiQ environment |
Outputs
| Name | Purpose |
|---|---|
DocumentGenerationLambdaArn | Inspect the deployed output and owning template. |
DocumentCertificationsLambdaArn | Inspect 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
| Name | Type / default | Constraints and purpose |
|---|---|---|
AdminEmail | String; Required | Administrator Email Pattern: .+. |
AppEnvironment | String; Required | The Document Stack Environment Pattern: .+. |
CognitoUserPool | String; Required | The Cognito User Pool Id Pattern: .+. |
CognitoUserPoolArn | String; Required | The Cognito User Pool Arn Pattern: .+. |
CognitoIdentityPool | String; Required | Cognito Identity Pool Id Pattern: .+. |
CognitoUserPoolClient | String; Required | Cognito User Pool Client Pattern: .+. |
IsGovCloud | String; Required | Is Installation AWS Region gov cloud Values: ["true","false"]. |
Outputs
| Name | Purpose |
|---|---|
AdminGroupRoleArn | Inspect 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
| Name | Type / default | Constraints and purpose |
|---|---|---|
AppEnvironment | String; Required | Unique Application Environment Identifier, IE dev/staging/prod Pattern: .+. |
DocumentsApiRequests | String; Required | Documents API Lambda Function Name |
DocumentsUpdateObject | String; Required | Documents Update Object Lambda Function Name |
StagingCreateObject | String; Required | Staging Create Object Lambda Function Name |
DocumentActionsProcessor | String; Required | Document Actions Processor Lambda Function Name |
DocumentsHttpApi | String; Required | Documents HTTP API Id |
DocumentsIamApi | String; Required | Documents IAM API Id |
UserAuthApiUrl | String; Required | User Auth API Url |
DocumentsDeadLetterQueueName | String; Required | Documents Dead Letter Queue Name |
KmsKeyArn | String; Required | KMS Key Arn Pattern: .+. |
Outputs
| Name | Purpose |
|---|---|
DashboardURL | Dashboard URL |
Commercial: Main/AccessLogs · Commercial: template-upgrade/AccessLogs
Source: Licensed 1.19.2 distribution: 905c69fc50b81b125f7fbfb34c19a05a.template
SHA-256: 1801db95c6d39be40394f59e47b8fc1daaacad2b73e5477bbdc0de9b5f2fc8d5
Parameters
| Name | Type / default | Constraints and purpose |
|---|---|---|
AppEnvironment | String; Required | The Application Environment |
KmsKeyArn | String; Required | Existing shared KMS key ARN Pattern: .+. |
EnableCloudFrontAccessLogs | String; Default false | Create the destination for CloudFront standard access logs (legacy) Values: ["true","false"]. |
EnableS3AccessLogs | String; Default false | Create the destination for S3 server access logs Values: ["true","false"]. |
Outputs
| Name | Purpose |
|---|---|
CloudFrontAccessLogsBucketName | CloudFront access log destination bucket Conditional. |
S3AccessLogsBucketName | S3 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
| Name | Type / default | Constraints and purpose |
|---|---|---|
AppEnvironment | String; Required | Unique Application Environment Identifier, IE dev/staging/prod Pattern: .+. |
Outputs
| Name | Purpose |
|---|---|
DocumentEventsBus | Name EventBridge Event Bus |
Commercial: Main/FulltextCognitoInstall · Commercial: template-upgrade/FulltextCognitoInstall
Source: Licensed 1.19.2 distribution: da366d456a9cd2c6cd4a8ff9561b37e2.template
SHA-256: 3375d773c7af373ab1cdde871d7768da32afaecd0b489bdb90ec78e530b71903
Parameters
| Name | Type / default | Constraints and purpose |
|---|---|---|
AppEnvironment | String; Required | The Document Stack Environment Pattern: .+. |
CognitoAdminGroupArn | String; Required | The ARN of the Cognito Admin Group Pattern: .+. |
UserPoolClientId | String; Required | The Cognito User Pool Client Id |
UserPoolId | String; Required | The Cognito User Pool Id |
IdentityPoolId | String; Required | The Cognito Identity Pool Id |
FormKiQType | String; Default enterprise | The type of FormKiQ installation Values: ["core","enterprise"]. |
LogRetentionInDays | Number; Required | The 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
| Name | Type / default | Constraints and purpose |
|---|---|---|
KeyPairName | AWS::EC2::KeyPair::KeyName; Required | Name of an existing public/private key pair, which allows you to securely connect to your instance after it launches. |
LatestAmiId | AWS::SSM::Parameter::Value<AWS::EC2::Image::Id>; Default /aws/service/ami-amazon-linux-latest/amzn2-ami-hvm-x86_64-gp2 | |
VpcStackName | String; Required | The name of the FormKiQ VPC Stack Name Pattern: .+. |
Outputs
| Name | Purpose |
|---|---|
BastionHostId | Bastion Host Id |
BastionPublicDnsName | Bastion Public Dns |
BastionPublicIp | Bastion 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
| Name | Type / default | Constraints and purpose |
|---|---|---|
EnableNatGateway | String; Default false | Enable a NAT Gateway for private subnets outbound internet access (requires public subnets) Values: ["false","true"]. |
EnableNetworkAcls | String; Default true | Enable 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"]. |
VpcLabel | String; Default formkiq | A Label for the VPC Pattern: .+. |
VpcCidr | String; Default 10.1.0.0/16 | VPC CIDR block Pattern: ^[0-9./\s]*. |
PublicSubnet1Cidr | String; Default 10.1.1.0/24 | Public Subnet1 CIDR block (optional leave empty to skip) |
PublicSubnet2Cidr | String; Default 10.1.2.0/24 | Public Subnet2 CIDR block (optional leave empty to skip) |
PublicSubnet3Cidr | String; Default 10.1.3.0/24 | Public Subnet3 CIDR block (optional leave empty to skip) |
PrivateSubnet1Cidr | String; Default 10.1.10.0/24 | Private Subnet1 CIDR block Pattern: ^[0-9./\s]*. |
PrivateSubnet2Cidr | String; Default 10.1.20.0/24 | Private Subnet2 CIDR block Pattern: ^[0-9./\s]*. |
PrivateSubnet3Cidr | String; Default 10.1.30.0/24 | Public Subnet3 CIDR block Pattern: ^[0-9./\s]*. |
EnableVpcEndpoints | String; Default false | Enable VPC Endpoints (S3, Dynamodb, SNS, SMS, Execute-Api) set to 'true' if using Opensearch Values: ["false","true"]. |
EnableVpcLinks | String; Default false | Enable VPC Links (needed for Typesense) Values: ["false","true"]. |
EnableVpcFlowLogs | String; Default false | Enable VPC Flow Logs (set to 'true' to enable) Values: ["false","true"]. |
VpcFlowLogsDestination | String; Default s3 | Destination for VPC Flow Logs. Options: s3, cloud-watch-logs Values: ["s3","cloud-watch-logs"]. |
FlowLogsRetentionInDays | Number; Default 30 | Retention 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
| Name | Purpose |
|---|---|
VpcFlowLogsBucket | Vpc Flow Logs S3 Bucket Conditional. |
Vpc | VPC Id |
VpcCidr | VPC Cidr |
PublicSubnet1 | Public Subnet 1 Conditional. |
PublicSubnet2 | Public Subnet 2 Conditional. |
PublicSubnet3 | Public Subnet 3 Conditional. |
PrivateSubnet1 | Private Subnet 1 |
PrivateSubnet2 | Private Subnet 2 |
PrivateSubnet3 | Private Subnet 3 |
PublicSubnets | VPC Public Subnets Conditional. |
PrivateSubnets | VPC Private Subnets |
CloudMapNamespace | Cloud Map Name Space Conditional. |
VpcLink | ApiGatewayV2 VPC Link Conditional. |
VpcLinkSecurityGroup | VPC Link Security Group Conditional. |
NatGatewayId | NAT Gateway Id Conditional. |
NatEipAllocationId | NAT 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
| Name | Type / default | Constraints and purpose |
|---|---|---|
VpcId | String; Required | The ID of the existing VPC (leave blank to create new vpc) |
VpcCidr | String; Required | VPC CIDR block |
NumberOfSubnets | Number; Default 3 | Number of private subnets and, when provided, public subnets to use Values: [2,3]. |
PublicSubnet1Id | String; Default (empty string) | Public Subnet 1 (optional) ID (starts with 'subnet-') |
PublicSubnet2Id | String; Default (empty string) | Public Subnet 2 (optional) ID (starts with 'subnet-') |
PublicSubnet3Id | String; Default (empty string) | Public Subnet 3 ID (only used with 3 subnets; optional when no public subnets are provided) |
PrivateSubnet1Id | String; Required | Private Subnet 1 ID (starts with 'subnet-') |
PrivateSubnet2Id | String; Required | Private Subnet 2 ID (starts with 'subnet-') |
PrivateSubnet3Id | String; Default (empty string) | Private Subnet 3 ID (starts with 'subnet-'; required when NumberOfSubnets is 3) |
EnableVpcEndpoints | String; Default false | Enable VPC Endpoints (S3, Dynamodb, SNS, SMS, Execute-Api) set to 'true' if using Opensearch Values: ["false","true"]. |
EnableVpcLinks | String; Default false | Enable VPC Links (needed for Typesense) Values: ["false","true"]. |
PrivateRouteTableId | CommaDelimitedList; Required | Private Route Table ID (starts with 'rtb-') |
Outputs
| Name | Purpose |
|---|---|
Vpc | VPC Id |
VpcCidr | VPC Cidr |
PublicSubnet1 | Public Subnet 1 Conditional. |
PublicSubnet2 | Public Subnet 2 Conditional. |
PublicSubnet3 | Public Subnet 3 Conditional. |
PrivateSubnet1 | Private Subnet 1 |
PrivateSubnet2 | Private Subnet 2 |
PrivateSubnet3 | Private Subnet 3 Conditional. |
PublicSubnets | VPC Public Subnets Conditional. |
PrivateSubnets | VPC Private Subnets |
CloudMapNamespace | Cloud Map Name Space Conditional. |
VpcLink | ApiGatewayV2 VPC Link Conditional. |
VpcLinkSecurityGroup | VPC Link Security Group Conditional. |
Commercial: backup
Source: Licensed 1.19.2 distribution: backup.yaml
SHA-256: b89650da3bddc3ace2b25f8e016e76277bea3239b32008bd16309c48aa16320f
Parameters
| Name | Type / default | Constraints and purpose |
|---|---|---|
AppEnvironment | String; 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. |
BackupVaultName | String; 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. |
BackupScheduleExpression | String; Default cron(0 5 * * ? *) | AWS cron expression that schedules backup jobs. The default runs every day at 05:00 UTC. |
BackupStartWindowMinutes | Number; Default 120 | Number 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. |
BackupCompletionWindowMinutes | Number; Default 480 | Number 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. |
BackupMoveToColdStorageAfterDays | Number; Default 30 | Number 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. |
BackupDeleteAfterDays | Number; Default 120 | Total 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. |
DestinationBackupVaultArn | String; 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. |
DestinationCopyDeleteAfterDays | Number; Default 120 | Number of days to retain copied recovery points in the destination Region. This value is used only when DestinationBackupVaultArn is specified. Min: 1. |
Outputs
| Name | Purpose |
|---|---|
BackupVaultName | Name of the AWS Backup vault storing recovery points. |
BackupPlanId | ID of the AWS Backup plan created by this template. |
BackupSelectionId | ID of the AWS Backup selection that targets tagged resources. |
Commercial: certificates
Source: Licensed 1.19.2 distribution: certificates.yaml
SHA-256: 5bfdffdf36fd0bcb8c59840eb12320ed8d172b0d1e4f1cd24007e30613a4eb83
Parameters
| Name | Type / default | Constraints and purpose |
|---|---|---|
ConsoleDomain | String; Default (empty string) | Domain for FormKiQ Console (eg: console.<domain>) |
HttpApiDomain | String; Default (empty string) | Domain for FormKiQ HTTP API (eg: api.<domain>) |
ShortlinksApiDomain | String; Default (empty string) | Domain for FormKiQ Shortlinks API (eg: api.<domain>) |
IamApiDomain | String; Default (empty string) | Domain for FormKiQ IAM API (eg: iamapi.<domain>) |
KeyApiDomain | String; Default (empty string) | Domain for FormKiQ Key API (eg: keyapi.<domain>) |
AuthApiDomain | String; Default (empty string) | Domain for FormKiQ Auth API (eg: auth.<domain>) |
HostedZoneId | String; Default (empty string) | (optional) Route53 Hosted Zone Id in which to add A record |
ConsoleCertificateArn | String; Default (empty string) | FormKiQ Console ACM Certificate ARN |
HttpCertificateArn | String; Default (empty string) | FormKiQ HTTP API ACM Certificate ARN |
IamCertificateArn | String; Default (empty string) | FormKiQ IAM API ACM Certificate ARN |
KeyCertificateArn | String; Default (empty string) | FormKiQ Key API ACM Certificate ARN |
AuthCertificateArn | String; Default (empty string) | FormKiQ Auth ACM Certificate ARN |
ShortlinksCertificateArn | String; Default (empty string) | FormKiQ Shortlinks ACM Certificate ARN |
Outputs
| Name | Purpose |
|---|---|
HttpApiDomain | Domain for FormKiQ HTTP API |
IamApiDomain | Domain for FormKiQ IAM API |
KeyApiDomain | Domain for FormKiQ Key API |
AuthApiDomain | Domain for FormKiQ Auth API (eg: auth.<domain>) |
ShortlinksApiDomain | Domain for FormKiQ Shortlinks API |
ConsoleDomain | Domain for FormKiQ Console |
ConsoleCertificateArn | FormKiQ Console ACM Certificate ARN |
HttpCertificateArn | FormKiQ HTTP API ACM Certificate ARN |
IamCertificateArn | FormKiQ IAM API ACM Certificate ARN |
KeyCertificateArn | FormKiQ Key API ACM Certificate ARN |
AuthCertificateArn | FormKiQ Auth ACM Certificate ARN |
ShortlinksCertificateArn | FormKiQ Shortlinks API ACM Certificate ARN |
HostedZoneId | (optional) Route53 Hosted Zone Id in which to add A record |
HttpApiDomainAliasTargetRoute53 | The Domain 'A' record AliasTarget for the HTTP Api endpoint to be used in Route53 |
IamApiDomainAliasTargetRoute53 | The Domain 'A' record AliasTarget for the IAM Api endpoint to be used in Route53 |
KeyApiDomainAliasTargetRoute53 | The Domain 'A' record AliasTarget for the Key Api endpoint to be used in Route53 |
ShortlinksApiDomainAliasTargetRoute53 | The 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
| Name | Type / default | Constraints and purpose |
|---|---|---|
SourceAccountId | String; Default 622653865277 | The AWS account ID of the source account that will replicate images Pattern: [0-9]{12}. |
SourceRepositoryName | String; Default formkiq-prod | The name of the source ECR repository that will replicate images into this repository |
RepositoryName | String; Default formkiq-prod | The name of the ECR repository that will be replicated into |
ImageTagMutability | String; Default IMMUTABLE | Use IMMUTABLE to prevent image tags from being overwritten, or MUTABLE to allow tag updates. Values: ["IMMUTABLE","MUTABLE"]. |
Outputs
| Name | Purpose |
|---|---|
ECRRepositoryURI | The URI of the newly created ECR repository |
Commercial: filesync
Source: Licensed 1.19.2 distribution: filesync.yaml
SHA-256: aa3242060517dcb4b6b59f95e53de5326caefe8f2ea5b10e931664343e23956e
Parameters
| Name | Type / default | Constraints and purpose |
|---|---|---|
S3ReadOnlyArns | String; Required | Comma delimited list of S3 bucket ARNs. For example: arn:aws:s3:::my-bucket,arn:aws:s3:::my-bucket2 |
DynamoDbTableNames | String; Required | Comma delimited list of DynamoDb table ARNS(s). For example: arn:aws:dynamodb:<region>:<aws_account_id>:table/<table_name> |
Outputs
| Name | Purpose |
|---|---|
AccessKey | FormKiQ Sync AWSAccessKeyId |
SecretKey | FormKiQ Sync AWSSecretAccessKey |
Commercial: formkiq-module-email/template
Source: Licensed 1.19.2 distribution: formkiq-module-email/template.yaml
SHA-256: 9107bba4d230ce7230778109a2f7750e5c4a21c2541e8490f26da0bd8cccb88e
Parameters
| Name | Type / default | Constraints and purpose |
|---|---|---|
S3BucketDestination | String; Required | FormKiQ Staging S3 Bucket to move attachments to Pattern: .+. |
Outputs
| Name | Purpose |
|---|---|
EmailBucketName | Inspect the deployed output and owning template. |
Commercial: opensearch-legacy
Source: Licensed 1.19.2 distribution: opensearch-legacy.yaml
SHA-256: e39cf728ae19f8752882c9f0e4c31a5b727544a3d9a4737c38d066e32bea73aa
Parameters
| Name | Type / default | Constraints and purpose |
|---|---|---|
VpcStackName | String; Required | The name of the FormKiQ VPC Stack Name Pattern: .+. |
Name | String; Default formkiq-enterprise-prod | A name for the OpenSearch Service domain Pattern: .+. |
EnableMultiAZStandby | String; Default false | Indicates whether Multi-AZ with Standby deployment option is enabled. Values: ["false","true"]. |
OpenSearchVersion | String; Default OpenSearch_2.17 | The 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"]. |
AppEnvironment | String; Default prod | Unique Application Environment Identifier, IE dev/staging/prod (MUST match FormKiQ installation AppEnvironment) Pattern: [a-zA-Z0-9_.-/]+. |
DataInstanceType | String; Default t3.small.search | The 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$. |
DataInstanceCount | Number; Default 1 | The number of data nodes (instances) to use in the OpenSearch Service domain. Min: 1. Max: 100. |
DataNodeVolumeSize | Number; Default 10 | The size (in GiB) of the EBS volume for each data node. Min: 10. Max: 2048. |
DedicatedMasterType | String; 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"]. |
DedicatedMasterCount | Number; Default 0 | The number of dediction master node(s) Values: [0,1,3,5]. |
Outputs
| Name | Purpose |
|---|---|
OpenSearchDomainType | Open Search Service Domain Type |
OpenSearchDomainEndpoint | Open Search Service Domain Endpoint |
Commercial: opensearch-serverless
Source: Licensed 1.19.2 distribution: opensearch-serverless.yaml
SHA-256: 16606b78e70d992947a37179ae45fbbd38966d9ae85194f63804d105f0db6f28
Parameters
| Name | Type / default | Constraints and purpose |
|---|---|---|
VpcStackName | String; Default formkiq-vpc | The name of the FormKiQ VPC Stack Name Pattern: .+. |
SourceVPCE | String; Default (empty string) | (Optional) The VPC Endpoint ID to allow. If this is not provided, the network security policy will not be created. |
CollectionName | String; Default formkiq-prod | The name of the OpenSearch Serverless collection. |
StandbyReplicas | String; Default ENABLED | The 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"]. |
EnableVpcEndpoint | String; Default true | Enable Opensearch VPC Endpoint Values: ["false","true"]. |
Outputs
| Name | Purpose |
|---|---|
HttpsSecurityGroup | Security Group which allows HTTPS access |
VpcEndpoint | The VPC Endpoint ID used for the security policy. Conditional. |
OpenSearchDomainType | Open Search Service Domain Type |
CollectionName | Open Search Collection Name |
OpenSearchDomainEndpoint | Open Search Service Domain Endpoint |
OpenSearchDashboardsEndpoint | OpenSearch Dashboards endpoint for the collection |
Commercial: opensearch
Source: Licensed 1.19.2 distribution: opensearch.yaml
SHA-256: 7a6bffac82f26c8ee7cc402da8fb92b4e74694d3b0b90e844bde8eb44c5ba2e7
Parameters
| Name | Type / default | Constraints and purpose |
|---|---|---|
VpcStackName | String; Required | The name of the FormKiQ VPC Stack Name Pattern: .+. |
Name | String; Default formkiq-prod | A name for the OpenSearch Service domain (must be lower-case, numbers, and hyphens only) Pattern: .+. |
EnableMultiAZStandby | String; Default false | Indicates whether Multi-AZ with Standby deployment option is enabled. Values: ["false","true"]. |
OpenSearchVersion | String; Default OpenSearch_3.5 | The 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"]. |
DataInstanceType | String; Default t3.small.search | The instance type for your data nodes Pattern: ^[a-z1-9]+\.[a-z1-9]+\.search$. |
DataInstanceCount | Number; Default 1 | The number of data nodes (instances) to use in the OpenSearch Service domain. Min: 1. Max: 100. |
DataNodeVolumeSize | Number; Default 10 | The size (in GiB) of the EBS volume for each data node. Min: 10. Max: 2048. |
FreeStorageSpaceAlarmThresholdPercent | Number; Default 25 | Alert when a data node's free storage is at or below this percentage of its provisioned EBS volume. Min: 1. Max: 100. |
DedicatedMasterType | String; 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"]. |
DedicatedMasterCount | Number; Default 0 | The number of dediction master node(s) Values: [0,1,3,5]. |
AlarmEmail | String; Default (empty string) | Optional email address to subscribe for alarm notifications. Leave empty if not needed. |
RetentionInDays | Number; Default 90 | Number 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]. |
LogsSearchSlowEnabled | String; Default false | Set to "true" to enable Search slow logs. Values: ["true","false"]. |
LogsIndexSlowEnabled | String; Default false | Set to "true" to enable Index slow logs. Values: ["true","false"]. |
LogsErrorEnabled | String; Default false | Set to "true" to enable Error logs. Values: ["true","false"]. |
Outputs
| Name | Purpose |
|---|---|
OpenSearchDomainType | Open Search Service Domain Type |
CognitoUserPoolArn | Open Search Service Cognito User Pool |
OpenSearchDomainEndpoint | Open Search Service Domain Endpoint |
OpenSearchSnapshotBucket | Name of the S3 bucket for OpenSearch snapshots |
OpenSearchSnapshotRoleArn | Deprecated OpenSearch snapshot role ARN. Use OpenSearchSnapshotServiceRoleArn instead. |
OpenSearchSnapshotServiceRoleArn | OpenSearch snapshot service role ARN |
Commercial: support
Source: Licensed 1.19.2 distribution: support.yaml
SHA-256: 370e74f1d40085d6d8cc39e11321dbc89118f0def400c77a4710c3336254b436
Parameters
| Name | Type / default | Constraints and purpose |
|---|---|---|
MasterAccountNumber | Number; Default 622653865277 | The account where the AWS Trusted Advisor Explorer solution will be deployed |
CrossAccountRoleName | String; Default FormKiQSupport | Your Role Name (ex: OrganizationAccountAccessRole); This will need to be the same across all of the Member Accounts |
Outputs
| Name | Purpose |
|---|---|
SupportRole | Inspect the deployed output and owning template. |
AwsAccountId | Inspect the deployed output and owning template. |
Commercial: template-upgrade
Source: Licensed 1.19.2 distribution: template-upgrade.yaml
SHA-256: 1abe19f9f0ae27d4536cac11fa186a0f44a049a1cdbc87ca08598cf723bba8be
Parameters
| Name | Type / default | Constraints and purpose |
|---|---|---|
ConsoleWafACLId | String; Default (empty string) | ARN of the Console WAF WebACL to associate with the CloudFront distribution |
AdminEmail | String; Required | Administrator Email (required) Pattern: .+. |
AppEnvironment | String; Default prod | Unique Application Environment Identifier, IE dev/staging/prod Pattern: [a-zA-Z0-9_.-/]+. |
EnablePublicUrls | String; Default false | Whether 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"]. |
PasswordMinimumLength | Number; Default 8 | Set the Amazon Cognito password policies, minimum password length requirement for all users Min: 6. Max: 99. |
PasswordRequireLowercase | String; Default false | Set the Amazon Cognito password policies, to require one lowercase letter in all passwords. Values: ["true","false"]. |
PasswordRequireNumbers | String; Default false | Set the Amazon Cognito password policies, to require one number in all passwords. Values: ["true","false"]. |
PasswordRequireSymbols | String; Default false | Set the Amazon Cognito password policies, to require one symbol in all passwords. Values: ["true","false"]. |
PasswordRequireUppercase | String; Default false | Set the Amazon Cognito password policies, to require one uppercase letter in all passwords. Values: ["true","false"]. |
TokenAccessIdValidityMinutes | Number; Default 1440 | The time limit in minutes, after which the access and ID tokens are no longer valid and cannot be used. Min: 5. Max: 1440. |
TokenRefreshValidityMinutes | Number; Default 43200 | The time limit in minutes, after which the refresh token is no longer valid and cannot be used. Min: 60. Max: 5256000. |
VpcStackName | String; Default (empty string) | The name of the FormKiQ VPC Stack Name |
CapacityProvider | String; Default FARGATE_SPOT | AWS Fargate capacity provider to use, either the FARGATE or FARGATE_SPOT Values: ["FARGATE_SPOT","FARGATE"]. |
LogRetentionInDays | Number; Default 90 | The 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]. |
LogFormat | String; Default Text | The format in which the application and system logs are stored. Values: ["Text","JSON"]. |
LogLevelApplication | String; Default INFO | The level of logging for the FormKiQ Application logs. Only used when LogFormat is JSON Values: ["TRACE","DEBUG","INFO","ERROR"]. |
LogLevelSystem | String; Default INFO | The level of logging for the AWS Platform System logs. Only used when LogFormat is JSON Values: ["DEBUG","INFO","WARN"]. |
EnableDeletionProtection | String; Default false | Enable deletion protection on AWS Services that support the feature Values: ["true","false"]. |
UserPoolTier | String; Default LITE | Cognito 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"]. |
EnableCloudFrontAccessLogs | String; Default false | Enable 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"]. |
EnableS3AccessLogs | String; Default false | Enable server access logs for console, Cognito configuration, documents, staging, and OCR buckets, and create a dedicated logging bucket. Values: ["true","false"]. |
CertificateStackName | String; Default (empty string) | The name of the FormKiQ Certificate Stack Name |
EnableS3TransferAcceleration | String; Default false | Enable opt-in S3 Transfer Acceleration for documents bucket URLs (additional transfer charges apply) Values: ["true","false"]. |
OpenSearchStackName | String; Default (empty string) | The name of the FormKiQ Open Search Stack Name |
OpenSearchIndexPrefix | String; Default formkiq_ | The string appended to the beginning of the OpenSearch Index Name |
ProvisionedConcurrencyDocumentGeneration | Number; Default 0 | The amount of provisioned concurrency to allocate for Document Generation Lambda Min: 0. |
CognitoSingleSignOnUrl | String; Default (empty string) | The Cognito Hosted UI URL to allow Single Sign-On |
SitePermissions | String; Default automatic | The 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"]. |
SamlProvider | String; 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"]. |
OperationalMode | String; Default ACTIVE | Controls 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"]. |
PermissionsBoundaryArn | String; 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
| Name | Purpose |
|---|---|
AppEnvironment | Unique Application Environment Identifier, IE dev/staging/prod |
IamApiUrl | The URL for the API endpoint that uses IAM authorization |
KeyApiUrl | The URL for the API endpoint that uses API Key authorization |
HttpApiUrl | The URL for the API endpoint that uses Cognito authorization |
AuthApiUrl | The endpoint url for the User Auth API |
ConsoleUrl | The URL for the FormKiQ Console |
ConsoleS3Bucket | The Console S3 Bucket |
CognitoUserPoolId | The Cognito User Pool Id |
CognitoUserPoolArn | The Cognito User Pool Arn |
CognitoClientId | The Cognito Client Id |
CognitoDomain | The Cognito Domain Url |
FormKiQVersion | The FormKiQ Version |
SnsDocumentEventArn | SNS Topic for Document Events |
DocumentsTableName | Document DynamoDb Table Name |
DocumentsTableArn | Document DynamoDb Table Arn |
DocumentsS3Buckets | Documents Bucket. |
DocumentsStageS3Bucket | Documents Staging Bucket. |
ShortlinksApiUrl | The endpoint url for the Shortlinks API |
DriveCognitoClientId | The Cognito Client Id for the Drive app client |
DriveAuthorizeUrl | The Cognito OAuth2 authorization URL for the Drive app client |
DriveLoginUrl | The URL for the Drive login page |