Definitions for @turbot/aws-directconnect

bgpPeerProperties

{
"type": "object",
"properties": {
"bgpPeerId": {
"type": "string"
},
"asn": {
"type": "integer"
},
"authKey": {
"type": "string"
},
"addressFamily": {
"type": "string"
},
"amazonAddress": {
"type": "string"
},
"customerAddress": {
"type": "string"
},
"bgpPeerState": {
"$ref": "#/definitions/bgpPeerStates"
},
"bgpStatus": {
"$ref": "#/definitions/bgpStatusValue"
},
"awsDeviceV2": {
"type": "string"
},
"awsLogicalDeviceId": {
"type": "string"
}
},
".turbot": {
"uri": "tmod:@turbot/aws-directconnect#/definitions/bgpPeerProperties",
"modUri": "tmod:@turbot/aws-directconnect"
}
}

bgpPeerStates

{
"type": "string",
"enum": [
"verifying",
"pending",
"available",
"deleting",
"deleted"
],
"tests": [
{
"input": "deleted"
},
{
"input": "available"
},
{
"describe": "invalid - value not allowed",
"input": "vaid",
"expected": false
}
],
".turbot": {
"uri": "tmod:@turbot/aws-directconnect#/definitions/bgpPeerStates",
"modUri": "tmod:@turbot/aws-directconnect"
}
}

bgpStatusValue

{
"type": "string",
"enum": [
"up",
"down",
"unknown"
],
"tests": [
{
"input": "unknown"
},
{
"describe": "invalid - value not allowed",
"input": "downnside",
"expected": false
}
],
".turbot": {
"uri": "tmod:@turbot/aws-directconnect#/definitions/bgpStatusValue",
"modUri": "tmod:@turbot/aws-directconnect"
}
}

connectId

{
"type": "string",
"pattern": "^[-a-zA-Z0-9]*$",
"tests": [
{
"input": "dxcon-ffhjjj7s"
},
{
"describe": "invalid - value not allowed",
"input": null,
"expected": false
}
],
".turbot": {
"uri": "tmod:@turbot/aws-directconnect#/definitions/connectId",
"modUri": "tmod:@turbot/aws-directconnect"
}
}

connection

{
"type": "object",
"properties": {
"ownerAccount": {
"type": "string"
},
"connectionId": {
"$ref": "#/definitions/connectId"
},
"connectionName": {
"type": "string"
},
"connectionState": {
"$ref": "#/definitions/connectionStates"
},
"region": {
"type": "string"
},
"location": {
"type": "string"
},
"bandwidth": {
"type": "string"
},
"vlan": {
"type": "integer"
},
"partnerName": {
"type": "string"
},
"loaIssueTime": {
"$ref": "turbot#/definitions/isoTimestamp"
},
"lagId": {
"type": "string"
},
"awsDevice": {
"type": "string"
},
"jumboFrameCapable": {
"type": "boolean"
},
"awsDeviceV2": {
"type": "string"
},
"awsLogicalDeviceId": {
"type": "string"
},
"hasLogicalRedundancy": {
"$ref": "#/definitions/hasLogicalRedundancies"
},
"tags": {
"$ref": "aws#/definitions/tagList"
},
"providerName": {
"type": "string"
},
"macSecCapable": {
"type": "boolean"
},
"portEncryptionStatus": {
"type": "string"
},
"encryptionMode": {
"$ref": "#/definitions/encryptionModes"
},
"macSecKeys": {
"$ref": "#/definitions/macSecKeys"
},
"turbot": {
"type": "object",
"properties": {
"akas": {
"type": "array",
"items": {
"$ref": "#/definitions/connectionArn"
}
},
"tags": {
"$ref": "aws#/definitions/tagsMap"
},
"title": {
"$ref": "#/definitions/connectId"
},
"custom": {
"type": "object",
"properties": {
"aws": {
"$ref": "aws#/definitions/awsMetadata"
},
"createTimestamp": {
"$ref": "turbot#/definitions/isoTimestamp"
}
}
}
}
}
},
"additionalProperties": true,
"tests": [
{
"description": "Valid - All properties",
"input": {
"ownerAccount": "388460667113",
"connectionId": "dxcon-fglwl87m",
"connectionName": "testconnection2",
"connectionState": "requested",
"region": "ap-northeast-1",
"location": "ATTC1",
"bandwidth": "1Gbps",
"jumboFrameCapable": false,
"macSecCapable": false,
"hasLogicalRedundancy": "unknown",
"tags": [
{
"key": "directconnect:resiliency-bundle-id",
"value": "b1f27ce4-1159-43f7-9557-1d7712ff3aa3"
}
],
"turbot": {
"akas": [
"arn:aws:directconnect:ap-northeast-1:388460667113:dxcon/turbot-rds-test-1-1"
],
"tags": {
"directconnect:resiliency-bundle-id": "b1f27ce4-1159-43f7-9557-1d7712ff3aa3"
},
"title": "dxcon-fglwl87m",
"custom": {
"aws": {
"accountId": 123456789012,
"regionName": "us-east-1"
}
}
}
}
}
],
".turbot": {
"uri": "tmod:@turbot/aws-directconnect#/definitions/connection",
"modUri": "tmod:@turbot/aws-directconnect"
}
}

connectionArn

{
"type": "string",
"pattern": "arn:aws(-us-gov|-cn)?:directconnect:[a-z]{2}(-gov)?-[a-z]+-[0-9]:[0-9]{12}:dxcon/[-a-zA-Z0-9]*?",
"tests": [
{
"input": "arn:aws:directconnect:us-east-1:123456789012:dxcon/dxcon-ffhjjj7s"
},
{
"description": "invalid - input not expected",
"input": "hi hi",
"expected": false
},
{
"description": "invalid - AWS account id is wrong",
"input": "arn:aws:directconnect:us-east-1:12121213:dxcon/dxcon-ffhjjj7s",
"expected": false
}
],
".turbot": {
"uri": "tmod:@turbot/aws-directconnect#/definitions/connectionArn",
"modUri": "tmod:@turbot/aws-directconnect"
}
}

connections

{
"type": "object",
"properties": {
"ownerAccount": {
"type": "string"
},
"connectionId": {
"$ref": "#/definitions/connectId"
},
"connectionName": {
"type": "string"
},
"connectionState": {
"$ref": "#/definitions/connectionStates"
},
"region": {
"type": "string"
},
"location": {
"type": "string"
},
"bandwidth": {
"type": "string"
},
"vlan": {
"type": "integer"
},
"partnerName": {
"type": "string"
},
"loaIssueTime": {
"$ref": "turbot#/definitions/isoTimestamp"
},
"lagId": {
"type": "string"
},
"awsDevice": {
"type": "string"
},
"jumboFrameCapable": {
"type": "boolean"
},
"awsDeviceV2": {
"type": "string"
},
"awsLogicalDeviceId": {
"type": "string"
},
"hasLogicalRedundancy": {
"$ref": "#/definitions/hasLogicalRedundancies"
},
"tags": {
"$ref": "aws#/definitions/tagList"
},
"providerName": {
"type": "string"
},
"macSecCapable": {
"type": "boolean"
},
"portEncryptionStatus": {
"type": "string"
},
"encryptionMode": {
"$ref": "#/definitions/encryptionModes"
},
"macSecKeys": {
"$ref": "#/definitions/macSecKeys"
}
},
".turbot": {
"uri": "tmod:@turbot/aws-directconnect#/definitions/connections",
"modUri": "tmod:@turbot/aws-directconnect"
}
}

connectionStates

{
"type": "string",
"enum": [
"ordering",
"requested",
"pending",
"available",
"down",
"deleting",
"deleted",
"rejected",
"unknown"
],
"tests": [
{
"input": "ordering"
},
{
"input": "available"
},
{
"describe": "invalid - value not allowed",
"input": "vaid",
"expected": false
}
],
".turbot": {
"uri": "tmod:@turbot/aws-directconnect#/definitions/connectionStates",
"modUri": "tmod:@turbot/aws-directconnect"
}
}

directConnect

{
"allOf": [
{
"$ref": "turbot#/definitions/service"
},
{
"type": "object",
"properties": {
"name": {
"const": "Direct Connect"
},
"turbot": {
"type": "object",
"properties": {
"akas": {
"type": "array",
"items": {
"$ref": "#/definitions/directConnectAka"
}
},
"title": {
"const": "Direct Connect"
},
"custom": {
"type": "object",
"properties": {
"aws": {
"$ref": "aws#/definitions/awsMetadata"
}
}
}
}
}
},
"additionalProperties": true,
"tests": [
{
"description": "Valid - All properties",
"input": {
"name": "Direct Connect",
"turbot": {
"akas": [
"arn:aws:directconnect::123456789012"
],
"title": "Direct Connect",
"custom": {
"aws": {
"accountId": 123456789012,
"partition": "aws"
}
}
}
}
}
]
}
],
".turbot": {
"uri": "tmod:@turbot/aws-directconnect#/definitions/directConnect",
"modUri": "tmod:@turbot/aws-directconnect"
}
}

directConnectAka

{
"type": "string",
"pattern": "^arn:aws(-us-gov|-cn)?:directconnect::[0-9]{12}$",
"tests": [
{
"description": "Base",
"input": "arn:aws:directconnect::123456789012"
},
{
"description": "Valid - gov partition",
"input": "arn:aws-us-gov:directconnect::123456786354"
},
{
"description": "Valid - china partition",
"input": "arn:aws-cn:directconnect::123456786354"
},
{
"description": "Invalid us gov partition",
"input": "arn:aws-cn-gov:directconnect::123456786354",
"expected": false
},
{
"description": "Invalid china partition",
"input": "arn:aws-us-cn:directconnect::123456786354",
"expected": false
},
{
"description": "Invalid service name",
"input": "arn:aws:amplifye::123456789012",
"expected": false
}
],
".turbot": {
"uri": "tmod:@turbot/aws-directconnect#/definitions/directConnectAka",
"modUri": "tmod:@turbot/aws-directconnect"
}
}

directConnectGateway

{
"type": "object",
"properties": {
"directConnectGatewayId": {
"type": "string"
},
"directConnectGatewayName": {
"type": "string"
},
"amazonSideAsn": {
"type": "integer"
},
"ownerAccount": {
"type": "string"
},
"directConnectGatewayState": {
"$ref": "#/definitions/directConnectGatewayStates"
},
"stateChangeError": {
"type": "string"
},
"turbot": {
"type": "object",
"properties": {
"akas": {
"type": "array",
"items": {
"$ref": "#/definitions/directConnectGatewayArn"
}
},
"title": {
"$ref": "#/definitions/directConnectGatewayId"
},
"custom": {
"type": "object",
"properties": {
"aws": {
"$ref": "aws#/definitions/awsMetadata"
},
"createTimestamp": {
"$ref": "turbot#/definitions/isoTimestamp"
}
}
}
}
}
},
"additionalProperties": true,
"tests": [
{
"description": "Valid - All properties",
"input": {
"directConnectGatewayId": "033f416a-a8fc-466f-bd16-cf16833f995f",
"directConnectGatewayName": "testdeletedirectconnectgate",
"amazonSideAsn": 64555,
"ownerAccount": "388460667113",
"directConnectGatewayState": "available",
"turbot": {
"akas": [
"arn:aws:directconnect::388460667113:dx-gateway:033f416a-a8fc-466f-bd16-cf16833f995f"
],
"title": "033f416a-a8fc-466f-bd16-cf16833f995f",
"custom": {
"aws": {
"accountId": 388460667113
}
}
}
}
}
],
".turbot": {
"uri": "tmod:@turbot/aws-directconnect#/definitions/directConnectGateway",
"modUri": "tmod:@turbot/aws-directconnect"
}
}

directConnectGatewayArn

{
"type": "string",
"pattern": "arn:aws(-us-gov|-cn)?:directconnect::[0-9]{12}:dx-gateway:[-a-zA-Z0-9]*?",
"tests": [
{
"input": "arn:aws:rds::111666065714:dx-gateway:033f416a-a8fc-466f-bd16-cf16833f995f"
},
{
"input": "arn:aws:rds::111666065714:dx-gateway:033f416a-a8fc-466f-bd16-cf16833f995f"
},
{
"description": "invalid - input not expected",
"input": "hi hi",
"expected": false
},
{
"description": "invalid - AWS account id is wrong",
"input": "arn:aws:rds::11166665714:dx-gateway:033f416a-a8fc-466f-bd16-cf16833f995f",
"expected": false
}
],
".turbot": {
"uri": "tmod:@turbot/aws-directconnect#/definitions/directConnectGatewayArn",
"modUri": "tmod:@turbot/aws-directconnect"
}
}

directConnectGatewayId

{
"type": "string",
"pattern": "^([-a-zA-Z0-9]*)$",
"tests": [
{
"input": "033f416a-a8fc-466f-bd16-cf16833f995f"
},
{
"description": "null value",
"input": null,
"expected": false
},
{
"description": "empty string",
"input": "",
"expected": false
},
{
"description": "invalid - can not end with underscore",
"input": "a0123-_",
"expected": false
}
],
".turbot": {
"uri": "tmod:@turbot/aws-directconnect#/definitions/directConnectGatewayId",
"modUri": "tmod:@turbot/aws-directconnect"
}
}

directConnectGatewayStates

{
"type": "string",
"enum": [
"pending",
"available",
"deleting",
"deleted"
],
"tests": [
{
"input": "available"
},
{
"input": "deleted"
},
{
"describe": "invalid - value not allowed",
"input": "avail",
"expected": false
}
],
".turbot": {
"uri": "tmod:@turbot/aws-directconnect#/definitions/directConnectGatewayStates",
"modUri": "tmod:@turbot/aws-directconnect"
}
}

encryptionModes

{
"type": "string",
"enum": [
"no_encrypt",
"should_encrypt",
"must_encrypt"
],
"tests": [
{
"input": "no_encrypt"
},
{
"describe": "invalid - value not allowed",
"input": "encrypt",
"expected": false
}
],
".turbot": {
"uri": "tmod:@turbot/aws-directconnect#/definitions/encryptionModes",
"modUri": "tmod:@turbot/aws-directconnect"
}
}

hasLogicalRedundancies

{
"type": "string",
"enum": [
"unknown",
"yes",
"no"
],
"tests": [
{
"input": "yes"
},
{
"input": "no"
},
{
"describe": "invalid - value not allowed",
"input": "ye",
"expected": false
}
],
".turbot": {
"uri": "tmod:@turbot/aws-directconnect#/definitions/hasLogicalRedundancies",
"modUri": "tmod:@turbot/aws-directconnect"
}
}

lag

{
"type": "object",
"properties": {
"connectionsBandwidth": {
"type": "string"
},
"numberOfConnections": {
"type": "integer"
},
"lagId": {
"type": "string"
},
"ownerAccount": {
"type": "string"
},
"lagName": {
"type": "string"
},
"lagState": {
"$ref": "#/definitions/lagStates"
},
"region": {
"type": "string"
},
"location": {
"type": "string"
},
"minimumLinks": {
"type": "integer"
},
"awsDevice": {
"type": "string"
},
"awsDeviceV2": {
"type": "string"
},
"awsLogicalDeviceId": {
"type": "string"
},
"connections": {
"$ref": "#/definitions/connections"
},
"allowsHostedConnections": {
"type": "boolean"
},
"jumboFrameCapable": {
"type": "boolean"
},
"hasLogicalRedundancy": {
"$ref": "#/definitions/hasLogicalRedundancies"
},
"providerName": {
"type": "string"
},
"macSecCapable": {
"type": "boolean"
},
"encryptionMode": {
"$ref": "#/definitions/encryptionModes"
},
"macSecKeys": {
"$ref": "#/definitions/macSecKeys"
},
"tags": {
"$ref": "aws#/definitions/tagList"
},
"turbot": {
"type": "object",
"properties": {
"akas": {
"type": "array",
"items": {
"$ref": "#/definitions/LagArn"
}
},
"tags": {
"$ref": "aws#/definitions/tagsMap"
},
"title": {
"$ref": "#/definitions/lagId"
},
"custom": {
"type": "object",
"properties": {
"aws": {
"$ref": "aws#/definitions/awsMetadata"
},
"createTimestamp": {
"$ref": "turbot#/definitions/isoTimestamp"
}
}
}
}
}
},
"additionalProperties": true,
"tests": [
{
"description": "Valid - All properties",
"input": {
"ownerAccount": "388460667113",
"lagId": "dxlag-fglwl87m",
"lagName": "testlag12",
"lagState": "requested",
"region": "us-east-1",
"location": "ATTC1",
"bandwidth": "1Gbps",
"jumboFrameCapable": false,
"macSecCapable": false,
"hasLogicalRedundancy": "unknown",
"tags": [
{
"Key": "directconnect:resiliency-bundle-id",
"Value": "b1f27ce4-1159-43f7-9557-1d7712ff3aa3"
}
],
"turbot": {
"akas": [
"arn:aws:directconnect:us-east-1:388460667113:dxlag/dxlag-fglwl87m"
],
"tags": {
"directconnect:resiliency-bundle-id": "b1f27ce4-1159-43f7-9557-1d7712ff3aa3"
},
"title": "dxlag-fglwl87m",
"custom": {
"aws": {
"accountId": 388460667113,
"regionName": "us-east-1"
}
}
}
}
}
],
".turbot": {
"uri": "tmod:@turbot/aws-directconnect#/definitions/lag",
"modUri": "tmod:@turbot/aws-directconnect"
}
}

LagArn

{
"type": "string",
"pattern": "arn:aws(-us-gov|-cn)?:directconnect:[a-z]{2}(-gov)?-[a-z]+-[0-9]:[0-9]{12}:dxlag/[-a-zA-Z0-9]*?",
"tests": [
{
"input": "arn:aws:directconnect:us-east-1:123456789012:dxlag/dxlag-ffhjjj7s"
},
{
"description": "invalid - input not expected",
"input": "hi hi",
"expected": false
},
{
"description": "invalid - AWS account id is wrong",
"input": "arn:aws:directconnect:us-east-1:12121213:dxlag/dxlag-ffhjjj7s",
"expected": false
}
],
".turbot": {
"uri": "tmod:@turbot/aws-directconnect#/definitions/LagArn",
"modUri": "tmod:@turbot/aws-directconnect"
}
}

lagId

{
"type": "string",
"pattern": "^[-a-zA-Z0-9]*$",
"tests": [
{
"input": "dxlag-ffhjjj7s"
},
{
"describe": "invalid - value not allowed",
"input": null,
"expected": false
}
],
".turbot": {
"uri": "tmod:@turbot/aws-directconnect#/definitions/lagId",
"modUri": "tmod:@turbot/aws-directconnect"
}
}

lagStates

{
"type": "string",
"enum": [
"requested",
"pending",
"available",
"down",
"deleting",
"deleted",
"unknown"
],
".turbot": {
"uri": "tmod:@turbot/aws-directconnect#/definitions/lagStates",
"modUri": "tmod:@turbot/aws-directconnect"
}
}

macSecKeys

{
"type": "array",
"items": {
"$ref": "#/definitions/macSecKeysMatcher"
},
".turbot": {
"uri": "tmod:@turbot/aws-directconnect#/definitions/macSecKeys",
"modUri": "tmod:@turbot/aws-directconnect"
}
}

macSecKeysMatcher

{
"type": "object",
"properties": {
"secretARN": {
"type": "string"
},
"ckn": {
"type": "string"
},
"state": {
"$ref": "#/definitions/states"
},
"startOn": {
"type": "string"
}
},
".turbot": {
"uri": "tmod:@turbot/aws-directconnect#/definitions/macSecKeysMatcher",
"modUri": "tmod:@turbot/aws-directconnect"
}
}

routeFilterPrefix

{
"type": "object",
"properties": {
"cidr": {
"type": "string"
}
},
".turbot": {
"uri": "tmod:@turbot/aws-directconnect#/definitions/routeFilterPrefix",
"modUri": "tmod:@turbot/aws-directconnect"
}
}

states

{
"type": "string",
"enum": [
"associating",
"associated",
"disassociating",
"disassociated"
],
"tests": [
{
"input": "associated"
},
{
"input": "disassociated"
},
{
"describe": "invalid - value not allowed",
"input": "associate",
"expected": false
}
],
".turbot": {
"uri": "tmod:@turbot/aws-directconnect#/definitions/states",
"modUri": "tmod:@turbot/aws-directconnect"
}
}

virtualInterface

{
"type": "object",
"properties": {
"ownerAccount": {
"type": "string"
},
"virtualInterfaceId": {
"$ref": "#/definitions/virtualInterfaceId"
},
"location": {
"type": "string"
},
"connectionId": {
"type": "string"
},
"virtualInterfaceType": {
"type": "string"
},
"virtualInterfaceName": {
"type": "string"
},
"vlan": {
"type": "integer"
},
"asn": {
"type": "integer"
},
"amazonSideAsn": {
"type": "integer"
},
"authKey": {
"type": "string"
},
"amazonAddress": {
"type": "string"
},
"customerAddress": {
"type": "string"
},
"addressFamily": {
"type": "string"
},
"virtualInterfaceState": {
"$ref": "#/definitions/virtualInterfaceStates"
},
"customerRouterConfig": {
"type": "string"
},
"mtu": {
"type": "integer"
},
"jumboFrameCapable": {
"type": "boolean"
},
"virtualGatewayId": {
"type": "string"
},
"directConnectGatewayId": {
"type": "string"
},
"routeFilterPrefixes": {
"type": "array",
"items": {
"$ref": "#/definitions/routeFilterPrefix"
}
},
"bgpPeers": {
"type": "array",
"items": {
"$ref": "#/definitions/bgpPeerProperties"
}
},
"region": {
"type": "string"
},
"awsDeviceV2": {
"type": "string"
},
"awsLogicalDeviceId": {
"type": "string"
},
"tags": {
"$ref": "aws#/definitions/tagList"
},
"turbot": {
"type": "object",
"properties": {
"akas": {
"type": "array",
"items": {
"$ref": "#/definitions/virtualInterfaceArn"
}
},
"tags": {
"$ref": "aws#/definitions/tagsMap"
},
"title": {
"$ref": "#/definitions/virtualInterfaceId"
},
"custom": {
"type": "object",
"properties": {
"aws": {
"$ref": "aws#/definitions/awsMetadata"
},
"createTimestamp": {
"$ref": "turbot#/definitions/isoTimestamp"
}
}
}
}
}
},
"additionalProperties": true,
"tests": [
{
"description": "Valid - All properties",
"input": {
"ownerAccount": "388460667113",
"turbot": {
"akas": [
"arn:aws:directconnect:us-east-1:388460667113:dxvif/dxvif-ffhjjj7s"
],
"title": "dxvif-ffhjjj7s",
"custom": {
"aws": {
"accountId": 388460667113,
"regionName": "us-east-1",
"partition": "aws"
}
}
}
}
}
],
".turbot": {
"uri": "tmod:@turbot/aws-directconnect#/definitions/virtualInterface",
"modUri": "tmod:@turbot/aws-directconnect"
}
}

virtualInterfaceArn

{
"type": "string",
"pattern": "arn:aws(-us-gov|-cn)?:directconnect:[a-z]{2}(-gov)?-[a-z]+-[0-9]:[0-9]{12}:dxvif:[-a-zA-Z0-9]*?",
"tests": [
{
"input": "arn:aws:directconnect:ap-south-1:111666065714:dxvif/turbot-directconnect-test-1-1"
},
{
"input": "arn:aws:directconnect:ap-south-1:111666065714:dxvif/dbname"
},
{
"description": "invalid - input not expected",
"input": "hi hi",
"expected": false
},
{
"description": "invalid - AWS account id is wrong",
"input": "arn:aws:directconnect:ap-south-1:11166665714:dxvif/dbname",
"expected": false
}
],
".turbot": {
"uri": "tmod:@turbot/aws-directconnect#/definitions/virtualInterfaceArn",
"modUri": "tmod:@turbot/aws-directconnect"
}
}

virtualInterfaceId

{
"type": "string",
".turbot": {
"uri": "tmod:@turbot/aws-directconnect#/definitions/virtualInterfaceId",
"modUri": "tmod:@turbot/aws-directconnect"
}
}

virtualInterfaceStates

{
"type": "string",
"enum": [
"confirming",
"verifying",
"pending",
"available",
"down",
"deleting",
"deleted",
"rejected",
"unknown"
],
"tests": [
{
"input": "available"
},
{
"input": "deleted"
},
{
"describe": "invalid - value not allowed",
"input": "avail",
"expected": false
}
],
".turbot": {
"uri": "tmod:@turbot/aws-directconnect#/definitions/virtualInterfaceStates",
"modUri": "tmod:@turbot/aws-directconnect"
}
}