Get Involved
Edit on GitHub

ResourceType

ResourceType

Represents a ResourceType defined within a Mod.

For more information, please see Resource Types & Categories and Mods.

categoryResourceCategoryThe category information for this ResourceType.
categoryUriStringUnique identifier for the category.
childrenResourceTypesThe immediate children for this ResourceType.
controlsControlsReturns any controls for this ResourceType that you have permission to get, subject to the optional filter and paging arguments.
descendantsResourceTypesThe descendants of this ResourceType.
descriptionStringShort human-friendly description.
graphQLGraphqlResourceTypeMetadataReturns compiled graphQL typedefs for this ResourceType, used for generating strongly-typed custom resource schemas in runnable input queries.
iconStringFontAwesome icon reference, used for display in the product and documentation. Will be in the format fal-<icon>, far-<icon> or fas-<icon> for light, regular and solid icon classes respectively.
metadataTemplatesScalarOptional metadataTemplates for the ResourceType.
modUriString!Unique identifier for the defining mod.
policySettingsPolicySettingsReturns any policySettings for this ResourceType that you have permission to get, subject to the optional filter and paging arguments.
resourcesResourcesThe resources of this ResourceType, subject to the optional filter and paging arguments.
terraformTerraformResourceTypeMetadataContains property mappings and other metadata to allow Turbot to manage resources of this the ResourceType using terraform.
titleString!Display title.
trunkTrunkItemsThe trunk for this ResourceType, subject to the optional filter and paging arguments. This will show the resource type hierarchy from the root down to this ResourceType.
turbotTurbotResourceTypeMetadata!Turbot metadata for this ResourceType.
uriString!Mod-specific unique identifier.