data [required]
\n[object]
List of AWS Account Integration Configs.
attributes
\nobject
AWS Account response attributes.
account_tags
\n[string]
Tags to apply to all hosts and metrics reporting for this account. Defaults to [].
auth_config
\n<oneOf>
AWS Authentication config.
Option 1
\nobject
AWS Authentication config to integrate your account using an access key pair.
access_key_id [required]
\nstring
AWS Access Key ID.
secret_access_key
\nstring
AWS Secret Access Key.
Option 2
\nobject
AWS Authentication config to integrate your account using an IAM role.
external_id
\nstring
AWS IAM External ID for associated role.
role_name [required]
\nstring
AWS IAM Role name.
aws_account_id [required]
\nstring
AWS Account ID.
aws_partition
\nenum
AWS partition your AWS account is scoped to. Defaults to aws.\nSee Partitions\nin the AWS documentation for more information. \nAllowed enum values: aws,aws-cn,aws-us-gov
aws_regions
\n<oneOf>
AWS Regions to collect data from. Defaults to include_all.
Option 1
\nobject
Include all regions. Defaults to true.
include_all [required]
\nboolean
Include all regions.
Option 2
\nobject
Include only these regions.
include_only [required]
\n[string]
Include only these regions.
created_at
\ndate-time
Timestamp of when the account integration was created.
logs_config
\nobject
AWS Logs Collection config.
lambda_forwarder
\nobject
Log Autosubscription configuration for Datadog Forwarder Lambda functions.\nAutomatically set up triggers for existing and new logs for some services,\nensuring no logs from new resources are missed and saving time spent on manual configuration.
lambdas
\n[string]
List of Datadog Lambda Log Forwarder ARNs in your AWS account. Defaults to [].
log_source_config
\nobject
Log source configuration.
tag_filters
\n[object]
List of AWS log source tag filters. Defaults to [].
source
\nstring
The AWS log source to which the tag filters defined in tags are applied.
tags
\n[string]
The AWS resource tags to filter on for the log source specified by source.
sources
\n[string]
List of service IDs set to enable automatic log collection.\nDiscover the list of available services with the\nGet list of AWS log ready\nservices\nendpoint.
metrics_config
\nobject
AWS Metrics Collection config.
automute_enabled
\nboolean
Enable EC2 automute for AWS metrics. Defaults to true.
collect_cloudwatch_alarms
\nboolean
Enable CloudWatch alarms collection. Defaults to false.
collect_custom_metrics
\nboolean
Enable custom metrics collection. Defaults to false.
enabled
\nboolean
Enable AWS metrics collection. Defaults to true.
metric_name_filters
\n[ <oneOf>]
AWS CloudWatch metric name filters. Each filter applies to a single namespace.\nExactly one of include_only or exclude_only must be set on each filter.
Option 1
\nobject
Include only metric names matching one of these patterns for a single namespace.
include_only [required]
\n[string]
Include only metric names matching one of these patterns.
namespace [required]
\nstring
The AWS CloudWatch namespace to which this metric name filter applies.
Option 2
\nobject
Exclude metric names matching one of these patterns for a single namespace.
exclude_only [required]
\n[string]
Exclude metric names matching one of these patterns.
namespace [required]
\nstring
The AWS CloudWatch namespace to which this metric name filter applies.
namespace_filters
\n<oneOf>
AWS Metrics namespace filters. Defaults to exclude_only.
Option 1
\nobject
Exclude only these namespaces from metrics collection.\nDefaults to ["AWS/SQS", "AWS/ElasticMapReduce", "AWS/Usage"].\nAWS/SQS, AWS/ElasticMapReduce, and AWS/Usage are excluded by default\nto reduce your AWS CloudWatch costs from GetMetricData API calls.
exclude_only [required]
\n[string]
Exclude only these namespaces from metrics collection.\nDefaults to ["AWS/SQS", "AWS/ElasticMapReduce", "AWS/Usage"].\nAWS/SQS, AWS/ElasticMapReduce, and AWS/Usage are excluded by default\nto reduce your AWS CloudWatch costs from GetMetricData API calls.
Option 2
\nobject
Include only these namespaces.
include_only [required]
\n[string]
Include only these namespaces.
tag_filters
\n[object]
AWS Metrics collection tag filters list. Defaults to [].
namespace
\nstring
The AWS service for which the tag filters defined in tags will be applied.
tags
\n[string]
The AWS resource tags to filter on for the service specified by namespace.
modified_at
\ndate-time
Timestamp of when the account integration was updated.
resources_config
\nobject
AWS Resources Collection config.
cloud_security_posture_management_collection
\nboolean
Enable Cloud Security Management to scan AWS resources for vulnerabilities, misconfigurations,\nidentity risks, and compliance violations. Defaults to false.\nRequires extended_collection to be set to true.
extended_collection
\nboolean
Whether Datadog collects additional attributes and configuration information about the resources\nin your AWS account. Defaults to true. Required for cloud_security_posture_management_collection.
traces_config
\nobject
AWS Traces Collection config.
xray_services
\n<oneOf>
AWS X-Ray services to collect traces from. Defaults to include_only.
Option 1
\nobject
Include all services.
include_all [required]
\nboolean
Include all services.
Option 2
\nobject
Include only these services. Defaults to [].
include_only [required]
\n[string]
Include only these services.
id [required]
\nstring
Unique Datadog ID of the AWS Account Integration Config.\nTo get the config ID for an account, use the\nList all AWS integrations\nendpoint and query by AWS Account ID.
type [required]
\nenum
AWS Account resource type. \nAllowed enum values: account
default: account
data [required]
\n[object]
List of AWS Account Integration Configs.
attributes
\nobject
AWS Account response attributes.
account_tags
\n[string]
Tags to apply to all hosts and metrics reporting for this account. Defaults to [].
auth_config
\n<oneOf>
AWS Authentication config.
Option 1
\nobject
AWS Authentication config to integrate your account using an access key pair.
access_key_id [required]
\nstring
AWS Access Key ID.
secret_access_key
\nstring
AWS Secret Access Key.
Option 2
\nobject
AWS Authentication config to integrate your account using an IAM role.
external_id
\nstring
AWS IAM External ID for associated role.
role_name [required]
\nstring
AWS IAM Role name.
aws_account_id [required]
\nstring
AWS Account ID.
aws_partition
\nenum
AWS partition your AWS account is scoped to. Defaults to aws.\nSee Partitions\nin the AWS documentation for more information. \nAllowed enum values: aws,aws-cn,aws-us-gov
aws_regions
\n<oneOf>
AWS Regions to collect data from. Defaults to include_all.
Option 1
\nobject
Include all regions. Defaults to true.
include_all [required]
\nboolean
Include all regions.
Option 2
\nobject
Include only these regions.
include_only [required]
\n[string]
Include only these regions.
created_at
\ndate-time
Timestamp of when the account integration was created.
logs_config
\nobject
AWS Logs Collection config.
lambda_forwarder
\nobject
Log Autosubscription configuration for Datadog Forwarder Lambda functions.\nAutomatically set up triggers for existing and new logs for some services,\nensuring no logs from new resources are missed and saving time spent on manual configuration.
lambdas
\n[string]
List of Datadog Lambda Log Forwarder ARNs in your AWS account. Defaults to [].
log_source_config
\nobject
Log source configuration.
tag_filters
\n[object]
List of AWS log source tag filters. Defaults to [].
source
\nstring
The AWS log source to which the tag filters defined in tags are applied.
tags
\n[string]
The AWS resource tags to filter on for the log source specified by source.
sources
\n[string]
List of service IDs set to enable automatic log collection.\nDiscover the list of available services with the\nGet list of AWS log ready\nservices\nendpoint.
metrics_config
\nobject
AWS Metrics Collection config.
automute_enabled
\nboolean
Enable EC2 automute for AWS metrics. Defaults to true.
collect_cloudwatch_alarms
\nboolean
Enable CloudWatch alarms collection. Defaults to false.
collect_custom_metrics
\nboolean
Enable custom metrics collection. Defaults to false.
enabled
\nboolean
Enable AWS metrics collection. Defaults to true.
namespace_filters
\n<oneOf>
AWS Metrics namespace filters. Defaults to exclude_only.
Option 1
\nobject
Exclude only these namespaces from metrics collection.\nDefaults to ["AWS/SQS", "AWS/ElasticMapReduce", "AWS/Usage"].\nAWS/SQS, AWS/ElasticMapReduce, and AWS/Usage are excluded by default\nto reduce your AWS CloudWatch costs from GetMetricData API calls.
exclude_only [required]
\n[string]
Exclude only these namespaces from metrics collection.\nDefaults to ["AWS/SQS", "AWS/ElasticMapReduce", "AWS/Usage"].\nAWS/SQS, AWS/ElasticMapReduce, and AWS/Usage are excluded by default\nto reduce your AWS CloudWatch costs from GetMetricData API calls.
Option 2
\nobject
Include only these namespaces.
include_only [required]
\n[string]
Include only these namespaces.
tag_filters
\n[object]
AWS Metrics collection tag filters list. Defaults to [].
namespace
\nstring
The AWS service for which the tag filters defined in tags will be applied.
tags
\n[string]
The AWS resource tags to filter on for the service specified by namespace.
modified_at
\ndate-time
Timestamp of when the account integration was updated.
resources_config
\nobject
AWS Resources Collection config.
cloud_security_posture_management_collection
\nboolean
Enable Cloud Security Management to scan AWS resources for vulnerabilities, misconfigurations,\nidentity risks, and compliance violations. Defaults to false.\nRequires extended_collection to be set to true.
extended_collection
\nboolean
Whether Datadog collects additional attributes and configuration information about the resources\nin your AWS account. Defaults to true. Required for cloud_security_posture_management_collection.
traces_config
\nobject
AWS Traces Collection config.
xray_services
\n<oneOf>
AWS X-Ray services to collect traces from. Defaults to include_only.
Option 1
\nobject
Include all services.
include_all [required]
\nboolean
Include all services.
Option 2
\nobject
Include only these services. Defaults to [].
include_only [required]
\n[string]
Include only these services.
id [required]
\nstring
Unique Datadog ID of the AWS Account Integration Config.\nTo get the config ID for an account, use the\nList all AWS integrations\nendpoint and query by AWS Account ID.
type [required]
\nenum
AWS Account resource type. \nAllowed enum values: account
default: account
data [required]
\nobject
AWS Account response data.
attributes
\nobject
AWS Account response attributes.
account_tags
\n[string]
Tags to apply to all hosts and metrics reporting for this account. Defaults to [].
auth_config
\n<oneOf>
AWS Authentication config.
Option 1
\nobject
AWS Authentication config to integrate your account using an access key pair.
access_key_id [required]
\nstring
AWS Access Key ID.
secret_access_key
\nstring
AWS Secret Access Key.
Option 2
\nobject
AWS Authentication config to integrate your account using an IAM role.
external_id
\nstring
AWS IAM External ID for associated role.
role_name [required]
\nstring
AWS IAM Role name.
aws_account_id [required]
\nstring
AWS Account ID.
aws_partition
\nenum
AWS partition your AWS account is scoped to. Defaults to aws.\nSee Partitions\nin the AWS documentation for more information. \nAllowed enum values: aws,aws-cn,aws-us-gov
aws_regions
\n<oneOf>
AWS Regions to collect data from. Defaults to include_all.
Option 1
\nobject
Include all regions. Defaults to true.
include_all [required]
\nboolean
Include all regions.
Option 2
\nobject
Include only these regions.
include_only [required]
\n[string]
Include only these regions.
created_at
\ndate-time
Timestamp of when the account integration was created.
logs_config
\nobject
AWS Logs Collection config.
lambda_forwarder
\nobject
Log Autosubscription configuration for Datadog Forwarder Lambda functions.\nAutomatically set up triggers for existing and new logs for some services,\nensuring no logs from new resources are missed and saving time spent on manual configuration.
lambdas
\n[string]
List of Datadog Lambda Log Forwarder ARNs in your AWS account. Defaults to [].
log_source_config
\nobject
Log source configuration.
tag_filters
\n[object]
List of AWS log source tag filters. Defaults to [].
source
\nstring
The AWS log source to which the tag filters defined in tags are applied.
tags
\n[string]
The AWS resource tags to filter on for the log source specified by source.
sources
\n[string]
List of service IDs set to enable automatic log collection.\nDiscover the list of available services with the\nGet list of AWS log ready\nservices\nendpoint.
metrics_config
\nobject
AWS Metrics Collection config.
automute_enabled
\nboolean
Enable EC2 automute for AWS metrics. Defaults to true.
collect_cloudwatch_alarms
\nboolean
Enable CloudWatch alarms collection. Defaults to false.
collect_custom_metrics
\nboolean
Enable custom metrics collection. Defaults to false.
enabled
\nboolean
Enable AWS metrics collection. Defaults to true.
metric_name_filters
\n[ <oneOf>]
AWS CloudWatch metric name filters. Each filter applies to a single namespace.\nExactly one of include_only or exclude_only must be set on each filter.
Option 1
\nobject
Include only metric names matching one of these patterns for a single namespace.
include_only [required]
\n[string]
Include only metric names matching one of these patterns.
namespace [required]
\nstring
The AWS CloudWatch namespace to which this metric name filter applies.
Option 2
\nobject
Exclude metric names matching one of these patterns for a single namespace.
exclude_only [required]
\n[string]
Exclude metric names matching one of these patterns.
namespace [required]
\nstring
The AWS CloudWatch namespace to which this metric name filter applies.
namespace_filters
\n<oneOf>
AWS Metrics namespace filters. Defaults to exclude_only.
Option 1
\nobject
Exclude only these namespaces from metrics collection.\nDefaults to ["AWS/SQS", "AWS/ElasticMapReduce", "AWS/Usage"].\nAWS/SQS, AWS/ElasticMapReduce, and AWS/Usage are excluded by default\nto reduce your AWS CloudWatch costs from GetMetricData API calls.
exclude_only [required]
\n[string]
Exclude only these namespaces from metrics collection.\nDefaults to ["AWS/SQS", "AWS/ElasticMapReduce", "AWS/Usage"].\nAWS/SQS, AWS/ElasticMapReduce, and AWS/Usage are excluded by default\nto reduce your AWS CloudWatch costs from GetMetricData API calls.
Option 2
\nobject
Include only these namespaces.
include_only [required]
\n[string]
Include only these namespaces.
tag_filters
\n[object]
AWS Metrics collection tag filters list. Defaults to [].
namespace
\nstring
The AWS service for which the tag filters defined in tags will be applied.
tags
\n[string]
The AWS resource tags to filter on for the service specified by namespace.
modified_at
\ndate-time
Timestamp of when the account integration was updated.
resources_config
\nobject
AWS Resources Collection config.
cloud_security_posture_management_collection
\nboolean
Enable Cloud Security Management to scan AWS resources for vulnerabilities, misconfigurations,\nidentity risks, and compliance violations. Defaults to false.\nRequires extended_collection to be set to true.
extended_collection
\nboolean
Whether Datadog collects additional attributes and configuration information about the resources\nin your AWS account. Defaults to true. Required for cloud_security_posture_management_collection.
traces_config
\nobject
AWS Traces Collection config.
xray_services
\n<oneOf>
AWS X-Ray services to collect traces from. Defaults to include_only.
Option 1
\nobject
Include all services.
include_all [required]
\nboolean
Include all services.
Option 2
\nobject
Include only these services. Defaults to [].
include_only [required]
\n[string]
Include only these services.
id [required]
\nstring
Unique Datadog ID of the AWS Account Integration Config.\nTo get the config ID for an account, use the\nList all AWS integrations\nendpoint and query by AWS Account ID.
type [required]
\nenum
AWS Account resource type. \nAllowed enum values: account
default: account
data [required]
\nobject
AWS Account response data.
attributes
\nobject
AWS Account response attributes.
account_tags
\n[string]
Tags to apply to all hosts and metrics reporting for this account. Defaults to [].
auth_config
\n<oneOf>
AWS Authentication config.
Option 1
\nobject
AWS Authentication config to integrate your account using an access key pair.
access_key_id [required]
\nstring
AWS Access Key ID.
secret_access_key
\nstring
AWS Secret Access Key.
Option 2
\nobject
AWS Authentication config to integrate your account using an IAM role.
external_id
\nstring
AWS IAM External ID for associated role.
role_name [required]
\nstring
AWS IAM Role name.
aws_account_id [required]
\nstring
AWS Account ID.
aws_partition
\nenum
AWS partition your AWS account is scoped to. Defaults to aws.\nSee Partitions\nin the AWS documentation for more information. \nAllowed enum values: aws,aws-cn,aws-us-gov
aws_regions
\n<oneOf>
AWS Regions to collect data from. Defaults to include_all.
Option 1
\nobject
Include all regions. Defaults to true.
include_all [required]
\nboolean
Include all regions.
Option 2
\nobject
Include only these regions.
include_only [required]
\n[string]
Include only these regions.
created_at
\ndate-time
Timestamp of when the account integration was created.
logs_config
\nobject
AWS Logs Collection config.
lambda_forwarder
\nobject
Log Autosubscription configuration for Datadog Forwarder Lambda functions.\nAutomatically set up triggers for existing and new logs for some services,\nensuring no logs from new resources are missed and saving time spent on manual configuration.
lambdas
\n[string]
List of Datadog Lambda Log Forwarder ARNs in your AWS account. Defaults to [].
log_source_config
\nobject
Log source configuration.
tag_filters
\n[object]
List of AWS log source tag filters. Defaults to [].
source
\nstring
The AWS log source to which the tag filters defined in tags are applied.
tags
\n[string]
The AWS resource tags to filter on for the log source specified by source.
sources
\n[string]
List of service IDs set to enable automatic log collection.\nDiscover the list of available services with the\nGet list of AWS log ready\nservices\nendpoint.
metrics_config
\nobject
AWS Metrics Collection config.
automute_enabled
\nboolean
Enable EC2 automute for AWS metrics. Defaults to true.
collect_cloudwatch_alarms
\nboolean
Enable CloudWatch alarms collection. Defaults to false.
collect_custom_metrics
\nboolean
Enable custom metrics collection. Defaults to false.
enabled
\nboolean
Enable AWS metrics collection. Defaults to true.
namespace_filters
\n<oneOf>
AWS Metrics namespace filters. Defaults to exclude_only.
Option 1
\nobject
Exclude only these namespaces from metrics collection.\nDefaults to ["AWS/SQS", "AWS/ElasticMapReduce", "AWS/Usage"].\nAWS/SQS, AWS/ElasticMapReduce, and AWS/Usage are excluded by default\nto reduce your AWS CloudWatch costs from GetMetricData API calls.
exclude_only [required]
\n[string]
Exclude only these namespaces from metrics collection.\nDefaults to ["AWS/SQS", "AWS/ElasticMapReduce", "AWS/Usage"].\nAWS/SQS, AWS/ElasticMapReduce, and AWS/Usage are excluded by default\nto reduce your AWS CloudWatch costs from GetMetricData API calls.
Option 2
\nobject
Include only these namespaces.
include_only [required]
\n[string]
Include only these namespaces.
tag_filters
\n[object]
AWS Metrics collection tag filters list. Defaults to [].
namespace
\nstring
The AWS service for which the tag filters defined in tags will be applied.
tags
\n[string]
The AWS resource tags to filter on for the service specified by namespace.
modified_at
\ndate-time
Timestamp of when the account integration was updated.
resources_config
\nobject
AWS Resources Collection config.
cloud_security_posture_management_collection
\nboolean
Enable Cloud Security Management to scan AWS resources for vulnerabilities, misconfigurations,\nidentity risks, and compliance violations. Defaults to false.\nRequires extended_collection to be set to true.
extended_collection
\nboolean
Whether Datadog collects additional attributes and configuration information about the resources\nin your AWS account. Defaults to true. Required for cloud_security_posture_management_collection.
traces_config
\nobject
AWS Traces Collection config.
xray_services
\n<oneOf>
AWS X-Ray services to collect traces from. Defaults to include_only.
Option 1
\nobject
Include all services.
include_all [required]
\nboolean
Include all services.
Option 2
\nobject
Include only these services. Defaults to [].
include_only [required]
\n[string]
Include only these services.
id [required]
\nstring
Unique Datadog ID of the AWS Account Integration Config.\nTo get the config ID for an account, use the\nList all AWS integrations\nendpoint and query by AWS Account ID.
type [required]
\nenum
AWS Account resource type. \nAllowed enum values: account
default: account
data [required]
\nobject
AWS Account Create Request data.
attributes [required]
\nobject
The AWS Account Integration Config to be created.
account_tags
\n[string]
Tags to apply to all hosts and metrics reporting for this account. Defaults to [].
auth_config [required]
\n<oneOf>
AWS Authentication config.
Option 1
\nobject
AWS Authentication config to integrate your account using an access key pair.
access_key_id [required]
\nstring
AWS Access Key ID.
secret_access_key
\nstring
AWS Secret Access Key.
Option 2
\nobject
AWS Authentication config to integrate your account using an IAM role.
external_id
\nstring
AWS IAM External ID for associated role.
role_name [required]
\nstring
AWS IAM Role name.
aws_account_id [required]
\nstring
AWS Account ID.
aws_partition [required]
\nenum
AWS partition your AWS account is scoped to. Defaults to aws.\nSee Partitions\nin the AWS documentation for more information. \nAllowed enum values: aws,aws-cn,aws-us-gov
aws_regions
\n<oneOf>
AWS Regions to collect data from. Defaults to include_all.
Option 1
\nobject
Include all regions. Defaults to true.
include_all [required]
\nboolean
Include all regions.
Option 2
\nobject
Include only these regions.
include_only [required]
\n[string]
Include only these regions.
logs_config
\nobject
AWS Logs Collection config.
lambda_forwarder
\nobject
Log Autosubscription configuration for Datadog Forwarder Lambda functions.\nAutomatically set up triggers for existing and new logs for some services,\nensuring no logs from new resources are missed and saving time spent on manual configuration.
lambdas
\n[string]
List of Datadog Lambda Log Forwarder ARNs in your AWS account. Defaults to [].
log_source_config
\nobject
Log source configuration.
tag_filters
\n[object]
List of AWS log source tag filters. Defaults to [].
source
\nstring
The AWS log source to which the tag filters defined in tags are applied.
tags
\n[string]
The AWS resource tags to filter on for the log source specified by source.
sources
\n[string]
List of service IDs set to enable automatic log collection.\nDiscover the list of available services with the\nGet list of AWS log ready\nservices\nendpoint.
metrics_config
\nobject
AWS Metrics Collection config.
automute_enabled
\nboolean
Enable EC2 automute for AWS metrics. Defaults to true.
collect_cloudwatch_alarms
\nboolean
Enable CloudWatch alarms collection. Defaults to false.
collect_custom_metrics
\nboolean
Enable custom metrics collection. Defaults to false.
enabled
\nboolean
Enable AWS metrics collection. Defaults to true.
metric_name_filters
\n[ <oneOf>]
AWS CloudWatch metric name filters. Each filter applies to a single namespace.\nExactly one of include_only or exclude_only must be set on each filter.
Option 1
\nobject
Include only metric names matching one of these patterns for a single namespace.
include_only [required]
\n[string]
Include only metric names matching one of these patterns.
namespace [required]
\nstring
The AWS CloudWatch namespace to which this metric name filter applies.
Option 2
\nobject
Exclude metric names matching one of these patterns for a single namespace.
exclude_only [required]
\n[string]
Exclude metric names matching one of these patterns.
namespace [required]
\nstring
The AWS CloudWatch namespace to which this metric name filter applies.
namespace_filters
\n<oneOf>
AWS Metrics namespace filters. Defaults to exclude_only.
Option 1
\nobject
Exclude only these namespaces from metrics collection.\nDefaults to ["AWS/SQS", "AWS/ElasticMapReduce", "AWS/Usage"].\nAWS/SQS, AWS/ElasticMapReduce, and AWS/Usage are excluded by default\nto reduce your AWS CloudWatch costs from GetMetricData API calls.
exclude_only [required]
\n[string]
Exclude only these namespaces from metrics collection.\nDefaults to ["AWS/SQS", "AWS/ElasticMapReduce", "AWS/Usage"].\nAWS/SQS, AWS/ElasticMapReduce, and AWS/Usage are excluded by default\nto reduce your AWS CloudWatch costs from GetMetricData API calls.
Option 2
\nobject
Include only these namespaces.
include_only [required]
\n[string]
Include only these namespaces.
tag_filters
\n[object]
AWS Metrics collection tag filters list. Defaults to [].
namespace
\nstring
The AWS service for which the tag filters defined in tags will be applied.
tags
\n[string]
The AWS resource tags to filter on for the service specified by namespace.
resources_config
\nobject
AWS Resources Collection config.
cloud_security_posture_management_collection
\nboolean
Enable Cloud Security Management to scan AWS resources for vulnerabilities, misconfigurations,\nidentity risks, and compliance violations. Defaults to false.\nRequires extended_collection to be set to true.
extended_collection
\nboolean
Whether Datadog collects additional attributes and configuration information about the resources\nin your AWS account. Defaults to true. Required for cloud_security_posture_management_collection.
traces_config
\nobject
AWS Traces Collection config.
xray_services
\n<oneOf>
AWS X-Ray services to collect traces from. Defaults to include_only.
Option 1
\nobject
Include all services.
include_all [required]
\nboolean
Include all services.
Option 2
\nobject
Include only these services. Defaults to [].
include_only [required]
\n[string]
Include only these services.
type [required]
\nenum
AWS Account resource type. \nAllowed enum values: account
default: account
data [required]
\nobject
AWS Account Create Request data.
attributes [required]
\nobject
The AWS Account Integration Config to be created.
account_tags
\n[string]
Tags to apply to all hosts and metrics reporting for this account. Defaults to [].
auth_config [required]
\n<oneOf>
AWS Authentication config.
Option 1
\nobject
AWS Authentication config to integrate your account using an access key pair.
access_key_id [required]
\nstring
AWS Access Key ID.
secret_access_key
\nstring
AWS Secret Access Key.
Option 2
\nobject
AWS Authentication config to integrate your account using an IAM role.
external_id
\nstring
AWS IAM External ID for associated role.
role_name [required]
\nstring
AWS IAM Role name.
aws_account_id [required]
\nstring
AWS Account ID.
aws_partition [required]
\nenum
AWS partition your AWS account is scoped to. Defaults to aws.\nSee Partitions\nin the AWS documentation for more information. \nAllowed enum values: aws,aws-cn,aws-us-gov
aws_regions
\n<oneOf>
AWS Regions to collect data from. Defaults to include_all.
Option 1
\nobject
Include all regions. Defaults to true.
include_all [required]
\nboolean
Include all regions.
Option 2
\nobject
Include only these regions.
include_only [required]
\n[string]
Include only these regions.
logs_config
\nobject
AWS Logs Collection config.
lambda_forwarder
\nobject
Log Autosubscription configuration for Datadog Forwarder Lambda functions.\nAutomatically set up triggers for existing and new logs for some services,\nensuring no logs from new resources are missed and saving time spent on manual configuration.
lambdas
\n[string]
List of Datadog Lambda Log Forwarder ARNs in your AWS account. Defaults to [].
log_source_config
\nobject
Log source configuration.
tag_filters
\n[object]
List of AWS log source tag filters. Defaults to [].
source
\nstring
The AWS log source to which the tag filters defined in tags are applied.
tags
\n[string]
The AWS resource tags to filter on for the log source specified by source.
sources
\n[string]
List of service IDs set to enable automatic log collection.\nDiscover the list of available services with the\nGet list of AWS log ready\nservices\nendpoint.
metrics_config
\nobject
AWS Metrics Collection config.
automute_enabled
\nboolean
Enable EC2 automute for AWS metrics. Defaults to true.
collect_cloudwatch_alarms
\nboolean
Enable CloudWatch alarms collection. Defaults to false.
collect_custom_metrics
\nboolean
Enable custom metrics collection. Defaults to false.
enabled
\nboolean
Enable AWS metrics collection. Defaults to true.
namespace_filters
\n<oneOf>
AWS Metrics namespace filters. Defaults to exclude_only.
Option 1
\nobject
Exclude only these namespaces from metrics collection.\nDefaults to ["AWS/SQS", "AWS/ElasticMapReduce", "AWS/Usage"].\nAWS/SQS, AWS/ElasticMapReduce, and AWS/Usage are excluded by default\nto reduce your AWS CloudWatch costs from GetMetricData API calls.
exclude_only [required]
\n[string]
Exclude only these namespaces from metrics collection.\nDefaults to ["AWS/SQS", "AWS/ElasticMapReduce", "AWS/Usage"].\nAWS/SQS, AWS/ElasticMapReduce, and AWS/Usage are excluded by default\nto reduce your AWS CloudWatch costs from GetMetricData API calls.
Option 2
\nobject
Include only these namespaces.
include_only [required]
\n[string]
Include only these namespaces.
tag_filters
\n[object]
AWS Metrics collection tag filters list. Defaults to [].
namespace
\nstring
The AWS service for which the tag filters defined in tags will be applied.
tags
\n[string]
The AWS resource tags to filter on for the service specified by namespace.
resources_config
\nobject
AWS Resources Collection config.
cloud_security_posture_management_collection
\nboolean
Enable Cloud Security Management to scan AWS resources for vulnerabilities, misconfigurations,\nidentity risks, and compliance violations. Defaults to false.\nRequires extended_collection to be set to true.
extended_collection
\nboolean
Whether Datadog collects additional attributes and configuration information about the resources\nin your AWS account. Defaults to true. Required for cloud_security_posture_management_collection.
traces_config
\nobject
AWS Traces Collection config.
xray_services
\n<oneOf>
AWS X-Ray services to collect traces from. Defaults to include_only.
Option 1
\nobject
Include all services.
include_all [required]
\nboolean
Include all services.
Option 2
\nobject
Include only these services. Defaults to [].
include_only [required]
\n[string]
Include only these services.
type [required]
\nenum
AWS Account resource type. \nAllowed enum values: account
default: account
data [required]
\nobject
AWS Account response data.
attributes
\nobject
AWS Account response attributes.
account_tags
\n[string]
Tags to apply to all hosts and metrics reporting for this account. Defaults to [].
auth_config
\n<oneOf>
AWS Authentication config.
Option 1
\nobject
AWS Authentication config to integrate your account using an access key pair.
access_key_id [required]
\nstring
AWS Access Key ID.
secret_access_key
\nstring
AWS Secret Access Key.
Option 2
\nobject
AWS Authentication config to integrate your account using an IAM role.
external_id
\nstring
AWS IAM External ID for associated role.
role_name [required]
\nstring
AWS IAM Role name.
aws_account_id [required]
\nstring
AWS Account ID.
aws_partition
\nenum
AWS partition your AWS account is scoped to. Defaults to aws.\nSee Partitions\nin the AWS documentation for more information. \nAllowed enum values: aws,aws-cn,aws-us-gov
aws_regions
\n<oneOf>
AWS Regions to collect data from. Defaults to include_all.
Option 1
\nobject
Include all regions. Defaults to true.
include_all [required]
\nboolean
Include all regions.
Option 2
\nobject
Include only these regions.
include_only [required]
\n[string]
Include only these regions.
created_at
\ndate-time
Timestamp of when the account integration was created.
logs_config
\nobject
AWS Logs Collection config.
lambda_forwarder
\nobject
Log Autosubscription configuration for Datadog Forwarder Lambda functions.\nAutomatically set up triggers for existing and new logs for some services,\nensuring no logs from new resources are missed and saving time spent on manual configuration.
lambdas
\n[string]
List of Datadog Lambda Log Forwarder ARNs in your AWS account. Defaults to [].
log_source_config
\nobject
Log source configuration.
tag_filters
\n[object]
List of AWS log source tag filters. Defaults to [].
source
\nstring
The AWS log source to which the tag filters defined in tags are applied.
tags
\n[string]
The AWS resource tags to filter on for the log source specified by source.
sources
\n[string]
List of service IDs set to enable automatic log collection.\nDiscover the list of available services with the\nGet list of AWS log ready\nservices\nendpoint.
metrics_config
\nobject
AWS Metrics Collection config.
automute_enabled
\nboolean
Enable EC2 automute for AWS metrics. Defaults to true.
collect_cloudwatch_alarms
\nboolean
Enable CloudWatch alarms collection. Defaults to false.
collect_custom_metrics
\nboolean
Enable custom metrics collection. Defaults to false.
enabled
\nboolean
Enable AWS metrics collection. Defaults to true.
metric_name_filters
\n[ <oneOf>]
AWS CloudWatch metric name filters. Each filter applies to a single namespace.\nExactly one of include_only or exclude_only must be set on each filter.
Option 1
\nobject
Include only metric names matching one of these patterns for a single namespace.
include_only [required]
\n[string]
Include only metric names matching one of these patterns.
namespace [required]
\nstring
The AWS CloudWatch namespace to which this metric name filter applies.
Option 2
\nobject
Exclude metric names matching one of these patterns for a single namespace.
exclude_only [required]
\n[string]
Exclude metric names matching one of these patterns.
namespace [required]
\nstring
The AWS CloudWatch namespace to which this metric name filter applies.
namespace_filters
\n<oneOf>
AWS Metrics namespace filters. Defaults to exclude_only.
Option 1
\nobject
Exclude only these namespaces from metrics collection.\nDefaults to ["AWS/SQS", "AWS/ElasticMapReduce", "AWS/Usage"].\nAWS/SQS, AWS/ElasticMapReduce, and AWS/Usage are excluded by default\nto reduce your AWS CloudWatch costs from GetMetricData API calls.
exclude_only [required]
\n[string]
Exclude only these namespaces from metrics collection.\nDefaults to ["AWS/SQS", "AWS/ElasticMapReduce", "AWS/Usage"].\nAWS/SQS, AWS/ElasticMapReduce, and AWS/Usage are excluded by default\nto reduce your AWS CloudWatch costs from GetMetricData API calls.
Option 2
\nobject
Include only these namespaces.
include_only [required]
\n[string]
Include only these namespaces.
tag_filters
\n[object]
AWS Metrics collection tag filters list. Defaults to [].
namespace
\nstring
The AWS service for which the tag filters defined in tags will be applied.
tags
\n[string]
The AWS resource tags to filter on for the service specified by namespace.
modified_at
\ndate-time
Timestamp of when the account integration was updated.
resources_config
\nobject
AWS Resources Collection config.
cloud_security_posture_management_collection
\nboolean
Enable Cloud Security Management to scan AWS resources for vulnerabilities, misconfigurations,\nidentity risks, and compliance violations. Defaults to false.\nRequires extended_collection to be set to true.
extended_collection
\nboolean
Whether Datadog collects additional attributes and configuration information about the resources\nin your AWS account. Defaults to true. Required for cloud_security_posture_management_collection.
traces_config
\nobject
AWS Traces Collection config.
xray_services
\n<oneOf>
AWS X-Ray services to collect traces from. Defaults to include_only.
Option 1
\nobject
Include all services.
include_all [required]
\nboolean
Include all services.
Option 2
\nobject
Include only these services. Defaults to [].
include_only [required]
\n[string]
Include only these services.
id [required]
\nstring
Unique Datadog ID of the AWS Account Integration Config.\nTo get the config ID for an account, use the\nList all AWS integrations\nendpoint and query by AWS Account ID.
type [required]
\nenum
AWS Account resource type. \nAllowed enum values: account
default: account
data [required]
\nobject
AWS Account response data.
attributes
\nobject
AWS Account response attributes.
account_tags
\n[string]
Tags to apply to all hosts and metrics reporting for this account. Defaults to [].
auth_config
\n<oneOf>
AWS Authentication config.
Option 1
\nobject
AWS Authentication config to integrate your account using an access key pair.
access_key_id [required]
\nstring
AWS Access Key ID.
secret_access_key
\nstring
AWS Secret Access Key.
Option 2
\nobject
AWS Authentication config to integrate your account using an IAM role.
external_id
\nstring
AWS IAM External ID for associated role.
role_name [required]
\nstring
AWS IAM Role name.
aws_account_id [required]
\nstring
AWS Account ID.
aws_partition
\nenum
AWS partition your AWS account is scoped to. Defaults to aws.\nSee Partitions\nin the AWS documentation for more information. \nAllowed enum values: aws,aws-cn,aws-us-gov
aws_regions
\n<oneOf>
AWS Regions to collect data from. Defaults to include_all.
Option 1
\nobject
Include all regions. Defaults to true.
include_all [required]
\nboolean
Include all regions.
Option 2
\nobject
Include only these regions.
include_only [required]
\n[string]
Include only these regions.
created_at
\ndate-time
Timestamp of when the account integration was created.
logs_config
\nobject
AWS Logs Collection config.
lambda_forwarder
\nobject
Log Autosubscription configuration for Datadog Forwarder Lambda functions.\nAutomatically set up triggers for existing and new logs for some services,\nensuring no logs from new resources are missed and saving time spent on manual configuration.
lambdas
\n[string]
List of Datadog Lambda Log Forwarder ARNs in your AWS account. Defaults to [].
log_source_config
\nobject
Log source configuration.
tag_filters
\n[object]
List of AWS log source tag filters. Defaults to [].
source
\nstring
The AWS log source to which the tag filters defined in tags are applied.
tags
\n[string]
The AWS resource tags to filter on for the log source specified by source.
sources
\n[string]
List of service IDs set to enable automatic log collection.\nDiscover the list of available services with the\nGet list of AWS log ready\nservices\nendpoint.
metrics_config
\nobject
AWS Metrics Collection config.
automute_enabled
\nboolean
Enable EC2 automute for AWS metrics. Defaults to true.
collect_cloudwatch_alarms
\nboolean
Enable CloudWatch alarms collection. Defaults to false.
collect_custom_metrics
\nboolean
Enable custom metrics collection. Defaults to false.
enabled
\nboolean
Enable AWS metrics collection. Defaults to true.
namespace_filters
\n<oneOf>
AWS Metrics namespace filters. Defaults to exclude_only.
Option 1
\nobject
Exclude only these namespaces from metrics collection.\nDefaults to ["AWS/SQS", "AWS/ElasticMapReduce", "AWS/Usage"].\nAWS/SQS, AWS/ElasticMapReduce, and AWS/Usage are excluded by default\nto reduce your AWS CloudWatch costs from GetMetricData API calls.
exclude_only [required]
\n[string]
Exclude only these namespaces from metrics collection.\nDefaults to ["AWS/SQS", "AWS/ElasticMapReduce", "AWS/Usage"].\nAWS/SQS, AWS/ElasticMapReduce, and AWS/Usage are excluded by default\nto reduce your AWS CloudWatch costs from GetMetricData API calls.
Option 2
\nobject
Include only these namespaces.
include_only [required]
\n[string]
Include only these namespaces.
tag_filters
\n[object]
AWS Metrics collection tag filters list. Defaults to [].
namespace
\nstring
The AWS service for which the tag filters defined in tags will be applied.
tags
\n[string]
The AWS resource tags to filter on for the service specified by namespace.
modified_at
\ndate-time
Timestamp of when the account integration was updated.
resources_config
\nobject
AWS Resources Collection config.
cloud_security_posture_management_collection
\nboolean
Enable Cloud Security Management to scan AWS resources for vulnerabilities, misconfigurations,\nidentity risks, and compliance violations. Defaults to false.\nRequires extended_collection to be set to true.
extended_collection
\nboolean
Whether Datadog collects additional attributes and configuration information about the resources\nin your AWS account. Defaults to true. Required for cloud_security_posture_management_collection.
traces_config
\nobject
AWS Traces Collection config.
xray_services
\n<oneOf>
AWS X-Ray services to collect traces from. Defaults to include_only.
Option 1
\nobject
Include all services.
include_all [required]
\nboolean
Include all services.
Option 2
\nobject
Include only these services. Defaults to [].
include_only [required]
\n[string]
Include only these services.
id [required]
\nstring
Unique Datadog ID of the AWS Account Integration Config.\nTo get the config ID for an account, use the\nList all AWS integrations\nendpoint and query by AWS Account ID.
type [required]
\nenum
AWS Account resource type. \nAllowed enum values: account
default: account
data [required]
\nobject
AWS Account response data.
attributes
\nobject
AWS Account response attributes.
account_tags
\n[string]
Tags to apply to all hosts and metrics reporting for this account. Defaults to [].
auth_config
\n<oneOf>
AWS Authentication config.
Option 1
\nobject
AWS Authentication config to integrate your account using an access key pair.
access_key_id [required]
\nstring
AWS Access Key ID.
secret_access_key
\nstring
AWS Secret Access Key.
Option 2
\nobject
AWS Authentication config to integrate your account using an IAM role.
external_id
\nstring
AWS IAM External ID for associated role.
role_name [required]
\nstring
AWS IAM Role name.
aws_account_id [required]
\nstring
AWS Account ID.
aws_partition
\nenum
AWS partition your AWS account is scoped to. Defaults to aws.\nSee Partitions\nin the AWS documentation for more information. \nAllowed enum values: aws,aws-cn,aws-us-gov
aws_regions
\n<oneOf>
AWS Regions to collect data from. Defaults to include_all.
Option 1
\nobject
Include all regions. Defaults to true.
include_all [required]
\nboolean
Include all regions.
Option 2
\nobject
Include only these regions.
include_only [required]
\n[string]
Include only these regions.
created_at
\ndate-time
Timestamp of when the account integration was created.
logs_config
\nobject
AWS Logs Collection config.
lambda_forwarder
\nobject
Log Autosubscription configuration for Datadog Forwarder Lambda functions.\nAutomatically set up triggers for existing and new logs for some services,\nensuring no logs from new resources are missed and saving time spent on manual configuration.
lambdas
\n[string]
List of Datadog Lambda Log Forwarder ARNs in your AWS account. Defaults to [].
log_source_config
\nobject
Log source configuration.
tag_filters
\n[object]
List of AWS log source tag filters. Defaults to [].
source
\nstring
The AWS log source to which the tag filters defined in tags are applied.
tags
\n[string]
The AWS resource tags to filter on for the log source specified by source.
sources
\n[string]
List of service IDs set to enable automatic log collection.\nDiscover the list of available services with the\nGet list of AWS log ready\nservices\nendpoint.
metrics_config
\nobject
AWS Metrics Collection config.
automute_enabled
\nboolean
Enable EC2 automute for AWS metrics. Defaults to true.
collect_cloudwatch_alarms
\nboolean
Enable CloudWatch alarms collection. Defaults to false.
collect_custom_metrics
\nboolean
Enable custom metrics collection. Defaults to false.
enabled
\nboolean
Enable AWS metrics collection. Defaults to true.
metric_name_filters
\n[ <oneOf>]
AWS CloudWatch metric name filters. Each filter applies to a single namespace.\nExactly one of include_only or exclude_only must be set on each filter.
Option 1
\nobject
Include only metric names matching one of these patterns for a single namespace.
include_only [required]
\n[string]
Include only metric names matching one of these patterns.
namespace [required]
\nstring
The AWS CloudWatch namespace to which this metric name filter applies.
Option 2
\nobject
Exclude metric names matching one of these patterns for a single namespace.
exclude_only [required]
\n[string]
Exclude metric names matching one of these patterns.
namespace [required]
\nstring
The AWS CloudWatch namespace to which this metric name filter applies.
namespace_filters
\n<oneOf>
AWS Metrics namespace filters. Defaults to exclude_only.
Option 1
\nobject
Exclude only these namespaces from metrics collection.\nDefaults to ["AWS/SQS", "AWS/ElasticMapReduce", "AWS/Usage"].\nAWS/SQS, AWS/ElasticMapReduce, and AWS/Usage are excluded by default\nto reduce your AWS CloudWatch costs from GetMetricData API calls.
exclude_only [required]
\n[string]
Exclude only these namespaces from metrics collection.\nDefaults to ["AWS/SQS", "AWS/ElasticMapReduce", "AWS/Usage"].\nAWS/SQS, AWS/ElasticMapReduce, and AWS/Usage are excluded by default\nto reduce your AWS CloudWatch costs from GetMetricData API calls.
Option 2
\nobject
Include only these namespaces.
include_only [required]
\n[string]
Include only these namespaces.
tag_filters
\n[object]
AWS Metrics collection tag filters list. Defaults to [].
namespace
\nstring
The AWS service for which the tag filters defined in tags will be applied.
tags
\n[string]
The AWS resource tags to filter on for the service specified by namespace.
modified_at
\ndate-time
Timestamp of when the account integration was updated.
resources_config
\nobject
AWS Resources Collection config.
cloud_security_posture_management_collection
\nboolean
Enable Cloud Security Management to scan AWS resources for vulnerabilities, misconfigurations,\nidentity risks, and compliance violations. Defaults to false.\nRequires extended_collection to be set to true.
extended_collection
\nboolean
Whether Datadog collects additional attributes and configuration information about the resources\nin your AWS account. Defaults to true. Required for cloud_security_posture_management_collection.
traces_config
\nobject
AWS Traces Collection config.
xray_services
\n<oneOf>
AWS X-Ray services to collect traces from. Defaults to include_only.
Option 1
\nobject
Include all services.
include_all [required]
\nboolean
Include all services.
Option 2
\nobject
Include only these services. Defaults to [].
include_only [required]
\n[string]
Include only these services.
id [required]
\nstring
Unique Datadog ID of the AWS Account Integration Config.\nTo get the config ID for an account, use the\nList all AWS integrations\nendpoint and query by AWS Account ID.
type [required]
\nenum
AWS Account resource type. \nAllowed enum values: account
default: account
data [required]
\nobject
AWS Account response data.
attributes
\nobject
AWS Account response attributes.
account_tags
\n[string]
Tags to apply to all hosts and metrics reporting for this account. Defaults to [].
auth_config
\n<oneOf>
AWS Authentication config.
Option 1
\nobject
AWS Authentication config to integrate your account using an access key pair.
access_key_id [required]
\nstring
AWS Access Key ID.
secret_access_key
\nstring
AWS Secret Access Key.
Option 2
\nobject
AWS Authentication config to integrate your account using an IAM role.
external_id
\nstring
AWS IAM External ID for associated role.
role_name [required]
\nstring
AWS IAM Role name.
aws_account_id [required]
\nstring
AWS Account ID.
aws_partition
\nenum
AWS partition your AWS account is scoped to. Defaults to aws.\nSee Partitions\nin the AWS documentation for more information. \nAllowed enum values: aws,aws-cn,aws-us-gov
aws_regions
\n<oneOf>
AWS Regions to collect data from. Defaults to include_all.
Option 1
\nobject
Include all regions. Defaults to true.
include_all [required]
\nboolean
Include all regions.
Option 2
\nobject
Include only these regions.
include_only [required]
\n[string]
Include only these regions.
created_at
\ndate-time
Timestamp of when the account integration was created.
logs_config
\nobject
AWS Logs Collection config.
lambda_forwarder
\nobject
Log Autosubscription configuration for Datadog Forwarder Lambda functions.\nAutomatically set up triggers for existing and new logs for some services,\nensuring no logs from new resources are missed and saving time spent on manual configuration.
lambdas
\n[string]
List of Datadog Lambda Log Forwarder ARNs in your AWS account. Defaults to [].
log_source_config
\nobject
Log source configuration.
tag_filters
\n[object]
List of AWS log source tag filters. Defaults to [].
source
\nstring
The AWS log source to which the tag filters defined in tags are applied.
tags
\n[string]
The AWS resource tags to filter on for the log source specified by source.
sources
\n[string]
List of service IDs set to enable automatic log collection.\nDiscover the list of available services with the\nGet list of AWS log ready\nservices\nendpoint.
metrics_config
\nobject
AWS Metrics Collection config.
automute_enabled
\nboolean
Enable EC2 automute for AWS metrics. Defaults to true.
collect_cloudwatch_alarms
\nboolean
Enable CloudWatch alarms collection. Defaults to false.
collect_custom_metrics
\nboolean
Enable custom metrics collection. Defaults to false.
enabled
\nboolean
Enable AWS metrics collection. Defaults to true.
namespace_filters
\n<oneOf>
AWS Metrics namespace filters. Defaults to exclude_only.
Option 1
\nobject
Exclude only these namespaces from metrics collection.\nDefaults to ["AWS/SQS", "AWS/ElasticMapReduce", "AWS/Usage"].\nAWS/SQS, AWS/ElasticMapReduce, and AWS/Usage are excluded by default\nto reduce your AWS CloudWatch costs from GetMetricData API calls.
exclude_only [required]
\n[string]
Exclude only these namespaces from metrics collection.\nDefaults to ["AWS/SQS", "AWS/ElasticMapReduce", "AWS/Usage"].\nAWS/SQS, AWS/ElasticMapReduce, and AWS/Usage are excluded by default\nto reduce your AWS CloudWatch costs from GetMetricData API calls.
Option 2
\nobject
Include only these namespaces.
include_only [required]
\n[string]
Include only these namespaces.
tag_filters
\n[object]
AWS Metrics collection tag filters list. Defaults to [].
namespace
\nstring
The AWS service for which the tag filters defined in tags will be applied.
tags
\n[string]
The AWS resource tags to filter on for the service specified by namespace.
modified_at
\ndate-time
Timestamp of when the account integration was updated.
resources_config
\nobject
AWS Resources Collection config.
cloud_security_posture_management_collection
\nboolean
Enable Cloud Security Management to scan AWS resources for vulnerabilities, misconfigurations,\nidentity risks, and compliance violations. Defaults to false.\nRequires extended_collection to be set to true.
extended_collection
\nboolean
Whether Datadog collects additional attributes and configuration information about the resources\nin your AWS account. Defaults to true. Required for cloud_security_posture_management_collection.
traces_config
\nobject
AWS Traces Collection config.
xray_services
\n<oneOf>
AWS X-Ray services to collect traces from. Defaults to include_only.
Option 1
\nobject
Include all services.
include_all [required]
\nboolean
Include all services.
Option 2
\nobject
Include only these services. Defaults to [].
include_only [required]
\n[string]
Include only these services.
id [required]
\nstring
Unique Datadog ID of the AWS Account Integration Config.\nTo get the config ID for an account, use the\nList all AWS integrations\nendpoint and query by AWS Account ID.
type [required]
\nenum
AWS Account resource type. \nAllowed enum values: account
default: account
data [required]
\nobject
AWS Account Update Request data.
attributes [required]
\nobject
The AWS Account Integration Config to be updated.
account_tags
\n[string]
Tags to apply to all hosts and metrics reporting for this account. Defaults to [].
auth_config
\n<oneOf>
AWS Authentication config.
Option 1
\nobject
AWS Authentication config to integrate your account using an access key pair.
access_key_id [required]
\nstring
AWS Access Key ID.
secret_access_key
\nstring
AWS Secret Access Key.
Option 2
\nobject
AWS Authentication config to integrate your account using an IAM role.
external_id
\nstring
AWS IAM External ID for associated role.
role_name [required]
\nstring
AWS IAM Role name.
aws_account_id [required]
\nstring
AWS Account ID.
aws_partition
\nenum
AWS partition your AWS account is scoped to. Defaults to aws.\nSee Partitions\nin the AWS documentation for more information. \nAllowed enum values: aws,aws-cn,aws-us-gov
aws_regions
\n<oneOf>
AWS Regions to collect data from. Defaults to include_all.
Option 1
\nobject
Include all regions. Defaults to true.
include_all [required]
\nboolean
Include all regions.
Option 2
\nobject
Include only these regions.
include_only [required]
\n[string]
Include only these regions.
logs_config
\nobject
AWS Logs Collection config.
lambda_forwarder
\nobject
Log Autosubscription configuration for Datadog Forwarder Lambda functions.\nAutomatically set up triggers for existing and new logs for some services,\nensuring no logs from new resources are missed and saving time spent on manual configuration.
lambdas
\n[string]
List of Datadog Lambda Log Forwarder ARNs in your AWS account. Defaults to [].
log_source_config
\nobject
Log source configuration.
tag_filters
\n[object]
List of AWS log source tag filters. Defaults to [].
source
\nstring
The AWS log source to which the tag filters defined in tags are applied.
tags
\n[string]
The AWS resource tags to filter on for the log source specified by source.
sources
\n[string]
List of service IDs set to enable automatic log collection.\nDiscover the list of available services with the\nGet list of AWS log ready\nservices\nendpoint.
metrics_config
\nobject
AWS Metrics Collection config.
automute_enabled
\nboolean
Enable EC2 automute for AWS metrics. Defaults to true.
collect_cloudwatch_alarms
\nboolean
Enable CloudWatch alarms collection. Defaults to false.
collect_custom_metrics
\nboolean
Enable custom metrics collection. Defaults to false.
enabled
\nboolean
Enable AWS metrics collection. Defaults to true.
metric_name_filters
\n[ <oneOf>]
AWS CloudWatch metric name filters. Each filter applies to a single namespace.\nExactly one of include_only or exclude_only must be set on each filter.
Option 1
\nobject
Include only metric names matching one of these patterns for a single namespace.
include_only [required]
\n[string]
Include only metric names matching one of these patterns.
namespace [required]
\nstring
The AWS CloudWatch namespace to which this metric name filter applies.
Option 2
\nobject
Exclude metric names matching one of these patterns for a single namespace.
exclude_only [required]
\n[string]
Exclude metric names matching one of these patterns.
namespace [required]
\nstring
The AWS CloudWatch namespace to which this metric name filter applies.
namespace_filters
\n<oneOf>
AWS Metrics namespace filters. Defaults to exclude_only.
Option 1
\nobject
Exclude only these namespaces from metrics collection.\nDefaults to ["AWS/SQS", "AWS/ElasticMapReduce", "AWS/Usage"].\nAWS/SQS, AWS/ElasticMapReduce, and AWS/Usage are excluded by default\nto reduce your AWS CloudWatch costs from GetMetricData API calls.
exclude_only [required]
\n[string]
Exclude only these namespaces from metrics collection.\nDefaults to ["AWS/SQS", "AWS/ElasticMapReduce", "AWS/Usage"].\nAWS/SQS, AWS/ElasticMapReduce, and AWS/Usage are excluded by default\nto reduce your AWS CloudWatch costs from GetMetricData API calls.
Option 2
\nobject
Include only these namespaces.
include_only [required]
\n[string]
Include only these namespaces.
tag_filters
\n[object]
AWS Metrics collection tag filters list. Defaults to [].
namespace
\nstring
The AWS service for which the tag filters defined in tags will be applied.
tags
\n[string]
The AWS resource tags to filter on for the service specified by namespace.
resources_config
\nobject
AWS Resources Collection config.
cloud_security_posture_management_collection
\nboolean
Enable Cloud Security Management to scan AWS resources for vulnerabilities, misconfigurations,\nidentity risks, and compliance violations. Defaults to false.\nRequires extended_collection to be set to true.
extended_collection
\nboolean
Whether Datadog collects additional attributes and configuration information about the resources\nin your AWS account. Defaults to true. Required for cloud_security_posture_management_collection.
traces_config
\nobject
AWS Traces Collection config.
xray_services
\n<oneOf>
AWS X-Ray services to collect traces from. Defaults to include_only.
Option 1
\nobject
Include all services.
include_all [required]
\nboolean
Include all services.
Option 2
\nobject
Include only these services. Defaults to [].
include_only [required]
\n[string]
Include only these services.
id
\nstring
Unique Datadog ID of the AWS Account Integration Config.\nTo get the config ID for an account, use the\nList all AWS integrations\nendpoint and query by AWS Account ID.
type [required]
\nenum
AWS Account resource type. \nAllowed enum values: account
default: account
data [required]
\nobject
AWS Account Update Request data.
attributes [required]
\nobject
The AWS Account Integration Config to be updated.
account_tags
\n[string]
Tags to apply to all hosts and metrics reporting for this account. Defaults to [].
auth_config
\n<oneOf>
AWS Authentication config.
Option 1
\nobject
AWS Authentication config to integrate your account using an access key pair.
access_key_id [required]
\nstring
AWS Access Key ID.
secret_access_key
\nstring
AWS Secret Access Key.
Option 2
\nobject
AWS Authentication config to integrate your account using an IAM role.
external_id
\nstring
AWS IAM External ID for associated role.
role_name [required]
\nstring
AWS IAM Role name.
aws_account_id [required]
\nstring
AWS Account ID.
aws_partition
\nenum
AWS partition your AWS account is scoped to. Defaults to aws.\nSee Partitions\nin the AWS documentation for more information. \nAllowed enum values: aws,aws-cn,aws-us-gov
aws_regions
\n<oneOf>
AWS Regions to collect data from. Defaults to include_all.
Option 1
\nobject
Include all regions. Defaults to true.
include_all [required]
\nboolean
Include all regions.
Option 2
\nobject
Include only these regions.
include_only [required]
\n[string]
Include only these regions.
logs_config
\nobject
AWS Logs Collection config.
lambda_forwarder
\nobject
Log Autosubscription configuration for Datadog Forwarder Lambda functions.\nAutomatically set up triggers for existing and new logs for some services,\nensuring no logs from new resources are missed and saving time spent on manual configuration.
lambdas
\n[string]
List of Datadog Lambda Log Forwarder ARNs in your AWS account. Defaults to [].
log_source_config
\nobject
Log source configuration.
tag_filters
\n[object]
List of AWS log source tag filters. Defaults to [].
source
\nstring
The AWS log source to which the tag filters defined in tags are applied.
tags
\n[string]
The AWS resource tags to filter on for the log source specified by source.
sources
\n[string]
List of service IDs set to enable automatic log collection.\nDiscover the list of available services with the\nGet list of AWS log ready\nservices\nendpoint.
metrics_config
\nobject
AWS Metrics Collection config.
automute_enabled
\nboolean
Enable EC2 automute for AWS metrics. Defaults to true.
collect_cloudwatch_alarms
\nboolean
Enable CloudWatch alarms collection. Defaults to false.
collect_custom_metrics
\nboolean
Enable custom metrics collection. Defaults to false.
enabled
\nboolean
Enable AWS metrics collection. Defaults to true.
namespace_filters
\n<oneOf>
AWS Metrics namespace filters. Defaults to exclude_only.
Option 1
\nobject
Exclude only these namespaces from metrics collection.\nDefaults to ["AWS/SQS", "AWS/ElasticMapReduce", "AWS/Usage"].\nAWS/SQS, AWS/ElasticMapReduce, and AWS/Usage are excluded by default\nto reduce your AWS CloudWatch costs from GetMetricData API calls.
exclude_only [required]
\n[string]
Exclude only these namespaces from metrics collection.\nDefaults to ["AWS/SQS", "AWS/ElasticMapReduce", "AWS/Usage"].\nAWS/SQS, AWS/ElasticMapReduce, and AWS/Usage are excluded by default\nto reduce your AWS CloudWatch costs from GetMetricData API calls.
Option 2
\nobject
Include only these namespaces.
include_only [required]
\n[string]
Include only these namespaces.
tag_filters
\n[object]
AWS Metrics collection tag filters list. Defaults to [].
namespace
\nstring
The AWS service for which the tag filters defined in tags will be applied.
tags
\n[string]
The AWS resource tags to filter on for the service specified by namespace.
resources_config
\nobject
AWS Resources Collection config.
cloud_security_posture_management_collection
\nboolean
Enable Cloud Security Management to scan AWS resources for vulnerabilities, misconfigurations,\nidentity risks, and compliance violations. Defaults to false.\nRequires extended_collection to be set to true.
extended_collection
\nboolean
Whether Datadog collects additional attributes and configuration information about the resources\nin your AWS account. Defaults to true. Required for cloud_security_posture_management_collection.
traces_config
\nobject
AWS Traces Collection config.
xray_services
\n<oneOf>
AWS X-Ray services to collect traces from. Defaults to include_only.
Option 1
\nobject
Include all services.
include_all [required]
\nboolean
Include all services.
Option 2
\nobject
Include only these services. Defaults to [].
include_only [required]
\n[string]
Include only these services.
id
\nstring
Unique Datadog ID of the AWS Account Integration Config.\nTo get the config ID for an account, use the\nList all AWS integrations\nendpoint and query by AWS Account ID.
type [required]
\nenum
AWS Account resource type. \nAllowed enum values: account
default: account
data [required]
\nobject
AWS CCM Config Create/Update Request data.
attributes [required]
\nobject
AWS CCM Config attributes for Create/Update requests.
ccm_config [required]
\nobject
AWS Cloud Cost Management config.
data_export_configs [required]
\n[object]
List of data export configurations for Cost and Usage Reports.
bucket_name [required]
\nstring
Name of the S3 bucket where the Cost and Usage Report is stored.
bucket_region [required]
\nstring
AWS region of the S3 bucket.
report_name [required]
\nstring
Name of the Cost and Usage Report.
report_prefix [required]
\nstring
S3 prefix where the Cost and Usage Report is stored.
report_type [required]
\nstring
Type of the Cost and Usage Report. Currently only CUR2.0 is supported.
type [required]
\nenum
AWS CCM Config resource type. \nAllowed enum values: ccm_config
default: ccm_config
data [required]
\nobject
AWS metric name filter preview response data.
attributes [required]
\nobject
AWS metric name filter preview response attributes.
namespaces [required]
\n[object]
The list of namespaces affected by the previewed metric name filters.
filters [required]
\n[object]
The metric name filter patterns evaluated for this namespace and how many metrics they matched.
match_count [required]
\nint64
The number of Datadog metric names matched by this pattern.
pattern [required]
\nstring
The metric name filter pattern.
metrics [required]
\n[object]
The CloudWatch metrics collected for this namespace and whether each resulting\nDatadog metric is filtered.
cw_name [required]
\nstring
The CloudWatch metric name.
dd_names [required]
\n[object]
The Datadog metric names produced from this CloudWatch metric.
filtered [required]
\nboolean
Whether this Datadog metric name is filtered out.
name [required]
\nstring
The Datadog metric name.
namespace [required]
\nstring
The AWS CloudWatch namespace.
id [required]
\nstring
Unique Datadog ID of the AWS Account Integration Config.\nTo get the config ID for an account, use the\nList all AWS integrations\nendpoint and query by AWS Account ID.
type [required]
\nenum
The AWSMetricNameFilterPreviewResponseData type. \nAllowed enum values: metric_name_filter_preview
default: metric_name_filter_preview
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
data [required]
\nobject
AWS metric name filter preview response data.
attributes [required]
\nobject
AWS metric name filter preview response attributes.
namespaces [required]
\n[object]
The list of namespaces affected by the previewed metric name filters.
filters [required]
\n[object]
The metric name filter patterns evaluated for this namespace and how many metrics they matched.
match_count [required]
\nint64
The number of Datadog metric names matched by this pattern.
pattern [required]
\nstring
The metric name filter pattern.
metrics [required]
\n[object]
The CloudWatch metrics collected for this namespace and whether each resulting\nDatadog metric is filtered.
cw_name [required]
\nstring
The CloudWatch metric name.
dd_names [required]
\n[object]
The Datadog metric names produced from this CloudWatch metric.
filtered [required]
\nboolean
Whether this Datadog metric name is filtered out.
name [required]
\nstring
The Datadog metric name.
namespace [required]
\nstring
The AWS CloudWatch namespace.
id [required]
\nstring
Unique Datadog ID of the AWS Account Integration Config.\nTo get the config ID for an account, use the\nList all AWS integrations\nendpoint and query by AWS Account ID.
type [required]
\nenum
The AWSMetricNameFilterPreviewResponseData type. \nAllowed enum values: metric_name_filter_preview
default: metric_name_filter_preview
errors [required]
\n[object]
A list of errors.
detail
\nstring
A human-readable explanation specific to this occurrence of the error.
meta
\nobject
Non-standard meta-information about the error
source
\nobject
References to the source of the error.
header
\nstring
A string indicating the name of a single request header which caused the error.
parameter
\nstring
A string indicating which URI query parameter caused the error.
pointer
\nstring
A JSON pointer to the value in the request document that caused the error.
status
\nstring
Status code of the response.
title
\nstring
Short human-readable summary of the error.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
data [required]
\nobject
AWS metric name filter preview request data.
attributes [required]
\nobject
AWS metric name filter preview request attributes.
metric_name_filters [required]
\n[ <oneOf>]
The metric name filters to preview.
Option 1
\nobject
Include only metric names matching one of these patterns for a single namespace.
include_only [required]
\n[string]
Include only metric names matching one of these patterns.
namespace [required]
\nstring
The AWS CloudWatch namespace to which this metric name filter applies.
Option 2
\nobject
Exclude metric names matching one of these patterns for a single namespace.
exclude_only [required]
\n[string]
Exclude metric names matching one of these patterns.
namespace [required]
\nstring
The AWS CloudWatch namespace to which this metric name filter applies.
type [required]
\nenum
The AWSMetricNameFilterPreviewResponseData type. \nAllowed enum values: metric_name_filter_preview
default: metric_name_filter_preview
data
\n[object]
A list of critical assets objects.
attributes
\nobject
The attributes of the critical asset.
creation_author_id
\nint64
ID of user who created the critical asset.
creation_date
\nint64
A Unix millisecond timestamp given the creation date of the critical asset.
creator
\nobject
A user.
handle
\nstring
The handle of the user.
name
\nstring
The name of the user.
description
\nstring
A description of the critical asset.
enabled
\nboolean
Whether the critical asset is enabled.
query
\nstring
The query for the critical asset. It uses the same syntax as the queries to search signals in the Signals Explorer.
rule_query
\nstring
The rule query of the critical asset, with the same syntax as the search bar for detection rules. This determines which rules this critical asset will apply to.
severity
\nenum
Severity associated with this critical asset. Either an explicit severity can be set, or the severity can be increased or decreased, or the severity can be left unchanged (no-op). \nAllowed enum values: info,low,medium,high,critical,increase,decrease,no-op
tags
\n[string]
List of tags associated with the critical asset.
update_author_id
\nint64
ID of user who updated the critical asset.
update_date
\nint64
A Unix millisecond timestamp given the update date of the critical asset.
updater
\nobject
A user.
handle
\nstring
The handle of the user.
name
\nstring
The name of the user.
version
\nint32
The version of the critical asset; it starts at 1, and is incremented at each update.
id
\nstring
The ID of the critical asset.
type
\nenum
The type of the resource. The value should always be critical_assets. \nAllowed enum values: critical_assets
default: critical_assets
data
\n[object]
A list of critical assets objects.
attributes
\nobject
The attributes of the critical asset.
creation_author_id
\nint64
ID of user who created the critical asset.
creation_date
\nint64
A Unix millisecond timestamp given the creation date of the critical asset.
creator
\nobject
A user.
handle
\nstring
The handle of the user.
name
\nstring
The name of the user.
description
\nstring
A description of the critical asset.
editable
\nboolean
Whether the critical asset is editable.
enabled
\nboolean
Whether the critical asset is enabled.
query
\nstring
The query for the critical asset. It uses the same syntax as the queries to search signals in the Signals Explorer.
rule_query
\nstring
The rule query of the critical asset, with the same syntax as the search bar for detection rules. This determines which rules this critical asset will apply to.
severity
\nenum
Severity associated with this critical asset. Either an explicit severity can be set, or the severity can be increased or decreased, or the severity can be left unchanged (no-op). \nAllowed enum values: info,low,medium,high,critical,increase,decrease,no-op
tags
\n[string]
List of tags associated with the critical asset.
update_author_id
\nint64
ID of user who updated the critical asset.
update_date
\nint64
A Unix millisecond timestamp given the update date of the critical asset.
updater
\nobject
A user.
handle
\nstring
The handle of the user.
name
\nstring
The name of the user.
version
\nint32
The version of the critical asset; it starts at 1, and is incremented at each update.
id
\nstring
The ID of the critical asset.
type
\nenum
The type of the resource. The value should always be critical_assets. \nAllowed enum values: critical_assets
default: critical_assets
data
\nobject
The critical asset's properties.
attributes
\nobject
The attributes of the critical asset.
creation_author_id
\nint64
ID of user who created the critical asset.
creation_date
\nint64
A Unix millisecond timestamp given the creation date of the critical asset.
creator
\nobject
A user.
handle
\nstring
The handle of the user.
name
\nstring
The name of the user.
description
\nstring
A description of the critical asset.
enabled
\nboolean
Whether the critical asset is enabled.
query
\nstring
The query for the critical asset. It uses the same syntax as the queries to search signals in the Signals Explorer.
rule_query
\nstring
The rule query of the critical asset, with the same syntax as the search bar for detection rules. This determines which rules this critical asset will apply to.
severity
\nenum
Severity associated with this critical asset. Either an explicit severity can be set, or the severity can be increased or decreased, or the severity can be left unchanged (no-op). \nAllowed enum values: info,low,medium,high,critical,increase,decrease,no-op
tags
\n[string]
List of tags associated with the critical asset.
update_author_id
\nint64
ID of user who updated the critical asset.
update_date
\nint64
A Unix millisecond timestamp given the update date of the critical asset.
updater
\nobject
A user.
handle
\nstring
The handle of the user.
name
\nstring
The name of the user.
version
\nint32
The version of the critical asset; it starts at 1, and is incremented at each update.
id
\nstring
The ID of the critical asset.
type
\nenum
The type of the resource. The value should always be critical_assets. \nAllowed enum values: critical_assets
default: critical_assets
data
\nobject
The critical asset's properties.
attributes
\nobject
The attributes of the critical asset.
creation_author_id
\nint64
ID of user who created the critical asset.
creation_date
\nint64
A Unix millisecond timestamp given the creation date of the critical asset.
creator
\nobject
A user.
handle
\nstring
The handle of the user.
name
\nstring
The name of the user.
description
\nstring
A description of the critical asset.
editable
\nboolean
Whether the critical asset is editable.
enabled
\nboolean
Whether the critical asset is enabled.
query
\nstring
The query for the critical asset. It uses the same syntax as the queries to search signals in the Signals Explorer.
rule_query
\nstring
The rule query of the critical asset, with the same syntax as the search bar for detection rules. This determines which rules this critical asset will apply to.
severity
\nenum
Severity associated with this critical asset. Either an explicit severity can be set, or the severity can be increased or decreased, or the severity can be left unchanged (no-op). \nAllowed enum values: info,low,medium,high,critical,increase,decrease,no-op
tags
\n[string]
List of tags associated with the critical asset.
update_author_id
\nint64
ID of user who updated the critical asset.
update_date
\nint64
A Unix millisecond timestamp given the update date of the critical asset.
updater
\nobject
A user.
handle
\nstring
The handle of the user.
name
\nstring
The name of the user.
version
\nint32
The version of the critical asset; it starts at 1, and is incremented at each update.
id
\nstring
The ID of the critical asset.
type
\nenum
The type of the resource. The value should always be critical_assets. \nAllowed enum values: critical_assets
default: critical_assets
data
\n[object]
A list of critical assets objects.
attributes
\nobject
The attributes of the critical asset.
creation_author_id
\nint64
ID of user who created the critical asset.
creation_date
\nint64
A Unix millisecond timestamp given the creation date of the critical asset.
creator
\nobject
A user.
handle
\nstring
The handle of the user.
name
\nstring
The name of the user.
description
\nstring
A description of the critical asset.
enabled
\nboolean
Whether the critical asset is enabled.
query
\nstring
The query for the critical asset. It uses the same syntax as the queries to search signals in the Signals Explorer.
rule_query
\nstring
The rule query of the critical asset, with the same syntax as the search bar for detection rules. This determines which rules this critical asset will apply to.
severity
\nenum
Severity associated with this critical asset. Either an explicit severity can be set, or the severity can be increased or decreased, or the severity can be left unchanged (no-op). \nAllowed enum values: info,low,medium,high,critical,increase,decrease,no-op
tags
\n[string]
List of tags associated with the critical asset.
update_author_id
\nint64
ID of user who updated the critical asset.
update_date
\nint64
A Unix millisecond timestamp given the update date of the critical asset.
updater
\nobject
A user.
handle
\nstring
The handle of the user.
name
\nstring
The name of the user.
version
\nint32
The version of the critical asset; it starts at 1, and is incremented at each update.
id
\nstring
The ID of the critical asset.
type
\nenum
The type of the resource. The value should always be critical_assets. \nAllowed enum values: critical_assets
default: critical_assets
data
\n[object]
A list of critical assets objects.
attributes
\nobject
The attributes of the critical asset.
creation_author_id
\nint64
ID of user who created the critical asset.
creation_date
\nint64
A Unix millisecond timestamp given the creation date of the critical asset.
creator
\nobject
A user.
handle
\nstring
The handle of the user.
name
\nstring
The name of the user.
description
\nstring
A description of the critical asset.
editable
\nboolean
Whether the critical asset is editable.
enabled
\nboolean
Whether the critical asset is enabled.
query
\nstring
The query for the critical asset. It uses the same syntax as the queries to search signals in the Signals Explorer.
rule_query
\nstring
The rule query of the critical asset, with the same syntax as the search bar for detection rules. This determines which rules this critical asset will apply to.
severity
\nenum
Severity associated with this critical asset. Either an explicit severity can be set, or the severity can be increased or decreased, or the severity can be left unchanged (no-op). \nAllowed enum values: info,low,medium,high,critical,increase,decrease,no-op
tags
\n[string]
List of tags associated with the critical asset.
update_author_id
\nint64
ID of user who updated the critical asset.
update_date
\nint64
A Unix millisecond timestamp given the update date of the critical asset.
updater
\nobject
A user.
handle
\nstring
The handle of the user.
name
\nstring
The name of the user.
version
\nint32
The version of the critical asset; it starts at 1, and is incremented at each update.
id
\nstring
The ID of the critical asset.
type
\nenum
The type of the resource. The value should always be critical_assets. \nAllowed enum values: critical_assets
default: critical_assets
data
\nobject
The critical asset's properties.
attributes
\nobject
The attributes of the critical asset.
creation_author_id
\nint64
ID of user who created the critical asset.
creation_date
\nint64
A Unix millisecond timestamp given the creation date of the critical asset.
creator
\nobject
A user.
handle
\nstring
The handle of the user.
name
\nstring
The name of the user.
description
\nstring
A description of the critical asset.
enabled
\nboolean
Whether the critical asset is enabled.
query
\nstring
The query for the critical asset. It uses the same syntax as the queries to search signals in the Signals Explorer.
rule_query
\nstring
The rule query of the critical asset, with the same syntax as the search bar for detection rules. This determines which rules this critical asset will apply to.
severity
\nenum
Severity associated with this critical asset. Either an explicit severity can be set, or the severity can be increased or decreased, or the severity can be left unchanged (no-op). \nAllowed enum values: info,low,medium,high,critical,increase,decrease,no-op
tags
\n[string]
List of tags associated with the critical asset.
update_author_id
\nint64
ID of user who updated the critical asset.
update_date
\nint64
A Unix millisecond timestamp given the update date of the critical asset.
updater
\nobject
A user.
handle
\nstring
The handle of the user.
name
\nstring
The name of the user.
version
\nint32
The version of the critical asset; it starts at 1, and is incremented at each update.
id
\nstring
The ID of the critical asset.
type
\nenum
The type of the resource. The value should always be critical_assets. \nAllowed enum values: critical_assets
default: critical_assets
data
\nobject
The critical asset's properties.
attributes
\nobject
The attributes of the critical asset.
creation_author_id
\nint64
ID of user who created the critical asset.
creation_date
\nint64
A Unix millisecond timestamp given the creation date of the critical asset.
creator
\nobject
A user.
handle
\nstring
The handle of the user.
name
\nstring
The name of the user.
description
\nstring
A description of the critical asset.
editable
\nboolean
Whether the critical asset is editable.
enabled
\nboolean
Whether the critical asset is enabled.
query
\nstring
The query for the critical asset. It uses the same syntax as the queries to search signals in the Signals Explorer.
rule_query
\nstring
The rule query of the critical asset, with the same syntax as the search bar for detection rules. This determines which rules this critical asset will apply to.
severity
\nenum
Severity associated with this critical asset. Either an explicit severity can be set, or the severity can be increased or decreased, or the severity can be left unchanged (no-op). \nAllowed enum values: info,low,medium,high,critical,increase,decrease,no-op
tags
\n[string]
List of tags associated with the critical asset.
update_author_id
\nint64
ID of user who updated the critical asset.
update_date
\nint64
A Unix millisecond timestamp given the update date of the critical asset.
updater
\nobject
A user.
handle
\nstring
The handle of the user.
name
\nstring
The name of the user.
version
\nint32
The version of the critical asset; it starts at 1, and is incremented at each update.
id
\nstring
The ID of the critical asset.
type
\nenum
The type of the resource. The value should always be critical_assets. \nAllowed enum values: critical_assets
default: critical_assets
data
\nobject
The critical asset's properties.
attributes
\nobject
The attributes of the critical asset.
creation_author_id
\nint64
ID of user who created the critical asset.
creation_date
\nint64
A Unix millisecond timestamp given the creation date of the critical asset.
creator
\nobject
A user.
handle
\nstring
The handle of the user.
name
\nstring
The name of the user.
description
\nstring
A description of the critical asset.
enabled
\nboolean
Whether the critical asset is enabled.
query
\nstring
The query for the critical asset. It uses the same syntax as the queries to search signals in the Signals Explorer.
rule_query
\nstring
The rule query of the critical asset, with the same syntax as the search bar for detection rules. This determines which rules this critical asset will apply to.
severity
\nenum
Severity associated with this critical asset. Either an explicit severity can be set, or the severity can be increased or decreased, or the severity can be left unchanged (no-op). \nAllowed enum values: info,low,medium,high,critical,increase,decrease,no-op
tags
\n[string]
List of tags associated with the critical asset.
update_author_id
\nint64
ID of user who updated the critical asset.
update_date
\nint64
A Unix millisecond timestamp given the update date of the critical asset.
updater
\nobject
A user.
handle
\nstring
The handle of the user.
name
\nstring
The name of the user.
version
\nint32
The version of the critical asset; it starts at 1, and is incremented at each update.
id
\nstring
The ID of the critical asset.
type
\nenum
The type of the resource. The value should always be critical_assets. \nAllowed enum values: critical_assets
default: critical_assets
data
\nobject
The critical asset's properties.
attributes
\nobject
The attributes of the critical asset.
creation_author_id
\nint64
ID of user who created the critical asset.
creation_date
\nint64
A Unix millisecond timestamp given the creation date of the critical asset.
creator
\nobject
A user.
handle
\nstring
The handle of the user.
name
\nstring
The name of the user.
description
\nstring
A description of the critical asset.
editable
\nboolean
Whether the critical asset is editable.
enabled
\nboolean
Whether the critical asset is enabled.
query
\nstring
The query for the critical asset. It uses the same syntax as the queries to search signals in the Signals Explorer.
rule_query
\nstring
The rule query of the critical asset, with the same syntax as the search bar for detection rules. This determines which rules this critical asset will apply to.
severity
\nenum
Severity associated with this critical asset. Either an explicit severity can be set, or the severity can be increased or decreased, or the severity can be left unchanged (no-op). \nAllowed enum values: info,low,medium,high,critical,increase,decrease,no-op
tags
\n[string]
List of tags associated with the critical asset.
update_author_id
\nint64
ID of user who updated the critical asset.
update_date
\nint64
A Unix millisecond timestamp given the update date of the critical asset.
updater
\nobject
A user.
handle
\nstring
The handle of the user.
name
\nstring
The name of the user.
version
\nint32
The version of the critical asset; it starts at 1, and is incremented at each update.
id
\nstring
The ID of the critical asset.
type
\nenum
The type of the resource. The value should always be critical_assets. \nAllowed enum values: critical_assets
default: critical_assets