Definitions for @turbot/aws-batch

batch

{
"allOf": [
{
"$ref": "turbot#/definitions/service"
},
{
"type": "object",
"properties": {
"name": {
"const": "Batch"
},
"turbot": {
"type": "object",
"properties": {
"akas": {
"type": "array",
"items": {
"$ref": "#/definitions/batchAka"
}
},
"title": {
"const": "Batch"
},
"custom": {
"type": "object",
"properties": {
"aws": {
"$ref": "aws#/definitions/awsMetadata"
}
}
}
}
}
},
"additionalProperties": true,
"tests": [
{
"description": "Base - All valid Properties",
"input": {
"name": "Batch",
"turbot": {
"akas": [
"arn:aws:batch:us-east-1:123456789012"
],
"title": "Batch",
"custom": {
"aws": {
"accountId": 123456789012,
"regionName": "us-east-1",
"partition": "aws"
}
}
}
}
},
{
"description": "Invalid - Incorrect name",
"input": {
"name": "Batching",
"turbot": {
"akas": [
"arn:aws:batch:us-east-1:123456789012"
],
"title": "Batching",
"custom": {
"aws": {
"accountId": 123456789012,
"regionName": "us-east-1",
"partition": "aws"
}
}
}
},
"expected": false
},
{
"description": "Invalid - Service name missing",
"input": {
"turbot": {
"akas": [
"arn:aws:ec2:us-east-1:123456789012"
],
"title": "Batch",
"custom": {
"aws": {
"accountId": 123456789012,
"regionName": "us-east-1",
"partition": "aws"
}
}
}
},
"expected": false
}
]
}
],
".turbot": {
"uri": "tmod:@turbot/aws-batch#/definitions/batch",
"modUri": "tmod:@turbot/aws-batch"
}
}

batchAka

{
"type": "string",
"pattern": "^arn:aws(-us-gov|-cn)?:batch:[a-z]{2}(-gov)?-[a-z]+-[0-9]{1}:[0-9]{12}$",
"tests": [
{
"description": "base",
"input": "arn:aws:batch:us-east-1:123123123123"
},
{
"description": "invalid service name",
"input": "arn:aws:xyz:us-east-1:123123123123",
"expected": false
},
{
"description": "invalid account id",
"input": "arn:aws:batch:us-east-1:123382743123123123",
"expected": false
},
{
"description": "invalid region name",
"input": "arn:aws:batch:us-eastdk-74381:123123123123",
"expected": false
},
{
"description": "invalid provider name",
"input": "arn:gcp:batch:us-eastdk-74381:123123123123",
"expected": false
}
],
".turbot": {
"uri": "tmod:@turbot/aws-batch#/definitions/batchAka",
"modUri": "tmod:@turbot/aws-batch"
}
}

clusterArn

{
"type": "string",
"pattern": "^arn:aws(-us-gov|-cn)?:ecs:[a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-[0-9]{1}:[0-9]{12}:cluster/[a-zA-Z][a-zA-Z0-9-]{1,107}$",
"tests": [
{
"input": "arn:aws-us-gov:ecs:us-east-1:012345678910:cluster/my-cluster"
},
{
"description": "invalid - cluster cannot start with numeric",
"input": [
"123cluster"
],
"expected": false
},
{
"description": "invalid - cluster cannot be more than 18 characters",
"input": "Turbot-mine-cluster-smart",
"expected": false
}
],
".turbot": {
"uri": "tmod:@turbot/aws-batch#/definitions/clusterArn",
"modUri": "tmod:@turbot/aws-batch"
}
}

computeEnvironment

{
"type": "object",
"properties": {
"computeEnvironmentName": {
"$ref": "#/definitions/computeEnvironmentName"
},
"computeEnvironmentArn": {
"$ref": "#/definitions/computeEnvironmentAka"
},
"ecsClusterArn": {
"$ref": "#/definitions/clusterArn"
},
"serviceRole": {
"type": "string"
},
"state": {
"type": "string",
"enum": [
"ENABLED",
"DISABLED"
]
},
"status": {
"type": "string",
"enum": [
"CREATING",
"UPDATING",
"DELETING",
"DELETED",
"VALID",
"INVALID"
]
},
"statusReason": {
"type": "string"
},
"tags": {
"$ref": "aws#/definitions/tagsMap"
},
"turbot": {
"type": "object",
"properties": {
"akas": {
"type": "array",
"items": {
"$ref": "#/definitions/computeEnvironmentAka"
}
},
"tags": {
"$ref": "aws#/definitions/tagsMap"
},
"title": {
"$ref": "#/definitions/computeEnvironmentName"
},
"custom": {
"type": "object",
"properties": {
"aws": {
"$ref": "aws#/definitions/awsMetadata"
},
"createTimestamp": {
"$ref": "turbot#/definitions/isoTimestamp"
}
}
}
}
}
},
"additionalProperties": true,
"tests": [
{
"description": "all properties given",
"input": {
"computeEnvironmentArn": "arn:aws:batch:us-east-1:388460667113:compute-environment/test",
"computeEnvironmentName": "test",
"ecsClusterArn": "arn:aws:ecs:us-east-1:388460667113:cluster/test_Batch_a8246278-1465-3226-9cf5-202335f0a6ab",
"serviceRole": "arn:aws:iam::388460667113:role/service-role/AWSBatchServiceRole",
"state": "ENABLED",
"status": "VALID",
"statusReason": "ComputeEnvironment Healthy",
"tags": {},
"turbot": {
"akas": [
"arn:aws:batch:us-east-1:388460667113:compute-environment/test"
],
"title": "test",
"custom": {
"aws": {
"accountId": 388460667113,
"partition": "aws",
"regionName": "us-east-1"
}
}
}
}
}
],
".turbot": {
"uri": "tmod:@turbot/aws-batch#/definitions/computeEnvironment",
"modUri": "tmod:@turbot/aws-batch"
}
}

computeEnvironmentAka

{
"type": "string",
"pattern": "^arn:aws(-us-gov|-cn)?:batch:[a-z]{2}-[a-z]+-[0-9]:[0-9]{12}:compute-environment/[a-zA-Z0-9_:-]{1,127}$",
"tests": [
{
"description": "Valid - Base case",
"input": "arn:aws:batch:us-east-1:123456789012:compute-environment/ved-test"
},
{
"description": "Invalid - Malformed resource collection",
"input": "arn:aws:batch:us-east-1:123456789012:workspacess/ved@12345",
"expected": false
}
],
".turbot": {
"uri": "tmod:@turbot/aws-batch#/definitions/computeEnvironmentAka",
"modUri": "tmod:@turbot/aws-batch"
}
}

computeEnvironmentName

{
"type": "string",
"pattern": "^[a-zA-Z0-9_-]{1,127}$",
"tests": [
{
"description": "Valid compute environment name",
"input": "ved-us-east-2"
},
{
"description": "valid backupvaultname- Uppercase letters",
"input": "Ved-US-east_2"
},
{
"description": "Invalid backupvaultname- special character other than hyphen",
"input": "ved/us-east-2@@",
"expected": false
}
],
".turbot": {
"uri": "tmod:@turbot/aws-batch#/definitions/computeEnvironmentName",
"modUri": "tmod:@turbot/aws-batch"
}
}

computeEnvOrderItem

{
"type": "object",
"properties": {
"order": {
"type": "number"
},
"computeEnvironment": {
"$ref": "#/definitions/computeEnvironmentAka"
}
},
"tests": [
{
"input": {
"order": 1,
"computeEnvironment": "arn:aws-us-gov:ecs:us-east-1:012345678910:cluster/my-cluster"
}
},
{
"description": "invalid - order cannot contain character",
"input": {
"order": "a",
"computeEnvironment": "arn:aws-us-gov:ecs:us-east-1:012345678910:cluster/my-cluster"
},
"expected": false
}
],
".turbot": {
"uri": "tmod:@turbot/aws-batch#/definitions/computeEnvOrderItem",
"modUri": "tmod:@turbot/aws-batch"
}
}

jobDefinition

{
"type": "object",
"properties": {
"jobDefinitionName": {
"$ref": "#/definitions/jobDefinitionName"
},
"status": {
"$ref": "#/definitions/status"
},
"jobDefinitionArn": {
"type": "string"
},
"revision": {
"type": "integer"
},
"parameters": {
"type": "object"
},
"containerProperties": {
"type": "object"
},
"nextToken": {
"type": "string"
},
"maxResults": {
"type": "integer"
},
"turbot": {
"type": "object",
"properties": {
"akas": {
"type": "array",
"items": {
"$ref": "#/definitions/jobDefinitionAka"
}
},
"title": {
"$ref": "#/definitions/jobDefinitionName"
},
"custom": {
"type": "object",
"properties": {
"aws": {
"$ref": "aws#/definitions/awsMetadata"
},
"createTimestamp": {
"$ref": "turbot#/definitions/isoTimestamp"
}
}
}
}
}
},
"additionalProperties": true,
"tests": [
{
"description": "all properties given",
"input": {
"jobDefinitionName": "ved-test",
"jobDefinitionArn": "arn:aws:batch:us-west-2:560741234067:job-definition/ved23:1",
"revision": 1,
"parameters": {},
"containerProperties": {
"image": "amazonlinux",
"vcpus": 1,
"memory": 4,
"command": [],
"volumes": [],
"environment": [],
"mountPoints": [],
"ulimits": [],
"resourceRequirements": []
},
"turbot": {
"akas": [
"arn:aws:batch:us-east-1:123456789012:job-definition/ved-test:1"
],
"title": "ved-test",
"custom": {
"aws": {
"accountId": 123456789012,
"regionName": "us-east-1"
}
}
}
}
}
],
".turbot": {
"uri": "tmod:@turbot/aws-batch#/definitions/jobDefinition",
"modUri": "tmod:@turbot/aws-batch"
}
}

jobDefinitionAka

{
"type": "string",
"pattern": "^arn:aws(-us-gov|-cn)?:batch:[a-z]{2}-[a-z]+-[0-9]:[0-9]{12}:job-definition/[a-zA-Z0-9_:-]{1,127}$",
"tests": [
{
"description": "Valid - Base case",
"input": "arn:aws:batch:us-east-1:123456789012:job-definition/ved-test"
},
{
"description": "Invalid - Malformed resource collection",
"input": "arn:aws:batch:us-east-1:123456789012:workspacess/ved@12345",
"expected": false
}
],
".turbot": {
"uri": "tmod:@turbot/aws-batch#/definitions/jobDefinitionAka",
"modUri": "tmod:@turbot/aws-batch"
}
}

jobDefinitionName

{
"type": "string",
"pattern": "^[a-zA-Z0-9_-]{1,127}$",
"tests": [
{
"description": "Valid job definition name",
"input": "ved-us-east-2"
},
{
"description": "valid backupvaultname- Uppercase letters",
"input": "Ved-US-east_2"
},
{
"description": "Invalid backupvaultname- special character other than hyphen",
"input": "ved/us-east-2@@",
"expected": false
}
],
".turbot": {
"uri": "tmod:@turbot/aws-batch#/definitions/jobDefinitionName",
"modUri": "tmod:@turbot/aws-batch"
}
}

jobqArn

{
"type": "string",
"pattern": "^arn:aws(-us-gov|-cn)?:batch:[a-z]{2}-[a-z]+-[0-9]:[0-9]{12}:job-queue/[a-zA-Z0-9_:-]{1,127}$",
"tests": [
{
"description": "Valid - Base case",
"input": "arn:aws:batch:us-east-1:123456789012:job-queue/ved-test"
},
{
"description": "Invalid - Malformed resource collection",
"input": "arn:aws:batch:us-east-1:123456789012:workspacess/ved@12345",
"expected": false
}
],
".turbot": {
"uri": "tmod:@turbot/aws-batch#/definitions/jobqArn",
"modUri": "tmod:@turbot/aws-batch"
}
}

jobqName

{
"type": "string",
"pattern": "^[a-zA-Z0-9_-]{1,127}$",
"tests": [
{
"description": "Valid job queue name",
"input": "ved-us-east-2"
},
{
"description": "Invalid job queue name - special character other than hyphen",
"input": "ved/us-east-2@@",
"expected": false
}
],
".turbot": {
"uri": "tmod:@turbot/aws-batch#/definitions/jobqName",
"modUri": "tmod:@turbot/aws-batch"
}
}

jobQueue

{
"type": "object",
"properties": {
"jobQueueName": {
"$ref": "#/definitions/jobqName"
},
"jobQueueArn": {
"$ref": "#/definitions/jobqArn"
},
"computeEnvironmentOrder": {
"type": "array",
"items": {
"$ref": "#/definitions/computeEnvOrderItem"
}
},
"priority": {
"type": "number"
},
"state": {
"type": "string",
"enum": [
"ENABLED",
"DISABLED"
]
},
"status": {
"type": "string",
"enum": [
"CREATING",
"UPDATING",
"DELETING",
"DELETED",
"VALID",
"INVALID"
]
},
"statusReason": {
"type": "string"
},
"tags": {
"$ref": "aws#/definitions/tagsMap"
},
"turbot": {
"type": "object",
"properties": {
"akas": {
"type": "array",
"items": {
"$ref": "#/definitions/jobqArn"
}
},
"tags": {
"$ref": "aws#/definitions/tagsMap"
},
"title": {
"$ref": "#/definitions/jobqName"
},
"custom": {
"type": "object",
"properties": {
"aws": {
"$ref": "aws#/definitions/awsMetadata"
},
"createTimestamp": {
"$ref": "turbot#/definitions/isoTimestamp"
}
}
}
}
}
},
"additionalProperties": true,
"tests": [
{
"description": "all properties given",
"input": {
"jobQueueArn": "arn:aws:batch:us-east-1:388460667113:job-queue/test",
"computeEnvironmentArn": "arn:aws:batch:us-east-1:388460667113:compute-environment/test",
"jobQueueName": "test",
"state": "ENABLED",
"status": "VALID",
"priority": 1,
"statusReason": "ComputeEnvironment Healthy",
"tags": {},
"turbot": {
"akas": [
"arn:aws:batch:us-east-1:388460667113:job-queue/test"
],
"title": "test",
"custom": {
"aws": {
"accountId": 388460667113,
"partition": "aws",
"regionName": "us-east-1"
}
}
}
}
}
],
".turbot": {
"uri": "tmod:@turbot/aws-batch#/definitions/jobQueue",
"modUri": "tmod:@turbot/aws-batch"
}
}

status

{
"type": "string",
"enum": [
"ACTIVE",
"INACTIVE"
],
".turbot": {
"uri": "tmod:@turbot/aws-batch#/definitions/status",
"modUri": "tmod:@turbot/aws-batch"
}
}