Definitions for @turbot/aws-stepfunctions
- regionName
- stateMachine
- stateMachineAka
- stateMachineName
- status
- stepFunctions
- stepFunctionsAka
- stepFunctionsSupportedRegions
regionName
{ "type": "string", "enum": [ "us-east-2", "us-east-1", "us-west-1", "us-west-2", "ap-northeast-1", "ap-northeast-2", "ap-south-1", "ap-southeast-1", "ap-southeast-2", "ca-central-1", "eu-central-1", "eu-west-1", "eu-west-2", "us-gov-west-1", "us-gov-east-1" ], "tests": [ { "input": "us-east-1" }, { "description": "invalid - not an aws region", "input": "usea1", "expected": false }, { "description": "invalid - not in the list", "input": "au-north-1", "expected": false } ], ".turbot": { "uri": "tmod:@turbot/aws-stepfunctions#/definitions/regionName", "modUri": "tmod:@turbot/aws-stepfunctions" }}stateMachine
{ "type": "object", "properties": { "name": { "$ref": "#/definitions/stateMachineName" }, "stateMachineArn": { "$ref": "#/definitions/stateMachineAka" }, "status": { "$ref": "#/definitions/status" }, "tags": { "type": "array" }, "definition": { "type": "object" }, "roleArn": { "type": "string" }, "loggingConfiguration": { "type": "object" }, "includeExecutionData": { "type": "boolean" }, "destinations": { "type": "boolean" }, "turbot": { "type": "object", "properties": { "akas": { "type": "array", "items": { "$ref": "#/definitions/stateMachineAka" } }, "title": { "$ref": "#/definitions/stateMachineName" }, "tags": { "$ref": "aws#/definitions/tagsMap" }, "custom": { "type": "object", "properties": { "aws": { "$ref": "aws#/definitions/awsMetadata" }, "createTimestamp": { "$ref": "turbot#/definitions/isoTimestamp" } } } } } }, "additionalProperties": true, "tests": [ { "description": "Valid - All properties", "input": { "name": "test01", "stateMachineArn": "arn:aws:states:us-west-2:492552618977:stateMachine:test01", "status": "ACTIVE", "includeExecutionData": false, "loggingConfiguration": { "level": "ALL" }, "tags": [ { "key": "Env", "value": "Test" } ], "turbot": { "tags": { "Env": "Test" }, "title": "test01", "custom": { "aws": { "accountId": 123456789012, "regionName": "us-east-1" } } } } } ], ".turbot": { "uri": "tmod:@turbot/aws-stepfunctions#/definitions/stateMachine", "modUri": "tmod:@turbot/aws-stepfunctions" }}stateMachineAka
{ "type": "string", "minLength": 1, "maxLength": 256, "pattern": "^arn:aws(-us-gov|-cn)?:states:[a-z]{2}(-gov)?-[a-z]+-[0-9]:[0-9]{12}:stateMachine:[a-zA-Z0-9_-]{1,80}$", "tests": [ { "input": "arn:aws:states:us-west-2:492552618977:stateMachine:test01" }, { "description": "gov cloud arn", "input": "arn:aws:states:us-gov-east-1:492552618977:stateMachine:test01" }, { "description": "arn with underscore in name", "input": "arn:aws:states:us-gov-east-1:492552618977:stateMachine:test_01" }, { "description": "invalid - asterisk not allowed in statemachine name", "input": "arn:aws:states:us-west-2:492552618977:stateMachine:test*01", "expected": false }, { "description": "invalid - aws account id length too long", "input": "arn:aws:states:us-west-2:01234567890123:stateMachine:test01", "expected": false }, { "description": "invalid - too long", "input": "arn:aws:states:us-west-2:492552618977:stateMachine:a1234567890123456789012345678901212345678901234567890123456789012345678901234567890a12345678901234567890123456789012123456789012345678901234567890123456789012345678900123456789001234567890012345678904567890", "expected": false } ], ".turbot": { "uri": "tmod:@turbot/aws-stepfunctions#/definitions/stateMachineAka", "modUri": "tmod:@turbot/aws-stepfunctions" }}stateMachineName
{ "type": "string", "pattern": "^[a-zA-Z0-9_-]{1,80}$", "tests": [ { "input": "Hello-123" }, { "description": "max length", "input": "a1234567890123456789012345678901212345678901234567890123456789012345678901234567" }, { "description": "invalid - too long", "input": "a1234567890123456789012345678901212345678901234567890123456789012345678901234567890", "expected": false }, { "description": "invalid - dollar symbol not allowed", "input": "machine$name", "expected": false }, { "input": "1234a" } ], ".turbot": { "uri": "tmod:@turbot/aws-stepfunctions#/definitions/stateMachineName", "modUri": "tmod:@turbot/aws-stepfunctions" }}status
{ "type": "string", "enum": [ "ACTIVE", "DELETING" ], "tests": [ { "input": "ACTIVE" }, { "description": "invalid - not listed in the options", "input": "DEACTIVATED", "expected": false }, { "description": "invalid - array type provided", "input": [ "ACTIVE" ], "expected": false } ], ".turbot": { "uri": "tmod:@turbot/aws-stepfunctions#/definitions/status", "modUri": "tmod:@turbot/aws-stepfunctions" }}stepFunctions
{ "allOf": [ { "$ref": "turbot#/definitions/service" }, { "type": "object", "properties": { "name": { "const": "Step Functions" }, "turbot": { "type": "object", "properties": { "akas": { "type": "array", "items": { "$ref": "#/definitions/stepFunctionsAka" } }, "title": { "const": "Step Functions" }, "custom": { "type": "object", "properties": { "aws": { "$ref": "aws#/definitions/awsMetadata" } } } } } }, "additionalProperties": true, "tests": [ { "description": "All data are valid", "input": { "name": "Step functions", "turbot": { "akas": [ "arn:aws:states:us-east-1:123123123123" ], "title": "Step Functions", "custom": { "aws": { "accountId": 123456789012, "regionName": "us-east-1" } } } } } ] } ], ".turbot": { "uri": "tmod:@turbot/aws-stepfunctions#/definitions/stepFunctions", "modUri": "tmod:@turbot/aws-stepfunctions" }}stepFunctionsAka
{ "type": "string", "pattern": "^arn:aws(-us-gov|-cn)?:states:[a-z]{2}(-gov)?-[a-z]+-[0-9]{1}:[0-9]{12}", "tests": [ { "description": "base", "input": "arn:aws:states:us-east-1:123123123123" }, { "description": "invalid service name", "input": "arn:aws:statess:us-east-1:123123123123", "expected": false }, { "description": "invalid region name", "input": "arn:aws:states:us-eastdk-74381:123456786354", "expected": false } ], ".turbot": { "uri": "tmod:@turbot/aws-stepfunctions#/definitions/stepFunctionsAka", "modUri": "tmod:@turbot/aws-stepfunctions" }}stepFunctionsSupportedRegions
{ "type": "array", "items": { "$ref": "#/definitions/regionName" }, "minItems": 1, "example": [ [ "us-east-1", "us-west-2" ] ], "default": [ "us-east-2", "us-east-1", "us-west-1", "us-west-2", "ap-northeast-1", "ap-northeast-2", "ap-south-1", "ap-southeast-1", "ap-southeast-2", "ca-central-1", "eu-central-1", "eu-west-1", "eu-west-2", "us-gov-west-1", "us-gov-east-1" ], "tests": [ { "description": "one region", "input": [ "us-east-1" ] }, { "description": "all supported regions", "input": [ "us-east-2", "us-east-1", "us-west-1", "us-west-2", "ap-northeast-1", "ap-northeast-2", "ap-south-1", "ap-southeast-1", "ap-southeast-2", "ca-central-1", "eu-central-1", "eu-west-1", "eu-west-2", "us-gov-west-1", "us-gov-east-1" ] }, { "description": "invalid - no regions", "input": [], "expected": false } ], ".turbot": { "uri": "tmod:@turbot/aws-stepfunctions#/definitions/stepFunctionsSupportedRegions", "modUri": "tmod:@turbot/aws-stepfunctions" }}