Try it free

Amazon API Gateway

  • Latest Dynatrace
  • Reference

Amazon API Gateway (v1 and v2) resource types in Smartscape on Grail

Amazon API Gateway REST API

Smartscape node name: aws.resource.name

Smartscape node type: AWS_APIGATEWAY_RESTAPI

This entity represents an Amazon API Gateway REST API.

Query

Fetch all Smartscape nodes from the smartscape.nodes table and filter for the entity type "AWS_APIGATEWAY_RESTAPI"

smartscapeNodes "AWS_APIGATEWAY_RESTAPI"

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.

AttributeTypeDescriptionExamples
idsmartscapeIdstable
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_classicstringdeprecated
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
namestringstable
Display name: Name
The entity name.
localhost; easyTravel; product-catalog
typestringstable
Display name: Type
The entity type. UPPER_SNAKE_CASE string that represents the type of the entity.
Tags: permission
TYPE_A
tagsrecordstable
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.
tags[tag_key-1] = [context_A_tag_val-1, context_B_tag_val-1]; tags[tag_key-2] = context_C_tag_val-1; tags:context_A[tag_key-1] = context_A_tag_val-1
lifetimetimeframestable
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.
{ start: 2022-07-06T13:36:00.808Z, end: 2024-04-11T06:56:01.204Z }
referencesrecordstable
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.
{ references[runs_on.host] : [HOST-C251A1173C2B4B39,HOST-0E9038C7C4409D69], references[runs_on.container] : [CONTAINER-68A08967EF4F675B] }
dt.security_contextstring[]resource stable
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.

AttributeTypeDescriptionExamples
cloud.acquisition.statusstringexperimental
Display name: Cloud acquisition status
The status of Smartscape nodes data acquisition by Data Acquisition Controller: OK —node is consistent; DELETED —node was deleted in the cloud platform; ERROR —there was an error acquiring the node, but the node was upserted; INCOMPLETE —there was an error acquiring the node child resource (for example an EC2 instance with no EBS volumes due to missing permissions), but the node was upserted.
OK; DELETED; ERROR; INCOMPLETE

AWS resource fields

AttributeTypeDescriptionExamples
aws.objectstringstable
Display name: AWS object
The full JSON content of any AWS object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}
aws.properties.versionstringexperimental
Display name: AWS properties version
The aws.object JSON content version
1.0
aws.regionstringresource stable
Display name: AWS region
A specific geographical AWS Cloud location.
Tags: primary-field
us-east-1
aws.account.idstringresource stable
Display name: AWS account ID
The 12-digit number, such as 123456789012, that uniquely identifies an AWS account.
Tags: permission primary-field
123456789012
aws.servicestringresource experimental
Display name: AWS service
The service that identifies the AWS product.
s3
aws.resource.typestringresource experimental
Display name: AWS resource type
The AWS resource type associated with the telemetry signal or Smartscape entity, in AWS CloudFormation format.
AWS::EC2::Instance; AWS::S3::Bucket; AWS::Lambda::Function
aws.resource.idstringresource stable
Display name: AWS resource ID
Unique, immutable identifier assigned to the AWS cloud resource.
i-0922cda4579db3a45
aws.resource.namestringresource stable
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.arnstringresource stable
Display name: AWS ARN
Amazon Resource Name (ARN) of the AWS resource associated with the telemetry signal or Smartscape entity.
arn:aws:lambda:us-east-1:478983378254:function:acceptanceWeatherBackend
cloud.providerstringresource stable
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.

ValueDescriptionDisplay name
alibaba_cloudAlibaba CloudAlibaba Cloud
awsAmazon Web ServicesAWS
azureMicrosoft AzureAzure
gcpGoogle Cloud PlatformGCP
herokuHeroku Platform as a ServiceHeroku
ibm_cloudIBM CloudIBM Cloud
tencent_cloudTencent CloudTencent Cloud

Amazon API Gateway VPC link

Smartscape node name: aws.resource.name

Smartscape node type: AWS_APIGATEWAY_VPCLINK

This entity represents an Amazon API Gateway VPC link.

Query

Fetch all Smartscape nodes from the smartscape.nodes table and filter for the entity type "AWS_APIGATEWAY_VPCLINK"

smartscapeNodes "AWS_APIGATEWAY_VPCLINK"

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.

AttributeTypeDescriptionExamples
idsmartscapeIdstable
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_classicstringdeprecated
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
namestringstable
Display name: Name
The entity name.
localhost; easyTravel; product-catalog
typestringstable
Display name: Type
The entity type. UPPER_SNAKE_CASE string that represents the type of the entity.
Tags: permission
TYPE_A
tagsrecordstable
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.
tags[tag_key-1] = [context_A_tag_val-1, context_B_tag_val-1]; tags[tag_key-2] = context_C_tag_val-1; tags:context_A[tag_key-1] = context_A_tag_val-1
lifetimetimeframestable
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.
{ start: 2022-07-06T13:36:00.808Z, end: 2024-04-11T06:56:01.204Z }
referencesrecordstable
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.
{ references[runs_on.host] : [HOST-C251A1173C2B4B39,HOST-0E9038C7C4409D69], references[runs_on.container] : [CONTAINER-68A08967EF4F675B] }
dt.security_contextstring[]resource stable
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.

AttributeTypeDescriptionExamples
cloud.acquisition.statusstringexperimental
Display name: Cloud acquisition status
The status of Smartscape nodes data acquisition by Data Acquisition Controller: OK —node is consistent; DELETED —node was deleted in the cloud platform; ERROR —there was an error acquiring the node, but the node was upserted; INCOMPLETE —there was an error acquiring the node child resource (for example an EC2 instance with no EBS volumes due to missing permissions), but the node was upserted.
OK; DELETED; ERROR; INCOMPLETE

AWS resource fields

AttributeTypeDescriptionExamples
aws.objectstringstable
Display name: AWS object
The full JSON content of any AWS object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}
aws.properties.versionstringexperimental
Display name: AWS properties version
The aws.object JSON content version
1.0
aws.regionstringresource stable
Display name: AWS region
A specific geographical AWS Cloud location.
Tags: primary-field
us-east-1
aws.account.idstringresource stable
Display name: AWS account ID
The 12-digit number, such as 123456789012, that uniquely identifies an AWS account.
Tags: permission primary-field
123456789012
aws.servicestringresource experimental
Display name: AWS service
The service that identifies the AWS product.
s3
aws.resource.typestringresource experimental
Display name: AWS resource type
The AWS resource type associated with the telemetry signal or Smartscape entity, in AWS CloudFormation format.
AWS::EC2::Instance; AWS::S3::Bucket; AWS::Lambda::Function
aws.resource.idstringresource stable
Display name: AWS resource ID
Unique, immutable identifier assigned to the AWS cloud resource.
i-0922cda4579db3a45
aws.resource.namestringresource stable
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.arnstringresource stable
Display name: AWS ARN
Amazon Resource Name (ARN) of the AWS resource associated with the telemetry signal or Smartscape entity.
arn:aws:lambda:us-east-1:478983378254:function:acceptanceWeatherBackend
cloud.providerstringresource stable
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.

ValueDescriptionDisplay name
alibaba_cloudAlibaba CloudAlibaba Cloud
awsAmazon Web ServicesAWS
azureMicrosoft AzureAzure
gcpGoogle Cloud PlatformGCP
herokuHeroku Platform as a ServiceHeroku
ibm_cloudIBM CloudIBM Cloud
tencent_cloudTencent CloudTencent Cloud

AWS state fields

Contains all fields that are provided by AWS entities that report state.

AttributeTypeDescriptionExamples
aws.statestringexperimental
Display name: AWS state
The operational state of the AWS resource. This attribute value depends on the specific resource type.
running; stopped; in-use; attached; detached; enabled; disabled; error

Amazon API Gateway VPC link relationships

TypeTarget typeKindDescription
routes_toAWS_ELASTICLOADBALANCINGV2_LOADBALANCERstaticstable
Define network route to the instance Examples: EC2 route table routes to EC2 NAT Gateway EC2 VPC Peering Connection routes to VPC

Amazon API Gateway authorizer

Smartscape node name: aws.resource.name

Smartscape node type: AWS_APIGATEWAY_AUTHORIZER

This entity represents an Amazon API Gateway authorizer.

Query

Fetch all Smartscape nodes from the smartscape.nodes table and filter for the entity type "AWS_APIGATEWAY_AUTHORIZER"

smartscapeNodes "AWS_APIGATEWAY_AUTHORIZER"

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.

AttributeTypeDescriptionExamples
idsmartscapeIdstable
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_classicstringdeprecated
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
namestringstable
Display name: Name
The entity name.
localhost; easyTravel; product-catalog
typestringstable
Display name: Type
The entity type. UPPER_SNAKE_CASE string that represents the type of the entity.
Tags: permission
TYPE_A
tagsrecordstable
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.
tags[tag_key-1] = [context_A_tag_val-1, context_B_tag_val-1]; tags[tag_key-2] = context_C_tag_val-1; tags:context_A[tag_key-1] = context_A_tag_val-1
lifetimetimeframestable
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.
{ start: 2022-07-06T13:36:00.808Z, end: 2024-04-11T06:56:01.204Z }
referencesrecordstable
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.
{ references[runs_on.host] : [HOST-C251A1173C2B4B39,HOST-0E9038C7C4409D69], references[runs_on.container] : [CONTAINER-68A08967EF4F675B] }
dt.security_contextstring[]resource stable
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.

AttributeTypeDescriptionExamples
cloud.acquisition.statusstringexperimental
Display name: Cloud acquisition status
The status of Smartscape nodes data acquisition by Data Acquisition Controller: OK —node is consistent; DELETED —node was deleted in the cloud platform; ERROR —there was an error acquiring the node, but the node was upserted; INCOMPLETE —there was an error acquiring the node child resource (for example an EC2 instance with no EBS volumes due to missing permissions), but the node was upserted.
OK; DELETED; ERROR; INCOMPLETE

AWS resource fields

AttributeTypeDescriptionExamples
aws.objectstringstable
Display name: AWS object
The full JSON content of any AWS object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}
aws.properties.versionstringexperimental
Display name: AWS properties version
The aws.object JSON content version
1.0
aws.regionstringresource stable
Display name: AWS region
A specific geographical AWS Cloud location.
Tags: primary-field
us-east-1
aws.account.idstringresource stable
Display name: AWS account ID
The 12-digit number, such as 123456789012, that uniquely identifies an AWS account.
Tags: permission primary-field
123456789012
aws.servicestringresource experimental
Display name: AWS service
The service that identifies the AWS product.
s3
aws.resource.typestringresource experimental
Display name: AWS resource type
The AWS resource type associated with the telemetry signal or Smartscape entity, in AWS CloudFormation format.
AWS::EC2::Instance; AWS::S3::Bucket; AWS::Lambda::Function
aws.resource.idstringresource stable
Display name: AWS resource ID
Unique, immutable identifier assigned to the AWS cloud resource.
i-0922cda4579db3a45
aws.resource.namestringresource stable
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.arnstringresource stable
Display name: AWS ARN
Amazon Resource Name (ARN) of the AWS resource associated with the telemetry signal or Smartscape entity.
arn:aws:lambda:us-east-1:478983378254:function:acceptanceWeatherBackend
cloud.providerstringresource stable
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.

ValueDescriptionDisplay name
alibaba_cloudAlibaba CloudAlibaba Cloud
awsAmazon Web ServicesAWS
azureMicrosoft AzureAzure
gcpGoogle Cloud PlatformGCP
herokuHeroku Platform as a ServiceHeroku
ibm_cloudIBM CloudIBM Cloud
tencent_cloudTencent CloudTencent Cloud

Amazon API Gateway authorizer relationships

TypeTarget typeKindDescription
is_attached_toAWS_APIGATEWAY_RESTAPIstaticstable
Is (typically) exclusively attached to the instance (1-many)
usesAWS_COGNITO_USERPOOLstaticstable
Similar to is_attached_to but in the opposite direction. Examples: EC2 Instance uses DHCP options, Auto Scaling Group uses EC2 Launch Template
usesAWS_LAMBDA_FUNCTIONstaticstable
Similar to is_attached_to but in the opposite direction. Examples: EC2 Instance uses DHCP options, Auto Scaling Group uses EC2 Launch Template

Amazon API Gateway stage

Smartscape node name: aws.resource.name

Smartscape node type: AWS_APIGATEWAY_STAGE

This entity represents an Amazon API Gateway (REST) stage, which is a named reference to a deployment of the API.

Query

Fetch all Smartscape nodes from the smartscape.nodes table and filter for the entity type "AWS_APIGATEWAY_STAGE"

smartscapeNodes "AWS_APIGATEWAY_STAGE"

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.

AttributeTypeDescriptionExamples
idsmartscapeIdstable
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_classicstringdeprecated
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
namestringstable
Display name: Name
The entity name.
localhost; easyTravel; product-catalog
typestringstable
Display name: Type
The entity type. UPPER_SNAKE_CASE string that represents the type of the entity.
Tags: permission
TYPE_A
tagsrecordstable
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.
tags[tag_key-1] = [context_A_tag_val-1, context_B_tag_val-1]; tags[tag_key-2] = context_C_tag_val-1; tags:context_A[tag_key-1] = context_A_tag_val-1
lifetimetimeframestable
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.
{ start: 2022-07-06T13:36:00.808Z, end: 2024-04-11T06:56:01.204Z }
referencesrecordstable
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.
{ references[runs_on.host] : [HOST-C251A1173C2B4B39,HOST-0E9038C7C4409D69], references[runs_on.container] : [CONTAINER-68A08967EF4F675B] }
dt.security_contextstring[]resource stable
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.

AttributeTypeDescriptionExamples
cloud.acquisition.statusstringexperimental
Display name: Cloud acquisition status
The status of Smartscape nodes data acquisition by Data Acquisition Controller: OK —node is consistent; DELETED —node was deleted in the cloud platform; ERROR —there was an error acquiring the node, but the node was upserted; INCOMPLETE —there was an error acquiring the node child resource (for example an EC2 instance with no EBS volumes due to missing permissions), but the node was upserted.
OK; DELETED; ERROR; INCOMPLETE

AWS resource fields

AttributeTypeDescriptionExamples
aws.objectstringstable
Display name: AWS object
The full JSON content of any AWS object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}
aws.properties.versionstringexperimental
Display name: AWS properties version
The aws.object JSON content version
1.0
aws.regionstringresource stable
Display name: AWS region
A specific geographical AWS Cloud location.
Tags: primary-field
us-east-1
aws.account.idstringresource stable
Display name: AWS account ID
The 12-digit number, such as 123456789012, that uniquely identifies an AWS account.
Tags: permission primary-field
123456789012
aws.servicestringresource experimental
Display name: AWS service
The service that identifies the AWS product.
s3
aws.resource.typestringresource experimental
Display name: AWS resource type
The AWS resource type associated with the telemetry signal or Smartscape entity, in AWS CloudFormation format.
AWS::EC2::Instance; AWS::S3::Bucket; AWS::Lambda::Function
aws.resource.idstringresource stable
Display name: AWS resource ID
Unique, immutable identifier assigned to the AWS cloud resource.
i-0922cda4579db3a45
aws.resource.namestringresource stable
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.arnstringresource stable
Display name: AWS ARN
Amazon Resource Name (ARN) of the AWS resource associated with the telemetry signal or Smartscape entity.
arn:aws:lambda:us-east-1:478983378254:function:acceptanceWeatherBackend
cloud.providerstringresource stable
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.

ValueDescriptionDisplay name
alibaba_cloudAlibaba CloudAlibaba Cloud
awsAmazon Web ServicesAWS
azureMicrosoft AzureAzure
gcpGoogle Cloud PlatformGCP
herokuHeroku Platform as a ServiceHeroku
ibm_cloudIBM CloudIBM Cloud
tencent_cloudTencent CloudTencent Cloud

Amazon API Gateway stage relationships

TypeTarget typeKindDescription
is_attached_toAWS_APIGATEWAY_RESTAPIstaticstable
Is (typically) exclusively attached to the instance (1-many)

Amazon API Gateway v2 API (HTTP or WebSocket)

Smartscape node name: aws.resource.name

Smartscape node type: AWS_APIGATEWAYV2_API

This entity represents an Amazon API Gateway v2 API (HTTP or WebSocket).

Query

Fetch all Smartscape nodes from the smartscape.nodes table and filter for the entity type "AWS_APIGATEWAYV2_API"

smartscapeNodes "AWS_APIGATEWAYV2_API"

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.

AttributeTypeDescriptionExamples
idsmartscapeIdstable
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_classicstringdeprecated
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
namestringstable
Display name: Name
The entity name.
localhost; easyTravel; product-catalog
typestringstable
Display name: Type
The entity type. UPPER_SNAKE_CASE string that represents the type of the entity.
Tags: permission
TYPE_A
tagsrecordstable
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.
tags[tag_key-1] = [context_A_tag_val-1, context_B_tag_val-1]; tags[tag_key-2] = context_C_tag_val-1; tags:context_A[tag_key-1] = context_A_tag_val-1
lifetimetimeframestable
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.
{ start: 2022-07-06T13:36:00.808Z, end: 2024-04-11T06:56:01.204Z }
referencesrecordstable
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.
{ references[runs_on.host] : [HOST-C251A1173C2B4B39,HOST-0E9038C7C4409D69], references[runs_on.container] : [CONTAINER-68A08967EF4F675B] }
dt.security_contextstring[]resource stable
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.

AttributeTypeDescriptionExamples
cloud.acquisition.statusstringexperimental
Display name: Cloud acquisition status
The status of Smartscape nodes data acquisition by Data Acquisition Controller: OK —node is consistent; DELETED —node was deleted in the cloud platform; ERROR —there was an error acquiring the node, but the node was upserted; INCOMPLETE —there was an error acquiring the node child resource (for example an EC2 instance with no EBS volumes due to missing permissions), but the node was upserted.
OK; DELETED; ERROR; INCOMPLETE

AWS resource fields

AttributeTypeDescriptionExamples
aws.objectstringstable
Display name: AWS object
The full JSON content of any AWS object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}
aws.properties.versionstringexperimental
Display name: AWS properties version
The aws.object JSON content version
1.0
aws.regionstringresource stable
Display name: AWS region
A specific geographical AWS Cloud location.
Tags: primary-field
us-east-1
aws.account.idstringresource stable
Display name: AWS account ID
The 12-digit number, such as 123456789012, that uniquely identifies an AWS account.
Tags: permission primary-field
123456789012
aws.servicestringresource experimental
Display name: AWS service
The service that identifies the AWS product.
s3
aws.resource.typestringresource experimental
Display name: AWS resource type
The AWS resource type associated with the telemetry signal or Smartscape entity, in AWS CloudFormation format.
AWS::EC2::Instance; AWS::S3::Bucket; AWS::Lambda::Function
aws.resource.idstringresource stable
Display name: AWS resource ID
Unique, immutable identifier assigned to the AWS cloud resource.
i-0922cda4579db3a45
aws.resource.namestringresource stable
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.arnstringresource stable
Display name: AWS ARN
Amazon Resource Name (ARN) of the AWS resource associated with the telemetry signal or Smartscape entity.
arn:aws:lambda:us-east-1:478983378254:function:acceptanceWeatherBackend
cloud.providerstringresource stable
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.

ValueDescriptionDisplay name
alibaba_cloudAlibaba CloudAlibaba Cloud
awsAmazon Web ServicesAWS
azureMicrosoft AzureAzure
gcpGoogle Cloud PlatformGCP
herokuHeroku Platform as a ServiceHeroku
ibm_cloudIBM CloudIBM Cloud
tencent_cloudTencent CloudTencent Cloud

Amazon API Gateway v2 VPC link

Smartscape node name: aws.resource.name

Smartscape node type: AWS_APIGATEWAYV2_VPCLINK

This entity represents an Amazon API Gateway v2 VPC link.

Query

Fetch all Smartscape nodes from the smartscape.nodes table and filter for the entity type "AWS_APIGATEWAYV2_VPCLINK"

smartscapeNodes "AWS_APIGATEWAYV2_VPCLINK"

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.

AttributeTypeDescriptionExamples
idsmartscapeIdstable
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_classicstringdeprecated
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
namestringstable
Display name: Name
The entity name.
localhost; easyTravel; product-catalog
typestringstable
Display name: Type
The entity type. UPPER_SNAKE_CASE string that represents the type of the entity.
Tags: permission
TYPE_A
tagsrecordstable
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.
tags[tag_key-1] = [context_A_tag_val-1, context_B_tag_val-1]; tags[tag_key-2] = context_C_tag_val-1; tags:context_A[tag_key-1] = context_A_tag_val-1
lifetimetimeframestable
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.
{ start: 2022-07-06T13:36:00.808Z, end: 2024-04-11T06:56:01.204Z }
referencesrecordstable
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.
{ references[runs_on.host] : [HOST-C251A1173C2B4B39,HOST-0E9038C7C4409D69], references[runs_on.container] : [CONTAINER-68A08967EF4F675B] }
dt.security_contextstring[]resource stable
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.

AttributeTypeDescriptionExamples
cloud.acquisition.statusstringexperimental
Display name: Cloud acquisition status
The status of Smartscape nodes data acquisition by Data Acquisition Controller: OK —node is consistent; DELETED —node was deleted in the cloud platform; ERROR —there was an error acquiring the node, but the node was upserted; INCOMPLETE —there was an error acquiring the node child resource (for example an EC2 instance with no EBS volumes due to missing permissions), but the node was upserted.
OK; DELETED; ERROR; INCOMPLETE

AWS resource fields

AttributeTypeDescriptionExamples
aws.objectstringstable
Display name: AWS object
The full JSON content of any AWS object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}
aws.properties.versionstringexperimental
Display name: AWS properties version
The aws.object JSON content version
1.0
aws.regionstringresource stable
Display name: AWS region
A specific geographical AWS Cloud location.
Tags: primary-field
us-east-1
aws.account.idstringresource stable
Display name: AWS account ID
The 12-digit number, such as 123456789012, that uniquely identifies an AWS account.
Tags: permission primary-field
123456789012
aws.servicestringresource experimental
Display name: AWS service
The service that identifies the AWS product.
s3
aws.resource.typestringresource experimental
Display name: AWS resource type
The AWS resource type associated with the telemetry signal or Smartscape entity, in AWS CloudFormation format.
AWS::EC2::Instance; AWS::S3::Bucket; AWS::Lambda::Function
aws.resource.idstringresource stable
Display name: AWS resource ID
Unique, immutable identifier assigned to the AWS cloud resource.
i-0922cda4579db3a45
aws.resource.namestringresource stable
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.arnstringresource stable
Display name: AWS ARN
Amazon Resource Name (ARN) of the AWS resource associated with the telemetry signal or Smartscape entity.
arn:aws:lambda:us-east-1:478983378254:function:acceptanceWeatherBackend
cloud.providerstringresource stable
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.

ValueDescriptionDisplay name
alibaba_cloudAlibaba CloudAlibaba Cloud
awsAmazon Web ServicesAWS
azureMicrosoft AzureAzure
gcpGoogle Cloud PlatformGCP
herokuHeroku Platform as a ServiceHeroku
ibm_cloudIBM CloudIBM Cloud
tencent_cloudTencent CloudTencent Cloud

AWS state fields

Contains all fields that are provided by AWS entities that report state.

AttributeTypeDescriptionExamples
aws.statestringexperimental
Display name: AWS state
The operational state of the AWS resource. This attribute value depends on the specific resource type.
running; stopped; in-use; attached; detached; enabled; disabled; error

Amazon API Gateway v2 VPC link relationships

TypeTarget typeKindDescription
is_attached_toAWS_EC2_SUBNETstaticstable
Is (typically) exclusively attached to the instance (1-many)
usesAWS_EC2_SECURITYGROUPstaticstable
Similar to is_attached_to but in the opposite direction. Examples: EC2 Instance uses DHCP options, Auto Scaling Group uses EC2 Launch Template

Amazon API Gateway v2 authorizer

Smartscape node name: aws.resource.name

Smartscape node type: AWS_APIGATEWAYV2_AUTHORIZER

This entity represents an Amazon API Gateway v2 authorizer.

Query

Fetch all Smartscape nodes from the smartscape.nodes table and filter for the entity type "AWS_APIGATEWAYV2_AUTHORIZER"

smartscapeNodes "AWS_APIGATEWAYV2_AUTHORIZER"

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.

AttributeTypeDescriptionExamples
idsmartscapeIdstable
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_classicstringdeprecated
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
namestringstable
Display name: Name
The entity name.
localhost; easyTravel; product-catalog
typestringstable
Display name: Type
The entity type. UPPER_SNAKE_CASE string that represents the type of the entity.
Tags: permission
TYPE_A
tagsrecordstable
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.
tags[tag_key-1] = [context_A_tag_val-1, context_B_tag_val-1]; tags[tag_key-2] = context_C_tag_val-1; tags:context_A[tag_key-1] = context_A_tag_val-1
lifetimetimeframestable
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.
{ start: 2022-07-06T13:36:00.808Z, end: 2024-04-11T06:56:01.204Z }
referencesrecordstable
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.
{ references[runs_on.host] : [HOST-C251A1173C2B4B39,HOST-0E9038C7C4409D69], references[runs_on.container] : [CONTAINER-68A08967EF4F675B] }
dt.security_contextstring[]resource stable
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.

AttributeTypeDescriptionExamples
cloud.acquisition.statusstringexperimental
Display name: Cloud acquisition status
The status of Smartscape nodes data acquisition by Data Acquisition Controller: OK —node is consistent; DELETED —node was deleted in the cloud platform; ERROR —there was an error acquiring the node, but the node was upserted; INCOMPLETE —there was an error acquiring the node child resource (for example an EC2 instance with no EBS volumes due to missing permissions), but the node was upserted.
OK; DELETED; ERROR; INCOMPLETE

AWS resource fields

AttributeTypeDescriptionExamples
aws.objectstringstable
Display name: AWS object
The full JSON content of any AWS object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}
aws.properties.versionstringexperimental
Display name: AWS properties version
The aws.object JSON content version
1.0
aws.regionstringresource stable
Display name: AWS region
A specific geographical AWS Cloud location.
Tags: primary-field
us-east-1
aws.account.idstringresource stable
Display name: AWS account ID
The 12-digit number, such as 123456789012, that uniquely identifies an AWS account.
Tags: permission primary-field
123456789012
aws.servicestringresource experimental
Display name: AWS service
The service that identifies the AWS product.
s3
aws.resource.typestringresource experimental
Display name: AWS resource type
The AWS resource type associated with the telemetry signal or Smartscape entity, in AWS CloudFormation format.
AWS::EC2::Instance; AWS::S3::Bucket; AWS::Lambda::Function
aws.resource.idstringresource stable
Display name: AWS resource ID
Unique, immutable identifier assigned to the AWS cloud resource.
i-0922cda4579db3a45
aws.resource.namestringresource stable
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.arnstringresource stable
Display name: AWS ARN
Amazon Resource Name (ARN) of the AWS resource associated with the telemetry signal or Smartscape entity.
arn:aws:lambda:us-east-1:478983378254:function:acceptanceWeatherBackend
cloud.providerstringresource stable
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.

ValueDescriptionDisplay name
alibaba_cloudAlibaba CloudAlibaba Cloud
awsAmazon Web ServicesAWS
azureMicrosoft AzureAzure
gcpGoogle Cloud PlatformGCP
herokuHeroku Platform as a ServiceHeroku
ibm_cloudIBM CloudIBM Cloud
tencent_cloudTencent CloudTencent Cloud

Amazon API Gateway v2 authorizer relationships

TypeTarget typeKindDescription
is_attached_toAWS_APIGATEWAYV2_APIstaticstable
Is (typically) exclusively attached to the instance (1-many)
usesAWS_LAMBDA_FUNCTIONstaticstable
Similar to is_attached_to but in the opposite direction. Examples: EC2 Instance uses DHCP options, Auto Scaling Group uses EC2 Launch Template

Amazon API Gateway v2 integration

Smartscape node name: aws.resource.name

Smartscape node type: AWS_APIGATEWAYV2_INTEGRATION

This entity represents an Amazon API Gateway v2 integration.

Query

Fetch all Smartscape nodes from the smartscape.nodes table and filter for the entity type "AWS_APIGATEWAYV2_INTEGRATION"

smartscapeNodes "AWS_APIGATEWAYV2_INTEGRATION"

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.

AttributeTypeDescriptionExamples
idsmartscapeIdstable
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_classicstringdeprecated
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
namestringstable
Display name: Name
The entity name.
localhost; easyTravel; product-catalog
typestringstable
Display name: Type
The entity type. UPPER_SNAKE_CASE string that represents the type of the entity.
Tags: permission
TYPE_A
tagsrecordstable
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.
tags[tag_key-1] = [context_A_tag_val-1, context_B_tag_val-1]; tags[tag_key-2] = context_C_tag_val-1; tags:context_A[tag_key-1] = context_A_tag_val-1
lifetimetimeframestable
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.
{ start: 2022-07-06T13:36:00.808Z, end: 2024-04-11T06:56:01.204Z }
referencesrecordstable
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.
{ references[runs_on.host] : [HOST-C251A1173C2B4B39,HOST-0E9038C7C4409D69], references[runs_on.container] : [CONTAINER-68A08967EF4F675B] }
dt.security_contextstring[]resource stable
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.

AttributeTypeDescriptionExamples
cloud.acquisition.statusstringexperimental
Display name: Cloud acquisition status
The status of Smartscape nodes data acquisition by Data Acquisition Controller: OK —node is consistent; DELETED —node was deleted in the cloud platform; ERROR —there was an error acquiring the node, but the node was upserted; INCOMPLETE —there was an error acquiring the node child resource (for example an EC2 instance with no EBS volumes due to missing permissions), but the node was upserted.
OK; DELETED; ERROR; INCOMPLETE

AWS resource fields

AttributeTypeDescriptionExamples
aws.objectstringstable
Display name: AWS object
The full JSON content of any AWS object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}
aws.properties.versionstringexperimental
Display name: AWS properties version
The aws.object JSON content version
1.0
aws.regionstringresource stable
Display name: AWS region
A specific geographical AWS Cloud location.
Tags: primary-field
us-east-1
aws.account.idstringresource stable
Display name: AWS account ID
The 12-digit number, such as 123456789012, that uniquely identifies an AWS account.
Tags: permission primary-field
123456789012
aws.servicestringresource experimental
Display name: AWS service
The service that identifies the AWS product.
s3
aws.resource.typestringresource experimental
Display name: AWS resource type
The AWS resource type associated with the telemetry signal or Smartscape entity, in AWS CloudFormation format.
AWS::EC2::Instance; AWS::S3::Bucket; AWS::Lambda::Function
aws.resource.idstringresource stable
Display name: AWS resource ID
Unique, immutable identifier assigned to the AWS cloud resource.
i-0922cda4579db3a45
aws.resource.namestringresource stable
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.arnstringresource stable
Display name: AWS ARN
Amazon Resource Name (ARN) of the AWS resource associated with the telemetry signal or Smartscape entity.
arn:aws:lambda:us-east-1:478983378254:function:acceptanceWeatherBackend
cloud.providerstringresource stable
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.

ValueDescriptionDisplay name
alibaba_cloudAlibaba CloudAlibaba Cloud
awsAmazon Web ServicesAWS
azureMicrosoft AzureAzure
gcpGoogle Cloud PlatformGCP
herokuHeroku Platform as a ServiceHeroku
ibm_cloudIBM CloudIBM Cloud
tencent_cloudTencent CloudTencent Cloud

Amazon API Gateway v2 integration relationships

TypeTarget typeKindDescription
is_attached_toAWS_APIGATEWAYV2_APIstaticstable
Is (typically) exclusively attached to the instance (1-many)
usesAWS_LAMBDA_FUNCTIONstaticstable
Similar to is_attached_to but in the opposite direction. Examples: EC2 Instance uses DHCP options, Auto Scaling Group uses EC2 Launch Template
usesAWS_APIGATEWAYV2_VPCLINKstaticstable
Similar to is_attached_to but in the opposite direction. Examples: EC2 Instance uses DHCP options, Auto Scaling Group uses EC2 Launch Template

Amazon API Gateway v2 stage (HTTP or WebSocket)

Smartscape node name: aws.resource.name

Smartscape node type: AWS_APIGATEWAYV2_STAGE

This entity represents an Amazon API Gateway v2 stage (HTTP or WebSocket), which is a named reference to a deployment of the API.

Query

Fetch all Smartscape nodes from the smartscape.nodes table and filter for the entity type "AWS_APIGATEWAYV2_STAGE"

smartscapeNodes "AWS_APIGATEWAYV2_STAGE"

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.

AttributeTypeDescriptionExamples
idsmartscapeIdstable
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_classicstringdeprecated
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
namestringstable
Display name: Name
The entity name.
localhost; easyTravel; product-catalog
typestringstable
Display name: Type
The entity type. UPPER_SNAKE_CASE string that represents the type of the entity.
Tags: permission
TYPE_A
tagsrecordstable
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.
tags[tag_key-1] = [context_A_tag_val-1, context_B_tag_val-1]; tags[tag_key-2] = context_C_tag_val-1; tags:context_A[tag_key-1] = context_A_tag_val-1
lifetimetimeframestable
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.
{ start: 2022-07-06T13:36:00.808Z, end: 2024-04-11T06:56:01.204Z }
referencesrecordstable
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.
{ references[runs_on.host] : [HOST-C251A1173C2B4B39,HOST-0E9038C7C4409D69], references[runs_on.container] : [CONTAINER-68A08967EF4F675B] }
dt.security_contextstring[]resource stable
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.

AttributeTypeDescriptionExamples
cloud.acquisition.statusstringexperimental
Display name: Cloud acquisition status
The status of Smartscape nodes data acquisition by Data Acquisition Controller: OK —node is consistent; DELETED —node was deleted in the cloud platform; ERROR —there was an error acquiring the node, but the node was upserted; INCOMPLETE —there was an error acquiring the node child resource (for example an EC2 instance with no EBS volumes due to missing permissions), but the node was upserted.
OK; DELETED; ERROR; INCOMPLETE

AWS resource fields

AttributeTypeDescriptionExamples
aws.objectstringstable
Display name: AWS object
The full JSON content of any AWS object: {"configuration":{ <describe_resource_output> }, "supplementary_configuration": { <supplementary_resource_configuration> }}
aws.properties.versionstringexperimental
Display name: AWS properties version
The aws.object JSON content version
1.0
aws.regionstringresource stable
Display name: AWS region
A specific geographical AWS Cloud location.
Tags: primary-field
us-east-1
aws.account.idstringresource stable
Display name: AWS account ID
The 12-digit number, such as 123456789012, that uniquely identifies an AWS account.
Tags: permission primary-field
123456789012
aws.servicestringresource experimental
Display name: AWS service
The service that identifies the AWS product.
s3
aws.resource.typestringresource experimental
Display name: AWS resource type
The AWS resource type associated with the telemetry signal or Smartscape entity, in AWS CloudFormation format.
AWS::EC2::Instance; AWS::S3::Bucket; AWS::Lambda::Function
aws.resource.idstringresource stable
Display name: AWS resource ID
Unique, immutable identifier assigned to the AWS cloud resource.
i-0922cda4579db3a45
aws.resource.namestringresource stable
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.arnstringresource stable
Display name: AWS ARN
Amazon Resource Name (ARN) of the AWS resource associated with the telemetry signal or Smartscape entity.
arn:aws:lambda:us-east-1:478983378254:function:acceptanceWeatherBackend
cloud.providerstringresource stable
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.

ValueDescriptionDisplay name
alibaba_cloudAlibaba CloudAlibaba Cloud
awsAmazon Web ServicesAWS
azureMicrosoft AzureAzure
gcpGoogle Cloud PlatformGCP
herokuHeroku Platform as a ServiceHeroku
ibm_cloudIBM CloudIBM Cloud
tencent_cloudTencent CloudTencent Cloud

Amazon API Gateway v2 stage (HTTP or WebSocket) relationships

TypeTarget typeKindDescription
is_attached_toAWS_APIGATEWAYV2_APIstaticstable
Is (typically) exclusively attached to the instance (1-many)