Definitions for @turbot/aws-appstream
- appStream
- appStreamAka
- AuthenticationType
- Code
- EndpointType
- ErrorCode
- fleet
- fleetAka
- fleetName
- FleetType
- image
- imageAka
- imageBuilder
- imageBuilderAka
- imageBuilderName
- imageName
- InstanceType
- Platform
- State
- user
- userArn
- userName
- Visibility
appStream
Schema
{ "allOf": [ { "$ref": "turbot#/definitions/service" }, { "type": "object", "properties": { "name": { "const": "AppStream" }, "turbot": { "type": "object", "properties": { "akas": { "type": "array", "items": { "$ref": "#/definitions/appStreamAka" } }, "title": { "const": "AppStream" }, "custom": { "type": "object", "properties": { "aws": { "$ref": "aws#/definitions/awsMetadata" } } } } } }, "additionalProperties": true, "tests": [ { "description": "All valid properties", "input": { "name": "AppStream", "turbot": { "akas": [ "arn:aws:appstream:us-east-1:123123123123" ], "title": "AppStream", "custom": { "aws": { "accountId": 123456789012, "regionName": "us-east-1" } } } } }, { "description": "invalid - name is missing", "input": { "turbot": { "akas": [ "arn:aws:appstream:us-east-1:123123123123" ], "title": "AppStream", "custom": { "aws": { "accountId": 123456789012, "regionName": "us-east-1" } } } }, "expected": false } ] } ], ".turbot": { "uri": "tmod:@turbot/aws-appstream#/definitions/appStream", "modUri": "tmod:@turbot/aws-appstream" }}appStreamAka
Schema
{ "type": "string", "pattern": "^arn:aws(-us-gov|-cn)?:appstream:[a-z]{2}(-gov)?-[a-z]+-[0-9]{1}:[0-9]{12}$", "tests": [ { "description": "base", "input": "arn:aws:appstream:us-east-1:123123123123" }, { "description": "invalid aka", "input": "arn:aws:appstream11:us-east-1:123123123123", "expected": false } ], ".turbot": { "uri": "tmod:@turbot/aws-appstream#/definitions/appStreamAka", "modUri": "tmod:@turbot/aws-appstream" }}AuthenticationType
Schema
{ "type": "string", "enum": [ "API", "SAML", "USERPOOL" ], ".turbot": { "uri": "tmod:@turbot/aws-appstream#/definitions/AuthenticationType", "modUri": "tmod:@turbot/aws-appstream" }}Code
Schema
{ "type": "string", "enum": [ "INTERNAL_ERROR", "IMAGE_UNAVAILABLE", "IMAGE_COPY_FAILURE" ], ".turbot": { "uri": "tmod:@turbot/aws-appstream#/definitions/Code", "modUri": "tmod:@turbot/aws-appstream" }}EndpointType
Schema
{ "type": "string", "enum": [ "STREAMING" ], ".turbot": { "uri": "tmod:@turbot/aws-appstream#/definitions/EndpointType", "modUri": "tmod:@turbot/aws-appstream" }}ErrorCode
Schema
{ "type": "string", "enum": [ "IAM_SERVICE_ROLE_MISSING_ENI_DESCRIBE_ACTION", "IAM_SERVICE_ROLE_MISSING_ENI_CREATE_ACTION", "IAM_SERVICE_ROLE_MISSING_ENI_DELETE_ACTION", "NETWORK_INTERFACE_LIMIT_EXCEEDED", "INTERNAL_SERVICE_ERROR", "IAM_SERVICE_ROLE_IS_MISSING", "MACHINE_ROLE_IS_MISSING", "STS_DISABLED_IN_REGION", "SUBNET_HAS_INSUFFICIENT_IP_ADDRESSES", "IAM_SERVICE_ROLE_MISSING_DESCRIBE_SUBNET_ACTION", "SUBNET_NOT_FOUND", "IMAGE_NOT_FOUND", "INVALID_SUBNET_CONFIGURATION", "SECURITY_GROUPS_NOT_FOUND", "IGW_NOT_ATTACHED", "IAM_SERVICE_ROLE_MISSING_DESCRIBE_SECURITY_GROUPS_ACTION", "DOMAIN_JOIN_ERROR_FILE_NOT_FOUND", "DOMAIN_JOIN_ERROR_ACCESS_DENIED", "DOMAIN_JOIN_ERROR_LOGON_FAILURE", "DOMAIN_JOIN_ERROR_INVALID_PARAMETER", "DOMAIN_JOIN_ERROR_MORE_DATA", "DOMAIN_JOIN_ERROR_NO_SUCH_DOMAIN", "DOMAIN_JOIN_ERROR_NOT_SUPPORTED", "DOMAIN_JOIN_NERR_INVALID_WORKGROUP_NAME", "DOMAIN_JOIN_NERR_WORKSTATION_NOT_STARTED", "DOMAIN_JOIN_ERROR_DS_MACHINE_ACCOUNT_QUOTA_EXCEEDED", "DOMAIN_JOIN_NERR_PASSWORD_EXPIRED", "DOMAIN_JOIN_INTERNAL_SERVICE_ERROR" ], ".turbot": { "uri": "tmod:@turbot/aws-appstream#/definitions/ErrorCode", "modUri": "tmod:@turbot/aws-appstream" }}fleet
Schema
{ "type": "object", "properties": { "Arn": { "$ref": "#/definitions/fleetAka" }, "ComputeCapacityStatus": { "type": "object", "properties": { "Available": { "type": "integer" }, "Desired": { "type": "integer" }, "InUse": { "type": "integer" }, "Running": { "type": "integer" } } }, "CreatedTime": { "$ref": "turbot#/definitions/isoTimestamp" }, "Description": { "type": "string" }, "DisconnectTimeoutInSeconds": { "type": "integer" }, "DisplayName": { "type": "string" }, "DomainJoinInfo": { "type": "object", "properties": { "DirectoryName": { "type": "string" }, "OrganizationalUnitDistinguishedName": { "type": "string" } } }, "EnableDefaultInternetAccess": { "type": "boolean" }, "FleetErrors": { "type": "array", "items": { "type": "object", "properties": { "ErrorCode": { "$ref": "#/definitions/ErrorCode" }, "ErrorMessage": { "type": "string" } } } }, "FleetType": { "$ref": "#/definitions/FleetType" }, "IamRoleArn": { "type": "string" }, "IdleDisconnectTimeoutInSeconds": { "type": "integer" }, "ImageArn": { "type": "string" }, "ImageName": { "type": "string" }, "InstanceType": { "$ref": "#/definitions/InstanceType" }, "MaxUserDurationInSeconds": { "type": "integer" }, "Name": { "$ref": "#/definitions/fleetName" }, "State": { "$ref": "#/definitions/State" }, "Tags": { "type": "object" }, "VpcConfig": { "type": "object", "properties": { "SecurityGroupIds": { "type": "array", "items": { "type": "string" } }, "SubnetIds": { "type": "array", "items": { "type": "string" } } } }, "turbot": { "type": "object", "properties": { "akas": { "type": "array", "items": { "$ref": "#/definitions/fleetAka" } }, "title": { "$ref": "#/definitions/fleetName" }, "metadata": { "type": "object", "properties": { "createTimestamp": { "$ref": "turbot#/definitions/isoTimestamp" }, "aws": { "$ref": "aws#/definitions/awsMetadata" } } }, "tags": { "$ref": "aws#/definitions/tagsMap" } } } }, "additionalProperties": true, ".turbot": { "uri": "tmod:@turbot/aws-appstream#/definitions/fleet", "modUri": "tmod:@turbot/aws-appstream" }}fleetAka
Schema
{ "type": "string", "pattern": "arn:aws(-us-gov|-cn)?:appstream:[a-z]{2}(-gov)?-[a-z]+-[0-9]:[0-9]{12}:fleet/([a-zA-Z0-9-_.]{0,1023})$", "tests": [ { "description": "Valid - Base case", "input": "arn:aws:appstream:us-east-1:650022101893:fleet/test01" }, { "description": "Invalid - Malformed resource name", "input": "arn:aws:appstream:us-east-1:650022101893:fleet/appstream-fleet-useast1-test01@", "expected": false }, { "description": "Invalid - Malformed region name", "input": "arn:aws:appstream:use-east-1:650022101893:fleet/appstream-fleet-useast1-test01", "expected": false } ], ".turbot": { "uri": "tmod:@turbot/aws-appstream#/definitions/fleetAka", "modUri": "tmod:@turbot/aws-appstream" }}fleetName
Schema
{ "type": "string", "minLength": 1, "pattern": "^[a-zA-Z0-9-_.]+$", "tests": [ { "input": "Te_st-01." }, { "description": "invalid - special characters dollar, hash, asterisk, ampersand, cap, percentile not allowed", "input": "test$#*&^%", "expected": false }, { "description": "invalid - can not be empty", "input": "", "expected": false } ], ".turbot": { "uri": "tmod:@turbot/aws-appstream#/definitions/fleetName", "modUri": "tmod:@turbot/aws-appstream" }}FleetType
Schema
{ "type": "string", "enum": [ "ALWAYS_ON", "ON_DEMAND" ], ".turbot": { "uri": "tmod:@turbot/aws-appstream#/definitions/FleetType", "modUri": "tmod:@turbot/aws-appstream" }}image
Schema
{ "type": "object", "properties": { "Applications": { "type": "array", "items": { "type": "object", "properties": { "DisplayName": { "type": "string" }, "Enabled": { "type": "boolean" }, "IconURL": { "type": "string" }, "LaunchParameters": { "type": "string" }, "LaunchPath": { "type": "string" }, "Metadata": { "type": "string" }, "Name": { "type": "string" } } } }, "AppstreamAgentVersion": { "type": "string" }, "Arn": { "$ref": "#/definitions/imageAka" }, "BaseImageArn": { "type": "string" }, "CreatedTime": { "$ref": "turbot#/definitions/isoTimestamp" }, "Description": { "type": "string" }, "DisplayName": { "type": "string" }, "ImageBuilderName": { "type": "string" }, "ImageBuilderSupported": { "type": "boolean" }, "ImagePermissions": { "type": "object", "properties": { "allowFleet": { "type": "boolean" }, "allowImageBuilder": { "type": "boolean" } } }, "Name": { "$ref": "#/definitions/imageName" }, "Platform": { "$ref": "#/definitions/Platform" }, "PublicBaseImageReleasedDate": { "$ref": "turbot#/definitions/isoTimestamp" }, "SharedImagePermissionsList": { "type": "array", "items": { "type": "object", "properties": { "sharedAccountId": { "type": "string" } } } }, "State": { "$ref": "#/definitions/State" }, "StateChangeReason": { "type": "object", "properties": { "Code": { "$ref": "#/definitions/Code" }, "Message": { "type": "string" } } }, "Visibility": { "$ref": "#/definitions/Visibility" }, "Tags": { "type": "object" }, "turbot": { "type": "object", "properties": { "akas": { "type": "array", "items": { "$ref": "#/definitions/imageAka" } }, "title": { "$ref": "#/definitions/imageName" }, "metadata": { "type": "object", "properties": { "createTimestamp": { "$ref": "turbot#/definitions/isoTimestamp" }, "aws": { "$ref": "aws#/definitions/awsMetadata" } } }, "tags": { "$ref": "aws#/definitions/tagsMap" } } } }, "additionalProperties": true, ".turbot": { "uri": "tmod:@turbot/aws-appstream#/definitions/image", "modUri": "tmod:@turbot/aws-appstream" }}imageAka
Schema
{ "type": "string", "pattern": "^arn:aws(-us-gov|-cn)?:appstream:[a-z]{2}(-gov)?-[a-z]+-[0-9]:[0-9]{12}:image/[A-Za-z0-9][A-Za-z0-9:_/+=,@.\\-]{0,1023}$", "tests": [ { "description": "correct arn", "input": "arn:aws:appstream:us-east-1:123456789012:image/test" }, { "description": "invalid - image arn is invalid", "input": "arn:aws:appstream:us-east-1:123456789012:test", "expected": false }, { "description": "invalid - array passed instead of string", "input": [ "foo" ], "expected": false } ], ".turbot": { "uri": "tmod:@turbot/aws-appstream#/definitions/imageAka", "modUri": "tmod:@turbot/aws-appstream" }}imageBuilder
Schema
{ "type": "object", "properties": { "AccessEndpoints": { "type": "array", "items": { "type": "object", "properties": { "EndpointType": { "$ref": "#/definitions/EndpointType" }, "VpceId": { "type": "string" } } } }, "AppstreamAgentVersion": { "type": "string" }, "Arn": { "$ref": "#/definitions/imageBuilderAka" }, "CreatedTime": { "$ref": "turbot#/definitions/isoTimestamp" }, "Description": { "type": "string" }, "DisplayName": { "type": "string" }, "DomainJoinInfo": { "type": "object", "properties": { "DirectoryName": { "type": "string" }, "OrganizationalUnitDistinguishedName": { "type": "string" } } }, "EnableDefaultInternetAccess": { "type": "boolean" }, "IamRoleArn": { "type": "string" }, "ImageArn": { "type": "string" }, "ImageBuilderErrors": { "type": "array", "items": { "type": "object", "properties": { "ErrorCode": { "$ref": "#/definitions/ErrorCode" }, "ErrorMessage": { "type": "string" }, "ErrorTimestamp": { "$ref": "turbot#/definitions/isoTimestamp" } } } }, "InstanceType": { "$ref": "#/definitions/InstanceType" }, "Name": { "$ref": "#/definitions/imageBuilderName" }, "NetworkAccessConfiguration": { "type": "object", "properties": { "EniId": { "type": "string" }, "EniPrivateIpAddress": { "type": "string" } } }, "Platform": { "$ref": "#/definitions/Platform" }, "State": { "$ref": "#/definitions/State" }, "StateChangeReason": { "type": "object", "properties": { "Code": { "$ref": "#/definitions/Code" }, "Message": { "type": "string" } } }, "VpcConfig": { "type": "object", "properties": { "SecurityGroupIds": { "type": "array", "items": { "type": "string" } }, "SubnetIds": { "type": "array", "items": { "type": "string" } } } }, "turbot": { "type": "object", "properties": { "metadata": { "type": "object", "properties": { "createTimestamp": { "$ref": "turbot#/definitions/isoTimestamp" }, "aws": { "$ref": "aws#/definitions/awsMetadata" } } }, "tags": { "$ref": "aws#/definitions/tagsMap" } } } }, "additionalProperties": true, ".turbot": { "uri": "tmod:@turbot/aws-appstream#/definitions/imageBuilder", "modUri": "tmod:@turbot/aws-appstream" }}imageBuilderAka
Schema
{ "type": "string", "pattern": "^arn:aws(-us-gov|-cn)?:appstream:[a-z]{2}(-gov)?-[a-z]+-[0-9]:[0-9]{12}:image-builder/[A-Za-z0-9][A-Za-z0-9:_/+=,@.\\-]{0,1023}$", "tests": [ { "description": "correct arn", "input": "arn:aws:appstream:us-east-1:123456789012:image-builder/test" }, { "description": "invalid - imageBuilder arn is invalid", "input": "arn:aws:appstream:us-east-1:123456789012:test", "expected": false }, { "description": "invalid - array passed instead of string", "input": [ "foo" ], "expected": false } ], ".turbot": { "uri": "tmod:@turbot/aws-appstream#/definitions/imageBuilderAka", "modUri": "tmod:@turbot/aws-appstream" }}imageBuilderName
Schema
{ "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9:_/+=,@.\\-]{0,1023}$", "tests": [ { "input": "$test-01." }, { "description": "invalid - empty string", "input": "", "expected": false }, { "description": "invalid - max length exceeded", "input": "imagebuilder01imagebuilder01imagebuilder01imagebuilder01imagebuilder01imagebuilder01imagebuilder01imagebuilder01imagebuilder01imagebuilder01imagebuilder01imagebuilder01image-$098765test01imagebuilder01imagebuilder01imagebuilder01imagebuilder01imagebuilder01imagebuilder011imagebuilder01imagebuilder01imagebuilder01imagebuilder01imagebuilder01imagebuilder01imagebuilder01imagebuilder01imagebuilder01imagebuilder01imagebuilder01imagebuilder01image-$098765test01imagebuilder01imagebuilder01imagebuilder01imagebuilder01imagebuilder01imagebuilder011imagebuilder01imagebuilder01imagebuilder01imagebuilder01imagebuilder01imagebuilder01imagebuilder01imagebuilder01imagebuilder01imagebuilder01imagebuilder01imagebuilder01image-$098765test01imagebuilder01imagebuilder01imagebuilder01imagebuilder01imagebuilder01imagebuilder011imagebuilder01imagebuilder01imagebuilder01imagebuilder01imagebuilder01imagebuilder01imagebuilder01imagebuilder01imagebuilder01imagebuilder01imagebuilder01imagebuilder01image-$098765test01imagebuilder01imagebuilder01imagebuilder01imagebuilder01imagebuilder01imagebuilder011imagebuilder01imagebuilder01imagebuilder01imagebuilder01imagebuilder01imagebuilder01imagebuilder01imagebuilder01imagebuilder01imagebuilder01imagebuilder01imagebuilder01image-$098765test01imagebuilder01", "expected": false } ], ".turbot": { "uri": "tmod:@turbot/aws-appstream#/definitions/imageBuilderName", "modUri": "tmod:@turbot/aws-appstream" }}imageName
Schema
{ "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9:_/+=,@.\\-]{0,1023}$", "tests": [ { "input": "$test-01." }, { "description": "invalid - empty string", "input": "", "expected": false }, { "description": "invalid - max length exceeded", "input": "imagetest01imagetest01imagetest01imagetest01imagetest01imagetest01imagetest01imagetest01imagetest01imagetest01imagetest01imagetest01image-$098765test01imagetest01imagetest01imagetest01imagetest01imagetest01imagetest011imagetest01imagetest01imagetest01imagetest01imagetest01imagetest01imagetest01imagetest01imagetest01imagetest01imagetest01imagetest01image-$098765test01imagetest01imagetest01imagetest01imagetest01imagetest01imagetest011imagetest01imagetest01imagetest01imagetest01imagetest01imagetest01imagetest01imagetest01imagetest01imagetest01imagetest01imagetest01image-$098765test01imagetest01imagetest01imagetest01imagetest01imagetest01imagetest011imagetest01imagetest01imagetest01imagetest01imagetest01imagetest01imagetest01imagetest01imagetest01imagetest01imagetest01imagetest01image-$098765test01imagetest01imagetest01imagetest01imagetest01imagetest01imagetest011imagetest01imagetest01imagetest01imagetest01imagetest01imagetest01imagetest01imagetest01imagetest01imagetest01imagetest01imagetest01image-$098765test01imagetest01", "expected": false } ], ".turbot": { "uri": "tmod:@turbot/aws-appstream#/definitions/imageName", "modUri": "tmod:@turbot/aws-appstream" }}InstanceType
Schema
{ "type": "string", "enum": [ "stream.standard.medium", "stream.standard.large", "stream.compute.large", "stream.compute.xlarge", "stream.compute.2xlarge", "stream.compute.4xlarge", "stream.compute.8xlarge", "stream.memory.large", "stream.memory.xlarge", "stream.memory.2xlarge", "stream.memory.4xlarge", "stream.memory.8xlarge", "stream.graphics-design.large", "stream.graphics-design.xlarge", "stream.graphics-design.2xlarge", "stream.graphics-design.4xlarge", "stream.graphics-desktop.2xlarge", "stream.graphics-pro.4xlarge", "stream.graphics-pro.8xlarge", "stream.graphics-pro.16xlarge" ], ".turbot": { "uri": "tmod:@turbot/aws-appstream#/definitions/InstanceType", "modUri": "tmod:@turbot/aws-appstream" }}Platform
Schema
{ "type": "string", "enum": [ "WINDOWS", "WINDOWS_SERVER_2016", "WINDOWS_SERVER_2019" ], ".turbot": { "uri": "tmod:@turbot/aws-appstream#/definitions/Platform", "modUri": "tmod:@turbot/aws-appstream" }}State
Schema
{ "type": "string", "enum": [ "PENDING", "UPDATING_AGENT", "RUNNING", "STOPPING", "STOPPED", "REBOOTING", "SNAPSHOTTING", "DELETING", "FAILED", "UPDATING", "PENDING_QUALIFICATION" ], ".turbot": { "uri": "tmod:@turbot/aws-appstream#/definitions/State", "modUri": "tmod:@turbot/aws-appstream" }}user
Schema
{ "type": "object", "properties": { "Arn": { "$ref": "#/definitions/userArn" }, "UserName": { "$ref": "#/definitions/userName" }, "Enabled": { "type": "boolean" }, "Status": { "type": "string" }, "FirstName": { "type": "string" }, "LastName": { "type": "string" }, "CreatedTime": { "$ref": "turbot#/definitions/isoTimestamp" }, "AuthenticationType": { "$ref": "#/definitions/AuthenticationType" }, "turbot": { "type": "object", "properties": { "akas": { "type": "array", "items": { "$ref": "#/definitions/userArn" } }, "title": { "$ref": "#/definitions/userName" }, "metadata": { "type": "object", "properties": { "createTimestamp": { "$ref": "turbot#/definitions/isoTimestamp" }, "aws": { "$ref": "aws#/definitions/awsMetadata" } } } } } }, "additionalProperties": true, ".turbot": { "uri": "tmod:@turbot/aws-appstream#/definitions/user", "modUri": "tmod:@turbot/aws-appstream" }}userArn
Schema
{ "type": "string", "minLength": 20, "maxLength": 2048, "pattern": "^arn:aws(-us-gov|-cn)?:appstream:[a-z]{2}(-gov)?-[a-z]+-\\d{1}:\\d{12}:user/userpool/([a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12})*$", "tests": [ { "input": "arn:aws:appstream:us-east-1:560741234067:user/userpool/12345678-1234-1234-1234-560741234067" }, { "input": "arn:aws:appstream:us-east-1:533793682495:user/userpool/8c6370dd-d94d-4172-82a8-1ca6345926b9" }, { "description": "invalid - incorrect arn inserted", "input": 12345, "expected": false }, { "description": "invalid - empty string inserted", "input": "", "expected": false }, { "description": "invalid - incorrect arn value provided", "input": "arn:aws:appstream:us-east-1:560741234067/12345678-1234-1234-1234-560741234067", "expected": false } ], ".turbot": { "uri": "tmod:@turbot/aws-appstream#/definitions/userArn", "modUri": "tmod:@turbot/aws-appstream" }}userName
Schema
{ "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^[A-Za-z0-9_+=,.@-]+$", "tests": [ { "input": "Foo,foo+fOO-bar" }, { "input": "00123" }, { "input": "ab@cde.com" }, { "input": "Test.The-Kitchen_Sink" }, { "description": "max length", "input": "a23456789_123456789_123456789_123456789_123456789_123456789_1234a23456789_123456789_123456789_123456789_123456789_123456789_1234" }, { "description": "invalid - too long", "input": "a23456789_123456789_123456789_123456789_123456789_123456789_123456789_123456789_123456789_123456789_123456789_123456789_123456789_123456789_123456789_123456789_123456789_123456789_123456789_123456789_123456789_123456789_123456789_123456789_123456789_123456", "expected": false }, { "description": "invalid - empty string", "input": "", "expected": false } ], ".turbot": { "uri": "tmod:@turbot/aws-appstream#/definitions/userName", "modUri": "tmod:@turbot/aws-appstream" }}Visibility
Schema
{ "type": "string", "enum": [ "PUBLIC", "PRIVATE", "SHARED" ], ".turbot": { "uri": "tmod:@turbot/aws-appstream#/definitions/Visibility", "modUri": "tmod:@turbot/aws-appstream" }}