Product logo
DocsBlogPricing

Definitions for @turbot/aws-storagegateway

fileShare

Schema
{
  "type": "object",
  "properties": {
    "FileShareARN": {
      "$ref": "#/definitions/fileShareAka"
    },
    "FileShareId": {
      "$ref": "#/definitions/fileShareId"
    },
    "FileShareType": {
      "$ref": "#/definitions/fileShareType"
    },
    "GatewayARN": {
      "$ref": "#/definitions/gatewayAka"
    },
    "FileShareStatus": {
      "$ref": "#/definitions/fileShareStatus"
    },
    "turbot": {
      "type": "object",
      "properties": {
        "akas": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/fileShareAka"
          }
        },
        "tags": {
          "$ref": "aws#/definitions/tagsMap"
        },
        "title": {
          "$ref": "#/definitions/fileShareId"
        },
        "metadata": {
          "type": "object",
          "properties": {
            "aws": {
              "$ref": "aws#/definitions/awsMetadata"
            },
            "lastUsedTimestamp": {
              "$ref": "turbot#/definitions/isoTimestamp"
            },
            "createTimestamp": {
              "$ref": "turbot#/definitions/isoTimestamp"
            }
          }
        }
      }
    }
  },
  "additionalProperties": true,
  "tests": [
    {
      "description": "Valid - All properties",
      "input": {
        "FileShareARN": "arn:aws:storagegateway:us-east-1:123456789012:share/share-F366CF99",
        "FileShareId": "share-F366CF99",
        "FileShareType": "NFS",
        "GatewayARN": "arn:aws:storagegateway:us-east-1:123456789012:gateway/sgw-325BB05B",
        "FileShareStatus": "AVAILABLE",
        "turbot": {
          "akas": [
            "arn:aws:storagegateway:us-east-1:123456789012:share/share-F366CF99"
          ],
          "tags": {
            "Env": "Test"
          },
          "title": "share-F366CF99",
          "metadata": {
            "aws": {
              "accountId": 123456789012,
              "regionName": "us-east-1",
              "partition": "aws"
            }
          }
        }
      }
    }
  ],
  ".turbot": {
    "uri": "tmod:@turbot/aws-storagegateway#/definitions/fileShare",
    "modUri": "tmod:@turbot/aws-storagegateway"
  }
}

fileShareAka

Schema
{
  "type": "string",
  "pattern": "^arn:aws(-us-gov|-cn)?:storagegateway:[a-z]{2}(-gov)?-[a-z]+-[0-9]:[0-9]{12}:share/share-([A-Z0-9]{6,24})$",
  "tests": [
    {
      "description": "Valid ARN",
      "input": "arn:aws:storagegateway:us-east-1:123456789012:share/share-F366CF99"
    },
    {
      "description": "Invalid ARN",
      "input": "arn:aws:storagegateway:us-east-1:123456782:share/share-F36",
      "expected": false
    }
  ],
  ".turbot": {
    "uri": "tmod:@turbot/aws-storagegateway#/definitions/fileShareAka",
    "modUri": "tmod:@turbot/aws-storagegateway"
  }
}

fileShareId

Schema
{
  "type": "string",
  "pattern": "^share-([A-Z0-9]{6,24})$",
  "tests": [
    {
      "description": "Valid ID",
      "input": "share-F366CF99"
    },
    {
      "description": "Invalid ID",
      "input": "share-F36",
      "expected": false
    }
  ],
  ".turbot": {
    "uri": "tmod:@turbot/aws-storagegateway#/definitions/fileShareId",
    "modUri": "tmod:@turbot/aws-storagegateway"
  }
}

fileShareStatus

Schema
{
  "type": "string",
  "enum": [
    "CREATING",
    "UPDATING",
    "AVAILABLE",
    "DELETING"
  ],
  ".turbot": {
    "uri": "tmod:@turbot/aws-storagegateway#/definitions/fileShareStatus",
    "modUri": "tmod:@turbot/aws-storagegateway"
  }
}

fileShareType

Schema
{
  "type": "string",
  "enum": [
    "NFS",
    "SMB"
  ],
  ".turbot": {
    "uri": "tmod:@turbot/aws-storagegateway#/definitions/fileShareType",
    "modUri": "tmod:@turbot/aws-storagegateway"
  }
}

gateway

Schema
{
  "type": "object",
  "properties": {
    "GatewayARN": {
      "$ref": "#/definitions/gatewayAka"
    },
    "GatewayId": {
      "$ref": "#/definitions/gatewayId"
    },
    "GatewayName": {
      "$ref": "#/definitions/gatewayName"
    },
    "GatewayTimezone": {
      "type": "string"
    },
    "GatewayState": {
      "type": "string"
    },
    "GatewayNetworkInterfaces": {
      "$ref": "#/definitions/gatewayNetworkInterfaces"
    },
    "GatewayType": {
      "type": "string"
    },
    "NextUpdateAvailabilityDate": {
      "type": "string"
    },
    "LastSoftwareUpdate": {
      "type": "string"
    },
    "Ec2InstanceId": {
      "type": "string"
    },
    "Ec2InstanceRegion": {
      "type": "string"
    },
    "Tags": {
      "$ref": "aws#/definitions/tagList"
    },
    "VPCEndpoint": {
      "type": "string"
    },
    "CloudWatchLogGroupARN": {
      "type": "string"
    },
    "HostEnvironment": {
      "$ref": "#/definitions/gatewayHostEnvironment"
    },
    "EndpointType": {
      "$ref": "#/definitions/gatewayEndpointType"
    },
    "SoftwareUpdatesEndDate": {
      "type": "string"
    },
    "DeprecationDate": {
      "type": "string"
    },
    "GatewayCapacity": {
      "$ref": "#/definitions/gatewayCapacity"
    },
    "SupportedGatewayCapacities": {
      "type": "string"
    },
    "HostEnvironmentId": {
      "type": "string"
    },
    "turbot": {
      "type": "object",
      "properties": {
        "akas": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/gatewayAka"
          }
        },
        "tags": {
          "$ref": "aws#/definitions/tagsMap"
        },
        "title": {
          "$ref": "#/definitions/gatewayName"
        },
        "custom": {
          "type": "object",
          "properties": {
            "aws": {
              "$ref": "aws#/definitions/awsMetadata"
            },
            "createTimestamp": {
              "$ref": "turbot#/definitions/isoTimestamp"
            }
          }
        }
      }
    }
  },
  "additionalProperties": true,
  "tests": [
    {
      "description": "Valid - All properties",
      "input": {
        "GatewayName": "turbotGateway",
        "GatewayARN": "arn:aws:storagegateway:us-east-1:123456789012:gateway/sgw-12A3456B",
        "TagSet": [
          {
            "Key": "Env",
            "Value": "Test"
          },
          {
            "Key": "Application",
            "Value": "Turbot"
          }
        ],
        "turbot": {
          "akas": [
            "arn:aws:storagegateway:us-east-1:123456789012:gateway/sgw-12A3456B"
          ],
          "title": "turbotGateway",
          "custom": {
            "aws": {
              "accountId": 123456789012,
              "regionName": "us-east-1",
              "partition": "aws"
            }
          }
        }
      }
    },
    {
      "description": "Invalid - Missing Name",
      "input": {
        "GatewayARN": "arn:aws:storagegateway:us-east-1:123456789012:gateway/sgw-12A3456B",
        "TagSet": [
          {
            "Key": "Env",
            "Value": "Test"
          },
          {
            "Key": "Application",
            "Value": "Turbot"
          }
        ],
        "turbot": {
          "akas": [
            "arn:aws:storagegateway:us-east-1:123456789012:gateway/sgw-12A3456B"
          ],
          "title": null,
          "custom": {
            "aws": {
              "accountId": 123456789012,
              "regionName": "us-east-1",
              "partition": "aws"
            }
          }
        }
      },
      "expected": false
    },
    {
      "description": "Invalid - Missing turbot data",
      "input": {
        "GatewayName": "turbotGateway",
        "GatewayARN": "arn:aws:storagegateway:us-east-1:123456789012:gateway/sgw-12A3456B",
        "TagSet": [
          {
            "Key": "Env",
            "Value": "Test"
          },
          {
            "Key": "Application",
            "Value": "Turbot"
          }
        ]
      },
      "expected": false
    }
  ],
  ".turbot": {
    "uri": "tmod:@turbot/aws-storagegateway#/definitions/gateway",
    "modUri": "tmod:@turbot/aws-storagegateway"
  }
}

gatewayAka

Schema
{
  "type": "string",
  "pattern": "^arn:aws(-us-gov|-cn)?:storagegateway:[a-z]{2}(-gov)?-[a-z]+-[0-9]:[0-9]{12}:gateway/[A-Za-z0-9_.-]{2,255}$",
  "tests": [
    {
      "description": "Valid - Base case",
      "input": "arn:aws:storagegateway:us-east-1:123456789012:gateway/turbotGateway"
    },
    {
      "description": "Invalid - Malformed region name",
      "input": "arn:aws:storagegateway:use-east-12:123456789012:gateway/turbotGateway",
      "expected": false
    },
    {
      "description": "Invalid - Malformed account ID",
      "input": "arn:aws:storagegateway:us-east-1:1234567890123:gateway/turbotGateway",
      "expected": false
    }
  ],
  ".turbot": {
    "uri": "tmod:@turbot/aws-storagegateway#/definitions/gatewayAka",
    "modUri": "tmod:@turbot/aws-storagegateway"
  }
}

gatewayCapacity

Schema
{
  "type": "string",
  "enum": [
    "Small",
    "Medium",
    "Large"
  ],
  ".turbot": {
    "uri": "tmod:@turbot/aws-storagegateway#/definitions/gatewayCapacity",
    "modUri": "tmod:@turbot/aws-storagegateway"
  }
}

gatewayEndpointType

Schema
{
  "type": "string",
  "enum": [
    "STANDARD",
    "FIPS"
  ],
  ".turbot": {
    "uri": "tmod:@turbot/aws-storagegateway#/definitions/gatewayEndpointType",
    "modUri": "tmod:@turbot/aws-storagegateway"
  }
}

gatewayHostEnvironment

Schema
{
  "type": "string",
  "enum": [
    "VMWARE",
    "HYPER-V",
    "EC2",
    "KVM",
    "OTHER",
    "SNOWBALL"
  ],
  ".turbot": {
    "uri": "tmod:@turbot/aws-storagegateway#/definitions/gatewayHostEnvironment",
    "modUri": "tmod:@turbot/aws-storagegateway"
  }
}

gatewayId

Schema
{
  "type": "string",
  "pattern": "^sgw-([a-zA-Z0-9]{8})$",
  "tests": [
    {
      "input": "sgw-068fAfeD"
    },
    {
      "description": "invalid - should always start with sgw",
      "input": "ei-068fAfeD",
      "expected": false
    }
  ],
  ".turbot": {
    "uri": "tmod:@turbot/aws-storagegateway#/definitions/gatewayId",
    "modUri": "tmod:@turbot/aws-storagegateway"
  }
}

gatewayName

Schema
{
  "type": "string",
  "pattern": "^[A-Za-z0-9_.-]{2,255}$",
  "tests": [
    {
      "input": "storage-gateway"
    },
    {
      "description": "invalid - should not contain slash",
      "input": "ei/068fAfeD",
      "expected": false
    }
  ],
  ".turbot": {
    "uri": "tmod:@turbot/aws-storagegateway#/definitions/gatewayName",
    "modUri": "tmod:@turbot/aws-storagegateway"
  }
}

gatewayNetworkInterfaceIpv6Address

Schema
{
  "type": "object",
  "properties": {
    "Ipv4Address": {
      "type": "string"
    },
    "MacAddress": {
      "type": "string"
    },
    "Ipv6Address": {
      "type": "string"
    }
  },
  ".turbot": {
    "uri": "tmod:@turbot/aws-storagegateway#/definitions/gatewayNetworkInterfaceIpv6Address",
    "modUri": "tmod:@turbot/aws-storagegateway"
  }
}

gatewayNetworkInterfaces

Schema
{
  "type": "array",
  "items": {
    "$ref": "#/definitions/gatewayNetworkInterfaceIpv6Address"
  },
  ".turbot": {
    "uri": "tmod:@turbot/aws-storagegateway#/definitions/gatewayNetworkInterfaces",
    "modUri": "tmod:@turbot/aws-storagegateway"
  }
}

storageGateway

Schema
{
  "allOf": [
    {
      "$ref": "turbot#/definitions/service"
    },
    {
      "type": "object",
      "properties": {
        "name": {
          "const": "Storage Gateway"
        },
        "turbot": {
          "type": "object",
          "properties": {
            "akas": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/storageGatewayAka"
              }
            },
            "title": {
              "const": "Storage Gateway"
            },
            "custom": {
              "type": "object",
              "properties": {
                "aws": {
                  "$ref": "aws#/definitions/awsMetadata"
                }
              }
            }
          }
        }
      },
      "additionalProperties": true,
      "tests": [
        {
          "description": "Valid - All properties",
          "input": {
            "name": "Storage Gateway",
            "turbot": {
              "akas": [
                "arn:aws:storagegateway:us-east-1:123456789012"
              ],
              "title": "Storage Gateway",
              "custom": {
                "aws": {
                  "accountId": 123456789012,
                  "regionName": "us-east-1",
                  "partition": "aws"
                }
              }
            }
          }
        }
      ]
    }
  ],
  ".turbot": {
    "uri": "tmod:@turbot/aws-storagegateway#/definitions/storageGateway",
    "modUri": "tmod:@turbot/aws-storagegateway"
  }
}

storageGatewayAka

Schema
{
  "type": "string",
  "pattern": "^arn:aws(-us-gov|-cn)?:storagegateway:[a-z]{2}(-gov)?-[a-z]+-[0-9]{1}:[0-9]{12}$",
  "tests": [
    {
      "description": "Base",
      "input": "arn:aws:storagegateway:us-east-1:123456789012"
    },
    {
      "description": "Valid - gov partition",
      "input": "arn:aws-us-gov:storagegateway:us-gov-east-1:123456786354"
    },
    {
      "description": "Valid - china partition",
      "input": "arn:aws-cn:storagegateway:cn-north-1:123456786354"
    },
    {
      "description": "Invalid us gov partition",
      "input": "arn:aws-cn-gov:storagegateway:us-gov-east-1:123456786354",
      "expected": false
    },
    {
      "description": "Invalid china partition",
      "input": "arn:aws-us-cn:storagegateway:cn-north-1:123456786354",
      "expected": false
    },
    {
      "description": "Invalid service name",
      "input": "arn:aws:amplifye:us-east-1:123456789012",
      "expected": false
    },
    {
      "description": "Invalid region name",
      "input": "arn:aws:storagegateway:us-eastdk-74381:123456786354",
      "expected": false
    },
    {
      "description": "Invalid us gov region",
      "input": "arn:aws-us-gov:storagegateway:us-east-2-74381:123456786354",
      "expected": false
    },
    {
      "description": "Invalid china region",
      "input": "arn:aws-cn:storagegateway:us-east-2-74381:123456786354",
      "expected": false
    }
  ],
  ".turbot": {
    "uri": "tmod:@turbot/aws-storagegateway#/definitions/storageGatewayAka",
    "modUri": "tmod:@turbot/aws-storagegateway"
  }
}

tape

Schema
{
  "type": "object",
  "properties": {
    "TapeARN": {
      "$ref": "#/definitions/tapeAka"
    },
    "TapeBarcode": {
      "type": "string"
    },
    "TapeCreatedDate": {
      "$ref": "turbot#/definitions/isoTimestamp"
    },
    "TapeSizeInBytes": {
      "type": "integer"
    },
    "TapeStatus": {
      "type": "string"
    },
    "VTLDevice": {
      "type": "string"
    },
    "TapeUsedInBytes": {
      "type": "integer"
    },
    "Progress": {
      "type": "number"
    },
    "KMSKey": {
      "type": "string"
    },
    "PoolId": {
      "type": "string"
    },
    "Worm": {
      "type": "boolean"
    },
    "RetentionStartDate": {
      "$ref": "turbot#/definitions/isoTimestamp"
    },
    "PoolEntryDate": {
      "$ref": "turbot#/definitions/isoTimestamp"
    },
    "GatewayARN": {
      "$ref": "#/definitions/gatewayAka"
    },
    "Tags": {
      "$ref": "aws#/definitions/tagList"
    },
    "turbot": {
      "type": "object",
      "properties": {
        "akas": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/tapeAka"
          }
        },
        "title": {
          "$ref": "#/definitions/tapeBarcode"
        },
        "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": {
        "TapeBarcode": "TEST04A2A1",
        "TapeARN": "arn:aws:storagegateway:us-east-1:123456789012:tape/TEST04A2A1",
        "GatewayARN": "arn:aws:storagegateway:us-east-1:123456789012:gateway/sgw-325BB05B",
        "Tags": [
          {
            "Key": "Env",
            "Value": "Test"
          },
          {
            "Key": "Application",
            "Value": "Turbot"
          }
        ],
        "turbot": {
          "akas": [
            "arn:aws:storagegateway:us-east-1:123456789012:tape/TEST04A2A1"
          ],
          "title": "TEST04A2A1",
          "custom": {
            "aws": {
              "accountId": 123456789012,
              "regionName": "us-east-1",
              "partition": "aws"
            }
          }
        }
      }
    },
    {
      "description": "Invalid - Missing Name",
      "input": {
        "TapeARN": "arn:aws:storagegateway:us-east-1:123456789012:tape/TEST04A2A1",
        "GatewayARN": "arn:aws:storagegateway:us-east-1:123456789012:gateway/sgw-325BB05B",
        "Tags": [
          {
            "Key": "Env",
            "Value": "Test"
          },
          {
            "Key": "Application",
            "Value": "Turbot"
          }
        ],
        "turbot": {
          "akas": [
            "arn:aws:storagegateway:us-east-1:123456789012:tape/TEST04A2A1"
          ],
          "title": null,
          "custom": {
            "aws": {
              "accountId": 123456789012,
              "regionName": "us-east-1",
              "partition": "aws"
            }
          }
        }
      },
      "expected": false
    }
  ],
  ".turbot": {
    "uri": "tmod:@turbot/aws-storagegateway#/definitions/tape",
    "modUri": "tmod:@turbot/aws-storagegateway"
  }
}

tapeAka

Schema
{
  "type": "string",
  "pattern": "^arn:aws(-us-gov|-cn)?:storagegateway:[a-z]{2}(-gov)?-[a-z]+-[0-9]:[0-9]{12}:tape/[a-zA-Z0-9]{10}$",
  "tests": [
    {
      "description": "Valid - Base case",
      "input": "arn:aws:storagegateway:us-east-1:123456789012:tape/TEST04A2A1"
    },
    {
      "description": "Invalid - Malformed region name",
      "input": "arn:aws:storagegateway:use-east-12:123456789012:tape/TEST04",
      "expected": false
    }
  ],
  ".turbot": {
    "uri": "tmod:@turbot/aws-storagegateway#/definitions/tapeAka",
    "modUri": "tmod:@turbot/aws-storagegateway"
  }
}

tapeBarcode

Schema
{
  "type": "string",
  "pattern": "^[a-zA-Z0-9]{10}$",
  "tests": [
    {
      "input": "TEST04A2A1"
    }
  ],
  ".turbot": {
    "uri": "tmod:@turbot/aws-storagegateway#/definitions/tapeBarcode",
    "modUri": "tmod:@turbot/aws-storagegateway"
  }
}

tapePool

Schema
{
  "type": "object",
  "properties": {
    "PoolARN": {
      "$ref": "#/definitions/tapePoolAka"
    },
    "PoolName": {
      "type": "string"
    },
    "StorageClass": {
      "$ref": "#/definitions/tapePoolStorageClass"
    },
    "RetentionLockType": {
      "$ref": "#/definitions/tapePoolRetentionLockType"
    },
    "RetentionLockTimeInDays": {
      "type": "integer"
    },
    "PoolStatus": {
      "$ref": "#/definitions/tapePoolPoolStatus"
    },
    "Tags": {
      "$ref": "aws#/definitions/tagList"
    },
    "turbot": {
      "type": "object",
      "properties": {
        "akas": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/tapePoolAka"
          }
        },
        "title": {
          "$ref": "#/definitions/tapeBarcode"
        },
        "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": {
        "PoolName": "test-niharika",
        "PoolARN": "arn:aws:storagegateway:us-east-1:013122550996:tapepool/pool-01F7D8BBA47051ADA",
        "Tags": [
          {
            "Key": "Env",
            "Value": "Test"
          },
          {
            "Key": "Application",
            "Value": "Turbot"
          }
        ],
        "turbot": {
          "akas": [
            "arn:aws:storagegateway:us-east-1:013122550996:tapepool/pool-01F7D8BBA47051ADA"
          ],
          "title": "test-niharika",
          "custom": {
            "aws": {
              "accountId": 123456789012,
              "regionName": "us-east-1",
              "partition": "aws"
            }
          }
        }
      }
    },
    {
      "description": "Invalid - Missing Name",
      "input": {
        "PoolARN": "arn:aws:storagegateway:us-east-1:013122550996:tapepool/pool-01F7D8BBA47051ADA",
        "Tags": [
          {
            "Key": "Env",
            "Value": "Test"
          },
          {
            "Key": "Application",
            "Value": "Turbot"
          }
        ],
        "turbot": {
          "akas": [
            "arn:aws:storagegateway:us-east-1:013122550996:tapepool/pool-01F7D8BBA47051ADA"
          ],
          "title": null,
          "custom": {
            "aws": {
              "accountId": 123456789012,
              "regionName": "us-east-1",
              "partition": "aws"
            }
          }
        }
      },
      "expected": false
    }
  ],
  ".turbot": {
    "uri": "tmod:@turbot/aws-storagegateway#/definitions/tapePool",
    "modUri": "tmod:@turbot/aws-storagegateway"
  }
}

tapePoolAka

Schema
{
  "type": "string",
  "pattern": "^arn:aws(-us-gov|-cn)?:storagegateway:[a-z]{2}(-gov)?-[a-z]+-[0-9]:[0-9]{12}:tapepool/pool-([a-zA-Z0-9]{17})$",
  "tests": [
    {
      "description": "Valid - Base case",
      "input": "arn:aws:storagegateway:us-east-1:013122550996:tapepool/pool-01F7D8BBA47051ADA"
    },
    {
      "description": "Invalid - Malformed region name",
      "input": "arn:aws:storagegateway:us-east-14:013122550996:tapepool/pool-01F7D8BBA47051ADA",
      "expected": false
    }
  ],
  ".turbot": {
    "uri": "tmod:@turbot/aws-storagegateway#/definitions/tapePoolAka",
    "modUri": "tmod:@turbot/aws-storagegateway"
  }
}

tapePoolPoolStatus

Schema
{
  "type": "string",
  "enum": [
    "ACTIVE",
    "DELETED"
  ],
  ".turbot": {
    "uri": "tmod:@turbot/aws-storagegateway#/definitions/tapePoolPoolStatus",
    "modUri": "tmod:@turbot/aws-storagegateway"
  }
}

tapePoolRetentionLockType

Schema
{
  "type": "string",
  "enum": [
    "COMPLIANCE",
    "GOVERNANCE",
    "NONE"
  ],
  ".turbot": {
    "uri": "tmod:@turbot/aws-storagegateway#/definitions/tapePoolRetentionLockType",
    "modUri": "tmod:@turbot/aws-storagegateway"
  }
}

tapePoolStorageClass

Schema
{
  "type": "string",
  "enum": [
    "DEEP_ARCHIVE",
    "GLACIER"
  ],
  ".turbot": {
    "uri": "tmod:@turbot/aws-storagegateway#/definitions/tapePoolStorageClass",
    "modUri": "tmod:@turbot/aws-storagegateway"
  }
}

volume

Schema
{
  "type": "object",
  "properties": {
    "VolumeARN": {
      "$ref": "#/definitions/volumeAka"
    },
    "VolumeId": {
      "$ref": "#/definitions/volumeId"
    },
    "GatewayARN": {
      "$ref": "#/definitions/gatewayAka"
    },
    "GatewayId": {
      "$ref": "#/definitions/gatewayId"
    },
    "VolumeType": {
      "type": "string"
    },
    "VolumeSizeInBytes": {
      "type": "string"
    },
    "VolumeAttachmentStatus": {
      "$ref": "#/definitions/volumeAttachmentStatus"
    },
    "VolumeStatus": {
      "type": "string"
    },
    "VolumeProgress": {
      "type": "number"
    },
    "SourceSnapshotId": {
      "type": "string"
    },
    "VolumeiSCSIAttributes": {
      "type": "object"
    },
    "CreatedDate": {
      "$ref": "turbot#/definitions/isoTimestamp"
    },
    "VolumeUsedInBytes": {
      "type": "string"
    },
    "KMSKey": {
      "type": "string"
    },
    "TargetName": {
      "type": "string"
    },
    "VolumeDiskId": {
      "type": "string"
    },
    "PreservedExistingData": {
      "type": "boolean"
    },
    "StorediSCSIVolumes": {
      "type": "array"
    },
    "Tags": {
      "type": "array"
    },
    "turbot": {
      "type": "object",
      "properties": {
        "akas": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/volumeAka"
          }
        },
        "tags": {
          "$ref": "aws#/definitions/tagsMap"
        },
        "title": {
          "$ref": "#/definitions/volumeId"
        },
        "custom": {
          "type": "object",
          "properties": {
            "aws": {
              "$ref": "aws#/definitions/awsMetadata"
            },
            "createTimestamp": {
              "$ref": "turbot#/definitions/isoTimestamp"
            }
          }
        }
      }
    }
  },
  "additionalProperties": true,
  "tests": [
    {
      "description": "Valid - All properties",
      "input": {
        "VolumeARN": "arn:aws:storagegateway:us-east-1:123456789012:gateway/sgw-AF56BDC6/volume/vol-07F70C2EF3D3DA08F",
        "VolumeId": "vol-07f70c2ef3d3da08f",
        "GatewayARN": "arn:aws:storagegateway:us-east-1:123456789012:gateway/sgw-AF56BDC6",
        "GatewayId": "sgw-AF56BDC6",
        "turbot": {
          "akas": [
            "arn:aws:storagegateway:us-east-1:123456789012:gateway/sgw-AF56BDC6/volume/vol-07F70C2EF3D3DA08F"
          ],
          "title": "vol-07f70c2ef3d3da08f",
          "custom": {
            "aws": {
              "accountId": 123456789012,
              "regionName": "us-east-1",
              "partition": "aws"
            }
          }
        }
      }
    }
  ],
  ".turbot": {
    "uri": "tmod:@turbot/aws-storagegateway#/definitions/volume",
    "modUri": "tmod:@turbot/aws-storagegateway"
  }
}

volumeAka

Schema
{
  "type": "string",
  "pattern": "^arn:aws(-us-gov|-cn)?:storagegateway:[a-z]{2}(-gov)?-[a-z]+-[0-9]:[0-9]{12}:gateway/sgw-([a-zA-Z0-9]{8})/volume/vol-([A-Z0-9]{8,26})$",
  "tests": [
    {
      "description": "Valid ARN",
      "input": "arn:aws:storagegateway:us-east-1:123456789012:gateway/sgw-AF56BDC6/volume/vol-07F70C2EF3D3DA08F"
    },
    {
      "description": "Invalid ARN",
      "input": "arn:aws:storagegateway:us-east-1:123456782:share/share-F36",
      "expected": false
    }
  ],
  ".turbot": {
    "uri": "tmod:@turbot/aws-storagegateway#/definitions/volumeAka",
    "modUri": "tmod:@turbot/aws-storagegateway"
  }
}

volumeAttachmentStatus

Schema
{
  "type": "string",
  "enum": [
    "ATTACHED",
    "DETACHED"
  ],
  ".turbot": {
    "uri": "tmod:@turbot/aws-storagegateway#/definitions/volumeAttachmentStatus",
    "modUri": "tmod:@turbot/aws-storagegateway"
  }
}

volumeId

Schema
{
  "type": "string",
  "pattern": "^vol-([A-Z0-9a-z]{8,26})$",
  "tests": [
    {
      "description": "Valid ID",
      "input": "vol-07F70C2EF3D3DA08F"
    },
    {
      "description": "Invalid ID",
      "input": "vol-07F",
      "expected": false
    }
  ],
  ".turbot": {
    "uri": "tmod:@turbot/aws-storagegateway#/definitions/volumeId",
    "modUri": "tmod:@turbot/aws-storagegateway"
  }
}