Definitions for @turbot/aws-cloudsearch

cloudSearch

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

cloudSearchAka

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

cloudSearchSupportedRegions

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

domain

{
"type": "object",
"properties": {
"DomainName": {
"$ref": "#/definitions/domainName"
},
"DomainId": {
"$ref": "#/definitions/domainId"
},
"ARN": {
"$ref": "#/definitions/domainArn"
},
"Created": {
"type": "boolean"
},
"Deleted": {
"type": "boolean"
},
"DocService": {
"type": "object"
},
"SearchService": {
"type": "object"
},
"RequiresIndexDocuments": {
"type": "boolean"
},
"Processing": {
"type": "boolean"
},
"SearchInstanceType": {
"type": "string"
},
"SearchPartitionCount": {
"type": "integer"
},
"SearchInstanceCount": {
"type": "integer"
},
"Limits": {
"type": "object"
},
"AccessPolicies": {
"type": "string"
},
"turbot": {
"type": "object",
"properties": {
"akas": {
"type": "array",
"items": {
"$ref": "#/definitions/domainArn"
}
},
"title": {
"$ref": "#/definitions/domainName"
},
"custom": {
"type": "object",
"properties": {
"aws": {
"$ref": "aws#/definitions/awsMetadata"
},
"createTimestamp": {
"$ref": "turbot#/definitions/isoTimestamp"
}
}
}
}
}
},
"additionalProperties": true,
"tests": [
{
"description": "base - All required properties",
"input": {
"DomainName": "test-01",
"DomainId": "123456789012/test-01",
"ARN": "arn:aws:cloudsearch:us-west-2:123456789012:domain/test-01",
"Created": true,
"Deleted": false,
"DocService": {
"Endpoint": "doc-test12-nyq4fnejyv6nzigzhb72eutrbi.us-west-2.cloudsearch.amazonaws.com"
},
"SearchService": {
"Endpoint": "search-test12-nyq4fnejyv6nzigzhb72eutrbi.us-west-2.cloudsearch.amazonaws.com"
},
"RequiresIndexDocuments": false,
"Processing": false,
"SearchInstanceType": "search.m1.small",
"SearchPartitionCount": 1,
"SearchInstanceCount": 1,
"Limits": {
"MaximumReplicationCount": 5,
"MaximumPartitionCount": 10
},
"turbot": {
"akas": [
"arn:aws:cloudsearch:us-west-2:123456789012:domain/test-01"
],
"title": "test-01",
"custom": {
"aws": {
"accountId": 123456789012,
"regionName": "us-east-1"
}
}
}
}
}
],
".turbot": {
"uri": "tmod:@turbot/aws-cloudsearch#/definitions/domain",
"modUri": "tmod:@turbot/aws-cloudsearch"
}
}

domainArn

{
"type": "string",
"pattern": "arn:aws(-us-gov|-cn)?:cloudsearch:[a-z]{2}(-gov)?-[a-z]+-[0-9]:[0-9]{12}:domain/[a-z0-9-]{3,28}$",
"tests": [
{
"input": "arn:aws:cloudsearch:us-west-2:123456789012:domain/test-01"
},
{
"description": "invalid - should start with arn",
"input": "arm:aws:cloudsearch:us-west-2:123456789012:domain/test-01",
"expected": false
},
{
"description": "invalid - AWS account id is wrong",
"input": "arn:aws:cloudsearch:us-west-2:123456789021312:domain/test-01",
"expected": false
}
],
".turbot": {
"uri": "tmod:@turbot/aws-cloudsearch#/definitions/domainArn",
"modUri": "tmod:@turbot/aws-cloudsearch"
}
}

domainId

{
"type": "string",
"pattern": "^[0-9]{12}/[a-z0-9-]{3,28}$",
"tests": [
{
"description": "max length",
"input": "123456789012/test-01test-01test-01test123"
},
{
"description": "min length",
"input": "123456789012/tes"
},
{
"description": "invalid - cannot use capital letters, underscore , dollar, hash, asterisk, ampersand, cap, percentile not allowed",
"input": "123456789012/Test-_01_01T#@^%$*01Test",
"expected": false
}
],
".turbot": {
"uri": "tmod:@turbot/aws-cloudsearch#/definitions/domainId",
"modUri": "tmod:@turbot/aws-cloudsearch"
}
}

domainName

{
"type": "string",
"pattern": "^[a-z0-9-]{3,28}$",
"tests": [
{
"input": "test-01test-01test-01test123"
},
{
"description": "invalid - too long",
"input": "test-01test-01test-01test1232",
"expected": false
},
{
"description": "invalid - less than minimum length",
"input": "ab",
"expected": false
}
],
".turbot": {
"uri": "tmod:@turbot/aws-cloudsearch#/definitions/domainName",
"modUri": "tmod:@turbot/aws-cloudsearch"
}
}

regionName

{
"type": "string",
"enum": [
"ap-northeast-1",
"ap-northeast-2",
"ap-southeast-1",
"ap-southeast-2",
"eu-central-1",
"eu-west-1",
"sa-east-1",
"us-east-1",
"us-west-1",
"us-west-2"
],
"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-cloudsearch#/definitions/regionName",
"modUri": "tmod:@turbot/aws-cloudsearch"
}
}