taskcat

taskcat

Type object
File match .taskcat.yml
Schema URL https://catalog.lintel.tools/schemas/schemastore/taskcat/latest.json
Source https://raw.githubusercontent.com/aws-quickstart/taskcat/master/taskcat/cfg/config_schema.json

Validate with Lintel

npx @lintel/lintel check
Type: object

Taskcat configuration file

Properties

general object

General configuration settings.

9 nested properties
artifact_regions string[]

List of AWS regions where artifacts need to be copied. This helps same region artifact bucket access to resources

auth Record<string, string>

AWS authentication section

Examples: {"cn-northwest-1":"china-profile","default":"my-default-profile","us-east-2":"specific-profile-for-us-east-2"}
parameters Record<string, integer | string[] | boolean | integer | string>

Parameter key-values to pass to CloudFormation, parameters provided in global config take precedence

posthooks HookData[]

hooks to execute after executing tests

prehooks HookData[]

hooks to execute prior to executing tests

regions string[]

List of AWS regions

s3_bucket string

Name of S3 bucket to upload project to, if left out a bucket will be auto-generated

Examples: "my-s3-bucket-name"
s3_regional_buckets boolean

Enable regional auto-buckets.

Examples: true, false
tags Record<string, string>

Tags to apply to CloudFormation template

Examples: {"CostCenter":"1001"}
project object

Project specific configuration section

22 nested properties
artifact_regions string[]

List of AWS regions where artifacts need to be copied. This helps same region artifact bucket access to resources

auth Record<string, string>

AWS authentication section

Examples: {"cn-northwest-1":"china-profile","default":"my-default-profile","us-east-2":"specific-profile-for-us-east-2"}
az_blacklist string[]

List of Availablilty Zones ID's to exclude when generating availability zones

build_submodules boolean

Build Lambda zips recursively for submodules, set to false to disable

Examples: true, false
lambda_source_path string

Path relative to the project root containing Lambda zip files, default is 'lambda_functions/source'

Examples: "functions/source"
lambda_zip_path string

Path relative to the project root to place Lambda zip files

Examples: "functions/packages"
name string

Project name, used as s3 key prefix when uploading objects

Examples: "my-project-name"
pattern=^[a-z0-9-/]*$
org_id string

Organization ID to use when launching CFN Stacks. starts with o-. It is found on Organization Settings page

owner string

email address for project owner (not used at present)

Examples: "[email protected]"
package_lambda boolean

Package Lambda functions into zips before uploading to s3, set to false to disable

Examples: true, false
parameters Record<string, integer | string[] | boolean | integer | string>

Parameter key-values to pass to CloudFormation, parameters provided in global config take precedence

posthooks HookData[]

hooks to execute after executing tests

prehooks HookData[]

hooks to execute prior to executing tests

regions string[]

List of AWS regions

role_name string

Role name to use when launching CFN Stacks.

s3_bucket string

Name of S3 bucket to upload project to, if left out a bucket will be auto-generated

Examples: "my-s3-bucket-name"
pattern=^[a-z0-9-]*$
s3_enable_sig_v2 boolean

Enable (deprecated) sigv2 access to auto-generated buckets

Examples: true, false
s3_object_acl string

ACL for uploaded s3 objects

Default: "private"
Examples: "bucket-owner-read", "private"
pattern=^(bucket-owner-full-control|bucket-owner-read|authenticated-read|aws-exec-read|public-read-write|public-read|private)$
s3_regional_buckets boolean

Enable regional auto-buckets.

Examples: true, false
shorten_stack_name boolean

Shorten stack names generated for tests, set to true to enable

Examples: true, false
tags Record<string, string>

Tags to apply to CloudFormation template

Examples: {"CostCenter":"1001"}
template string

path to template file relative to the project config file path

Examples: "cloudformation_templates/"
tests Record<string, object>
Default:
{}

Definitions

GeneralConfig object

General configuration settings.

artifact_regions string[]

List of AWS regions where artifacts need to be copied. This helps same region artifact bucket access to resources

auth Record<string, string>

AWS authentication section

Examples: {"cn-northwest-1":"china-profile","default":"my-default-profile","us-east-2":"specific-profile-for-us-east-2"}
parameters Record<string, integer | string[] | boolean | integer | string>

Parameter key-values to pass to CloudFormation, parameters provided in global config take precedence

posthooks HookData[]

hooks to execute after executing tests

prehooks HookData[]

hooks to execute prior to executing tests

regions string[]

List of AWS regions

s3_bucket string

Name of S3 bucket to upload project to, if left out a bucket will be auto-generated

Examples: "my-s3-bucket-name"
s3_regional_buckets boolean

Enable regional auto-buckets.

Examples: true, false
tags Record<string, string>

Tags to apply to CloudFormation template

Examples: {"CostCenter":"1001"}
HookData object

Hook definition

config object

hook configuration

type string

hook type

ProjectConfig object

Project specific configuration section

artifact_regions string[]

List of AWS regions where artifacts need to be copied. This helps same region artifact bucket access to resources

auth Record<string, string>

AWS authentication section

Examples: {"cn-northwest-1":"china-profile","default":"my-default-profile","us-east-2":"specific-profile-for-us-east-2"}
az_blacklist string[]

List of Availablilty Zones ID's to exclude when generating availability zones

build_submodules boolean

Build Lambda zips recursively for submodules, set to false to disable

Examples: true, false
lambda_source_path string

Path relative to the project root containing Lambda zip files, default is 'lambda_functions/source'

Examples: "functions/source"
lambda_zip_path string

Path relative to the project root to place Lambda zip files

Examples: "functions/packages"
name string

Project name, used as s3 key prefix when uploading objects

Examples: "my-project-name"
pattern=^[a-z0-9-/]*$
org_id string

Organization ID to use when launching CFN Stacks. starts with o-. It is found on Organization Settings page

owner string

email address for project owner (not used at present)

Examples: "[email protected]"
package_lambda boolean

Package Lambda functions into zips before uploading to s3, set to false to disable

Examples: true, false
parameters Record<string, integer | string[] | boolean | integer | string>

Parameter key-values to pass to CloudFormation, parameters provided in global config take precedence

posthooks HookData[]

hooks to execute after executing tests

prehooks HookData[]

hooks to execute prior to executing tests

regions string[]

List of AWS regions

role_name string

Role name to use when launching CFN Stacks.

s3_bucket string

Name of S3 bucket to upload project to, if left out a bucket will be auto-generated

Examples: "my-s3-bucket-name"
pattern=^[a-z0-9-]*$
s3_enable_sig_v2 boolean

Enable (deprecated) sigv2 access to auto-generated buckets

Examples: true, false
s3_object_acl string

ACL for uploaded s3 objects

Default: "private"
Examples: "bucket-owner-read", "private"
pattern=^(bucket-owner-full-control|bucket-owner-read|authenticated-read|aws-exec-read|public-read-write|public-read|private)$
s3_regional_buckets boolean

Enable regional auto-buckets.

Examples: true, false
shorten_stack_name boolean

Shorten stack names generated for tests, set to true to enable

Examples: true, false
tags Record<string, string>

Tags to apply to CloudFormation template

Examples: {"CostCenter":"1001"}
template string

path to template file relative to the project config file path

Examples: "cloudformation_templates/"
TestConfig object

Test specific configuration section.

artifact_regions string[]

List of AWS regions where artifacts need to be copied. This helps same region artifact bucket access to resources

auth Record<string, string>

AWS authentication section

Examples: {"cn-northwest-1":"china-profile","default":"my-default-profile","us-east-2":"specific-profile-for-us-east-2"}
az_blacklist string[]

List of Availablilty Zones ID's to exclude when generating availability zones

parameters Record<string, integer | string[] | boolean | integer | string>

Parameter key-values to pass to CloudFormation, parameters provided in global config take precedence

Default:
{}
posthooks HookData[]

hooks to execute after executing tests

prehooks HookData[]

hooks to execute prior to executing tests

regions string[]

List of AWS regions

role_name string

Role name to use when launching CFN Stacks.

s3_bucket string

Name of S3 bucket to upload project to, if left out a bucket will be auto-generated

Examples: "my-s3-bucket-name"
pattern=^[a-z0-9-]*$
s3_regional_buckets boolean

Enable regional auto-buckets.

Examples: true, false
stack_name string

Cloudformation Stack Name

stack_name_prefix string

Prefix to apply to generated CFN Stack Name

stack_name_suffix string

Suffix to apply to generated CFN Stack Name

tags Record<string, string>

Tags to apply to CloudFormation template

Examples: {"CostCenter":"1001"}
template string

path to template file relative to the project config file path

Examples: "cloudformation_templates/"