Definitions for @turbot/aws-efs

efs

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

efsAka

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

fileSystem

{
"type": "object",
"properties": {
"FileSystemId": {
"$ref": "#/definitions/fileSystemId"
},
"Name": {
"$ref": "#/definitions/fileSystemName"
},
"tags": {
"$ref": "aws#/definitions/tagList"
},
"LifeCycleState": {
"$ref": "#/definitions/fileSystemLifeCycleState"
},
"CreationTime": {
"type": "string"
},
"OwnerId": {
"type": "string"
},
"CreationToken": {
"type": "string"
},
"MountTargetCount": {
"type": "integer"
},
"SizeInBytes": {
"type": "object"
},
"PerformanceMode": {
"type": "string"
},
"Policy": {
"type": "string"
},
"Encrypted": {
"type": "boolean"
},
"KmsKeyId": {
"type": "string"
},
"ThroughputMode": {
"type": "string"
},
"ProvisionedThroughputInMibps": {
"type": "number"
},
"MountTargets": {
"type": "array"
},
"turbot": {
"type": "object",
"properties": {
"akas": {
"type": "array",
"items": {
"$ref": "#/definitions/fileSystemAka"
}
},
"tags": {
"$ref": "aws#/definitions/tagsMap"
},
"title": {
"$ref": "#/definitions/fileSystemId"
},
"custom": {
"type": "object",
"properties": {
"aws": {
"$ref": "aws#/definitions/awsMetadata"
},
"createTimestamp": {
"$ref": "turbot#/definitions/isoTimestamp"
},
"NumberOfMountTargets": {
"$ref": "#/definitions/NumberOfMountTargets"
}
}
}
}
}
},
"additionalProperties": true,
"test": [
{
"description": "Valid - All properties",
"input": {
"FileSystemId": "fs-7d0fa8d5",
"Name": "test",
"tags": [
{
"Key": "keyTest",
"Value": "ValueTest"
}
],
"turbot": {
"akas": [
"arn:aws:elasticfilesystem:us-east-1:123456789012:file-system/fs-333c9b9b"
],
"tags": {
"keyTest": "ValueTest"
},
"title": "fs-7d0fa8d5",
"custom": {
"aws": {
"accountId": 123456789012,
"regionName": "us-east-1"
}
}
}
}
},
{
"description": "Invalid - Missing FileSystemId",
"input": {
"Name": "test",
"tags": [
{
"Key": "keyTest",
"Value": "ValueTest"
}
],
"turbot": {
"akas": [
"arn:aws:elasticfilesystem:us-east-1:123456789012:file-system/fs-333c9b9b"
],
"tags": {
"keyTest": "ValueTest"
},
"title": "fs-7d0fa8d5",
"custom": {
"aws": {
"accountId": 123456789012,
"regionName": "us-east-1"
}
}
}
},
"expected": false
},
{
"description": "Invalid - Missing turbot data",
"input": {
"FileSystemId": "fs-7d0fa8d5",
"Name": "test",
"tags": [
{
"Key": "keyTest",
"Value": "ValueTest"
}
],
"expected": false
}
}
],
".turbot": {
"uri": "tmod:@turbot/aws-efs#/definitions/fileSystem",
"modUri": "tmod:@turbot/aws-efs"
}
}

fileSystemAka

{
"type": "string",
"pattern": "^arn:aws(-us-gov|-cn)?:elasticfilesystem:[a-z]{2}(-gov)?-[a-z]+-[0-9]{1}:[0-9]{12}:file-system/[-_.a-zA-Z0-9]{3,255}$",
"tests": [
{
"description": "Valid - Base case",
"input": "arn:aws:elasticfilesystem:us-east-1:123456789012:file-system/fs-333c9b9b"
},
{
"description": "Invalid - Malformed resource collection",
"input": "arn:aws:elasticfilesystem:us-east-1:123456789012:file-systems/fs-333c9b9b",
"expected": false
},
{
"description": "Invalid - Malformed region name",
"input": "aarn:aws:elasticfilesystem:use-east-1:123456789012:file-system/fs-333c9b9b",
"expected": false
},
{
"description": "Invalid - Malformed account ID",
"input": "arn:aws:elasticfilesystem:us-east-1:1234567890123:file-system/fs-333c9b9b",
"expected": false
}
],
".turbot": {
"uri": "tmod:@turbot/aws-efs#/definitions/fileSystemAka",
"modUri": "tmod:@turbot/aws-efs"
}
}

fileSystemId

{
"type": "string",
"pattern": "^fs-[0-9a-f]{8,40}$",
"tests": [
{
"input": "fs-333c9b9b"
},
{
"decsription": "invalid - cannot be array",
"input": [
"fs-333c9b9b"
],
"expected": false
},
{
"description": "invalid - incorrect pattern",
"input": "testSystemId",
"expected": false
},
{
"description": "invalid - length limit exceeded",
"input": "fs-333c9b9b9873a",
"expected": false
}
],
".turbot": {
"uri": "tmod:@turbot/aws-efs#/definitions/fileSystemId",
"modUri": "tmod:@turbot/aws-efs"
}
}

fileSystemLifeCycleState

{
"type": "string",
"enum": [
"creating",
"available",
"updating",
"deleting",
"deleted"
],
"tests": [
{
"input": "deleted"
},
{
"input": "updating"
},
{
"description": "invalid - not listed in options",
"input": "Reactive",
"expected": false
},
{
"description": "invalid - null value",
"input": null,
"expected": false
}
],
".turbot": {
"uri": "tmod:@turbot/aws-efs#/definitions/fileSystemLifeCycleState",
"modUri": "tmod:@turbot/aws-efs"
}
}

fileSystemName

{
"type": "string",
"minLength": 0,
"maxLength": 128,
"tests": [
{
"input": "testKey01"
},
{
"description": "invalid - cannot be array",
"input": [
"testKey"
],
"expected": false
},
{
"description": "invalid - empty string passed",
"input": "",
"expected": false
},
{
"description": "invalid - too long",
"input": "uhsufhavuwefiuagwfugavlwufabfugweufgakuwgevkgwEUYFTAKUWEFUYAGCTHISisSpartaEFJGAEJFBAHJSFBMHVSDFHJVMFHVFESBJMGSERJVGERlonjwfhlibehfthegsfking",
"expected": false
}
],
".turbot": {
"uri": "tmod:@turbot/aws-efs#/definitions/fileSystemName",
"modUri": "tmod:@turbot/aws-efs"
}
}

mountTarget

{
"type": "object",
"properties": {
"MountTargetId": {
"$ref": "#/definitions/mountTargetId"
},
"FileSystemId": {
"$ref": "#/definitions/fileSystemId"
},
"LifeCycleState": {
"$ref": "#/definitions/fileSystemLifeCycleState"
},
"OwnerId": {
"type": "string"
},
"SubnetId": {
"type": "string"
},
"IpAddress": {
"type": "string"
},
"NetworkInterfaceId": {
"type": "string"
},
"SecurityGroups": {
"type": "array"
},
"turbot": {
"type": "object",
"properties": {
"akas": {
"type": "array",
"items": {
"$ref": "#/definitions/mountTargetAka"
}
},
"title": {
"$ref": "#/definitions/mountTargetId"
},
"custom": {
"type": "object",
"properties": {
"aws": {
"$ref": "aws#/definitions/awsMetadata"
},
"createTimestamp": {
"$ref": "turbot#/definitions/isoTimestamp"
}
}
}
}
}
},
"additionalProperties": true,
"test": [
{
"description": "Valid - All properties",
"input": {
"MountTargetId": "fsmt-2285e08a",
"FileSystemId": "fs-7d0fa8d5",
"turbot": {
"akas": [
"arn:aws:elasticfilesystem:us-east-1:123456789012:file-system/fs-7d0fa8d5/mount-target/fsmt-2285e08a"
],
"title": "fsmt-2285e08a",
"custom": {
"aws": {
"accountId": 123456789012,
"regionName": "us-east-1"
}
}
}
}
},
{
"description": "Invalid - Missing MountTargetId",
"input": {
"FileSystemId": "fs-7d0fa8d5",
"turbot": {
"akas": [
"arn:aws:elasticfilesystem:us-east-1:123456789012:file-system/fs-7d0fa8d5/mount-target/fsmt-2285e08a"
],
"title": "fsmt-2285e08a",
"custom": {
"aws": {
"accountId": 123456789012,
"regionName": "us-east-1"
}
}
}
}
},
{
"description": "Invalid - Missing turbot data",
"input": {
"MountTargetId": "fsmt-2285e08a",
"FileSystemId": "fs-7d0fa8d5"
}
}
],
".turbot": {
"uri": "tmod:@turbot/aws-efs#/definitions/mountTarget",
"modUri": "tmod:@turbot/aws-efs"
}
}

mountTargetAka

{
"type": "string",
"pattern": "^arn:aws(-us-gov|-cn)?:elasticfilesystem:[a-z]{2}(-gov)?-[a-z]+-[0-9]{1}:[0-9]{12}:file-system/[-_.a-zA-Z0-9]{3,255}/mount-target/[-_.a-zA-Z0-9]{3,255}$",
"tests": [
{
"description": "Valid - Base case",
"input": "arn:aws-us-gov:elasticfilesystem:us-east-1:123456789012:file-system/fs-333c9b9b/mount-target/fsmt-2285e08a"
},
{
"description": "Invalid - Malformed resource collection",
"input": "arn:aws:elasticfilesystem:us-east-1:123456789012:file-systems/fs-333c9b9b",
"expected": false
},
{
"description": "Invalid - Malformed region name",
"input": "aarn:aws:elasticfilesystem:use-east-1:123456789012:file-system/fs-333c9b9b",
"expected": false
},
{
"description": "Invalid - Malformed account ID",
"input": "arn:aws:elasticfilesystem:us-east-1:1234567890123:file-system/fs-333c9b9b",
"expected": false
}
],
".turbot": {
"uri": "tmod:@turbot/aws-efs#/definitions/mountTargetAka",
"modUri": "tmod:@turbot/aws-efs"
}
}

mountTargetId

{
"type": "string",
"pattern": "^fsmt-[0-9a-f]{8,40}$",
"tests": [
{
"input": "fsmt-77aabcjeko882e"
},
{
"decsription": "invalid - cannot be array",
"input": [
"fsmt-77aabcjeko882e"
],
"expected": false
},
{
"description": "invalid - incorrect pattern",
"input": "testSystemId",
"expected": false
}
],
".turbot": {
"uri": "tmod:@turbot/aws-efs#/definitions/mountTargetId",
"modUri": "tmod:@turbot/aws-efs"
}
}

NumberOfMountTargets

{
"type": "number",
".turbot": {
"uri": "tmod:@turbot/aws-efs#/definitions/NumberOfMountTargets",
"modUri": "tmod:@turbot/aws-efs"
}
}