This section documents a set of preconfigured entities that are created for AWS based on AWS resources. All entity types are prefixed with AWS_*.
All AWS entities have at least the following fields:
Get an overview of all AWS entities.
smartscapeNodes "AWS_*"| summarize by:type, count()
| Attribute | Type | Description | Examples |
|---|---|---|---|
aws.account.id | string | resource stable Display name: AWS account IDThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account. Tags: permission primary-field | 123456789012 |
aws.arn | string | resource stable Display name: AWS ARNAmazon Resource Name (ARN). | arn:aws:lambda:us-east-1:478983378254:function:acceptanceWeatherBackend |
aws.object | string | stable Display name: AWS objectThe full JSON content of any AWS object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }} | |
aws.properties.version | string | experimental Display name: AWS properties versionThe aws.object JSON content version | 1.0 |
aws.region | string | resource stable Display name: AWS regionA specific geographical AWS Cloud location. Tags: primary-field | us-east-1 |
aws.resource.id | string | resource stable Display name: AWS resource IDUnique, immutable identifier assigned to the AWS cloud resource. | i-0922cda4579db3a45 |
aws.resource.name | string | resource stable Display name: AWS resource nameName of the resource for named resources, value of the "Name" tag in AWS for non-named resources (if unavailable, same as aws.resource.id). | my-ec2-instance |
aws.resource.type | string | resource experimental Display name: AWS resource typeThe name of a resource type in CloudFormation format. | AWS::EC2::Instance; AWS::S3::Bucket; AWS::Lambda::Function |
aws.service | string | resource experimental Display name: AWS serviceThe service that identifies the AWS product. | s3 |
cloud.provider | string | resource stable Display name: Cloud providerName of the cloud provider. | alibaba_cloud |
cloud.provider has the following list of well-known values. If one of them applies, then the respective value MUST be used, otherwise a custom value MAY be used.
| Value | Description | Display name |
|---|---|---|
alibaba_cloud | Alibaba Cloud | Alibaba Cloud |
aws | Amazon Web Services | AWS |
azure | Microsoft Azure | Azure |
gcp | Google Cloud Platform | GCP |
heroku | Heroku Platform as a Service | Heroku |
ibm_cloud | IBM Cloud | IBM Cloud |
tencent_cloud | Tencent Cloud | Tencent Cloud |
The Smartscape ID for a given entity is calculated based on aws.arn of the AWS resource.
The aws.object field contains the configuration of the resource as JSON string.
All AWS tags of an entity are captured automatically and available via the tags:aws and additionally via the tags field. E.g. to access the CREATED_BY tag you can use tags[CREATED_BY].
All AWS entities support the following fields to set up permissions:
aws.account.iddt.security_contextSmartscape node name: aws.resource.name
Smartscape node type: AWS_ACCOUNT
This entity represents an AWS Account.
Fetch all Smartscape nodes from the smartscape.nodes table and filter for the entity type "AWS_ACCOUNT"
smartscapeNodes "AWS_ACCOUNT"
The ID is calculated based on the following fields in the defined order: aws.arn
The following base fields are used for all entities.
| Attribute | Type | Description | Examples |
|---|---|---|---|
id | smartscapeId | stable Display name: IDA Smartscape ID consists of two components: an UPPER_CASE entity type and a random 16-character hexadecimal unique identifier, separated by a dash. Use Smartscape conversion functions when working with strings that represent Smartscape IDs. | <type>-017198AD253CBD63 |
id_classic | string | deprecated Display name: Classic IDThe entity ID that was used in the classic entity store. This ID is present in old monitoring data. Not all entities have this ID, and it is not generated for new entities. Use the id field instead, which is the Smartscape ID. | <type>-017198AD253CBD63 |
name | string | stable Display name: NameThe entity name. | localhost; easyTravel; product-catalog |
type | string | stable Display name: TypeThe entity type. UPPER_SNAKE_CASE string that represents the type of the entity. Tags: permission | TYPE_A |
tags | record | stable Display name: TagsA consolidated record that aggregates all tag values originating from different contexts. Each nested field within tags represents a specific key (for example, release or name). The value of each nested field is the tag value from one or multiple contexts. Tags for specific context can be queried via tags:context field. Note that rule-based tags do not exist in the new model. | tags[tag_key-1] = [context_A_tag_val-1, context_B_tag_val-1]; tags[tag_key-2] = context_C_tag_val-1; tags:context_A[tag_key-1] = context_A_tag_val-1 |
lifetime | timeframe | stable Display name: LifetimeThe lifetime of the entity. This is a record with two nested fields: start and end, which represent the time when the entity was first and last observed, respectively. Each time an entity is updated, the end time is updated to the current time. | { start: 2022-07-06T13:36:00.808Z, end: 2024-04-11T06:56:01.204Z } |
references | record | stable Display name: ReferencesProvides access to static edges pointing to other entities. In this record each nested field represents a relationship type and target type, and the value is an array of target Smartscape IDs. This field is hidden by default but can be added using the fieldsAdd command. | { references[runs_on.host] : [HOST-C251A1173C2B4B39,HOST-0E9038C7C4409D69], references[runs_on.container] : [CONTAINER-68A08967EF4F675B] } |
dt.security_context | string[] | resource stable Display name: DT security contextThe security contexts associated with the entity. For Smartscape entities, this field is always an array. Tags: permission | [] |
Fields that are provided by all Cloud workloads.
| Attribute | Type | Description | Examples |
|---|---|---|---|
cloud.acquisition.status | string | experimental Display name: Cloud acquisition statusThe status of Smartscape nodes data acquisition by Data Acquisition Controller: OK —node is consistent; DELETED —node was deleted in the cloud platform; ERROR —there was an error acquiring the node, but the node was upserted; INCOMPLETE —there was an error acquiring the node child resource (for example an EC2 instance with no EBS volumes due to missing permissions), but the node was upserted. | OK; DELETED; ERROR; INCOMPLETE |
| Attribute | Type | Description | Examples |
|---|---|---|---|
aws.account.id | string | resource stable Display name: AWS account IDThe 12-digit number, such as 123456789012, that uniquely identifies an AWS account. Tags: permission primary-field | 123456789012 |
aws.resource.id | string | resource stable Display name: AWS resource IDUnique, immutable identifier assigned to the AWS cloud resource. | i-0922cda4579db3a45 |
aws.resource.name | string | resource stable Display name: AWS resource nameName of the resource for named resources, value of the "Name" tag in AWS for non-named resources (if unavailable, same as aws.resource.id). | my-ec2-instance |
aws.arn | string | resource stable Display name: AWS ARNAmazon Resource Name (ARN). | arn:aws:lambda:us-east-1:478983378254:function:acceptanceWeatherBackend |
Smartscape node name: aws.resource.name
Smartscape node type: AWS_AVAILABILITY_ZONE
This entity represents a physical AWS Availability Zone (e.g. use1-az1).
Fetch all Smartscape nodes from the smartscape.nodes table and filter for the entity type "AWS_AVAILABILITY_ZONE"
smartscapeNodes "AWS_AVAILABILITY_ZONE"
The ID is calculated based on the following fields in the defined order: aws.arn
The following base fields are used for all entities.
| Attribute | Type | Description | Examples |
|---|---|---|---|
id | smartscapeId | stable Display name: IDA Smartscape ID consists of two components: an UPPER_CASE entity type and a random 16-character hexadecimal unique identifier, separated by a dash. Use Smartscape conversion functions when working with strings that represent Smartscape IDs. | <type>-017198AD253CBD63 |
id_classic | string | deprecated Display name: Classic IDThe entity ID that was used in the classic entity store. This ID is present in old monitoring data. Not all entities have this ID, and it is not generated for new entities. Use the id field instead, which is the Smartscape ID. | <type>-017198AD253CBD63 |
name | string | stable Display name: NameThe entity name. | localhost; easyTravel; product-catalog |
type | string | stable Display name: TypeThe entity type. UPPER_SNAKE_CASE string that represents the type of the entity. Tags: permission | TYPE_A |
tags | record | stable Display name: TagsA consolidated record that aggregates all tag values originating from different contexts. Each nested field within tags represents a specific key (for example, release or name). The value of each nested field is the tag value from one or multiple contexts. Tags for specific context can be queried via tags:context field. Note that rule-based tags do not exist in the new model. | tags[tag_key-1] = [context_A_tag_val-1, context_B_tag_val-1]; tags[tag_key-2] = context_C_tag_val-1; tags:context_A[tag_key-1] = context_A_tag_val-1 |
lifetime | timeframe | stable Display name: LifetimeThe lifetime of the entity. This is a record with two nested fields: start and end, which represent the time when the entity was first and last observed, respectively. Each time an entity is updated, the end time is updated to the current time. | { start: 2022-07-06T13:36:00.808Z, end: 2024-04-11T06:56:01.204Z } |
references | record | stable Display name: ReferencesProvides access to static edges pointing to other entities. In this record each nested field represents a relationship type and target type, and the value is an array of target Smartscape IDs. This field is hidden by default but can be added using the fieldsAdd command. | { references[runs_on.host] : [HOST-C251A1173C2B4B39,HOST-0E9038C7C4409D69], references[runs_on.container] : [CONTAINER-68A08967EF4F675B] } |
dt.security_context | string[] | resource stable Display name: DT security contextThe security contexts associated with the entity. For Smartscape entities, this field is always an array. Tags: permission | [] |
Fields that are provided by all Cloud workloads.
| Attribute | Type | Description | Examples |
|---|---|---|---|
cloud.acquisition.status | string | experimental Display name: Cloud acquisition statusThe status of Smartscape nodes data acquisition by Data Acquisition Controller: OK —node is consistent; DELETED —node was deleted in the cloud platform; ERROR —there was an error acquiring the node, but the node was upserted; INCOMPLETE —there was an error acquiring the node child resource (for example an EC2 instance with no EBS volumes due to missing permissions), but the node was upserted. | OK; DELETED; ERROR; INCOMPLETE |
| Attribute | Type | Description | Examples |
|---|---|---|---|
aws.region | string | resource stable Display name: AWS regionA specific geographical AWS Cloud location. Tags: primary-field | us-east-1 |
aws.resource.id | string | resource stable Display name: AWS resource IDUnique, immutable identifier assigned to the AWS cloud resource. | i-0922cda4579db3a45 |
aws.resource.name | string | resource stable Display name: AWS resource nameName of the resource for named resources, value of the "Name" tag in AWS for non-named resources (if unavailable, same as aws.resource.id). | my-ec2-instance |
aws.arn | string | resource stable Display name: AWS ARNAmazon Resource Name (ARN). | arn:aws:lambda:us-east-1:478983378254:function:acceptanceWeatherBackend |
| Type | Target type | Kind | Description |
|---|---|---|---|
is_part_of | AWS_REGION | static | stable Defines if the instance is part of a cluster, similar to a composition in UML. The source (child) cannot exist without the destination (parent). |
Smartscape node name: aws.resource.name
Smartscape node type: AWS_REGION
This entity represents an AWS Region.
Fetch all Smartscape nodes from the smartscape.nodes table and filter for the entity type "AWS_REGION"
smartscapeNodes "AWS_REGION"
The ID is calculated based on the following fields in the defined order: aws.arn
The following base fields are used for all entities.
| Attribute | Type | Description | Examples |
|---|---|---|---|
id | smartscapeId | stable Display name: IDA Smartscape ID consists of two components: an UPPER_CASE entity type and a random 16-character hexadecimal unique identifier, separated by a dash. Use Smartscape conversion functions when working with strings that represent Smartscape IDs. | <type>-017198AD253CBD63 |
id_classic | string | deprecated Display name: Classic IDThe entity ID that was used in the classic entity store. This ID is present in old monitoring data. Not all entities have this ID, and it is not generated for new entities. Use the id field instead, which is the Smartscape ID. | <type>-017198AD253CBD63 |
name | string | stable Display name: NameThe entity name. | localhost; easyTravel; product-catalog |
type | string | stable Display name: TypeThe entity type. UPPER_SNAKE_CASE string that represents the type of the entity. Tags: permission | TYPE_A |
tags | record | stable Display name: TagsA consolidated record that aggregates all tag values originating from different contexts. Each nested field within tags represents a specific key (for example, release or name). The value of each nested field is the tag value from one or multiple contexts. Tags for specific context can be queried via tags:context field. Note that rule-based tags do not exist in the new model. | tags[tag_key-1] = [context_A_tag_val-1, context_B_tag_val-1]; tags[tag_key-2] = context_C_tag_val-1; tags:context_A[tag_key-1] = context_A_tag_val-1 |
lifetime | timeframe | stable Display name: LifetimeThe lifetime of the entity. This is a record with two nested fields: start and end, which represent the time when the entity was first and last observed, respectively. Each time an entity is updated, the end time is updated to the current time. | { start: 2022-07-06T13:36:00.808Z, end: 2024-04-11T06:56:01.204Z } |
references | record | stable Display name: ReferencesProvides access to static edges pointing to other entities. In this record each nested field represents a relationship type and target type, and the value is an array of target Smartscape IDs. This field is hidden by default but can be added using the fieldsAdd command. | { references[runs_on.host] : [HOST-C251A1173C2B4B39,HOST-0E9038C7C4409D69], references[runs_on.container] : [CONTAINER-68A08967EF4F675B] } |
dt.security_context | string[] | resource stable Display name: DT security contextThe security contexts associated with the entity. For Smartscape entities, this field is always an array. Tags: permission | [] |
Fields that are provided by all Cloud workloads.
| Attribute | Type | Description | Examples |
|---|---|---|---|
cloud.acquisition.status | string | experimental Display name: Cloud acquisition statusThe status of Smartscape nodes data acquisition by Data Acquisition Controller: OK —node is consistent; DELETED —node was deleted in the cloud platform; ERROR —there was an error acquiring the node, but the node was upserted; INCOMPLETE —there was an error acquiring the node child resource (for example an EC2 instance with no EBS volumes due to missing permissions), but the node was upserted. | OK; DELETED; ERROR; INCOMPLETE |
| Attribute | Type | Description | Examples |
|---|---|---|---|
aws.region | string | resource stable Display name: AWS regionA specific geographical AWS Cloud location. Tags: primary-field | us-east-1 |
aws.resource.id | string | resource stable Display name: AWS resource IDUnique, immutable identifier assigned to the AWS cloud resource. | i-0922cda4579db3a45 |
aws.resource.name | string | resource stable Display name: AWS resource nameName of the resource for named resources, value of the "Name" tag in AWS for non-named resources (if unavailable, same as aws.resource.id). | my-ec2-instance |
aws.arn | string | resource stable Display name: AWS ARNAmazon Resource Name (ARN). | arn:aws:lambda:us-east-1:478983378254:function:acceptanceWeatherBackend |