Definitions for @turbot/aws-amplify

amplify

{
"allOf": [
{
"$ref": "turbot#/definitions/service"
},
{
"type": "object",
"properties": {
"name": {
"const": "Amplify"
},
"turbot": {
"type": "object",
"properties": {
"akas": {
"type": "array",
"items": {
"$ref": "#/definitions/amplifyAka"
}
},
"title": {
"const": "Amplify"
},
"custom": {
"type": "object",
"properties": {
"aws": {
"$ref": "aws#/definitions/awsMetadata"
}
}
}
}
}
},
"required": [
"turbot"
],
"additionalProperties": true,
"tests": [
{
"description": "All data are valid",
"input": {
"name": "Amplify",
"turbot": {
"akas": [
"arn:aws:amplify:us-east-1:123123123123"
],
"title": "Amplify",
"custom": {
"aws": {
"accountId": 123456789012,
"regionName": "us-east-1"
}
}
}
}
}
]
}
],
".turbot": {
"uri": "tmod:@turbot/aws-amplify#/definitions/amplify",
"modUri": "tmod:@turbot/aws-amplify"
}
}

amplifyAka

{
"type": "string",
"pattern": "^arn:aws:amplify:[a-z]{2}-[a-z]+-[0-9]{1}:[0-9]{12}",
"tests": [
{
"description": "base",
"input": "arn:aws:amplify:us-east-1:123123123123"
},
{
"description": "invalid service name",
"input": "arn:aws:amplifye:us-east-1:123123123123",
"expected": false
},
{
"description": "invalid region name",
"input": "arn:aws:amplify:us-eastdk-74381:123456786354",
"expected": false
}
],
".turbot": {
"uri": "tmod:@turbot/aws-amplify#/definitions/amplifyAka",
"modUri": "tmod:@turbot/aws-amplify"
}
}

amplifySupportedRegions

{
"type": "array",
"items": {
"$ref": "#/definitions/regionName"
},
"minItems": 1,
"example": [
"eu-west-1",
"eu-west-2"
],
"default": [
"ap-southeast-2",
"eu-west-1",
"us-east-1",
"us-east-2",
"us-west-2"
],
"tests": [
{
"description": "one region",
"input": [
"us-east-1"
]
},
{
"description": "all supported regions",
"input": [
"ap-southeast-2",
"eu-west-1",
"us-east-1",
"us-east-2",
"us-west-2"
]
},
{
"description": "invalid - no regions",
"input": [],
"expected": false
}
],
".turbot": {
"uri": "tmod:@turbot/aws-amplify#/definitions/amplifySupportedRegions",
"modUri": "tmod:@turbot/aws-amplify"
}
}

app

{
"type": "object",
"properties": {
"appId": {
"$ref": "#/definitions/appId"
},
"name": {
"$ref": "#/definitions/appName"
},
"appArn": {
"$ref": "#/definitions/appArn"
},
"tags": {
"$ref": "aws#/definitions/tagsMap"
},
"description": {
"type": "string"
},
"repository": {
"type": "string"
},
"platform": {
"type": "string"
},
"iamServiceRoleArn": {
"type": "string"
},
"environmentVariables": {
"type": "string"
},
"enableBranchAutoBuild": {
"type": "boolean"
},
"enableBasicAuth": {
"type": "boolean"
},
"basicAuthCredentials": {
"type": "string"
},
"customRules": {
"type": "array"
},
"buildSpec": {
"type": "string"
},
"enableAutoBranchCreation": {
"type": "boolean"
},
"defaultDomain": {
"type": "string"
},
"productionBranch": {
"type": "object"
},
"createTime": {
"$ref": "turbot#/definitions/isoTimestamp"
},
"updateTime": {
"$ref": "turbot#/definitions/isoTimestamp"
},
"turbot": {
"type": "object",
"properties": {
"akas": {
"type": "array",
"items": {
"$ref": "#/definitions/appArn"
}
},
"tags": {
"$ref": "aws#/definitions/tagsMap"
},
"title": {
"$ref": "#/definitions/appName"
},
"custom": {
"type": "object",
"properties": {
"aws": {
"$ref": "aws#/definitions/awsMetadata"
},
"createTimestamp": {
"$ref": "turbot#/definitions/isoTimestamp"
},
"lastUsedTimestamp": {
"$ref": "turbot#/definitions/isoTimestamp"
}
}
}
}
}
},
"additionalProperties": true,
"tests": [
{
"description": "Valid - All properties",
"input": {
"appId": "d23xd0h2qqh7nh",
"name": "test01",
"description": null,
"repository": null,
"platform": "WEB",
"enableAutoBranchCreation": false,
"iamServiceRoleArn": null,
"buildSpec": null,
"customRules": [],
"enableBasicAuth": false,
"basicAuthCredentials": null,
"productionBranch": {
"lastDeployTime": null,
"status": "RUNNING",
"thumbnailUrl": "https://aws-amplify-prod-us-east-1-artifacts.s3.amazonaws.com/d3it4qtgt8lqc4/dev/SCREENSHOTS/thumbnail.png?X-Amz-Security-Token=IQoJb3JpZ2luX2VjEJ%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaCXVzLWVhc3QtMSJGMEQCIGrNCzrjiBmLbGiHgH4NmdQb96slG3GXSMZ5%2B7M%2BQpHaAiBQ872eCBinirnSYhO%2F6N1uhEloJxaUKyYwmbOHn1lJDyr%2BAQjo%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F8BEAEaDDA3MzY1MzE3MTU3NiIMP7l2BCt9WKkfFcDjKtIBpzUBOr5zrTG6DaLxGpQ8llS9%2Bd5moVsnUbf6E7C89O4zUWRwCL5QWM%2FgoEWgi%2FoYONl6fc9kT0FvwzByBYsYm2UjJSSFay24Kx1KrZdvlMiFUTa6rKHxlzpidg7dLjm4VmrIt%2Boe1HNj%2B2EhiUzy4Jtox03PQ5dF7HFFNM8F62Sh1KS3%2BHNNjhg%2FeiJtXarKTyiQcEiOk8j6cWcnhWPzcziRFrqucKmrTSStbdP5Q3q4%2FAnIAk2gWPdMVzqDkcxx%2BnADFVm2PWjLhRm%2FUPsbjEfWMP2awu8FOuEB1Bps5B2JqiunozI7RcRnA5wwmG%2BNOG0SB1xryfZVguxQruwtw7aMIBnb%2Bft%2FlPTppAhA3WOcAS6ufrTeSc%2BnBsWNc7P867f11iDubmSEVKAeSk44IKIS%2BqN%2BkeEiHx4S0NYug0anxvggWERDepiVinXpRB%2BfiQcLMWAziqeANQUWxKlRkGqB8rWZ8kJYGyVHSlJlUE2aW0U3PaxsDsXVkjTrUvipJufU2MGeWoevDTMtl4OReC%2BASOE4zXIiSvgTxlkhHTdKPD3iOhz6KzyrQwntxdACW4DOrg3M0ajbHomi&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20191211T072112Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Credential=ASIARCJQSGV4DPK5FEEY%2F20191211%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=7a70cc05fc76438ff30741de4234576108cbf16970f865edcbb7ac68aec914b9",
"branchName": "dev"
},
"defaultDomain": "d3it4qtgt8lqc4.amplifyapp.com",
"turbot": {
"akas": [
"arn:aws:amplify:us-west-2:492552618977:apps/d23xd0h2qqh7nh"
],
"title": "test01",
"custom": {
"aws": {
"accountId": 123456789012,
"regionName": "us-east-1"
}
}
}
}
},
{
"description": "Invalid - Missing appId",
"input": {
"name": "test01",
"turbot": {
"akas": [
"arn:aws:amplify:us-west-2:492552618977:apps/d23xd0h2qqh7nh"
],
"title": "test01",
"custom": {
"aws": {
"accountId": 123456789012,
"regionName": "us-east-1"
}
}
}
}
},
{
"description": "Invalid - Missing turbot data",
"input": {
"appId": "d23xd0h2qqh7nh",
"name": "test01"
}
}
],
".turbot": {
"uri": "tmod:@turbot/aws-amplify#/definitions/app",
"modUri": "tmod:@turbot/aws-amplify"
}
}

appArn

{
"type": "string",
"pattern": "^arn:aws(-us-gov|-cn)?:amplify:[a-z]{2}(-gov)?-[a-z]+-[0-9]:[0-9]{12}:apps/[a-z0-9]{1,14}$",
"tests": [
{
"input": "arn:aws:amplify:us-west-2:492552618977:apps/d23xd0h2qqh7nh"
},
{
"description": "invalid - incorrect arn pattern",
"input": "arn:aws:AMPLIFY:us-west-2:492552618977:APPS/d23xd0h2qq",
"expected": false
},
{
"description": "invalid - arn passed as array",
"input": [
"arn:aws:amplify:us-west-2:1234567898:apps/d23xd0h2qqh7nh"
],
"expected": false
}
],
".turbot": {
"uri": "tmod:@turbot/aws-amplify#/definitions/appArn",
"modUri": "tmod:@turbot/aws-amplify"
}
}

appId

{
"type": "string",
"pattern": "^[a-z0-9]{1,14}$",
"tests": [
{
"input": "d23xd0h2qqh7nh"
},
{
"description": "invalid - should not be empty",
"input": "",
"expected": false
},
{
"description": "invalid - max length exceeded",
"input": "d23xd0h2qqh7nhd23xd0h2qqh7nhd23xd0h2qqh7nh",
"expected": false
}
],
".turbot": {
"uri": "tmod:@turbot/aws-amplify#/definitions/appId",
"modUri": "tmod:@turbot/aws-amplify"
}
}

appName

{
"type": "string",
"minLength": 1,
"tests": [
{
"input": "test01"
},
{
"description": "invalid - should not be empty",
"input": "",
"expected": false
},
{
"description": "invalid - array type passed",
"input": [
"cluster123cluster123cluster123cluster123cluster123cluster123cluster123"
],
"expected": false
}
],
".turbot": {
"uri": "tmod:@turbot/aws-amplify#/definitions/appName",
"modUri": "tmod:@turbot/aws-amplify"
}
}

regionName

{
"type": "string",
"enum": [
"ap-southeast-2",
"eu-west-1",
"us-east-1",
"us-east-2",
"us-west-2"
],
"tests": [
{
"input": "us-east-1"
},
{
"description": "invalid - usea1",
"input": "usea1",
"expected": false
},
{
"description": "invalid - au-north-1",
"input": "au-north-1",
"expected": false
}
],
".turbot": {
"uri": "tmod:@turbot/aws-amplify#/definitions/regionName",
"modUri": "tmod:@turbot/aws-amplify"
}
}