Taskcat schema

Schema Docs

Type: object

Taskcat configuration file

No Additional Properties

Type: object Default: {"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

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

Type: string

Type: object

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

Type: array

hooks to execute after executing tests

Each item of this array must be:

Type: object

Hook definition

No Additional Properties

Type: object

hook configuration

Type: string

hook type

Type: array

hooks to execute prior to executing tests

Each item of this array must be:

Type: object

Hook definition

Same definition as HookData

Type: array of string

List of AWS regions

Each item of this array must be:

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"

Type: string

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


Example:

"my-s3-bucket-name"

Type: boolean

Enable regional auto-buckets.


Examples:

true
false

Type: object

Tags to apply to CloudFormation template


Example:

{
    "CostCenter": "1001"
}

Each additional property must conform to the following schema

Type: string

Type: object Default: {"auth": null, "az_blacklist": null, "build_submodules": null, "lambda_source_path": null, "lambda_zip_path": null, "name": 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

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

Type: string

Type: array of string

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

Each item of this array must be:

Type: string

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

Must match regular expression: ^((ap|eu|us|sa|ca|cn|af|me)(n|s|e|w|c|ne|se|nw|sw)[0-9]-az[0-9]|usw2-lax1-az(1|2))$
Examples:

"usw2-laz1-az1"
"use2-az2"

Type: boolean

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


Examples:

true
false

Type: string

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


Example:

"functions/source"

Type: string

Path relative to the project root to place Lambda zip files


Example:

"functions/packages"

Type: string

Project name, used as s3 key prefix when uploading objects

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

"my-project-name"

Type: string

email address for project owner (not used at present)


Example:

"Bob.Slydell@example.com"

Type: boolean

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


Examples:

true
false

Type: object

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

Type: array

hooks to execute after executing tests

Each item of this array must be:

Type: object

Hook definition

Same definition as HookData

Type: array

hooks to execute prior to executing tests

Each item of this array must be:

Type: object

Hook definition

Same definition as HookData

Type: array of string

List of AWS regions

Each item of this array must be:

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"

Type: string

Role name to use when launching CFN Stacks.

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"

Type: boolean

Enable (deprecated) sigv2 access to auto-generated buckets


Examples:

true
false

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"

Type: boolean

Enable regional auto-buckets.


Examples:

true
false

Type: boolean

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


Examples:

true
false

Type: object

Tags to apply to CloudFormation template


Example:

{
    "CostCenter": "1001"
}

Each additional property must conform to the following schema

Type: string

Type: string

path to template file relative to the project config file path


Example:

"cloudformation_templates/"

Type: object Default: {}

Each additional property must conform to the following schema

Type: object

Test specific configuration section.

No Additional Properties

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

Type: string

Type: array of string

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

Each item of this array must be:

Type: string

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

Must match regular expression: ^((ap|eu|us|sa|ca|cn|af|me)(n|s|e|w|c|ne|se|nw|sw)[0-9]-az[0-9]|usw2-lax1-az(1|2))$
Examples:

"usw2-laz1-az1"
"use2-az2"

Type: object Default: {}

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

Type: array

hooks to execute after executing tests

Each item of this array must be:

Type: array

hooks to execute prior to executing tests

Each item of this array must be:

Type: array of string

List of AWS regions

Each item of this array must be:

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"

Type: string

Role name to use when launching CFN Stacks.

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"

Type: boolean

Enable regional auto-buckets.


Examples:

true
false

Type: string

Cloudformation Stack Name

Type: string

Prefix to apply to generated CFN Stack Name

Type: string

Suffix to apply to generated CFN Stack Name

Type: object

Tags to apply to CloudFormation template


Example:

{
    "CostCenter": "1001"
}

Each additional property must conform to the following schema

Type: string

Type: string

path to template file relative to the project config file path


Example:

"cloudformation_templates/"