Definitions for @turbot/aws-mq
- broker
- brokerArn
- brokerId
- brokerName
- brokerState
- configuration
- configurationArn
- configurationId
- configurationName
- mq
- mqAka
broker
Schema
{ "type": "object", "properties": { "BrokerId": { "$ref": "#/definitions/brokerId" }, "BrokerName": { "$ref": "#/definitions/brokerName" }, "Tags": { "$ref": "aws#/definitions/tagsMap" }, "BrokerArn": { "$ref": "#/definitions/brokerArn" }, "BrokerInstances": { "type": "array" }, "Created": { "$ref": "turbot#/definitions/isoTimestamp" }, "EncryptionOptions": { "type": "object" }, "Logs": { "type": "object" }, "Users": { "type": "array" }, "BrokerState": { "$ref": "#/definitions/brokerState" }, "turbot": { "type": "object", "properties": { "tags": { "$ref": "aws#/definitions/tagsMap" }, "akas": { "type": "array", "items": { "$ref": "#/definitions/brokerArn" } }, "title": { "$ref": "#/definitions/brokerName" }, "metadata": { "type": "object", "properties": { "aws": { "$ref": "aws#/definitions/awsMetadata" }, "createTimestamp": { "$ref": "turbot#/definitions/isoTimestamp" } } } } } }, "additionalProperties": true, "tests": [ { "description": "Valid - All properties", "input": { "BrokerId": "b-71e07010-2568-4f78-90a1-b58d5dd3d789", "BrokerName": "test02", "BrokerInstances": [ { "ConsoleURL": "https://b-e86ab90b-1c98-4d08-ab08-5f3d18ae2795-1.mq.us-east-1.amazonaws.com:8162", "Endpoints": [ "ssl://b-e86ab90b-1c98-4d08-ab08-5f3d18ae2795-1.mq.us-east-1.amazonaws.com:61617" ] } ], "BrokerState": "RUNNING", "Created": "2019-12-08T05:25:48.289Z", "EncryptionOptions": { "UseAwsOwnedKey": true }, "Logs": { "Audit": false }, "Users": [ { "Username": "broker6" } ], "BrokerArn": "arn:aws:mq:us-west-2:492552618977:broker:test02:b-71e07010-2568-4f78-90a1-b58d5dd3d789", "tags": { "Env": "Test", "App": "Facebook" }, "turbot": { "akas": [ "arn:aws:mq:us-west-2:492552618977:broker:test02:b-71e07010-2568-4f78-90a1-b58d5dd3d789" ], "tags": { "Env": "Test", "App": "Facebook" }, "title": "i-a2345678" }, "metadata": { "aws": { "accountId": 123456789012, "regionName": "us-east-1", "partition": "aws" } } } } ], ".turbot": { "uri": "tmod:@turbot/aws-mq#/definitions/broker", "modUri": "tmod:@turbot/aws-mq" }}brokerArn
Schema
{ "type": "string", "pattern": "^arn:aws(-us-gov|-cn)?:mq:[a-z]{2}(-gov)?-[a-z]+-[0-9]{1}:[0-9]{12}:broker:[a-zA-Z0-9-_]{1,50}:[a-f0-9]-[a-f0-9]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[a-f0-9]{12}", "tests": [ { "description": "Valid AWS Partition Non-Gov", "input": "arn:aws:mq:us-west-2:492552618977:broker:test02:b-71e07010-2568-4f78-90a1-b58d5dd3d789" }, { "description": "Valid AWS Partition US Gov", "input": "arn:aws-us-gov:mq:us-gov-west-2:492552618977:broker:test02:b-71e07010-2568-4f78-90a1-b58d5dd3d789" }, { "description": "Valid AWS Partition CHINA Gov", "input": "arn:aws-cn:mq:cn-west-2:492552618977:broker:test02:b-71e07010-2568-4f78-90a1-b58d5dd3d789" }, { "description": "Invalid Service Name in the AKA", "input": "arn:aws:ram:us-west-2:492552618977:broker:test02:b-71e07010-2568-4f78-90a1-b58d5dd3d789", "expected": false }, { "description": "Invalid Region Name in the AKA", "input": "arn:aws:mq:us-west-222:492552618977:broker:test02:b-71e07010-2568-4f78-90a1-b58d5dd3d789", "expected": false }, { "description": "Invalid Account Id in the AKA", "input": "arn:aws:mq:us-west-2:49255261896677:broker:test02:b-71e07010-2568-4f78-90a1-b58d5dd3d789", "expected": false }, { "description": "Invalid AKA pattern", "input": "arn-aws-mq:us-west-2:492552618977:broker:test02:b-71e07010-2568-4f78-90a1-b58d5dd3d789", "expected": false }, { "description": "Invalid AWS partition name", "input": "arn:aws-ind:mq:us-west-2:492552618977:broker:test02:b-71e07010-2568-4f78-90a1-b58d5dd3d789", "expected": false } ], ".turbot": { "uri": "tmod:@turbot/aws-mq#/definitions/brokerArn", "modUri": "tmod:@turbot/aws-mq" }}brokerId
Schema
{ "type": "string", "pattern": "^[a-f0-9]-[a-f0-9]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[a-f0-9]{12}$", "tests": [ { "input": "b-71e07010-2568-4f78-90a1-b58d5dd3d789" }, { "description": "invalid - id should not contain special characters except -_", "input": "a!!aa52617", "expected": false }, { "description": "max length", "input": "b-71e07010-2568-4f78-90a1-b58d5dd3d789" }, { "description": "invalid - should not contain white spaces", "input": "b-71e07010-2568-4f78-90a1-b58d5dd3d7 89", "expected": false } ], ".turbot": { "uri": "tmod:@turbot/aws-mq#/definitions/brokerId", "modUri": "tmod:@turbot/aws-mq" }}brokerName
Schema
{ "type": "string", "pattern": "^[a-zA-Z0-9-_]{1,50}$", "tests": [ { "input": "test-broker" }, { "description": "invalid - broker cannot contain exclamation character", "input": "a!!aa52617", "expected": false }, { "description": "max length", "input": "abcdefghijklmnopqrstuvwxyzabcdefghijklmnopqrstasdc" }, { "description": "invalid - broker name too long", "input": "abcdefghijklmnopqrstuvwxyzabcdefghijklmnopqrstasdca", "expected": false } ], ".turbot": { "uri": "tmod:@turbot/aws-mq#/definitions/brokerName", "modUri": "tmod:@turbot/aws-mq" }}brokerState
Schema
{ "type": "string", "enum": [ "CREATION_IN_PROGRESS", "CREATION_FAILED", "DELETION_IN_PROGRESS", "RUNNING", "REBOOT_IN_PROGRESS" ], "tests": [ { "input": "DELETION_IN_PROGRESS" }, { "description": "invalid - empty string", "input": "", "expected": false } ], ".turbot": { "uri": "tmod:@turbot/aws-mq#/definitions/brokerState", "modUri": "tmod:@turbot/aws-mq" }}configuration
Schema
{ "type": "object", "properties": { "Id": { "$ref": "#/definitions/configurationId" }, "Tags": { "$ref": "aws#/definitions/tagsMap" }, "Name": { "$ref": "#/definitions/configurationName" }, "Arn": { "$ref": "#/definitions/configurationArn" }, "turbot": { "type": "object", "properties": { "tags": { "$ref": "aws#/definitions/tagsMap" }, "akas": { "type": "array", "items": { "$ref": "#/definitions/configurationArn" } }, "title": { "$ref": "#/definitions/configurationName" }, "metadata": { "type": "object", "properties": { "aws": { "$ref": "aws#/definitions/awsMetadata" }, "createTimestamp": { "$ref": "turbot#/definitions/isoTimestamp" } } } } } }, "required": [ "Name", "Id", "Arn", "turbot" ], "tests": [ { "description": "Base - all required properties", "input": { "Id": "c-1234a5b6-78cd-901e-2fgh-3i45j6k178l9", "Name": "MyConfiguration", "Arn": "arn:aws:mq:us-east-2:123456789012:configuration:c-9876l5k4-32ji-109h-8gfe-7d65c4b132a1", "Tags": { "Env": "Test", "App": "Facebook" }, "turbot": { "akas": [ "arn:aws:mq:us-east-2:123456789012:configuration:c-9876l5k4-32ji-109h-8gfe-7d65c4b132a1" ], "tags": { "Env": "Test", "App": "Facebook" }, "title": "MyConfiguration", "metadata": { "aws": { "accountId": 123456789012, "regionName": "us-east-1", "partition": "aws" } } } } }, { "descripion": "invalid - Id is missing", "input": { "Name": "MyConfiguration", "Arn": "arn:aws:mq:us-east-2:123456789012:configuration:MyConfiguration:c-9876l5k4-32ji-109h-8gfe-7d65c4b132a1", "Tags": { "Env": "Test", "App": "Facebook" }, "turbot": { "akas": [ "arn:aws:mq:us-east-2:123456789012:configuration:MyConfiguration:c-9876l5k4-32ji-109h-8gfe-7d65c4b132a1" ], "tags": { "Env": "Test", "App": "Facebook" }, "title": "MyConfiguration", "metadata": { "aws": { "accountId": 123456789012, "regionName": "us-east-1", "partition": "aws" } } } }, "expected": false } ], ".turbot": { "uri": "tmod:@turbot/aws-mq#/definitions/configuration", "modUri": "tmod:@turbot/aws-mq" }}configurationArn
Schema
{ "type": "string", "pattern": "^arn:aws(-us-gov|-cn)?:mq:[a-z]{2}(-gov)?-[a-z]+-[0-9]{1}:[0-9]{12}:configuration:c-[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$", "tests": [ { "input": "arn:aws:mq:us-east-2:123456789012:configuration:c-9876l5k4-32ji-109h-8gfe-7d65c4b132a1" }, { "description": "Invalid - should start with arn", "input": "arm:aws:mq:us-east-2:123456789012:configuration:c-9876l5k4-32ji-109h-8gfe-7d65c4b132a1", "expected": false }, { "description": "Invalid - AWS account id is wrong", "input": "arn:aws:mq:us-east-2:12345678901232:configuration:c-9876l5k4-32ji-109h-8gfe-7d65c4b132a1", "expected": false } ], ".turbot": { "uri": "tmod:@turbot/aws-mq#/definitions/configurationArn", "modUri": "tmod:@turbot/aws-mq" }}configurationId
Schema
{ "type": "string", "pattern": "^c-[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$", "tests": [ { "description": "Base", "input": "c-1234a5b6-78cd-901e-2fgh-3i45j6k178l9" }, { "description": "Invalid - cannot use dollar, hash, asterisk, ampersand, cap, percentile not allowed", "input": "c-123^a5*6-78cd-9%1e-2fgh-3$45j6&178l9", "expected": false }, { "description": "Invalid - exceeds max length", "input": "c-123^a5*6-78cd-9%1e-2fgh-3$45j6&178l912", "expected": false } ], ".turbot": { "uri": "tmod:@turbot/aws-mq#/definitions/configurationId", "modUri": "tmod:@turbot/aws-mq" }}configurationName
Schema
{ "type": "string", "pattern": "^[a-zA-Z0-9-._~]{1,150}$", "tests": [ { "input": "MyConfiguration123MyConfiguration123MyConfiguration123MyConf" } ], ".turbot": { "uri": "tmod:@turbot/aws-mq#/definitions/configurationName", "modUri": "tmod:@turbot/aws-mq" }}mq
Schema
{ "allOf": [ { "$ref": "turbot#/definitions/service" }, { "type": "object", "properties": { "name": { "const": "Amazon MQ" }, "turbot": { "type": "object", "properties": { "akas": { "type": "array", "items": { "$ref": "#/definitions/mqAka" } }, "title": { "const": "Amazon MQ" }, "metadata": { "type": "object", "properties": { "aws": { "$ref": "aws#/definitions/awsMetadata" } } } } } }, "additionalProperties": true, "tests": [ { "description": "Valid - All Properties", "input": { "name": "Amazon MQ", "turbot": { "akas": [ "arn:aws:mq:us-east-1:123456789012" ], "title": "Amazon MQ", "metadata": { "aws": { "accountId": 123456789012, "regionName": "us-east-1", "partition": "aws" } } } } } ] } ], ".turbot": { "uri": "tmod:@turbot/aws-mq#/definitions/mq", "modUri": "tmod:@turbot/aws-mq" }}mqAka
Schema
{ "type": "string", "pattern": "arn:aws(-us-gov|-cn)?:mq:[a-z]{2}(-gov)?-[a-z]+-[0-9]{1}:[0-9]{12}$", "tests": [ { "description": "Valid AWS Partition Non-Gov", "input": "arn:aws:mq:us-west-1:560741234067" }, { "description": "Valid AWS Partition US Gov", "input": "arn:aws-us-gov:mq:us-gov-west-1:560741234067" }, { "description": "Valid AWS Partition CHINA Gov", "input": "arn:aws-cn:mq:cn-north-1:560741234067" }, { "description": "Invalid Service Name in the AKA", "input": "arn:aws:ds11:us-east-1:560741234067", "expected": false }, { "description": "Invalid Region Name in the AKA", "input": "arn:aws:mq:us-easted-441:560741234067", "expected": false }, { "description": "Invalid Account Id in the AKA", "input": "arn:aws:mq:us-east-1:12345678905512", "expected": false }, { "description": "Invalid AKA pattern", "input": "ramV2|us-east-1:560741234067", "expected": false }, { "description": "Invalid AWS partition name", "input": "arn:aws-eu:mq:us-east-1:560741234067", "expected": false } ], ".turbot": { "uri": "tmod:@turbot/aws-mq#/definitions/mqAka", "modUri": "tmod:@turbot/aws-mq" }}