Definitions for @turbot/aws-cloudwatch
- alarm
- alarmArn
- alarmComparisonOperator
- alarmName
- alarmStatistic
- alarmStatus
- alarmUnit
- cloudWatch
- cloudWatchAka
- cloudWatchSupportedRegions
- regionName
alarm
Schema
{ "type": "object", "properties": { "AlarmName": { "$ref": "#/definitions/alarmName" }, "AlarmArn": { "$ref": "#/definitions/alarmArn" }, "AlarmDescription": { "type": "string" }, "AlarmConfigurationUpdatedTimestamp": { "$ref": "turbot#/definitions/isoTimestamp" }, "ActionsEnabled": { "type": "boolean" }, "OKActions": { "type": "array" }, "AlarmActions": { "type": "array" }, "InsufficientDataActions": { "type": "array" }, "StateValue": { "$ref": "#/definitions/alarmStatus" }, "StateReason": { "type": "string" }, "StateReasonData": { "type": "object" }, "StateUpdatedTimestamp": { "$ref": "turbot#/definitions/isoTimestamp" }, "MetricName": { "type": "string" }, "Namespace": { "type": "string" }, "Statistic": { "$ref": "#/definitions/alarmStatistic" }, "ExtendedStatistic": { "type": "string" }, "Dimensions": { "type": "array" }, "Period": { "type": "number" }, "Unit": { "$ref": "#/definitions/alarmUnit" }, "EvaluationPeriods": { "type": "number" }, "DatapointsToAlarm": { "type": "number" }, "Threshold": { "type": "number" }, "ComparisonOperator": { "$ref": "#/definitions/alarmComparisonOperator" }, "TreatMissingData": { "type": "string" }, "EvaluateLowSampleCountPercentile": { "type": "string" }, "Metrics": { "type": "array" }, "ThresholdMetricId": { "type": "string" }, "turbot": { "type": "object", "properties": { "akas": { "type": "array", "items": { "$ref": "#/definitions/alarmArn" } }, "title": { "$ref": "#/definitions/alarmName" }, "metadata": { "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": { "AlarmName": "Test.The-Kitchen_Sink", "AlarmArn": "arn:aws:cloudwatch:us-east-1:123456789012:alarm:Test.The-Kitchen_Sink", "turbot": { "akas": [ "arn:aws:cloudwatch:us-east-1:123456789012:alarm:Test.The-Kitchen_Sink" ], "title": "Test.The-Kitchen_Sink", "metadata": { "aws": { "accountId": 123456789012, "regionName": "us-east-1", "partition": "aws" } } } } } ], ".turbot": { "uri": "tmod:@turbot/aws-cloudwatch#/definitions/alarm", "modUri": "tmod:@turbot/aws-cloudwatch" }}alarmArn
Schema
{ "minLength": 1, "maxLength": 1600, "type": "string", "pattern": "^arn:aws(-us-gov|-cn)?:cloudwatch:[a-z]{2}(-gov)?-[a-z]+-[0-9]{1}:[0-9]{12}:alarm:.{1,255}$", "tests": [ { "input": "arn:aws:cloudwatch:us-west-2:123456789012:alarm:alarm-name" }, { "description": "special characters", "input": "arn:aws:cloudwatch:us-west-2:492552618977:alarm:a!@#$%^&*()_+=`" }, { "description": "gov region", "input": "arn:aws:cloudwatch:us-gov-west-1:492552618977:alarm:test01" }, { "description": "invalid - should start with arn", "input": "hi hi", "expected": false }, { "description": "invalid - AWS account id is wrong", "input": "arn:aws:cloudwatch:us-west-2:492552618987977:alarm:test01", "expected": false } ], ".turbot": { "uri": "tmod:@turbot/aws-cloudwatch#/definitions/alarmArn", "modUri": "tmod:@turbot/aws-cloudwatch" }}alarmComparisonOperator
Schema
{ "type": "string", "enum": [ "GreaterThanOrEqualToThreshold", "GreaterThanThreshold", "LessThanThreshold", "LessThanOrEqualToThreshold", "LessThanLowerOrGreaterThanUpperThreshold", "LessThanLowerThreshold", "GreaterThanUpperThreshold" ], ".turbot": { "uri": "tmod:@turbot/aws-cloudwatch#/definitions/alarmComparisonOperator", "modUri": "tmod:@turbot/aws-cloudwatch" }}alarmName
Schema
{ "type": "string", "pattern": "^.{1,255}$", "tests": [ { "input": "Test.The-Kitchen_Sink" }, { "description": "min length", "input": "A" }, { "description": "max length", "input": "a123456789_a123456789_a123456789_a123456789_a123456789_a123456789_a123456789_a123456789_a123456789_a123456789_a123456789_a123456789_a123456789_a123456789_a123456789_a123456789_a123456789_a123456789_a123456789_a123456789_a123456789_a123456789_a123456789_a1" }, { "description": "invalid - too long", "input": "a123456789_a123456789_a123456789_a123456789_a123456789_a123456789_a123456789_a123456789_a123456789_a123456789_a123456789_a123456789_a123456789_a123456789_a123456789_a123456789_a123456789_a123456789_a123456789_a123456789_a123456789_a123456789_a123456789_a12345", "expected": false } ], ".turbot": { "uri": "tmod:@turbot/aws-cloudwatch#/definitions/alarmName", "modUri": "tmod:@turbot/aws-cloudwatch" }}alarmStatistic
Schema
{ "type": "string", "enum": [ "SampleCount", "Average", "Sum", "Minimum", "Maximum" ], ".turbot": { "uri": "tmod:@turbot/aws-cloudwatch#/definitions/alarmStatistic", "modUri": "tmod:@turbot/aws-cloudwatch" }}alarmStatus
Schema
{ "type": "string", ".turbot": { "uri": "tmod:@turbot/aws-cloudwatch#/definitions/alarmStatus", "modUri": "tmod:@turbot/aws-cloudwatch" }}alarmUnit
Schema
{ "type": "string", "enum": [ "Seconds", "Microseconds", "Milliseconds", "Bytes", "Kilobytes", "Megabytes", "Gigabytes", "Terabytes", "Bits", "Kilobits", "Megabits", "Gigabits", "Terabits", "Percent", "Count", "Bytes/Second", "Kilobytes/Second", "Megabytes/Second", "Gigabytes/Second", "Terabytes/Second", "Bits/Second", "Kilobits/Second", "Megabits/Second", "Gigabits/Second", "Terabits/Second", "Count/Second", "None" ], ".turbot": { "uri": "tmod:@turbot/aws-cloudwatch#/definitions/alarmUnit", "modUri": "tmod:@turbot/aws-cloudwatch" }}cloudWatch
Schema
{ "allOf": [ { "$ref": "turbot#/definitions/service" }, { "type": "object", "properties": { "name": { "const": "CloudWatch" }, "turbot": { "type": "object", "properties": { "akas": { "type": "array", "items": { "$ref": "#/definitions/cloudWatchAka" } }, "title": { "const": "CloudWatch" }, "custom": { "type": "object", "properties": { "aws": { "$ref": "aws#/definitions/awsMetadata" } } } } } }, "additionalProperties": true, "tests": [ { "description": "All data are valid", "input": { "name": "CloudWatch", "turbot": { "akas": [ "arn:aws:cloudwatch:us-east-1:123456789012" ], "title": "CloudWatch", "custom": { "aws": { "accountId": 123456789012, "regionName": "us-east-1" } } } } } ] } ], ".turbot": { "uri": "tmod:@turbot/aws-cloudwatch#/definitions/cloudWatch", "modUri": "tmod:@turbot/aws-cloudwatch" }}cloudWatchAka
Schema
{ "type": "string", "pattern": "^arn:aws(-us-gov|-cn)?:cloudwatch:[a-z]{2}(-gov)?-[a-z]+-[0-9]{1}:[0-9]{12}", "tests": [ { "description": "base", "input": "arn:aws:cloudwatch:us-east-1:123123123123" }, { "description": "invalid service name", "input": "arn:aws:cloudWatch:us-east-1:123123123123", "expected": false }, { "description": "invalid region name", "input": "arn:aws:cloudwatch:us-eastdk-74381:123456786354", "expected": false } ], ".turbot": { "uri": "tmod:@turbot/aws-cloudwatch#/definitions/cloudWatchAka", "modUri": "tmod:@turbot/aws-cloudwatch" }}cloudWatchSupportedRegions
Schema
{ "type": "array", "items": { "$ref": "#/definitions/regionName" }, "minItems": 1, "example": [ [ "us-east-1", "us-east-2" ] ], "default": [ "ap-northeast-1", "ap-northeast-2", "ap-northeast-3", "ap-south-1", "ap-southeast-1", "ap-southeast-2", "ca-central-1", "cn-north-1", "cn-northwest-1", "eu-central-1", "eu-north-1", "eu-west-1", "eu-west-2", "eu-west-3", "sa-east-1", "us-east-1", "us-east-2", "us-gov-east-1", "us-gov-west-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-northeast-3", "ap-south-1", "ap-southeast-1", "ap-southeast-2", "ca-central-1", "cn-north-1", "cn-northwest-1", "eu-central-1", "eu-north-1", "eu-west-1", "eu-west-2", "eu-west-3", "sa-east-1", "us-east-1", "us-east-2", "us-gov-east-1", "us-gov-west-1", "us-west-1", "us-west-2" ] }, { "description": "invalid - no regions", "input": [], "expected": false } ], ".turbot": { "uri": "tmod:@turbot/aws-cloudwatch#/definitions/cloudWatchSupportedRegions", "modUri": "tmod:@turbot/aws-cloudwatch" }}regionName
Schema
{ "type": "string", "enum": [ "ap-northeast-1", "ap-northeast-2", "ap-northeast-3", "ap-south-1", "ap-southeast-1", "ap-southeast-2", "ca-central-1", "cn-north-1", "cn-northwest-1", "eu-central-1", "eu-north-1", "eu-west-1", "eu-west-2", "eu-west-3", "sa-east-1", "us-east-1", "us-east-2", "us-gov-east-1", "us-gov-west-1", "us-west-1", "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-cloudwatch#/definitions/regionName", "modUri": "tmod:@turbot/aws-cloudwatch" }}