Module Reference / @tinystacks/ops-aws-core-widgets / AwsJsonTree
Interface: AwsJsonTree
@tinystacks/ops-aws-core-widgets.AwsJsonTree
A widget is an object that is passed in and out of the API. It is used to serialize the complex and resolved widgets into only the information needed by the API and frontend to fetch data and render the widget, respectively. The main difference between this object and YamlWidget is that this object does not carry over resolved references to providers and children.
Hierarchy
↳ AwsJsonTree
Table of contents
Properties
- additionalProperties
- childrenIds
- cloudControlType
- description
- displayName
- displayOptions
- id
- paths
- providerIds
- region
- resourceModel
- type
Properties
additionalProperties
• Optional additionalProperties: any
Inherited from
Widget.additionalProperties
Defined in
node_modules/@tinystacks/ops-model/dist/models/Widget.d.ts:30
childrenIds
• Optional childrenIds: string[]
Inherited from
Widget.childrenIds
Defined in
node_modules/@tinystacks/ops-model/dist/models/Widget.d.ts:18
cloudControlType
• cloudControlType: string
Defined in
node_modules/@tinystacks/ops-aws-core-widgets/dist/ops-types.d.ts:173
description
• Optional description: string
Inherited from
Widget.description
Defined in
node_modules/@tinystacks/ops-model/dist/models/Widget.d.ts:19
displayName
• displayName: string
A human-readable display name, usually used to title a widget
Inherited from
Widget.displayName
Defined in
node_modules/@tinystacks/ops-model/dist/models/Widget.d.ts:12
displayOptions
• Optional displayOptions: Object
Type declaration
| Name | Type | Description |
|---|---|---|
showDescription? |
boolean |
Whether to show the description |
showDisplayName? |
boolean |
Whether to show the display name |
Inherited from
Widget.displayOptions
Defined in
node_modules/@tinystacks/ops-model/dist/models/Widget.d.ts:20
id
• id: string
Unique Id for this widget.
Inherited from
Widget.id
Defined in
node_modules/@tinystacks/ops-model/dist/models/Widget.d.ts:8
paths
• Optional paths: string[]
Defined in
node_modules/@tinystacks/ops-aws-core-widgets/dist/ops-types.d.ts:175
providerIds
• Optional providerIds: string[]
Inherited from
Widget.providerIds
Defined in
node_modules/@tinystacks/ops-model/dist/models/Widget.d.ts:17
region
• region: string
Defined in
node_modules/@tinystacks/ops-aws-core-widgets/dist/ops-types.d.ts:172
resourceModel
• Optional resourceModel: string
Defined in
node_modules/@tinystacks/ops-aws-core-widgets/dist/ops-types.d.ts:174
type
• type: string
This describes how this widget should be rendered. The "type" should be equivalent to the Object definition's name of the widget you are trying to render.
Inherited from
Widget.type
Defined in
node_modules/@tinystacks/ops-model/dist/models/Widget.d.ts:16