Configuration Schema

Schema Docs
Type: object

Taskcat configuration file

 No Additional Properties

root general
Type: object Default: {"artifact_regions": null, "auth": null, "parameters": null, "posthooks": null, "prehooks": null, "regions": null, "s3_bucket": null, "s3_regional_buckets": null, "tags": null}

General configuration settings.

 No Additional Properties

root general artifact_regions
Type: array of string

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

Each item of this array must be:

root general artifact_regions artifact_regions items
Type: string

AWS Region name

Must match regular expression: ^(ap|eu|us|sa|ca|cn|af|me|us-gov)-(central|south|north|east|west|southeast|southwest|northeast|northwest)-[0-9]$
Example:

"us-east-1"

root general auth
Type: object

AWS authentication section
Example:

{
    "cn-northwest-1": "china-profile",
    "default": "my-default-profile",
    "us-east-2": "specific-profile-for-us-east-2"
}

Each additional property must conform to the following schema

root general auth additionalProperties
Type: string

root general parameters
Type: object

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

root general posthooks
Type: array

hooks to execute after executing tests

Each item of this array must be:

root general posthooks HookData
Type: object

Hook definition

 No Additional Properties

root general posthooks posthooks items config
Type: object

hook configuration

root general posthooks posthooks items type
Type: string

hook type

root general prehooks
Type: array

hooks to execute prior to executing tests

Each item of this array must be:

root general prehooks HookData
Type: object

Hook definition

Same definition as general_posthooks_items

root general regions
Type: array of string

List of AWS regions

Each item of this array must be:

root general regions regions items
Type: string

AWS Region name

Must match regular expression: ^(ap|eu|us|sa|ca|cn|af|me|us-gov)-(central|south|north|east|west|southeast|southwest|northeast|northwest)-[0-9]$
Example:

"us-east-1"

root general s3_bucket
Type: string

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

"my-s3-bucket-name"

root general s3_regional_buckets
Type: boolean

Enable regional auto-buckets.
Examples:

true

false

root general tags
Type: object

Tags to apply to CloudFormation template
Example:

{
    "CostCenter": "1001"
}

Each additional property must conform to the following schema

root general tags additionalProperties
Type: string

root project
Type: object Default: {"artifact_regions": null, "auth": null, "az_blacklist": null, "build_submodules": null, "lambda_source_path": null, "lambda_zip_path": null, "name": null, "org_id": null, "owner": null, "package_lambda": null, "parameters": null, "posthooks": null, "prehooks": null, "regions": null, "role_name": null, "s3_bucket": null, "s3_enable_sig_v2": null, "s3_object_acl": null, "s3_regional_buckets": null, "shorten_stack_name": null, "tags": null, "template": null}

Project specific configuration section

 No Additional Properties

root project artifact_regions
Type: array of string

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

Each item of this array must be:

root project artifact_regions artifact_regions items
Type: string

AWS Region name

Must match regular expression: ^(ap|eu|us|sa|ca|cn|af|me|us-gov)-(central|south|north|east|west|southeast|southwest|northeast|northwest)-[0-9]$
Example:

"us-east-1"

root project auth
Type: object

AWS authentication section
Example:

{
    "cn-northwest-1": "china-profile",
    "default": "my-default-profile",
    "us-east-2": "specific-profile-for-us-east-2"
}

Each additional property must conform to the following schema

root project auth additionalProperties
Type: string

root project az_blacklist
Type: array of string

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

Each item of this array must be:

root project az_blacklist az_blacklist items
Type: string

Availability Zone ID, eg.: 'use1-az1'

Must match regular expression: (afs1-az1|afs1-az2|afs1-az3|ape1-az1|ape1-az2|ape1-az3|apne1-az1|apne1-az2|apne1-az4|apne2-az1|apne2-az2|apne2-az3|apne2-az4|apne3-az1|apne3-az2|apne3-az3|aps1-az1|aps1-az2|aps1-az3|apse1-az1|apse1-az2|apse1-az3|apse2-az1|apse2-az2|apse2-az3|apse3-az1|apse3-az2|apse3-az3|cac1-az1|cac1-az2|cac1-az4|euc1-az1|euc1-az2|euc1-az3|eun1-az1|eun1-az2|eun1-az3|eus1-az1|eus1-az2|eus1-az3|euw1-az1|euw1-az2|euw1-az3|euw2-az1|euw2-az2|euw2-az3|euw3-az1|euw3-az2|euw3-az3|mes1-az1|mes1-az2|mes1-az3|sae1-az1|sae1-az2|sae1-az3|use1-atl1-az1|use1-az1|use1-az2|use1-az3|use1-az4|use1-az5|use1-az6|use1-bos1-az1|use1-chi1-az1|use1-dfw1-az1|use1-iah1-az1|use1-mci1-az1|use1-mia1-az1|use1-msp1-az1|use1-nyc1-az1|use1-phl1-az1|use2-az1|use2-az2|use2-az3|usw1-az1|usw1-az3|usw2-az1|usw2-az2|usw2-az3|usw2-az4|usw2-den1-az1|usw2-las1-az1|usw2-lax1-az1|usw2-lax1-az2|usw2-pdx1-az1|usw2-phx1-az1|usw2-sea1-az1)
Examples:

"usw2-laz1-az1"

"use2-az2"

root project build_submodules
Type: boolean

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

true

false

root project lambda_source_path
Type: string

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

"functions/source"

root project lambda_zip_path
Type: string

Path relative to the project root to place Lambda zip files
Example:

"functions/packages"

root project name
Type: string

Project name, used as s3 key prefix when uploading objects

Must match regular expression: ^[a-z0-9-]*$
Example:

"my-project-name"

root project org_id
Type: string

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

root project owner
Type: string

email address for project owner (not used at present)
Example:

"Bob.Slydell@example.com"

root project package_lambda
Type: boolean

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

true

false

root project parameters
Type: object

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

root project posthooks
Type: array

hooks to execute after executing tests

Each item of this array must be:

root project posthooks HookData
Type: object

Hook definition

Same definition as general_posthooks_items

root project prehooks
Type: array

hooks to execute prior to executing tests

Each item of this array must be:

root project prehooks HookData
Type: object

Hook definition

Same definition as general_posthooks_items

root project regions
Type: array of string

List of AWS regions

Each item of this array must be:

root project regions regions items
Type: string

AWS Region name

Must match regular expression: ^(ap|eu|us|sa|ca|cn|af|me|us-gov)-(central|south|north|east|west|southeast|southwest|northeast|northwest)-[0-9]$
Example:

"us-east-1"

root project role_name
Type: string

Role name to use when launching CFN Stacks.

root project s3_bucket
Type: string

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

Must match regular expression: ^[a-z0-9-]*$
Example:

"my-s3-bucket-name"

root project s3_enable_sig_v2
Type: boolean

Enable (deprecated) sigv2 access to auto-generated buckets
Examples:

true

false

root project s3_object_acl
Type: string Default: "private"

ACL for uploaded s3 objects

Must match regular expression: ^(bucket-owner-full-control|bucket-owner-read|authenticated-read|aws-exec-read|public-read-write|public-read|private)$
Examples:

"bucket-owner-read"

"private"

root project s3_regional_buckets
Type: boolean

Enable regional auto-buckets.
Examples:

true

false

root project shorten_stack_name
Type: boolean

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

true

false

root project tags
Type: object

Tags to apply to CloudFormation template
Example:

{
    "CostCenter": "1001"
}

Each additional property must conform to the following schema

root project tags additionalProperties
Type: string

root project template
Type: string

path to template file relative to the project config file path
Example:

"cloudformation_templates/"

root tests
Type: object Default: {}

Each additional property must conform to the following schema

root tests TestConfig
Type: object

Test specific configuration section.

 No Additional Properties

root tests additionalProperties artifact_regions
Type: array of string

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

Each item of this array must be:

root tests additionalProperties artifact_regions artifact_regions items
Type: string

AWS Region name

Must match regular expression: ^(ap|eu|us|sa|ca|cn|af|me|us-gov)-(central|south|north|east|west|southeast|southwest|northeast|northwest)-[0-9]$
Example:

"us-east-1"

root tests additionalProperties auth
Type: object

AWS authentication section
Example:

{
    "cn-northwest-1": "china-profile",
    "default": "my-default-profile",
    "us-east-2": "specific-profile-for-us-east-2"
}

Each additional property must conform to the following schema

root tests additionalProperties auth additionalProperties
Type: string

root tests additionalProperties az_blacklist
Type: array of string

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

Each item of this array must be:

root tests additionalProperties az_blacklist az_blacklist items
Type: string

Availability Zone ID, eg.: 'use1-az1'

Must match regular expression: (afs1-az1|afs1-az2|afs1-az3|ape1-az1|ape1-az2|ape1-az3|apne1-az1|apne1-az2|apne1-az4|apne2-az1|apne2-az2|apne2-az3|apne2-az4|apne3-az1|apne3-az2|apne3-az3|aps1-az1|aps1-az2|aps1-az3|apse1-az1|apse1-az2|apse1-az3|apse2-az1|apse2-az2|apse2-az3|apse3-az1|apse3-az2|apse3-az3|cac1-az1|cac1-az2|cac1-az4|euc1-az1|euc1-az2|euc1-az3|eun1-az1|eun1-az2|eun1-az3|eus1-az1|eus1-az2|eus1-az3|euw1-az1|euw1-az2|euw1-az3|euw2-az1|euw2-az2|euw2-az3|euw3-az1|euw3-az2|euw3-az3|mes1-az1|mes1-az2|mes1-az3|sae1-az1|sae1-az2|sae1-az3|use1-atl1-az1|use1-az1|use1-az2|use1-az3|use1-az4|use1-az5|use1-az6|use1-bos1-az1|use1-chi1-az1|use1-dfw1-az1|use1-iah1-az1|use1-mci1-az1|use1-mia1-az1|use1-msp1-az1|use1-nyc1-az1|use1-phl1-az1|use2-az1|use2-az2|use2-az3|usw1-az1|usw1-az3|usw2-az1|usw2-az2|usw2-az3|usw2-az4|usw2-den1-az1|usw2-las1-az1|usw2-lax1-az1|usw2-lax1-az2|usw2-pdx1-az1|usw2-phx1-az1|usw2-sea1-az1)
Examples:

"usw2-laz1-az1"

"use2-az2"

root tests additionalProperties posthooks
Type: array

hooks to execute after executing tests

Each item of this array must be:

root tests additionalProperties posthooks HookData
Type: object

Hook definition

Same definition as general_posthooks_items

root tests additionalProperties prehooks
Type: array

hooks to execute prior to executing tests

Each item of this array must be:

root tests additionalProperties prehooks HookData
Type: object

Hook definition

Same definition as general_posthooks_items

root tests additionalProperties regions
Type: array of string

List of AWS regions

Each item of this array must be:

root tests additionalProperties regions regions items
Type: string

AWS Region name

Must match regular expression: ^(ap|eu|us|sa|ca|cn|af|me|us-gov)-(central|south|north|east|west|southeast|southwest|northeast|northwest)-[0-9]$
Example:

"us-east-1"

root tests additionalProperties role_name
Type: string

Role name to use when launching CFN Stacks.

root tests additionalProperties s3_bucket
Type: string

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

Must match regular expression: ^[a-z0-9-]*$
Example:

"my-s3-bucket-name"

root tests additionalProperties s3_regional_buckets
Type: boolean

Enable regional auto-buckets.
Examples:

true

false

root tests additionalProperties stack_name
Type: string

Cloudformation Stack Name

root tests additionalProperties stack_name_prefix
Type: string

Prefix to apply to generated CFN Stack Name

root tests additionalProperties stack_name_suffix
Type: string

Suffix to apply to generated CFN Stack Name

root tests additionalProperties tags
Type: object

Tags to apply to CloudFormation template
Example:

{
    "CostCenter": "1001"
}

Each additional property must conform to the following schema

root tests additionalProperties tags additionalProperties
Type: string

root tests additionalProperties template
Type: string

path to template file relative to the project config file path
Example:

"cloudformation_templates/"