Definitions for @turbot/aws-kinesis
- consumer
- consumerARN
- consumerName
- consumerStatus
- kinesis
- kinesisAka
- status
- stream
- streamArn
- streamARN
- streamName
consumer
Schema
{ "type": "object", "properties": { "ConsumerName": { "$ref": "#/definitions/consumerName" }, "ConsumerCreationTimestamp": { "type": "string" }, "StreamARN": { "$ref": "#/definitions/streamARN" }, "ConsumerARN": { "$ref": "#/definitions/consumerARN" }, "ConsumerStatus": { "$ref": "#/definitions/consumerStatus" }, "turbot": { "type": "object", "properties": { "akas": { "type": "array", "items": { "$ref": "#/definitions/consumerARN" } }, "title": { "$ref": "#/definitions/consumerName" }, "custom": { "type": "object", "properties": { "aws": { "$ref": "aws#/definitions/awsMetadata" }, "createTimestamp": { "$ref": "turbot#/definitions/isoTimestamp" } } } } } }, "additionalProperties": true, "tests": [ { "description": "base case", "input": { "ConsumerName": "test01", "StreamARN": "arn:aws:kinesis:us-east-1:123456789012:stream/test01", "ConsumerARN": "arn:aws:kinesis:us-east-2:624358524054:stream/pratiksstream/consumer/pratiksconsumer:1582527978", "turbot": { "akas": [ "arn:aws:kinesis:us-east-2:624358524054:stream/pratiksstream/consumer/pratiksconsumer:1582527978" ], "title": "test01", "custom": { "aws": { "accountId": 123456789012, "regionName": "us-east-1" } } } } } ], ".turbot": { "uri": "tmod:@turbot/aws-kinesis#/definitions/consumer", "modUri": "tmod:@turbot/aws-kinesis" }}consumerARN
Schema
{ "type": "string", "minLength": 1, "maxLength": 2048, "pattern": "^arn:aws(-us-gov|-cn)?:kinesis:[a-z]{2}(-gov)?-[a-z]+-[0-9]:[0-9]{12}:stream/[a-zA-Z0-9_.-]+/consumer/[a-zA-Z0-9_.-]+:[0-9]+$", "tests": [ { "input": "arn:aws:kinesis:us-east-2:624358524054:stream/pratiksstream/consumer/pratiksconsumer:1582527978" }, { "description": "invalid - should start with arn", "input": "hi hi", "expected": false }, { "description": "invalid - aws account id is wrong", "input": "arn:aws:kinesis:us-east-1:123456788799012:stream/stream-test01/consumer/test01", "expected": false } ], ".turbot": { "uri": "tmod:@turbot/aws-kinesis#/definitions/consumerARN", "modUri": "tmod:@turbot/aws-kinesis" }}consumerName
Schema
{ "type": "string", "pattern": "^[a-zA-Z0-9_.-]{1,128}$", "tests": [ { "input": "test01" }, { "description": "invalid - empty string", "input": "", "expected": false }, { "description": "invalid - max length exceeded", "input": "test01test01test01test01test01test01test01test01test01test01test01test01test01test01test01test01test01test01test01test01test01test01", "expected": false }, { "description": "invalid - cannot use hash, asterisk, ampersand, cap, percentile not allowed", "input": "consumer#*&^%", "expected": false }, { "description": "invalid - cannot start with at character", "input": "@consumer", "expected": false } ], ".turbot": { "uri": "tmod:@turbot/aws-kinesis#/definitions/consumerName", "modUri": "tmod:@turbot/aws-kinesis" }}consumerStatus
Schema
{ "type": "string", "enum": [ "CREATING", "DELETING", "ACTIVE" ], "tests": [ { "input": "CREATING" }, { "description": "invalid - empty string", "input": "", "expected": false } ], ".turbot": { "uri": "tmod:@turbot/aws-kinesis#/definitions/consumerStatus", "modUri": "tmod:@turbot/aws-kinesis" }}kinesis
Schema
{ "allOf": [ { "$ref": "turbot#/definitions/service" }, { "type": "object", "properties": { "name": { "const": "Kinesis" }, "turbot": { "type": "object", "properties": { "akas": { "type": "array", "items": { "$ref": "#/definitions/kinesisAka" } }, "title": { "const": "Kinesis" }, "custom": { "type": "object", "properties": { "aws": { "$ref": "aws#/definitions/awsMetadata" } } } } } }, "additionalProperties": true, "tests": [ { "description": "base", "input": { "name": "Kinesis", "turbot": { "akas": [ "arn:aws:kinesis:us-east-1:123456789012" ], "title": "Kinesis", "custom": { "aws": { "accountId": 123456789012, "regionName": "us-east-1" } } } } } ] } ], ".turbot": { "uri": "tmod:@turbot/aws-kinesis#/definitions/kinesis", "modUri": "tmod:@turbot/aws-kinesis" }}kinesisAka
Schema
{ "type": "string", "pattern": "^arn:aws(-us-gov|-cn)?:kinesis:[a-z]{2}(-gov)?-[a-z]+-[0-9]{1}:[0-9]{12}$", "tests": [ { "description": "base", "input": "arn:aws:kinesis:us-east-1:123456789012" }, { "description": "invalid aka", "input": "arn:aws:kinesisservice:us-east-1:123456789012", "expected": false } ], ".turbot": { "uri": "tmod:@turbot/aws-kinesis#/definitions/kinesisAka", "modUri": "tmod:@turbot/aws-kinesis" }}status
Schema
{ "type": "string", "enum": [ "CREATING", "DELETING", "ACTIVE", "UPDATING" ], "tests": [ { "description": "base case", "input": "ACTIVE" }, { "description": "invalid - not listed", "input": "ON", "expected": false } ], ".turbot": { "uri": "tmod:@turbot/aws-kinesis#/definitions/status", "modUri": "tmod:@turbot/aws-kinesis" }}stream
Schema
{ "type": "object", "properties": { "StreamARN": { "$ref": "#/definitions/streamArn" }, "StreamStatus": { "$ref": "#/definitions/status" }, "StreamName": { "$ref": "#/definitions/streamName" }, "Tags": { "$ref": "aws#/definitions/tagList" }, "Shards": { "type": "array" }, "HasMoreShards": { "type": "boolean" }, "RetentionPeriodHours": { "type": "integer" }, "StreamCreationTimestamp": { "$ref": "turbot#/definitions/isoTimestamp" }, "EnhancedMonitoring": { "type": "array" }, "EncryptionType": { "type": "string" }, "KeyId": { "type": "string" }, "turbot": { "type": "object", "properties": { "akas": { "type": "array", "items": { "$ref": "#/definitions/streamArn" } }, "title": { "$ref": "#/definitions/streamName" }, "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": { "StreamStatus": "CREATING", "StreamName": "stream", "StreamARN": "arn:aws:kinesis:us-east-1:123456789012:stream/example-stream-name", "Shards": [ { "ShardId": "shardId-000000000000", "HashKeyRange": { "StartingHashKey": "0", "EndingHashKey": "340282366920938463463374607431768211455" }, "SequenceNumberRange": { "StartingSequenceNumber": "49596445454599619013932230954290036685523562764051677186" } } ], "HasMoreShards": false, "RetentionPeriodHours": 24, "StreamCreationTimestamp": "2019-06-07T07:23:54.000Z", "EnhancedMonitoring": [ { "ShardLevelMetrics": [] } ], "EncryptionType": "NONE", "Tags": [ { "Key": "Env", "Value": "Test" }, { "Key": "App", "Value": "Facebook" } ], "turbot": { "akas": [ "arn:aws:kinesis:us-east-1:123456789012:stream/example-stream-name" ], "tags": { "Env": "Test", "App": "Facebook" }, "custom": { "aws": { "accountId": 123456789012, "regionName": "us-east-1" } } } } } ], ".turbot": { "uri": "tmod:@turbot/aws-kinesis#/definitions/stream", "modUri": "tmod:@turbot/aws-kinesis" }}streamArn
Schema
{ "type": "string", "pattern": "^arn:aws(-us-gov|-cn)?:kinesis:[a-z]{2}(-gov)?-[a-z]+-[0-9]:[0-9]{12}:stream/[a-zA-Z0-9_.-]+$", "tests": [ { "description": "base", "input": "arn:aws:kinesis:us-east-1:123456789012:stream/example-stream-name" }, { "description": "invalid - array type provided", "input": [ "test" ], "expected": false } ], ".turbot": { "uri": "tmod:@turbot/aws-kinesis#/definitions/streamArn", "modUri": "tmod:@turbot/aws-kinesis" }}streamARN
Schema
{ "type": "string", "minLength": 1, "maxLength": 2048, "pattern": "^arn:aws(-us-gov|-cn)?:kinesis:[a-z]{2}(-gov)?-[a-z]+-[0-9]:[0-9]{12}:stream/[a-zA-Z0-9_.-]+$", "tests": [ { "input": "arn:aws:kinesis:us-east-1:123456789012:stream/test01" }, { "description": "invalid - should start with arn", "input": "hello", "expected": false }, { "description": "invalid - aws account id is wrong", "input": "arn:aws:kinesis:us-east-1:123478956789012:stream/test01", "expected": false } ], ".turbot": { "uri": "tmod:@turbot/aws-kinesis#/definitions/streamARN", "modUri": "tmod:@turbot/aws-kinesis" }}streamName
Schema
{ "type": "string", "pattern": "^[a-zA-Z0-9_.-]+$", "maxLength": 128, "minLength": 1, "tests": [ { "description": "base", "input": "stream" }, { "description": "max length", "input": "myfirststreammyfirststreammyfirststreammyfirststreammyfirststreammyfirststreammyfirststreammyfirststreammyfirstst123456789123450" }, { "description": "invalid - too long", "input": "myfirststreammyfirststreammyfirststreammyfirststreammyfirststreammyfirststreammyfirststreammyfirststreammyfirstst1234567891234501234", "expected": false }, { "description": "invalid - cannot start with at character", "input": "@stream", "expected": false } ], ".turbot": { "uri": "tmod:@turbot/aws-kinesis#/definitions/streamName", "modUri": "tmod:@turbot/aws-kinesis" }}