This entity represents an AWS Client VPN endpoint.
Query
Fetch all Smartscape nodes from the smartscape.nodes table and filter for the entity type "AWS_EC2_CLIENTVPNENDPOINT"
smartscapeNodes"AWS_EC2_CLIENTVPNENDPOINT"
ID input
The ID is calculated based on the following fields in the defined order: aws.arn
Base entity fields
The following base fields are used for all entities.
Attribute
Type
Description
Examples
id
smartscapeId
stable Display name: ID A 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 ID The 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: Name The entity name.
localhost; easyTravel; product-catalog
type
string
stable Display name: Type The entity type. UPPER_SNAKE_CASE string that represents the type of the entity.
TYPE_A
tags
record
stable Display name: Tags A 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.
stable Display name: Lifetime The 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.
stable Display name: References Provides 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.
resourcestable Display name: DT security context The security contexts associated with the entity. For Smartscape entities, this field is always an array. Tags: permission
[]
Cloud entity fields
Fields that are provided by all Cloud workloads.
Attribute
Type
Description
Examples
cloud.acquisition.status
string
experimental Display name: Cloud acquisition status The status of Smartscape nodes data acquisition by Data Acquisition Conroller OK - node is consistent DELETED - node was deleted in the cloud platform ERROR - there was an error acquiring node, but the node was upserted INCOMPLETE - there was an error acquiring node child resource (ie. EC2 Instance, with no EBS volumes due to missing permissions) , but the node was upserted.
OK; DELETED; ERROR; INCOMPLETE
AWS resource fields
Attribute
Type
Description
Examples
aws.object
string
stable Display name: AWS object The 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 version The aws.object json content version
1.0
aws.region
string
resourcestable Display name: AWS region A specific geographical AWS Cloud location. Tags: primary-field
us-east-1
aws.account.id
string
resourcestable Display name: AWS account ID The 12-digit number, such as 123456789012, that uniquely identifies an AWS account. Tags: permissionprimary-field
123456789012
aws.service
string
resourceexperimental Display name: AWS service The service that identifies the AWS product.
s3
aws.resource.type
string
resourceexperimental Display name: AWS resource type The name of a resource type in CloudFormation format.
resourcestable Display name: AWS resource ID Unique, immutable identifier assigned to the AWS cloud resource.
i-0922cda4579db3a45
aws.resource.name
string
resourcestable Display name: AWS resource name Name 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
resourcestable Display name: AWS ARN Amazon Resource Name (ARN).
resourcestable Display name: Cloud provider Name 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
AWS VPC attached resource fields
Contains all fields that are provided by VPC-attached AWS entities.
experimental Display name: AWS security group ID Assigned Security Group or array of Groups
sg-184e3ddb341dd478b; sg-2b3aa4b9409c734ec
AWS Client VPN endpoint relationships
Type
Target type
Kind
Description
is_attached_to
AWS_EC2_VPC
static
stable Is (typically) exclusively attached to the instance (1-many)
AWS Site-to-Site VPN Customer Gateway
Smartscape node name: aws.resource.name
Smartscape node type: AWS_EC2_CUSTOMERGATEWAY
This entity represents an AWS Site-to-Site VPN Customer Gateway.
Query
Fetch all Smartscape nodes from the smartscape.nodes table and filter for the entity type "AWS_EC2_CUSTOMERGATEWAY"
smartscapeNodes"AWS_EC2_CUSTOMERGATEWAY"
ID input
The ID is calculated based on the following fields in the defined order: aws.arn
Base entity fields
The following base fields are used for all entities.
Attribute
Type
Description
Examples
id
smartscapeId
stable Display name: ID A 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 ID The 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: Name The entity name.
localhost; easyTravel; product-catalog
type
string
stable Display name: Type The entity type. UPPER_SNAKE_CASE string that represents the type of the entity.
TYPE_A
tags
record
stable Display name: Tags A 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.
stable Display name: Lifetime The 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.
stable Display name: References Provides 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.
resourcestable Display name: DT security context The security contexts associated with the entity. For Smartscape entities, this field is always an array. Tags: permission
[]
Cloud entity fields
Fields that are provided by all Cloud workloads.
Attribute
Type
Description
Examples
cloud.acquisition.status
string
experimental Display name: Cloud acquisition status The status of Smartscape nodes data acquisition by Data Acquisition Conroller OK - node is consistent DELETED - node was deleted in the cloud platform ERROR - there was an error acquiring node, but the node was upserted INCOMPLETE - there was an error acquiring node child resource (ie. EC2 Instance, with no EBS volumes due to missing permissions) , but the node was upserted.
OK; DELETED; ERROR; INCOMPLETE
AWS resource fields
Attribute
Type
Description
Examples
aws.object
string
stable Display name: AWS object The 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 version The aws.object json content version
1.0
aws.region
string
resourcestable Display name: AWS region A specific geographical AWS Cloud location. Tags: primary-field
us-east-1
aws.account.id
string
resourcestable Display name: AWS account ID The 12-digit number, such as 123456789012, that uniquely identifies an AWS account. Tags: permissionprimary-field
123456789012
aws.service
string
resourceexperimental Display name: AWS service The service that identifies the AWS product.
s3
aws.resource.type
string
resourceexperimental Display name: AWS resource type The name of a resource type in CloudFormation format.
resourcestable Display name: AWS resource ID Unique, immutable identifier assigned to the AWS cloud resource.
i-0922cda4579db3a45
aws.resource.name
string
resourcestable Display name: AWS resource name Name 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
resourcestable Display name: AWS ARN Amazon Resource Name (ARN).
resourcestable Display name: Cloud provider Name 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
AWS Site-to-Site VPN connection
Smartscape node name: aws.resource.name
Smartscape node type: AWS_EC2_VPNCONNECTION
This entity represents an AWS Site-to-Site VPN connection.
Query
Fetch all Smartscape nodes from the smartscape.nodes table and filter for the entity type "AWS_EC2_VPNCONNECTION"
smartscapeNodes"AWS_EC2_VPNCONNECTION"
ID input
The ID is calculated based on the following fields in the defined order: aws.arn
Base entity fields
The following base fields are used for all entities.
Attribute
Type
Description
Examples
id
smartscapeId
stable Display name: ID A 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 ID The 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: Name The entity name.
localhost; easyTravel; product-catalog
type
string
stable Display name: Type The entity type. UPPER_SNAKE_CASE string that represents the type of the entity.
TYPE_A
tags
record
stable Display name: Tags A 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.
stable Display name: Lifetime The 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.
stable Display name: References Provides 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.
resourcestable Display name: DT security context The security contexts associated with the entity. For Smartscape entities, this field is always an array. Tags: permission
[]
Cloud entity fields
Fields that are provided by all Cloud workloads.
Attribute
Type
Description
Examples
cloud.acquisition.status
string
experimental Display name: Cloud acquisition status The status of Smartscape nodes data acquisition by Data Acquisition Conroller OK - node is consistent DELETED - node was deleted in the cloud platform ERROR - there was an error acquiring node, but the node was upserted INCOMPLETE - there was an error acquiring node child resource (ie. EC2 Instance, with no EBS volumes due to missing permissions) , but the node was upserted.
OK; DELETED; ERROR; INCOMPLETE
AWS resource fields
Attribute
Type
Description
Examples
aws.object
string
stable Display name: AWS object The 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 version The aws.object json content version
1.0
aws.region
string
resourcestable Display name: AWS region A specific geographical AWS Cloud location. Tags: primary-field
us-east-1
aws.account.id
string
resourcestable Display name: AWS account ID The 12-digit number, such as 123456789012, that uniquely identifies an AWS account. Tags: permissionprimary-field
123456789012
aws.service
string
resourceexperimental Display name: AWS service The service that identifies the AWS product.
s3
aws.resource.type
string
resourceexperimental Display name: AWS resource type The name of a resource type in CloudFormation format.
resourcestable Display name: AWS resource ID Unique, immutable identifier assigned to the AWS cloud resource.
i-0922cda4579db3a45
aws.resource.name
string
resourcestable Display name: AWS resource name Name 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
resourcestable Display name: AWS ARN Amazon Resource Name (ARN).
resourcestable Display name: Cloud provider Name 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
AWS Site-to-Site VPN connection relationships
Type
Target type
Kind
Description
routes_to
AWS_EC2_VPNGATEWAY
static
stable Define network route to the instance Examples: EC2 route table routes to EC2 NAT Gateway EC2 VPC Peering Connection routes to VPC
routes_to
AWS_EC2_CUSTOMERGATEWAY
static
stable Define network route to the instance Examples: EC2 route table routes to EC2 NAT Gateway EC2 VPC Peering Connection routes to VPC
routes_to
AWS_EC2_TRANSITGATEWAY
static
stable Define network route to the instance Examples: EC2 route table routes to EC2 NAT Gateway EC2 VPC Peering Connection routes to VPC
AWS Site-to-Site VPN gateway
Smartscape node name: aws.resource.name
Smartscape node type: AWS_EC2_VPNGATEWAY
This entity represents an AWS Site-to-Site VPN gateway.
Query
Fetch all Smartscape nodes from the smartscape.nodes table and filter for the entity type "AWS_EC2_VPNGATEWAY"
smartscapeNodes"AWS_EC2_VPNGATEWAY"
ID input
The ID is calculated based on the following fields in the defined order: aws.arn
Base entity fields
The following base fields are used for all entities.
Attribute
Type
Description
Examples
id
smartscapeId
stable Display name: ID A 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 ID The 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: Name The entity name.
localhost; easyTravel; product-catalog
type
string
stable Display name: Type The entity type. UPPER_SNAKE_CASE string that represents the type of the entity.
TYPE_A
tags
record
stable Display name: Tags A 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.
stable Display name: Lifetime The 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.
stable Display name: References Provides 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.
resourcestable Display name: DT security context The security contexts associated with the entity. For Smartscape entities, this field is always an array. Tags: permission
[]
Cloud entity fields
Fields that are provided by all Cloud workloads.
Attribute
Type
Description
Examples
cloud.acquisition.status
string
experimental Display name: Cloud acquisition status The status of Smartscape nodes data acquisition by Data Acquisition Conroller OK - node is consistent DELETED - node was deleted in the cloud platform ERROR - there was an error acquiring node, but the node was upserted INCOMPLETE - there was an error acquiring node child resource (ie. EC2 Instance, with no EBS volumes due to missing permissions) , but the node was upserted.
OK; DELETED; ERROR; INCOMPLETE
AWS resource fields
Attribute
Type
Description
Examples
aws.object
string
stable Display name: AWS object The 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 version The aws.object json content version
1.0
aws.region
string
resourcestable Display name: AWS region A specific geographical AWS Cloud location. Tags: primary-field
us-east-1
aws.account.id
string
resourcestable Display name: AWS account ID The 12-digit number, such as 123456789012, that uniquely identifies an AWS account. Tags: permissionprimary-field
123456789012
aws.service
string
resourceexperimental Display name: AWS service The service that identifies the AWS product.
s3
aws.resource.type
string
resourceexperimental Display name: AWS resource type The name of a resource type in CloudFormation format.
resourcestable Display name: AWS resource ID Unique, immutable identifier assigned to the AWS cloud resource.
i-0922cda4579db3a45
aws.resource.name
string
resourcestable Display name: AWS resource name Name 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
resourcestable Display name: AWS ARN Amazon Resource Name (ARN).
resourcestable Display name: Cloud provider Name 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
AWS VPC attached resource fields
Contains all fields that are provided by VPC-attached AWS entities.
experimental Display name: AWS security group ID Assigned Security Group or array of Groups
sg-184e3ddb341dd478b; sg-2b3aa4b9409c734ec
AWS Site-to-Site VPN gateway relationships
Type
Target type
Kind
Description
is_attached_to
AWS_EC2_VPC
static
stable Is (typically) exclusively attached to the instance (1-many)
AWS Transit Gateway
Smartscape node name: aws.resource.name
Smartscape node type: AWS_EC2_TRANSITGATEWAY
This entity represents an AWS Transit Gateway.
Query
Fetch all Smartscape nodes from the smartscape.nodes table and filter for the entity type "AWS_EC2_TRANSITGATEWAY"
smartscapeNodes"AWS_EC2_TRANSITGATEWAY"
ID input
The ID is calculated based on the following fields in the defined order: aws.arn
Base entity fields
The following base fields are used for all entities.
Attribute
Type
Description
Examples
id
smartscapeId
stable Display name: ID A 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 ID The 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: Name The entity name.
localhost; easyTravel; product-catalog
type
string
stable Display name: Type The entity type. UPPER_SNAKE_CASE string that represents the type of the entity.
TYPE_A
tags
record
stable Display name: Tags A 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.
stable Display name: Lifetime The 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.
stable Display name: References Provides 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.
resourcestable Display name: DT security context The security contexts associated with the entity. For Smartscape entities, this field is always an array. Tags: permission
[]
Cloud entity fields
Fields that are provided by all Cloud workloads.
Attribute
Type
Description
Examples
cloud.acquisition.status
string
experimental Display name: Cloud acquisition status The status of Smartscape nodes data acquisition by Data Acquisition Conroller OK - node is consistent DELETED - node was deleted in the cloud platform ERROR - there was an error acquiring node, but the node was upserted INCOMPLETE - there was an error acquiring node child resource (ie. EC2 Instance, with no EBS volumes due to missing permissions) , but the node was upserted.
OK; DELETED; ERROR; INCOMPLETE
AWS resource fields
Attribute
Type
Description
Examples
aws.object
string
stable Display name: AWS object The 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 version The aws.object json content version
1.0
aws.region
string
resourcestable Display name: AWS region A specific geographical AWS Cloud location. Tags: primary-field
us-east-1
aws.account.id
string
resourcestable Display name: AWS account ID The 12-digit number, such as 123456789012, that uniquely identifies an AWS account. Tags: permissionprimary-field
123456789012
aws.service
string
resourceexperimental Display name: AWS service The service that identifies the AWS product.
s3
aws.resource.type
string
resourceexperimental Display name: AWS resource type The name of a resource type in CloudFormation format.
resourcestable Display name: AWS resource ID Unique, immutable identifier assigned to the AWS cloud resource.
i-0922cda4579db3a45
aws.resource.name
string
resourcestable Display name: AWS resource name Name 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
resourcestable Display name: AWS ARN Amazon Resource Name (ARN).
resourcestable Display name: Cloud provider Name 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.
This entity represents an AWS Transit Gateway attachment.
Query
Fetch all Smartscape nodes from the smartscape.nodes table and filter for the entity type "AWS_EC2_TRANSITGATEWAYATTACHMENT"
smartscapeNodes"AWS_EC2_TRANSITGATEWAYATTACHMENT"
ID input
The ID is calculated based on the following fields in the defined order: aws.arn
Base entity fields
The following base fields are used for all entities.
Attribute
Type
Description
Examples
id
smartscapeId
stable Display name: ID A 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 ID The 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: Name The entity name.
localhost; easyTravel; product-catalog
type
string
stable Display name: Type The entity type. UPPER_SNAKE_CASE string that represents the type of the entity.
TYPE_A
tags
record
stable Display name: Tags A 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.
stable Display name: Lifetime The 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.
stable Display name: References Provides 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.
resourcestable Display name: DT security context The security contexts associated with the entity. For Smartscape entities, this field is always an array. Tags: permission
[]
Cloud entity fields
Fields that are provided by all Cloud workloads.
Attribute
Type
Description
Examples
cloud.acquisition.status
string
experimental Display name: Cloud acquisition status The status of Smartscape nodes data acquisition by Data Acquisition Conroller OK - node is consistent DELETED - node was deleted in the cloud platform ERROR - there was an error acquiring node, but the node was upserted INCOMPLETE - there was an error acquiring node child resource (ie. EC2 Instance, with no EBS volumes due to missing permissions) , but the node was upserted.
OK; DELETED; ERROR; INCOMPLETE
AWS resource fields
Attribute
Type
Description
Examples
aws.object
string
stable Display name: AWS object The 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 version The aws.object json content version
1.0
aws.region
string
resourcestable Display name: AWS region A specific geographical AWS Cloud location. Tags: primary-field
us-east-1
aws.account.id
string
resourcestable Display name: AWS account ID The 12-digit number, such as 123456789012, that uniquely identifies an AWS account. Tags: permissionprimary-field
123456789012
aws.service
string
resourceexperimental Display name: AWS service The service that identifies the AWS product.
s3
aws.resource.type
string
resourceexperimental Display name: AWS resource type The name of a resource type in CloudFormation format.
resourcestable Display name: AWS resource ID Unique, immutable identifier assigned to the AWS cloud resource.
i-0922cda4579db3a45
aws.resource.name
string
resourcestable Display name: AWS resource name Name 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
resourcestable Display name: AWS ARN Amazon Resource Name (ARN).
resourcestable Display name: Cloud provider Name 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
AWS VPC attached resource fields
Contains all fields that are provided by VPC-attached AWS entities.
experimental Display name: AWS security group ID Assigned Security Group or array of Groups
sg-184e3ddb341dd478b; sg-2b3aa4b9409c734ec
AWS Transit Gateway attachment relationships
Type
Target type
Kind
Description
is_attached_to
AWS_EC2_TRANSITGATEWAY
static
stable Is (typically) exclusively attached to the instance (1-many)
is_attached_to
AWS_EC2_VPC
static
stable Is (typically) exclusively attached to the instance (1-many)
is_attached_to
AWS_EC2_VPNCONNECTION
static
stable Is (typically) exclusively attached to the instance (1-many)
Amazon EBS snapshot
Smartscape node name: aws.resource.name
Smartscape node type: AWS_EC2_SNAPSHOT
This entity represents an Amazon EBS snapshot.
Query
Fetch all Smartscape nodes from the smartscape.nodes table and filter for the entity type "AWS_EC2_SNAPSHOT"
smartscapeNodes"AWS_EC2_SNAPSHOT"
ID input
The ID is calculated based on the following fields in the defined order: aws.arn
Base entity fields
The following base fields are used for all entities.
Attribute
Type
Description
Examples
id
smartscapeId
stable Display name: ID A 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 ID The 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: Name The entity name.
localhost; easyTravel; product-catalog
type
string
stable Display name: Type The entity type. UPPER_SNAKE_CASE string that represents the type of the entity.
TYPE_A
tags
record
stable Display name: Tags A 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.
stable Display name: Lifetime The 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.
stable Display name: References Provides 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.
resourcestable Display name: DT security context The security contexts associated with the entity. For Smartscape entities, this field is always an array. Tags: permission
[]
Cloud entity fields
Fields that are provided by all Cloud workloads.
Attribute
Type
Description
Examples
cloud.acquisition.status
string
experimental Display name: Cloud acquisition status The status of Smartscape nodes data acquisition by Data Acquisition Conroller OK - node is consistent DELETED - node was deleted in the cloud platform ERROR - there was an error acquiring node, but the node was upserted INCOMPLETE - there was an error acquiring node child resource (ie. EC2 Instance, with no EBS volumes due to missing permissions) , but the node was upserted.
OK; DELETED; ERROR; INCOMPLETE
AWS resource fields
Attribute
Type
Description
Examples
aws.object
string
stable Display name: AWS object The 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 version The aws.object json content version
1.0
aws.region
string
resourcestable Display name: AWS region A specific geographical AWS Cloud location. Tags: primary-field
us-east-1
aws.account.id
string
resourcestable Display name: AWS account ID The 12-digit number, such as 123456789012, that uniquely identifies an AWS account. Tags: permissionprimary-field
123456789012
aws.service
string
resourceexperimental Display name: AWS service The service that identifies the AWS product.
s3
aws.resource.type
string
resourceexperimental Display name: AWS resource type The name of a resource type in CloudFormation format.
resourcestable Display name: AWS resource ID Unique, immutable identifier assigned to the AWS cloud resource.
i-0922cda4579db3a45
aws.resource.name
string
resourcestable Display name: AWS resource name Name 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
resourcestable Display name: AWS ARN Amazon Resource Name (ARN).
resourcestable Display name: Cloud provider Name 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
Amazon EBS snapshot relationships
Type
Target type
Kind
Description
uses
AWS_KMS_KEY
static
stable Similar to is_attached_to but in the opposite direction. Examples: EC2 Instance uses DHCP options, Auto Scaling Group uses EC2 Launch Template
uses
AWS_KMS_ALIAS
static
stable Similar to is_attached_to but in the opposite direction. Examples: EC2 Instance uses DHCP options, Auto Scaling Group uses EC2 Launch Template
Amazon EBS volume
Smartscape node name: aws.resource.name
Smartscape node type: AWS_EC2_VOLUME
This entity represents an Amazon EBS volume.
Query
Fetch all Smartscape nodes from the smartscape.nodes table and filter for the entity type "AWS_EC2_VOLUME"
smartscapeNodes"AWS_EC2_VOLUME"
ID input
The ID is calculated based on the following fields in the defined order: aws.arn
Base entity fields
The following base fields are used for all entities.
Attribute
Type
Description
Examples
id
smartscapeId
stable Display name: ID A 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 ID The 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: Name The entity name.
localhost; easyTravel; product-catalog
type
string
stable Display name: Type The entity type. UPPER_SNAKE_CASE string that represents the type of the entity.
TYPE_A
tags
record
stable Display name: Tags A 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.
stable Display name: Lifetime The 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.
stable Display name: References Provides 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.
resourcestable Display name: DT security context The security contexts associated with the entity. For Smartscape entities, this field is always an array. Tags: permission
[]
Cloud entity fields
Fields that are provided by all Cloud workloads.
Attribute
Type
Description
Examples
cloud.acquisition.status
string
experimental Display name: Cloud acquisition status The status of Smartscape nodes data acquisition by Data Acquisition Conroller OK - node is consistent DELETED - node was deleted in the cloud platform ERROR - there was an error acquiring node, but the node was upserted INCOMPLETE - there was an error acquiring node child resource (ie. EC2 Instance, with no EBS volumes due to missing permissions) , but the node was upserted.
OK; DELETED; ERROR; INCOMPLETE
AWS resource fields
Attribute
Type
Description
Examples
aws.object
string
stable Display name: AWS object The 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 version The aws.object json content version
1.0
aws.region
string
resourcestable Display name: AWS region A specific geographical AWS Cloud location. Tags: primary-field
us-east-1
aws.account.id
string
resourcestable Display name: AWS account ID The 12-digit number, such as 123456789012, that uniquely identifies an AWS account. Tags: permissionprimary-field
123456789012
aws.service
string
resourceexperimental Display name: AWS service The service that identifies the AWS product.
s3
aws.resource.type
string
resourceexperimental Display name: AWS resource type The name of a resource type in CloudFormation format.
resourcestable Display name: AWS resource ID Unique, immutable identifier assigned to the AWS cloud resource.
i-0922cda4579db3a45
aws.resource.name
string
resourcestable Display name: AWS resource name Name 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
resourcestable Display name: AWS ARN Amazon Resource Name (ARN).
resourcestable Display name: Cloud provider Name 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
AWS Zonal resource fields
Contains all fields that are provided by AWS entities that are scoped to an Availability Zone.
Attribute
Type
Description
Examples
aws.availability_zone
string
resourcestable Display name: Availability zone A specific availability zone or array of zones in given AWS region.
us-east-1a; us-east-1b
Amazon EBS volume relationships
Type
Target type
Kind
Description
is_attached_to
AWS_EC2_INSTANCE
static
stable Is (typically) exclusively attached to the instance (1-many)
uses
AWS_KMS_KEY
static
stable Similar to is_attached_to but in the opposite direction. Examples: EC2 Instance uses DHCP options, Auto Scaling Group uses EC2 Launch Template
uses
AWS_KMS_ALIAS
static
stable Similar to is_attached_to but in the opposite direction. Examples: EC2 Instance uses DHCP options, Auto Scaling Group uses EC2 Launch Template
runs_on
AWS_AVAILABILITY_ZONE
static
stable Defines a "vertical" relation of an entity running on some other entity. It does not imply any composition or aggregation but only a looser association between the entities. One entity can run on multiple other entities. Examples: Service running on a POD, a CONTAINER or a HOST.
Amazon EC2 Identity and Access Management instance profile association
The ID is calculated based on the following fields in the defined order: aws.arn
Base entity fields
The following base fields are used for all entities.
Attribute
Type
Description
Examples
id
smartscapeId
stable Display name: ID A 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 ID The 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: Name The entity name.
localhost; easyTravel; product-catalog
type
string
stable Display name: Type The entity type. UPPER_SNAKE_CASE string that represents the type of the entity.
TYPE_A
tags
record
stable Display name: Tags A 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.
stable Display name: Lifetime The 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.
stable Display name: References Provides 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.
resourcestable Display name: DT security context The security contexts associated with the entity. For Smartscape entities, this field is always an array. Tags: permission
[]
Cloud entity fields
Fields that are provided by all Cloud workloads.
Attribute
Type
Description
Examples
cloud.acquisition.status
string
experimental Display name: Cloud acquisition status The status of Smartscape nodes data acquisition by Data Acquisition Conroller OK - node is consistent DELETED - node was deleted in the cloud platform ERROR - there was an error acquiring node, but the node was upserted INCOMPLETE - there was an error acquiring node child resource (ie. EC2 Instance, with no EBS volumes due to missing permissions) , but the node was upserted.
OK; DELETED; ERROR; INCOMPLETE
AWS resource fields
Attribute
Type
Description
Examples
aws.object
string
stable Display name: AWS object The 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 version The aws.object json content version
1.0
aws.region
string
resourcestable Display name: AWS region A specific geographical AWS Cloud location. Tags: primary-field
us-east-1
aws.account.id
string
resourcestable Display name: AWS account ID The 12-digit number, such as 123456789012, that uniquely identifies an AWS account. Tags: permissionprimary-field
123456789012
aws.service
string
resourceexperimental Display name: AWS service The service that identifies the AWS product.
s3
aws.resource.type
string
resourceexperimental Display name: AWS resource type The name of a resource type in CloudFormation format.
resourcestable Display name: AWS resource ID Unique, immutable identifier assigned to the AWS cloud resource.
i-0922cda4579db3a45
aws.resource.name
string
resourcestable Display name: AWS resource name Name 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
resourcestable Display name: AWS ARN Amazon Resource Name (ARN).
resourcestable Display name: Cloud provider Name 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
Amazon EC2 elastic IP address
Smartscape node name: aws.resource.name
Smartscape node type: AWS_EC2_EIP
This entity represents an Amazon EC2 elastic IP address.
Query
Fetch all Smartscape nodes from the smartscape.nodes table and filter for the entity type "AWS_EC2_EIP"
smartscapeNodes"AWS_EC2_EIP"
ID input
The ID is calculated based on the following fields in the defined order: aws.arn
Base entity fields
The following base fields are used for all entities.
Attribute
Type
Description
Examples
id
smartscapeId
stable Display name: ID A 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 ID The 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: Name The entity name.
localhost; easyTravel; product-catalog
type
string
stable Display name: Type The entity type. UPPER_SNAKE_CASE string that represents the type of the entity.
TYPE_A
tags
record
stable Display name: Tags A 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.
stable Display name: Lifetime The 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.
stable Display name: References Provides 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.
resourcestable Display name: DT security context The security contexts associated with the entity. For Smartscape entities, this field is always an array. Tags: permission
[]
Cloud entity fields
Fields that are provided by all Cloud workloads.
Attribute
Type
Description
Examples
cloud.acquisition.status
string
experimental Display name: Cloud acquisition status The status of Smartscape nodes data acquisition by Data Acquisition Conroller OK - node is consistent DELETED - node was deleted in the cloud platform ERROR - there was an error acquiring node, but the node was upserted INCOMPLETE - there was an error acquiring node child resource (ie. EC2 Instance, with no EBS volumes due to missing permissions) , but the node was upserted.
OK; DELETED; ERROR; INCOMPLETE
AWS resource fields
Attribute
Type
Description
Examples
aws.object
string
stable Display name: AWS object The 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 version The aws.object json content version
1.0
aws.region
string
resourcestable Display name: AWS region A specific geographical AWS Cloud location. Tags: primary-field
us-east-1
aws.account.id
string
resourcestable Display name: AWS account ID The 12-digit number, such as 123456789012, that uniquely identifies an AWS account. Tags: permissionprimary-field
123456789012
aws.service
string
resourceexperimental Display name: AWS service The service that identifies the AWS product.
s3
aws.resource.type
string
resourceexperimental Display name: AWS resource type The name of a resource type in CloudFormation format.
resourcestable Display name: AWS resource ID Unique, immutable identifier assigned to the AWS cloud resource.
i-0922cda4579db3a45
aws.resource.name
string
resourcestable Display name: AWS resource name Name 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
resourcestable Display name: AWS ARN Amazon Resource Name (ARN).
resourcestable Display name: Cloud provider Name 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
Amazon EC2 elastic IP address relationships
Type
Target type
Kind
Description
is_attached_to
AWS_EC2_NETWORKINTERFACE
static
stable Is (typically) exclusively attached to the instance (1-many)
is_attached_to
AWS_EC2_INSTANCE
static
stable Is (typically) exclusively attached to the instance (1-many)
Amazon EC2 elastic IP association
Smartscape node name: aws.resource.name
Smartscape node type: AWS_EC2_EIPASSOCIATION
This entity represents an Amazon EC2 elastic IP association.
Query
Fetch all Smartscape nodes from the smartscape.nodes table and filter for the entity type "AWS_EC2_EIPASSOCIATION"
smartscapeNodes"AWS_EC2_EIPASSOCIATION"
ID input
The ID is calculated based on the following fields in the defined order: aws.arn
Base entity fields
The following base fields are used for all entities.
Attribute
Type
Description
Examples
id
smartscapeId
stable Display name: ID A 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 ID The 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: Name The entity name.
localhost; easyTravel; product-catalog
type
string
stable Display name: Type The entity type. UPPER_SNAKE_CASE string that represents the type of the entity.
TYPE_A
tags
record
stable Display name: Tags A 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.
stable Display name: Lifetime The 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.
stable Display name: References Provides 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.
resourcestable Display name: DT security context The security contexts associated with the entity. For Smartscape entities, this field is always an array. Tags: permission
[]
Cloud entity fields
Fields that are provided by all Cloud workloads.
Attribute
Type
Description
Examples
cloud.acquisition.status
string
experimental Display name: Cloud acquisition status The status of Smartscape nodes data acquisition by Data Acquisition Conroller OK - node is consistent DELETED - node was deleted in the cloud platform ERROR - there was an error acquiring node, but the node was upserted INCOMPLETE - there was an error acquiring node child resource (ie. EC2 Instance, with no EBS volumes due to missing permissions) , but the node was upserted.
OK; DELETED; ERROR; INCOMPLETE
AWS resource fields
Attribute
Type
Description
Examples
aws.object
string
stable Display name: AWS object The 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 version The aws.object json content version
1.0
aws.region
string
resourcestable Display name: AWS region A specific geographical AWS Cloud location. Tags: primary-field
us-east-1
aws.account.id
string
resourcestable Display name: AWS account ID The 12-digit number, such as 123456789012, that uniquely identifies an AWS account. Tags: permissionprimary-field
123456789012
aws.service
string
resourceexperimental Display name: AWS service The service that identifies the AWS product.
s3
aws.resource.type
string
resourceexperimental Display name: AWS resource type The name of a resource type in CloudFormation format.
resourcestable Display name: AWS resource ID Unique, immutable identifier assigned to the AWS cloud resource.
i-0922cda4579db3a45
aws.resource.name
string
resourcestable Display name: AWS resource name Name 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
resourcestable Display name: AWS ARN Amazon Resource Name (ARN).
resourcestable Display name: Cloud provider Name 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
Amazon EC2 elastic network interface
Smartscape node name: aws.resource.name
Smartscape node type: AWS_EC2_NETWORKINTERFACE
This entity represents an Amazon EC2 elastic network interface.
Query
Fetch all Smartscape nodes from the smartscape.nodes table and filter for the entity type "AWS_EC2_NETWORKINTERFACE"
smartscapeNodes"AWS_EC2_NETWORKINTERFACE"
ID input
The ID is calculated based on the following fields in the defined order: aws.arn
Base entity fields
The following base fields are used for all entities.
Attribute
Type
Description
Examples
id
smartscapeId
stable Display name: ID A 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 ID The 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: Name The entity name.
localhost; easyTravel; product-catalog
type
string
stable Display name: Type The entity type. UPPER_SNAKE_CASE string that represents the type of the entity.
TYPE_A
tags
record
stable Display name: Tags A 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.
stable Display name: Lifetime The 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.
stable Display name: References Provides 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.
resourcestable Display name: DT security context The security contexts associated with the entity. For Smartscape entities, this field is always an array. Tags: permission
[]
Cloud entity fields
Fields that are provided by all Cloud workloads.
Attribute
Type
Description
Examples
cloud.acquisition.status
string
experimental Display name: Cloud acquisition status The status of Smartscape nodes data acquisition by Data Acquisition Conroller OK - node is consistent DELETED - node was deleted in the cloud platform ERROR - there was an error acquiring node, but the node was upserted INCOMPLETE - there was an error acquiring node child resource (ie. EC2 Instance, with no EBS volumes due to missing permissions) , but the node was upserted.
OK; DELETED; ERROR; INCOMPLETE
AWS resource fields
Attribute
Type
Description
Examples
aws.object
string
stable Display name: AWS object The 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 version The aws.object json content version
1.0
aws.region
string
resourcestable Display name: AWS region A specific geographical AWS Cloud location. Tags: primary-field
us-east-1
aws.account.id
string
resourcestable Display name: AWS account ID The 12-digit number, such as 123456789012, that uniquely identifies an AWS account. Tags: permissionprimary-field
123456789012
aws.service
string
resourceexperimental Display name: AWS service The service that identifies the AWS product.
s3
aws.resource.type
string
resourceexperimental Display name: AWS resource type The name of a resource type in CloudFormation format.
resourcestable Display name: AWS resource ID Unique, immutable identifier assigned to the AWS cloud resource.
i-0922cda4579db3a45
aws.resource.name
string
resourcestable Display name: AWS resource name Name 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
resourcestable Display name: AWS ARN Amazon Resource Name (ARN).
resourcestable Display name: Cloud provider Name 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
AWS VPC attached resource fields
Contains all fields that are provided by VPC-attached AWS entities.
stable Similar to is_attached_to but in the opposite direction. Examples: EC2 Instance uses DHCP options, Auto Scaling Group uses EC2 Launch Template
is_attached_to
AWS_EC2_INSTANCE
static
stable Is (typically) exclusively attached to the instance (1-many)
is_attached_to
AWS_EC2_SUBNET
static
stable Is (typically) exclusively attached to the instance (1-many)
is_attached_to
AWS_EC2_VPC
static
stable Is (typically) exclusively attached to the instance (1-many)
runs_on
AWS_AVAILABILITY_ZONE
static
stable Defines a "vertical" relation of an entity running on some other entity. It does not imply any composition or aggregation but only a looser association between the entities. One entity can run on multiple other entities. Examples: Service running on a POD, a CONTAINER or a HOST.
The ID is calculated based on the following fields in the defined order: aws.arn
Base entity fields
The following base fields are used for all entities.
Attribute
Type
Description
Examples
id
smartscapeId
stable Display name: ID A 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 ID The 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: Name The entity name.
localhost; easyTravel; product-catalog
type
string
stable Display name: Type The entity type. UPPER_SNAKE_CASE string that represents the type of the entity.
TYPE_A
tags
record
stable Display name: Tags A 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.
stable Display name: Lifetime The 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.
stable Display name: References Provides 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.
resourcestable Display name: DT security context The security contexts associated with the entity. For Smartscape entities, this field is always an array. Tags: permission
[]
Cloud entity fields
Fields that are provided by all Cloud workloads.
Attribute
Type
Description
Examples
cloud.acquisition.status
string
experimental Display name: Cloud acquisition status The status of Smartscape nodes data acquisition by Data Acquisition Conroller OK - node is consistent DELETED - node was deleted in the cloud platform ERROR - there was an error acquiring node, but the node was upserted INCOMPLETE - there was an error acquiring node child resource (ie. EC2 Instance, with no EBS volumes due to missing permissions) , but the node was upserted.
OK; DELETED; ERROR; INCOMPLETE
AWS resource fields
Attribute
Type
Description
Examples
aws.object
string
stable Display name: AWS object The 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 version The aws.object json content version
1.0
aws.region
string
resourcestable Display name: AWS region A specific geographical AWS Cloud location. Tags: primary-field
us-east-1
aws.account.id
string
resourcestable Display name: AWS account ID The 12-digit number, such as 123456789012, that uniquely identifies an AWS account. Tags: permissionprimary-field
123456789012
aws.service
string
resourceexperimental Display name: AWS service The service that identifies the AWS product.
s3
aws.resource.type
string
resourceexperimental Display name: AWS resource type The name of a resource type in CloudFormation format.
resourcestable Display name: AWS resource ID Unique, immutable identifier assigned to the AWS cloud resource.
i-0922cda4579db3a45
aws.resource.name
string
resourcestable Display name: AWS resource name Name 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
resourcestable Display name: AWS ARN Amazon Resource Name (ARN).
resourcestable Display name: Cloud provider Name 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
AWS VPC attached resource fields
Contains all fields that are provided by VPC-attached AWS entities.
stable Defines a "vertical" relation of an entity running on some other entity. It does not imply any composition or aggregation but only a looser association between the entities. One entity can run on multiple other entities. Examples: Service running on a POD, a CONTAINER or a HOST.
Amazon EC2 instance
Smartscape node name: aws.resource.name
Smartscape node type: AWS_EC2_INSTANCE
This entity represents an Amazon EC2 instance.
Query
Fetch all Smartscape nodes from the smartscape.nodes table and filter for the entity type "AWS_EC2_INSTANCE"
smartscapeNodes"AWS_EC2_INSTANCE"
Fetch all "AWS_EC2_INSTANCE" nodes from the smartscape.nodes table and show the instance type, number of cores, number of threads per core, image id, public IP address and private IP address.
Fetch all "AWS_EC2_INSTANCE" nodes from the smartscape.nodes table tagged with owner_team=team-acme and running in VPC vpc-abcde12345.
smartscapeNodes"AWS_EC2_INSTANCE"
|filter tags[owner_team]=="team-acme" and aws.vpc.id =="vpc-abcde12345"
Fetch an "AWS_EC2_INSTANCE" node from the smartscape.nodes table with id i-abcde12345 and traverse its relationships to "AWS_EC2_VOLUME" nodes that have an edge of type is_attached_to towards the fetched AWS_EC2_INSTANCE.
The ID is calculated based on the following fields in the defined order: aws.arn
Base entity fields
The following base fields are used for all entities.
Attribute
Type
Description
Examples
id
smartscapeId
stable Display name: ID A 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 ID The 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: Name The entity name.
localhost; easyTravel; product-catalog
type
string
stable Display name: Type The entity type. UPPER_SNAKE_CASE string that represents the type of the entity.
TYPE_A
tags
record
stable Display name: Tags A 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.
stable Display name: Lifetime The 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.
stable Display name: References Provides 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.
resourcestable Display name: DT security context The security contexts associated with the entity. For Smartscape entities, this field is always an array. Tags: permission
[]
Cloud entity fields
Fields that are provided by all Cloud workloads.
Attribute
Type
Description
Examples
cloud.acquisition.status
string
experimental Display name: Cloud acquisition status The status of Smartscape nodes data acquisition by Data Acquisition Conroller OK - node is consistent DELETED - node was deleted in the cloud platform ERROR - there was an error acquiring node, but the node was upserted INCOMPLETE - there was an error acquiring node child resource (ie. EC2 Instance, with no EBS volumes due to missing permissions) , but the node was upserted.
OK; DELETED; ERROR; INCOMPLETE
AWS resource fields
Attribute
Type
Description
Examples
aws.object
string
stable Display name: AWS object The 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 version The aws.object json content version
1.0
aws.region
string
resourcestable Display name: AWS region A specific geographical AWS Cloud location. Tags: primary-field
us-east-1
aws.account.id
string
resourcestable Display name: AWS account ID The 12-digit number, such as 123456789012, that uniquely identifies an AWS account. Tags: permissionprimary-field
123456789012
aws.service
string
resourceexperimental Display name: AWS service The service that identifies the AWS product.
s3
aws.resource.type
string
resourceexperimental Display name: AWS resource type The name of a resource type in CloudFormation format.
resourcestable Display name: AWS resource ID Unique, immutable identifier assigned to the AWS cloud resource.
i-0922cda4579db3a45
aws.resource.name
string
resourcestable Display name: AWS resource name Name 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
resourcestable Display name: AWS ARN Amazon Resource Name (ARN).
resourcestable Display name: Cloud provider Name 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
AWS VPC attached resource fields
Contains all fields that are provided by VPC-attached AWS entities.
experimental Display name: AWS security group ID Assigned Security Group or array of Groups
sg-184e3ddb341dd478b; sg-2b3aa4b9409c734ec
AWS Zonal resource fields
Contains all fields that are provided by AWS entities that are scoped to an Availability Zone.
Attribute
Type
Description
Examples
aws.availability_zone
string
resourcestable Display name: Availability zone A specific availability zone or array of zones in given AWS region.
us-east-1a; us-east-1b
Amazon EC2 instance relationships
Type
Target type
Kind
Description
uses
AWS_EC2_SECURITYGROUP
static
stable Similar to is_attached_to but in the opposite direction. Examples: EC2 Instance uses DHCP options, Auto Scaling Group uses EC2 Launch Template
uses
AWS_IAM_INSTANCEPROFILE
static
stable Similar to is_attached_to but in the opposite direction. Examples: EC2 Instance uses DHCP options, Auto Scaling Group uses EC2 Launch Template
is_attached_to
AWS_EC2_SUBNET
static
stable Is (typically) exclusively attached to the instance (1-many)
is_attached_to
AWS_EC2_VPC
static
stable Is (typically) exclusively attached to the instance (1-many)
runs_on
AWS_AVAILABILITY_ZONE
static
stable Defines a "vertical" relation of an entity running on some other entity. It does not imply any composition or aggregation but only a looser association between the entities. One entity can run on multiple other entities. Examples: Service running on a POD, a CONTAINER or a HOST.
Amazon EC2 launch template
Smartscape node name: aws.resource.name
Smartscape node type: AWS_EC2_LAUNCHTEMPLATE
This entity represents an Amazon EC2 launch template.
Query
Fetch all Smartscape nodes from the smartscape.nodes table and filter for the entity type "AWS_EC2_LAUNCHTEMPLATE"
smartscapeNodes"AWS_EC2_LAUNCHTEMPLATE"
ID input
The ID is calculated based on the following fields in the defined order: aws.arn
Base entity fields
The following base fields are used for all entities.
Attribute
Type
Description
Examples
id
smartscapeId
stable Display name: ID A 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 ID The 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: Name The entity name.
localhost; easyTravel; product-catalog
type
string
stable Display name: Type The entity type. UPPER_SNAKE_CASE string that represents the type of the entity.
TYPE_A
tags
record
stable Display name: Tags A 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.
stable Display name: Lifetime The 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.
stable Display name: References Provides 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.
resourcestable Display name: DT security context The security contexts associated with the entity. For Smartscape entities, this field is always an array. Tags: permission
[]
Cloud entity fields
Fields that are provided by all Cloud workloads.
Attribute
Type
Description
Examples
cloud.acquisition.status
string
experimental Display name: Cloud acquisition status The status of Smartscape nodes data acquisition by Data Acquisition Conroller OK - node is consistent DELETED - node was deleted in the cloud platform ERROR - there was an error acquiring node, but the node was upserted INCOMPLETE - there was an error acquiring node child resource (ie. EC2 Instance, with no EBS volumes due to missing permissions) , but the node was upserted.
OK; DELETED; ERROR; INCOMPLETE
AWS resource fields
Attribute
Type
Description
Examples
aws.object
string
stable Display name: AWS object The 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 version The aws.object json content version
1.0
aws.region
string
resourcestable Display name: AWS region A specific geographical AWS Cloud location. Tags: primary-field
us-east-1
aws.account.id
string
resourcestable Display name: AWS account ID The 12-digit number, such as 123456789012, that uniquely identifies an AWS account. Tags: permissionprimary-field
123456789012
aws.service
string
resourceexperimental Display name: AWS service The service that identifies the AWS product.
s3
aws.resource.type
string
resourceexperimental Display name: AWS resource type The name of a resource type in CloudFormation format.
resourcestable Display name: AWS resource ID Unique, immutable identifier assigned to the AWS cloud resource.
i-0922cda4579db3a45
aws.resource.name
string
resourcestable Display name: AWS resource name Name 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
resourcestable Display name: AWS ARN Amazon Resource Name (ARN).
resourcestable Display name: Cloud provider Name 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
Amazon EC2 security group
Smartscape node name: aws.resource.name
Smartscape node type: AWS_EC2_SECURITYGROUP
This entity represents an Amazon EC2 security group.
Query
Fetch all Smartscape nodes from the smartscape.nodes table and filter for the entity type "AWS_EC2_SECURITYGROUP"
smartscapeNodes"AWS_EC2_SECURITYGROUP"
ID input
The ID is calculated based on the following fields in the defined order: aws.arn
Base entity fields
The following base fields are used for all entities.
Attribute
Type
Description
Examples
id
smartscapeId
stable Display name: ID A 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 ID The 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: Name The entity name.
localhost; easyTravel; product-catalog
type
string
stable Display name: Type The entity type. UPPER_SNAKE_CASE string that represents the type of the entity.
TYPE_A
tags
record
stable Display name: Tags A 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.
stable Display name: Lifetime The 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.
stable Display name: References Provides 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.
resourcestable Display name: DT security context The security contexts associated with the entity. For Smartscape entities, this field is always an array. Tags: permission
[]
Cloud entity fields
Fields that are provided by all Cloud workloads.
Attribute
Type
Description
Examples
cloud.acquisition.status
string
experimental Display name: Cloud acquisition status The status of Smartscape nodes data acquisition by Data Acquisition Conroller OK - node is consistent DELETED - node was deleted in the cloud platform ERROR - there was an error acquiring node, but the node was upserted INCOMPLETE - there was an error acquiring node child resource (ie. EC2 Instance, with no EBS volumes due to missing permissions) , but the node was upserted.
OK; DELETED; ERROR; INCOMPLETE
AWS resource fields
Attribute
Type
Description
Examples
aws.object
string
stable Display name: AWS object The 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 version The aws.object json content version
1.0
aws.region
string
resourcestable Display name: AWS region A specific geographical AWS Cloud location. Tags: primary-field
us-east-1
aws.account.id
string
resourcestable Display name: AWS account ID The 12-digit number, such as 123456789012, that uniquely identifies an AWS account. Tags: permissionprimary-field
123456789012
aws.service
string
resourceexperimental Display name: AWS service The service that identifies the AWS product.
s3
aws.resource.type
string
resourceexperimental Display name: AWS resource type The name of a resource type in CloudFormation format.
resourcestable Display name: AWS resource ID Unique, immutable identifier assigned to the AWS cloud resource.
i-0922cda4579db3a45
aws.resource.name
string
resourcestable Display name: AWS resource name Name 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
resourcestable Display name: AWS ARN Amazon Resource Name (ARN).
resourcestable Display name: Cloud provider Name 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
AWS VPC attached resource fields
Contains all fields that are provided by VPC-attached AWS entities.
experimental Display name: AWS security group ID Assigned Security Group or array of Groups
sg-184e3ddb341dd478b; sg-2b3aa4b9409c734ec
Amazon EC2 security group relationships
Type
Target type
Kind
Description
is_attached_to
AWS_EC2_VPC
static
stable Is (typically) exclusively attached to the instance (1-many)
Amazon VPC DHCP options set
Smartscape node name: aws.resource.name
Smartscape node type: AWS_EC2_DHCPOPTIONS
This entity represents an Amazon VPC DHCP options set.
Query
Fetch all Smartscape nodes from the smartscape.nodes table and filter for the entity type "AWS_EC2_DHCPOPTIONS"
smartscapeNodes"AWS_EC2_DHCPOPTIONS"
ID input
The ID is calculated based on the following fields in the defined order: aws.arn
Base entity fields
The following base fields are used for all entities.
Attribute
Type
Description
Examples
id
smartscapeId
stable Display name: ID A 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 ID The 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: Name The entity name.
localhost; easyTravel; product-catalog
type
string
stable Display name: Type The entity type. UPPER_SNAKE_CASE string that represents the type of the entity.
TYPE_A
tags
record
stable Display name: Tags A 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.
stable Display name: Lifetime The 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.
stable Display name: References Provides 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.
resourcestable Display name: DT security context The security contexts associated with the entity. For Smartscape entities, this field is always an array. Tags: permission
[]
Cloud entity fields
Fields that are provided by all Cloud workloads.
Attribute
Type
Description
Examples
cloud.acquisition.status
string
experimental Display name: Cloud acquisition status The status of Smartscape nodes data acquisition by Data Acquisition Conroller OK - node is consistent DELETED - node was deleted in the cloud platform ERROR - there was an error acquiring node, but the node was upserted INCOMPLETE - there was an error acquiring node child resource (ie. EC2 Instance, with no EBS volumes due to missing permissions) , but the node was upserted.
OK; DELETED; ERROR; INCOMPLETE
AWS resource fields
Attribute
Type
Description
Examples
aws.object
string
stable Display name: AWS object The 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 version The aws.object json content version
1.0
aws.region
string
resourcestable Display name: AWS region A specific geographical AWS Cloud location. Tags: primary-field
us-east-1
aws.account.id
string
resourcestable Display name: AWS account ID The 12-digit number, such as 123456789012, that uniquely identifies an AWS account. Tags: permissionprimary-field
123456789012
aws.service
string
resourceexperimental Display name: AWS service The service that identifies the AWS product.
s3
aws.resource.type
string
resourceexperimental Display name: AWS resource type The name of a resource type in CloudFormation format.
resourcestable Display name: AWS resource ID Unique, immutable identifier assigned to the AWS cloud resource.
i-0922cda4579db3a45
aws.resource.name
string
resourcestable Display name: AWS resource name Name 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
resourcestable Display name: AWS ARN Amazon Resource Name (ARN).
resourcestable Display name: Cloud provider Name 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
Amazon VPC IP address manager
Smartscape node name: aws.resource.name
Smartscape node type: AWS_EC2_IPAM
This entity represents an Amazon VPC IP address manager for planning and tracking IP address usage.
Query
Fetch all Smartscape nodes from the smartscape.nodes table and filter for the entity type "AWS_EC2_IPAM"
smartscapeNodes"AWS_EC2_IPAM"
ID input
The ID is calculated based on the following fields in the defined order: aws.arn
Base entity fields
The following base fields are used for all entities.
Attribute
Type
Description
Examples
id
smartscapeId
stable Display name: ID A 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 ID The 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: Name The entity name.
localhost; easyTravel; product-catalog
type
string
stable Display name: Type The entity type. UPPER_SNAKE_CASE string that represents the type of the entity.
TYPE_A
tags
record
stable Display name: Tags A 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.
stable Display name: Lifetime The 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.
stable Display name: References Provides 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.
resourcestable Display name: DT security context The security contexts associated with the entity. For Smartscape entities, this field is always an array. Tags: permission
[]
Cloud entity fields
Fields that are provided by all Cloud workloads.
Attribute
Type
Description
Examples
cloud.acquisition.status
string
experimental Display name: Cloud acquisition status The status of Smartscape nodes data acquisition by Data Acquisition Conroller OK - node is consistent DELETED - node was deleted in the cloud platform ERROR - there was an error acquiring node, but the node was upserted INCOMPLETE - there was an error acquiring node child resource (ie. EC2 Instance, with no EBS volumes due to missing permissions) , but the node was upserted.
OK; DELETED; ERROR; INCOMPLETE
AWS resource fields
Attribute
Type
Description
Examples
aws.object
string
stable Display name: AWS object The 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 version The aws.object json content version
1.0
aws.region
string
resourcestable Display name: AWS region A specific geographical AWS Cloud location. Tags: primary-field
us-east-1
aws.account.id
string
resourcestable Display name: AWS account ID The 12-digit number, such as 123456789012, that uniquely identifies an AWS account. Tags: permissionprimary-field
123456789012
aws.service
string
resourceexperimental Display name: AWS service The service that identifies the AWS product.
s3
aws.resource.type
string
resourceexperimental Display name: AWS resource type The name of a resource type in CloudFormation format.
resourcestable Display name: AWS resource ID Unique, immutable identifier assigned to the AWS cloud resource.
i-0922cda4579db3a45
aws.resource.name
string
resourcestable Display name: AWS resource name Name 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
resourcestable Display name: AWS ARN Amazon Resource Name (ARN).
resourcestable Display name: Cloud provider Name 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
Amazon VPC IP address manager pool
Smartscape node name: aws.resource.name
Smartscape node type: AWS_EC2_IPAMPOOL
This entity represents an Amazon VPC IP address manager pool.
Query
Fetch all Smartscape nodes from the smartscape.nodes table and filter for the entity type "AWS_EC2_IPAMPOOL"
smartscapeNodes"AWS_EC2_IPAMPOOL"
ID input
The ID is calculated based on the following fields in the defined order: aws.arn
Base entity fields
The following base fields are used for all entities.
Attribute
Type
Description
Examples
id
smartscapeId
stable Display name: ID A 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 ID The 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: Name The entity name.
localhost; easyTravel; product-catalog
type
string
stable Display name: Type The entity type. UPPER_SNAKE_CASE string that represents the type of the entity.
TYPE_A
tags
record
stable Display name: Tags A 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.
stable Display name: Lifetime The 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.
stable Display name: References Provides 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.
resourcestable Display name: DT security context The security contexts associated with the entity. For Smartscape entities, this field is always an array. Tags: permission
[]
Cloud entity fields
Fields that are provided by all Cloud workloads.
Attribute
Type
Description
Examples
cloud.acquisition.status
string
experimental Display name: Cloud acquisition status The status of Smartscape nodes data acquisition by Data Acquisition Conroller OK - node is consistent DELETED - node was deleted in the cloud platform ERROR - there was an error acquiring node, but the node was upserted INCOMPLETE - there was an error acquiring node child resource (ie. EC2 Instance, with no EBS volumes due to missing permissions) , but the node was upserted.
OK; DELETED; ERROR; INCOMPLETE
AWS resource fields
Attribute
Type
Description
Examples
aws.object
string
stable Display name: AWS object The 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 version The aws.object json content version
1.0
aws.region
string
resourcestable Display name: AWS region A specific geographical AWS Cloud location. Tags: primary-field
us-east-1
aws.account.id
string
resourcestable Display name: AWS account ID The 12-digit number, such as 123456789012, that uniquely identifies an AWS account. Tags: permissionprimary-field
123456789012
aws.service
string
resourceexperimental Display name: AWS service The service that identifies the AWS product.
s3
aws.resource.type
string
resourceexperimental Display name: AWS resource type The name of a resource type in CloudFormation format.
resourcestable Display name: AWS resource ID Unique, immutable identifier assigned to the AWS cloud resource.
i-0922cda4579db3a45
aws.resource.name
string
resourcestable Display name: AWS resource name Name 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
resourcestable Display name: AWS ARN Amazon Resource Name (ARN).
resourcestable Display name: Cloud provider Name 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
Amazon VPC IP address manager pool relationships
Type
Target type
Kind
Description
belongs_to
AWS_EC2_IPAMSCOPE
static
stable This is similar to an aggregation in UML. It is a many-to-many relationship without existential properties (the destination is not composed of the sources).
Amazon VPC IP address manager scope
Smartscape node name: aws.resource.name
Smartscape node type: AWS_EC2_IPAMSCOPE
This entity represents an Amazon VPC IP address manager scope.
Query
Fetch all Smartscape nodes from the smartscape.nodes table and filter for the entity type "AWS_EC2_IPAMSCOPE"
smartscapeNodes"AWS_EC2_IPAMSCOPE"
ID input
The ID is calculated based on the following fields in the defined order: aws.arn
Base entity fields
The following base fields are used for all entities.
Attribute
Type
Description
Examples
id
smartscapeId
stable Display name: ID A 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 ID The 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: Name The entity name.
localhost; easyTravel; product-catalog
type
string
stable Display name: Type The entity type. UPPER_SNAKE_CASE string that represents the type of the entity.
TYPE_A
tags
record
stable Display name: Tags A 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.
stable Display name: Lifetime The 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.
stable Display name: References Provides 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.
resourcestable Display name: DT security context The security contexts associated with the entity. For Smartscape entities, this field is always an array. Tags: permission
[]
Cloud entity fields
Fields that are provided by all Cloud workloads.
Attribute
Type
Description
Examples
cloud.acquisition.status
string
experimental Display name: Cloud acquisition status The status of Smartscape nodes data acquisition by Data Acquisition Conroller OK - node is consistent DELETED - node was deleted in the cloud platform ERROR - there was an error acquiring node, but the node was upserted INCOMPLETE - there was an error acquiring node child resource (ie. EC2 Instance, with no EBS volumes due to missing permissions) , but the node was upserted.
OK; DELETED; ERROR; INCOMPLETE
AWS resource fields
Attribute
Type
Description
Examples
aws.object
string
stable Display name: AWS object The 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 version The aws.object json content version
1.0
aws.region
string
resourcestable Display name: AWS region A specific geographical AWS Cloud location. Tags: primary-field
us-east-1
aws.account.id
string
resourcestable Display name: AWS account ID The 12-digit number, such as 123456789012, that uniquely identifies an AWS account. Tags: permissionprimary-field
123456789012
aws.service
string
resourceexperimental Display name: AWS service The service that identifies the AWS product.
s3
aws.resource.type
string
resourceexperimental Display name: AWS resource type The name of a resource type in CloudFormation format.
resourcestable Display name: AWS resource ID Unique, immutable identifier assigned to the AWS cloud resource.
i-0922cda4579db3a45
aws.resource.name
string
resourcestable Display name: AWS resource name Name 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
resourcestable Display name: AWS ARN Amazon Resource Name (ARN).
resourcestable Display name: Cloud provider Name 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
Amazon VPC IP address manager scope relationships
Type
Target type
Kind
Description
belongs_to
AWS_EC2_IPAM
static
stable This is similar to an aggregation in UML. It is a many-to-many relationship without existential properties (the destination is not composed of the sources).
Amazon VPC NAT gateway
Smartscape node name: aws.resource.name
Smartscape node type: AWS_EC2_NATGATEWAY
This entity represents an Amazon VPC NAT gateway.
Query
Fetch all Smartscape nodes from the smartscape.nodes table and filter for the entity type "AWS_EC2_NATGATEWAY"
smartscapeNodes"AWS_EC2_NATGATEWAY"
ID input
The ID is calculated based on the following fields in the defined order: aws.arn
Base entity fields
The following base fields are used for all entities.
Attribute
Type
Description
Examples
id
smartscapeId
stable Display name: ID A 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 ID The 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: Name The entity name.
localhost; easyTravel; product-catalog
type
string
stable Display name: Type The entity type. UPPER_SNAKE_CASE string that represents the type of the entity.
TYPE_A
tags
record
stable Display name: Tags A 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.
stable Display name: Lifetime The 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.
stable Display name: References Provides 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.
resourcestable Display name: DT security context The security contexts associated with the entity. For Smartscape entities, this field is always an array. Tags: permission
[]
Cloud entity fields
Fields that are provided by all Cloud workloads.
Attribute
Type
Description
Examples
cloud.acquisition.status
string
experimental Display name: Cloud acquisition status The status of Smartscape nodes data acquisition by Data Acquisition Conroller OK - node is consistent DELETED - node was deleted in the cloud platform ERROR - there was an error acquiring node, but the node was upserted INCOMPLETE - there was an error acquiring node child resource (ie. EC2 Instance, with no EBS volumes due to missing permissions) , but the node was upserted.
OK; DELETED; ERROR; INCOMPLETE
AWS resource fields
Attribute
Type
Description
Examples
aws.object
string
stable Display name: AWS object The 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 version The aws.object json content version
1.0
aws.region
string
resourcestable Display name: AWS region A specific geographical AWS Cloud location. Tags: primary-field
us-east-1
aws.account.id
string
resourcestable Display name: AWS account ID The 12-digit number, such as 123456789012, that uniquely identifies an AWS account. Tags: permissionprimary-field
123456789012
aws.service
string
resourceexperimental Display name: AWS service The service that identifies the AWS product.
s3
aws.resource.type
string
resourceexperimental Display name: AWS resource type The name of a resource type in CloudFormation format.
resourcestable Display name: AWS resource ID Unique, immutable identifier assigned to the AWS cloud resource.
i-0922cda4579db3a45
aws.resource.name
string
resourcestable Display name: AWS resource name Name 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
resourcestable Display name: AWS ARN Amazon Resource Name (ARN).
resourcestable Display name: Cloud provider Name 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
AWS VPC attached resource fields
Contains all fields that are provided by VPC-attached AWS entities.
The ID is calculated based on the following fields in the defined order: aws.arn
Base entity fields
The following base fields are used for all entities.
Attribute
Type
Description
Examples
id
smartscapeId
stable Display name: ID A 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 ID The 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: Name The entity name.
localhost; easyTravel; product-catalog
type
string
stable Display name: Type The entity type. UPPER_SNAKE_CASE string that represents the type of the entity.
TYPE_A
tags
record
stable Display name: Tags A 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.
stable Display name: Lifetime The 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.
stable Display name: References Provides 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.
resourcestable Display name: DT security context The security contexts associated with the entity. For Smartscape entities, this field is always an array. Tags: permission
[]
Cloud entity fields
Fields that are provided by all Cloud workloads.
Attribute
Type
Description
Examples
cloud.acquisition.status
string
experimental Display name: Cloud acquisition status The status of Smartscape nodes data acquisition by Data Acquisition Conroller OK - node is consistent DELETED - node was deleted in the cloud platform ERROR - there was an error acquiring node, but the node was upserted INCOMPLETE - there was an error acquiring node child resource (ie. EC2 Instance, with no EBS volumes due to missing permissions) , but the node was upserted.
OK; DELETED; ERROR; INCOMPLETE
AWS resource fields
Attribute
Type
Description
Examples
aws.object
string
stable Display name: AWS object The 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 version The aws.object json content version
1.0
aws.region
string
resourcestable Display name: AWS region A specific geographical AWS Cloud location. Tags: primary-field
us-east-1
aws.account.id
string
resourcestable Display name: AWS account ID The 12-digit number, such as 123456789012, that uniquely identifies an AWS account. Tags: permissionprimary-field
123456789012
aws.service
string
resourceexperimental Display name: AWS service The service that identifies the AWS product.
s3
aws.resource.type
string
resourceexperimental Display name: AWS resource type The name of a resource type in CloudFormation format.
resourcestable Display name: AWS resource ID Unique, immutable identifier assigned to the AWS cloud resource.
i-0922cda4579db3a45
aws.resource.name
string
resourcestable Display name: AWS resource name Name 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
resourcestable Display name: AWS ARN Amazon Resource Name (ARN).
resourcestable Display name: Cloud provider Name 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
AWS VPC attached resource fields
Contains all fields that are provided by VPC-attached AWS entities.
experimental Display name: AWS security group ID Assigned Security Group or array of Groups
sg-184e3ddb341dd478b; sg-2b3aa4b9409c734ec
Amazon VPC egress-only internet gateway relationships
Type
Target type
Kind
Description
is_attached_to
AWS_EC2_VPC
static
stable Is (typically) exclusively attached to the instance (1-many)
Amazon VPC endpoint (PrivateLink)
Smartscape node name: aws.resource.name
Smartscape node type: AWS_EC2_VPCENDPOINT
This entity represents an Amazon VPC endpoint (PrivateLink).
Query
Fetch all Smartscape nodes from the smartscape.nodes table and filter for the entity type "AWS_EC2_VPCENDPOINT"
smartscapeNodes"AWS_EC2_VPCENDPOINT"
ID input
The ID is calculated based on the following fields in the defined order: aws.arn
Base entity fields
The following base fields are used for all entities.
Attribute
Type
Description
Examples
id
smartscapeId
stable Display name: ID A 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 ID The 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: Name The entity name.
localhost; easyTravel; product-catalog
type
string
stable Display name: Type The entity type. UPPER_SNAKE_CASE string that represents the type of the entity.
TYPE_A
tags
record
stable Display name: Tags A 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.
stable Display name: Lifetime The 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.
stable Display name: References Provides 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.
resourcestable Display name: DT security context The security contexts associated with the entity. For Smartscape entities, this field is always an array. Tags: permission
[]
Cloud entity fields
Fields that are provided by all Cloud workloads.
Attribute
Type
Description
Examples
cloud.acquisition.status
string
experimental Display name: Cloud acquisition status The status of Smartscape nodes data acquisition by Data Acquisition Conroller OK - node is consistent DELETED - node was deleted in the cloud platform ERROR - there was an error acquiring node, but the node was upserted INCOMPLETE - there was an error acquiring node child resource (ie. EC2 Instance, with no EBS volumes due to missing permissions) , but the node was upserted.
OK; DELETED; ERROR; INCOMPLETE
AWS resource fields
Attribute
Type
Description
Examples
aws.object
string
stable Display name: AWS object The 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 version The aws.object json content version
1.0
aws.region
string
resourcestable Display name: AWS region A specific geographical AWS Cloud location. Tags: primary-field
us-east-1
aws.account.id
string
resourcestable Display name: AWS account ID The 12-digit number, such as 123456789012, that uniquely identifies an AWS account. Tags: permissionprimary-field
123456789012
aws.service
string
resourceexperimental Display name: AWS service The service that identifies the AWS product.
s3
aws.resource.type
string
resourceexperimental Display name: AWS resource type The name of a resource type in CloudFormation format.
resourcestable Display name: AWS resource ID Unique, immutable identifier assigned to the AWS cloud resource.
i-0922cda4579db3a45
aws.resource.name
string
resourcestable Display name: AWS resource name Name 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
resourcestable Display name: AWS ARN Amazon Resource Name (ARN).
resourcestable Display name: Cloud provider Name 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
AWS VPC attached resource fields
Contains all fields that are provided by VPC-attached AWS entities.
experimental Display name: AWS security group ID Assigned Security Group or array of Groups
sg-184e3ddb341dd478b; sg-2b3aa4b9409c734ec
Amazon VPC endpoint (PrivateLink) relationships
Type
Target type
Kind
Description
is_attached_to
AWS_EC2_VPC
static
stable Is (typically) exclusively attached to the instance (1-many)
is_attached_to
AWS_EC2_SUBNET
static
stable Is (typically) exclusively attached to the instance (1-many)
uses
AWS_EC2_NETWORKINTERFACE
static
stable Similar to is_attached_to but in the opposite direction. Examples: EC2 Instance uses DHCP options, Auto Scaling Group uses EC2 Launch Template
uses
AWS_EC2_SECURITYGROUP
static
stable Similar to is_attached_to but in the opposite direction. Examples: EC2 Instance uses DHCP options, Auto Scaling Group uses EC2 Launch Template
Amazon VPC endpoint service (PrivateLink)
Smartscape node name: aws.resource.name
Smartscape node type: AWS_EC2_VPCENDPOINTSERVICE
This entity represents an Amazon VPC endpoint service (PrivateLink).
Query
Fetch all Smartscape nodes from the smartscape.nodes table and filter for the entity type "AWS_EC2_VPCENDPOINTSERVICE"
smartscapeNodes"AWS_EC2_VPCENDPOINTSERVICE"
ID input
The ID is calculated based on the following fields in the defined order: aws.arn
Base entity fields
The following base fields are used for all entities.
Attribute
Type
Description
Examples
id
smartscapeId
stable Display name: ID A 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 ID The 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: Name The entity name.
localhost; easyTravel; product-catalog
type
string
stable Display name: Type The entity type. UPPER_SNAKE_CASE string that represents the type of the entity.
TYPE_A
tags
record
stable Display name: Tags A 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.
stable Display name: Lifetime The 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.
stable Display name: References Provides 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.
resourcestable Display name: DT security context The security contexts associated with the entity. For Smartscape entities, this field is always an array. Tags: permission
[]
Cloud entity fields
Fields that are provided by all Cloud workloads.
Attribute
Type
Description
Examples
cloud.acquisition.status
string
experimental Display name: Cloud acquisition status The status of Smartscape nodes data acquisition by Data Acquisition Conroller OK - node is consistent DELETED - node was deleted in the cloud platform ERROR - there was an error acquiring node, but the node was upserted INCOMPLETE - there was an error acquiring node child resource (ie. EC2 Instance, with no EBS volumes due to missing permissions) , but the node was upserted.
OK; DELETED; ERROR; INCOMPLETE
AWS resource fields
Attribute
Type
Description
Examples
aws.object
string
stable Display name: AWS object The 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 version The aws.object json content version
1.0
aws.region
string
resourcestable Display name: AWS region A specific geographical AWS Cloud location. Tags: primary-field
us-east-1
aws.account.id
string
resourcestable Display name: AWS account ID The 12-digit number, such as 123456789012, that uniquely identifies an AWS account. Tags: permissionprimary-field
123456789012
aws.service
string
resourceexperimental Display name: AWS service The service that identifies the AWS product.
s3
aws.resource.type
string
resourceexperimental Display name: AWS resource type The name of a resource type in CloudFormation format.
resourcestable Display name: AWS resource ID Unique, immutable identifier assigned to the AWS cloud resource.
i-0922cda4579db3a45
aws.resource.name
string
resourcestable Display name: AWS resource name Name 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
resourcestable Display name: AWS ARN Amazon Resource Name (ARN).
resourcestable Display name: Cloud provider Name 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
AWS Zonal resource fields
Contains all fields that are provided by AWS entities that are scoped to an Availability Zone.
Attribute
Type
Description
Examples
aws.availability_zone
string
resourcestable Display name: Availability zone A specific availability zone or array of zones in given AWS region.
us-east-1a; us-east-1b
Amazon VPC endpoint service (PrivateLink) relationships
Type
Target type
Kind
Description
routes_to
AWS_ELASTICLOADBALANCINGV2_LOADBALANCER
static
stable Define network route to the instance Examples: EC2 route table routes to EC2 NAT Gateway EC2 VPC Peering Connection routes to VPC
runs_on
AWS_AVAILABILITY_ZONE
static
stable Defines a "vertical" relation of an entity running on some other entity. It does not imply any composition or aggregation but only a looser association between the entities. One entity can run on multiple other entities. Examples: Service running on a POD, a CONTAINER or a HOST.
Amazon VPC flow log
Smartscape node name: aws.resource.name
Smartscape node type: AWS_EC2_FLOWLOG
This entity represents an Amazon VPC flow log.
Query
Fetch all Smartscape nodes from the smartscape.nodes table and filter for the entity type "AWS_EC2_FLOWLOG"
smartscapeNodes"AWS_EC2_FLOWLOG"
ID input
The ID is calculated based on the following fields in the defined order: aws.arn
Base entity fields
The following base fields are used for all entities.
Attribute
Type
Description
Examples
id
smartscapeId
stable Display name: ID A 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 ID The 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: Name The entity name.
localhost; easyTravel; product-catalog
type
string
stable Display name: Type The entity type. UPPER_SNAKE_CASE string that represents the type of the entity.
TYPE_A
tags
record
stable Display name: Tags A 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.
stable Display name: Lifetime The 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.
stable Display name: References Provides 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.
resourcestable Display name: DT security context The security contexts associated with the entity. For Smartscape entities, this field is always an array. Tags: permission
[]
Cloud entity fields
Fields that are provided by all Cloud workloads.
Attribute
Type
Description
Examples
cloud.acquisition.status
string
experimental Display name: Cloud acquisition status The status of Smartscape nodes data acquisition by Data Acquisition Conroller OK - node is consistent DELETED - node was deleted in the cloud platform ERROR - there was an error acquiring node, but the node was upserted INCOMPLETE - there was an error acquiring node child resource (ie. EC2 Instance, with no EBS volumes due to missing permissions) , but the node was upserted.
OK; DELETED; ERROR; INCOMPLETE
AWS resource fields
Attribute
Type
Description
Examples
aws.object
string
stable Display name: AWS object The 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 version The aws.object json content version
1.0
aws.region
string
resourcestable Display name: AWS region A specific geographical AWS Cloud location. Tags: primary-field
us-east-1
aws.account.id
string
resourcestable Display name: AWS account ID The 12-digit number, such as 123456789012, that uniquely identifies an AWS account. Tags: permissionprimary-field
123456789012
aws.service
string
resourceexperimental Display name: AWS service The service that identifies the AWS product.
s3
aws.resource.type
string
resourceexperimental Display name: AWS resource type The name of a resource type in CloudFormation format.
resourcestable Display name: AWS resource ID Unique, immutable identifier assigned to the AWS cloud resource.
i-0922cda4579db3a45
aws.resource.name
string
resourcestable Display name: AWS resource name Name 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
resourcestable Display name: AWS ARN Amazon Resource Name (ARN).
resourcestable Display name: Cloud provider Name 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
Amazon VPC flow log relationships
Type
Target type
Kind
Description
is_attached_to
AWS_EC2_VPC
static
stable Is (typically) exclusively attached to the instance (1-many)
is_attached_to
AWS_EC2_SUBNET
static
stable Is (typically) exclusively attached to the instance (1-many)
is_attached_to
AWS_EC2_NETWORKINTERFACE
static
stable Is (typically) exclusively attached to the instance (1-many)
uses
AWS_IAM_ROLE
static
stable Similar to is_attached_to but in the opposite direction. Examples: EC2 Instance uses DHCP options, Auto Scaling Group uses EC2 Launch Template
uses
AWS_S3_BUCKET
static
stable Similar to is_attached_to but in the opposite direction. Examples: EC2 Instance uses DHCP options, Auto Scaling Group uses EC2 Launch Template
uses
AWS_LOGS_LOGGROUP
static
stable Similar to is_attached_to but in the opposite direction. Examples: EC2 Instance uses DHCP options, Auto Scaling Group uses EC2 Launch Template
uses
AWS_KINESISFIREHOSE_DELIVERYSTREAM
static
stable Similar to is_attached_to but in the opposite direction. Examples: EC2 Instance uses DHCP options, Auto Scaling Group uses EC2 Launch Template
Amazon VPC internet gateway
Smartscape node name: aws.resource.name
Smartscape node type: AWS_EC2_INTERNETGATEWAY
This entity represents an Amazon VPC internet gateway.
Query
Fetch all Smartscape nodes from the smartscape.nodes table and filter for the entity type "AWS_EC2_INTERNETGATEWAY"
smartscapeNodes"AWS_EC2_INTERNETGATEWAY"
ID input
The ID is calculated based on the following fields in the defined order: aws.arn
Base entity fields
The following base fields are used for all entities.
Attribute
Type
Description
Examples
id
smartscapeId
stable Display name: ID A 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 ID The 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: Name The entity name.
localhost; easyTravel; product-catalog
type
string
stable Display name: Type The entity type. UPPER_SNAKE_CASE string that represents the type of the entity.
TYPE_A
tags
record
stable Display name: Tags A 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.
stable Display name: Lifetime The 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.
stable Display name: References Provides 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.
resourcestable Display name: DT security context The security contexts associated with the entity. For Smartscape entities, this field is always an array. Tags: permission
[]
Cloud entity fields
Fields that are provided by all Cloud workloads.
Attribute
Type
Description
Examples
cloud.acquisition.status
string
experimental Display name: Cloud acquisition status The status of Smartscape nodes data acquisition by Data Acquisition Conroller OK - node is consistent DELETED - node was deleted in the cloud platform ERROR - there was an error acquiring node, but the node was upserted INCOMPLETE - there was an error acquiring node child resource (ie. EC2 Instance, with no EBS volumes due to missing permissions) , but the node was upserted.
OK; DELETED; ERROR; INCOMPLETE
AWS resource fields
Attribute
Type
Description
Examples
aws.object
string
stable Display name: AWS object The 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 version The aws.object json content version
1.0
aws.region
string
resourcestable Display name: AWS region A specific geographical AWS Cloud location. Tags: primary-field
us-east-1
aws.account.id
string
resourcestable Display name: AWS account ID The 12-digit number, such as 123456789012, that uniquely identifies an AWS account. Tags: permissionprimary-field
123456789012
aws.service
string
resourceexperimental Display name: AWS service The service that identifies the AWS product.
s3
aws.resource.type
string
resourceexperimental Display name: AWS resource type The name of a resource type in CloudFormation format.
resourcestable Display name: AWS resource ID Unique, immutable identifier assigned to the AWS cloud resource.
i-0922cda4579db3a45
aws.resource.name
string
resourcestable Display name: AWS resource name Name 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
resourcestable Display name: AWS ARN Amazon Resource Name (ARN).
resourcestable Display name: Cloud provider Name 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
AWS VPC attached resource fields
Contains all fields that are provided by VPC-attached AWS entities.
experimental Display name: AWS security group ID Assigned Security Group or array of Groups
sg-184e3ddb341dd478b; sg-2b3aa4b9409c734ec
Amazon VPC internet gateway relationships
Type
Target type
Kind
Description
is_attached_to
AWS_EC2_VPC
static
stable Is (typically) exclusively attached to the instance (1-many)
Amazon VPC network ACL
Smartscape node name: aws.resource.name
Smartscape node type: AWS_EC2_NETWORKACL
This entity represents an Amazon VPC network ACL.
Query
Fetch all Smartscape nodes from the smartscape.nodes table and filter for the entity type "AWS_EC2_NETWORKACL"
smartscapeNodes"AWS_EC2_NETWORKACL"
ID input
The ID is calculated based on the following fields in the defined order: aws.arn
Base entity fields
The following base fields are used for all entities.
Attribute
Type
Description
Examples
id
smartscapeId
stable Display name: ID A 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 ID The 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: Name The entity name.
localhost; easyTravel; product-catalog
type
string
stable Display name: Type The entity type. UPPER_SNAKE_CASE string that represents the type of the entity.
TYPE_A
tags
record
stable Display name: Tags A 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.
stable Display name: Lifetime The 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.
stable Display name: References Provides 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.
resourcestable Display name: DT security context The security contexts associated with the entity. For Smartscape entities, this field is always an array. Tags: permission
[]
Cloud entity fields
Fields that are provided by all Cloud workloads.
Attribute
Type
Description
Examples
cloud.acquisition.status
string
experimental Display name: Cloud acquisition status The status of Smartscape nodes data acquisition by Data Acquisition Conroller OK - node is consistent DELETED - node was deleted in the cloud platform ERROR - there was an error acquiring node, but the node was upserted INCOMPLETE - there was an error acquiring node child resource (ie. EC2 Instance, with no EBS volumes due to missing permissions) , but the node was upserted.
OK; DELETED; ERROR; INCOMPLETE
AWS resource fields
Attribute
Type
Description
Examples
aws.object
string
stable Display name: AWS object The 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 version The aws.object json content version
1.0
aws.region
string
resourcestable Display name: AWS region A specific geographical AWS Cloud location. Tags: primary-field
us-east-1
aws.account.id
string
resourcestable Display name: AWS account ID The 12-digit number, such as 123456789012, that uniquely identifies an AWS account. Tags: permissionprimary-field
123456789012
aws.service
string
resourceexperimental Display name: AWS service The service that identifies the AWS product.
s3
aws.resource.type
string
resourceexperimental Display name: AWS resource type The name of a resource type in CloudFormation format.
resourcestable Display name: AWS resource ID Unique, immutable identifier assigned to the AWS cloud resource.
i-0922cda4579db3a45
aws.resource.name
string
resourcestable Display name: AWS resource name Name 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
resourcestable Display name: AWS ARN Amazon Resource Name (ARN).
resourcestable Display name: Cloud provider Name 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
AWS VPC attached resource fields
Contains all fields that are provided by VPC-attached AWS entities.
This entity represents an Amazon VPC peering connection.
Query
Fetch all Smartscape nodes from the smartscape.nodes table and filter for the entity type "AWS_EC2_VPCPEERINGCONNECTION"
smartscapeNodes"AWS_EC2_VPCPEERINGCONNECTION"
ID input
The ID is calculated based on the following fields in the defined order: aws.arn
Base entity fields
The following base fields are used for all entities.
Attribute
Type
Description
Examples
id
smartscapeId
stable Display name: ID A 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 ID The 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: Name The entity name.
localhost; easyTravel; product-catalog
type
string
stable Display name: Type The entity type. UPPER_SNAKE_CASE string that represents the type of the entity.
TYPE_A
tags
record
stable Display name: Tags A 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.
stable Display name: Lifetime The 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.
stable Display name: References Provides 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.
resourcestable Display name: DT security context The security contexts associated with the entity. For Smartscape entities, this field is always an array. Tags: permission
[]
Cloud entity fields
Fields that are provided by all Cloud workloads.
Attribute
Type
Description
Examples
cloud.acquisition.status
string
experimental Display name: Cloud acquisition status The status of Smartscape nodes data acquisition by Data Acquisition Conroller OK - node is consistent DELETED - node was deleted in the cloud platform ERROR - there was an error acquiring node, but the node was upserted INCOMPLETE - there was an error acquiring node child resource (ie. EC2 Instance, with no EBS volumes due to missing permissions) , but the node was upserted.
OK; DELETED; ERROR; INCOMPLETE
AWS resource fields
Attribute
Type
Description
Examples
aws.object
string
stable Display name: AWS object The 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 version The aws.object json content version
1.0
aws.region
string
resourcestable Display name: AWS region A specific geographical AWS Cloud location. Tags: primary-field
us-east-1
aws.account.id
string
resourcestable Display name: AWS account ID The 12-digit number, such as 123456789012, that uniquely identifies an AWS account. Tags: permissionprimary-field
123456789012
aws.service
string
resourceexperimental Display name: AWS service The service that identifies the AWS product.
s3
aws.resource.type
string
resourceexperimental Display name: AWS resource type The name of a resource type in CloudFormation format.
resourcestable Display name: AWS resource ID Unique, immutable identifier assigned to the AWS cloud resource.
i-0922cda4579db3a45
aws.resource.name
string
resourcestable Display name: AWS resource name Name 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
resourcestable Display name: AWS ARN Amazon Resource Name (ARN).
resourcestable Display name: Cloud provider Name 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
Amazon VPC peering connection relationships
Type
Target type
Kind
Description
routes_to
AWS_EC2_VPC
static
stable Define network route to the instance Examples: EC2 route table routes to EC2 NAT Gateway EC2 VPC Peering Connection routes to VPC
Amazon VPC route table
Smartscape node name: aws.resource.name
Smartscape node type: AWS_EC2_ROUTETABLE
This entity represents an Amazon VPC route table.
Query
Fetch all Smartscape nodes from the smartscape.nodes table and filter for the entity type "AWS_EC2_ROUTETABLE"
smartscapeNodes"AWS_EC2_ROUTETABLE"
ID input
The ID is calculated based on the following fields in the defined order: aws.arn
Base entity fields
The following base fields are used for all entities.
Attribute
Type
Description
Examples
id
smartscapeId
stable Display name: ID A 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 ID The 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: Name The entity name.
localhost; easyTravel; product-catalog
type
string
stable Display name: Type The entity type. UPPER_SNAKE_CASE string that represents the type of the entity.
TYPE_A
tags
record
stable Display name: Tags A 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.
stable Display name: Lifetime The 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.
stable Display name: References Provides 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.
resourcestable Display name: DT security context The security contexts associated with the entity. For Smartscape entities, this field is always an array. Tags: permission
[]
Cloud entity fields
Fields that are provided by all Cloud workloads.
Attribute
Type
Description
Examples
cloud.acquisition.status
string
experimental Display name: Cloud acquisition status The status of Smartscape nodes data acquisition by Data Acquisition Conroller OK - node is consistent DELETED - node was deleted in the cloud platform ERROR - there was an error acquiring node, but the node was upserted INCOMPLETE - there was an error acquiring node child resource (ie. EC2 Instance, with no EBS volumes due to missing permissions) , but the node was upserted.
OK; DELETED; ERROR; INCOMPLETE
AWS resource fields
Attribute
Type
Description
Examples
aws.object
string
stable Display name: AWS object The 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 version The aws.object json content version
1.0
aws.region
string
resourcestable Display name: AWS region A specific geographical AWS Cloud location. Tags: primary-field
us-east-1
aws.account.id
string
resourcestable Display name: AWS account ID The 12-digit number, such as 123456789012, that uniquely identifies an AWS account. Tags: permissionprimary-field
123456789012
aws.service
string
resourceexperimental Display name: AWS service The service that identifies the AWS product.
s3
aws.resource.type
string
resourceexperimental Display name: AWS resource type The name of a resource type in CloudFormation format.
resourcestable Display name: AWS resource ID Unique, immutable identifier assigned to the AWS cloud resource.
i-0922cda4579db3a45
aws.resource.name
string
resourcestable Display name: AWS resource name Name 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
resourcestable Display name: AWS ARN Amazon Resource Name (ARN).
resourcestable Display name: Cloud provider Name 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
AWS VPC attached resource fields
Contains all fields that are provided by VPC-attached AWS entities.
experimental Display name: AWS security group ID Assigned Security Group or array of Groups
sg-184e3ddb341dd478b; sg-2b3aa4b9409c734ec
Amazon VPC route table relationships
Type
Target type
Kind
Description
is_attached_to
AWS_EC2_VPC
static
stable Is (typically) exclusively attached to the instance (1-many)
is_attached_to
AWS_EC2_SUBNET
static
stable Is (typically) exclusively attached to the instance (1-many)
routes_to
AWS_EC2_INSTANCE
static
stable Define network route to the instance Examples: EC2 route table routes to EC2 NAT Gateway EC2 VPC Peering Connection routes to VPC
routes_to
AWS_EC2_NETWORKINTERFACE
static
stable Define network route to the instance Examples: EC2 route table routes to EC2 NAT Gateway EC2 VPC Peering Connection routes to VPC
routes_to
AWS_EC2_VPNGATEWAY
static
stable Define network route to the instance Examples: EC2 route table routes to EC2 NAT Gateway EC2 VPC Peering Connection routes to VPC
routes_to
AWS_EC2_INTERNETGATEWAY
static
stable Define network route to the instance Examples: EC2 route table routes to EC2 NAT Gateway EC2 VPC Peering Connection routes to VPC
routes_to
AWS_EC2_EGRESSONLYINTERNETGATEWAY
static
stable Define network route to the instance Examples: EC2 route table routes to EC2 NAT Gateway EC2 VPC Peering Connection routes to VPC
routes_to
AWS_EC2_VPCENDPOINT
static
stable Define network route to the instance Examples: EC2 route table routes to EC2 NAT Gateway EC2 VPC Peering Connection routes to VPC
routes_to
AWS_EC2_NATGATEWAY
static
stable Define network route to the instance Examples: EC2 route table routes to EC2 NAT Gateway EC2 VPC Peering Connection routes to VPC
routes_to
AWS_EC2_TRANSITGATEWAY
static
stable Define network route to the instance Examples: EC2 route table routes to EC2 NAT Gateway EC2 VPC Peering Connection routes to VPC
routes_to
AWS_EC2_VPCPEERINGCONNECTION
static
stable Define network route to the instance Examples: EC2 route table routes to EC2 NAT Gateway EC2 VPC Peering Connection routes to VPC
Amazon VPC subnet
Smartscape node name: aws.resource.name
Smartscape node type: AWS_EC2_SUBNET
This entity represents an Amazon VPC subnet.
Query
Fetch all Smartscape nodes from the smartscape.nodes table and filter for the entity type "AWS_EC2_SUBNET"
smartscapeNodes"AWS_EC2_SUBNET"
ID input
The ID is calculated based on the following fields in the defined order: aws.arn
Base entity fields
The following base fields are used for all entities.
Attribute
Type
Description
Examples
id
smartscapeId
stable Display name: ID A 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 ID The 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: Name The entity name.
localhost; easyTravel; product-catalog
type
string
stable Display name: Type The entity type. UPPER_SNAKE_CASE string that represents the type of the entity.
TYPE_A
tags
record
stable Display name: Tags A 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.
stable Display name: Lifetime The 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.
stable Display name: References Provides 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.
resourcestable Display name: DT security context The security contexts associated with the entity. For Smartscape entities, this field is always an array. Tags: permission
[]
Cloud entity fields
Fields that are provided by all Cloud workloads.
Attribute
Type
Description
Examples
cloud.acquisition.status
string
experimental Display name: Cloud acquisition status The status of Smartscape nodes data acquisition by Data Acquisition Conroller OK - node is consistent DELETED - node was deleted in the cloud platform ERROR - there was an error acquiring node, but the node was upserted INCOMPLETE - there was an error acquiring node child resource (ie. EC2 Instance, with no EBS volumes due to missing permissions) , but the node was upserted.
OK; DELETED; ERROR; INCOMPLETE
AWS resource fields
Attribute
Type
Description
Examples
aws.object
string
stable Display name: AWS object The 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 version The aws.object json content version
1.0
aws.region
string
resourcestable Display name: AWS region A specific geographical AWS Cloud location. Tags: primary-field
us-east-1
aws.account.id
string
resourcestable Display name: AWS account ID The 12-digit number, such as 123456789012, that uniquely identifies an AWS account. Tags: permissionprimary-field
123456789012
aws.service
string
resourceexperimental Display name: AWS service The service that identifies the AWS product.
s3
aws.resource.type
string
resourceexperimental Display name: AWS resource type The name of a resource type in CloudFormation format.
resourcestable Display name: AWS resource ID Unique, immutable identifier assigned to the AWS cloud resource.
i-0922cda4579db3a45
aws.resource.name
string
resourcestable Display name: AWS resource name Name 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
resourcestable Display name: AWS ARN Amazon Resource Name (ARN).
resourcestable Display name: Cloud provider Name 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
AWS VPC attached resource fields
Contains all fields that are provided by VPC-attached AWS entities.
experimental Display name: AWS security group ID Assigned Security Group or array of Groups
sg-184e3ddb341dd478b; sg-2b3aa4b9409c734ec
AWS Zonal resource fields
Contains all fields that are provided by AWS entities that are scoped to an Availability Zone.
Attribute
Type
Description
Examples
aws.availability_zone
string
resourcestable Display name: Availability zone A specific availability zone or array of zones in given AWS region.
us-east-1a; us-east-1b
Amazon VPC subnet relationships
Type
Target type
Kind
Description
is_attached_to
AWS_EC2_VPC
static
stable Is (typically) exclusively attached to the instance (1-many)
runs_on
AWS_AVAILABILITY_ZONE
static
stable Defines a "vertical" relation of an entity running on some other entity. It does not imply any composition or aggregation but only a looser association between the entities. One entity can run on multiple other entities. Examples: Service running on a POD, a CONTAINER or a HOST.
The ID is calculated based on the following fields in the defined order: aws.arn
Base entity fields
The following base fields are used for all entities.
Attribute
Type
Description
Examples
id
smartscapeId
stable Display name: ID A 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 ID The 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: Name The entity name.
localhost; easyTravel; product-catalog
type
string
stable Display name: Type The entity type. UPPER_SNAKE_CASE string that represents the type of the entity.
TYPE_A
tags
record
stable Display name: Tags A 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.
stable Display name: Lifetime The 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.
stable Display name: References Provides 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.
resourcestable Display name: DT security context The security contexts associated with the entity. For Smartscape entities, this field is always an array. Tags: permission
[]
Cloud entity fields
Fields that are provided by all Cloud workloads.
Attribute
Type
Description
Examples
cloud.acquisition.status
string
experimental Display name: Cloud acquisition status The status of Smartscape nodes data acquisition by Data Acquisition Conroller OK - node is consistent DELETED - node was deleted in the cloud platform ERROR - there was an error acquiring node, but the node was upserted INCOMPLETE - there was an error acquiring node child resource (ie. EC2 Instance, with no EBS volumes due to missing permissions) , but the node was upserted.
OK; DELETED; ERROR; INCOMPLETE
AWS resource fields
Attribute
Type
Description
Examples
aws.object
string
stable Display name: AWS object The 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 version The aws.object json content version
1.0
aws.region
string
resourcestable Display name: AWS region A specific geographical AWS Cloud location. Tags: primary-field
us-east-1
aws.account.id
string
resourcestable Display name: AWS account ID The 12-digit number, such as 123456789012, that uniquely identifies an AWS account. Tags: permissionprimary-field
123456789012
aws.service
string
resourceexperimental Display name: AWS service The service that identifies the AWS product.
s3
aws.resource.type
string
resourceexperimental Display name: AWS resource type The name of a resource type in CloudFormation format.
resourcestable Display name: AWS resource ID Unique, immutable identifier assigned to the AWS cloud resource.
i-0922cda4579db3a45
aws.resource.name
string
resourcestable Display name: AWS resource name Name 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
resourcestable Display name: AWS ARN Amazon Resource Name (ARN).
resourcestable Display name: Cloud provider Name 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.
The ID is calculated based on the following fields in the defined order: aws.arn
Base entity fields
The following base fields are used for all entities.
Attribute
Type
Description
Examples
id
smartscapeId
stable Display name: ID A 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 ID The 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: Name The entity name.
localhost; easyTravel; product-catalog
type
string
stable Display name: Type The entity type. UPPER_SNAKE_CASE string that represents the type of the entity.
TYPE_A
tags
record
stable Display name: Tags A 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.
stable Display name: Lifetime The 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.
stable Display name: References Provides 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.
resourcestable Display name: DT security context The security contexts associated with the entity. For Smartscape entities, this field is always an array. Tags: permission
[]
Cloud entity fields
Fields that are provided by all Cloud workloads.
Attribute
Type
Description
Examples
cloud.acquisition.status
string
experimental Display name: Cloud acquisition status The status of Smartscape nodes data acquisition by Data Acquisition Conroller OK - node is consistent DELETED - node was deleted in the cloud platform ERROR - there was an error acquiring node, but the node was upserted INCOMPLETE - there was an error acquiring node child resource (ie. EC2 Instance, with no EBS volumes due to missing permissions) , but the node was upserted.
OK; DELETED; ERROR; INCOMPLETE
AWS resource fields
Attribute
Type
Description
Examples
aws.object
string
stable Display name: AWS object The 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 version The aws.object json content version
1.0
aws.region
string
resourcestable Display name: AWS region A specific geographical AWS Cloud location. Tags: primary-field
us-east-1
aws.account.id
string
resourcestable Display name: AWS account ID The 12-digit number, such as 123456789012, that uniquely identifies an AWS account. Tags: permissionprimary-field
123456789012
aws.service
string
resourceexperimental Display name: AWS service The service that identifies the AWS product.
s3
aws.resource.type
string
resourceexperimental Display name: AWS resource type The name of a resource type in CloudFormation format.
resourcestable Display name: AWS resource ID Unique, immutable identifier assigned to the AWS cloud resource.
i-0922cda4579db3a45
aws.resource.name
string
resourcestable Display name: AWS resource name Name 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
resourcestable Display name: AWS ARN Amazon Resource Name (ARN).
resourcestable Display name: Cloud provider Name 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
Amazon Virtual Private Cloud
Smartscape node name: aws.resource.name
Smartscape node type: AWS_EC2_VPC
This entity represents an Amazon Virtual Private Cloud.
Query
Fetch all Smartscape nodes from the smartscape.nodes table and filter for the entity type "AWS_EC2_VPC"
smartscapeNodes"AWS_EC2_VPC"
ID input
The ID is calculated based on the following fields in the defined order: aws.arn
Base entity fields
The following base fields are used for all entities.
Attribute
Type
Description
Examples
id
smartscapeId
stable Display name: ID A 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 ID The 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: Name The entity name.
localhost; easyTravel; product-catalog
type
string
stable Display name: Type The entity type. UPPER_SNAKE_CASE string that represents the type of the entity.
TYPE_A
tags
record
stable Display name: Tags A 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.
stable Display name: Lifetime The 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.
stable Display name: References Provides 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.
resourcestable Display name: DT security context The security contexts associated with the entity. For Smartscape entities, this field is always an array. Tags: permission
[]
Cloud entity fields
Fields that are provided by all Cloud workloads.
Attribute
Type
Description
Examples
cloud.acquisition.status
string
experimental Display name: Cloud acquisition status The status of Smartscape nodes data acquisition by Data Acquisition Conroller OK - node is consistent DELETED - node was deleted in the cloud platform ERROR - there was an error acquiring node, but the node was upserted INCOMPLETE - there was an error acquiring node child resource (ie. EC2 Instance, with no EBS volumes due to missing permissions) , but the node was upserted.
OK; DELETED; ERROR; INCOMPLETE
AWS resource fields
Attribute
Type
Description
Examples
aws.object
string
stable Display name: AWS object The 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 version The aws.object json content version
1.0
aws.region
string
resourcestable Display name: AWS region A specific geographical AWS Cloud location. Tags: primary-field
us-east-1
aws.account.id
string
resourcestable Display name: AWS account ID The 12-digit number, such as 123456789012, that uniquely identifies an AWS account. Tags: permissionprimary-field
123456789012
aws.service
string
resourceexperimental Display name: AWS service The service that identifies the AWS product.
s3
aws.resource.type
string
resourceexperimental Display name: AWS resource type The name of a resource type in CloudFormation format.
resourcestable Display name: AWS resource ID Unique, immutable identifier assigned to the AWS cloud resource.
i-0922cda4579db3a45
aws.resource.name
string
resourcestable Display name: AWS resource name Name 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
resourcestable Display name: AWS ARN Amazon Resource Name (ARN).
resourcestable Display name: Cloud provider Name 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
Amazon Virtual Private Cloud relationships
Type
Target type
Kind
Description
uses
AWS_EC2_DHCPOPTIONS
static
stable Similar to is_attached_to but in the opposite direction. Examples: EC2 Instance uses DHCP options, Auto Scaling Group uses EC2 Launch Template