From 12059fd93ba8f40c121cbb0df429cff4e1858d5b Mon Sep 17 00:00:00 2001 From: "ci.datadog-api-spec" Date: Tue, 10 Dec 2024 16:51:01 +0000 Subject: [PATCH] Regenerate client from commit 66a83aa3 of spec repo --- .apigentools-info | 8 +- .../en/api/v2/aws-integration/examples.json | 106 +- data/api/v2/full_spec.yaml | 223 +- data/api/v2/full_spec_deref.json | 2086 +++++++++-------- data/api/v2/translate_actions.json | 10 +- static/resources/json/full_spec_v2.json | 2086 +++++++++-------- 6 files changed, 2306 insertions(+), 2213 deletions(-) diff --git a/.apigentools-info b/.apigentools-info index 4e7d2b7d2c781..a5404522f94cc 100644 --- a/.apigentools-info +++ b/.apigentools-info @@ -4,13 +4,13 @@ "spec_versions": { "v1": { "apigentools_version": "1.6.6", - "regenerated": "2024-12-10 15:39:59.165623", - "spec_repo_commit": "aee36841" + "regenerated": "2024-12-10 16:50:42.978745", + "spec_repo_commit": "66a83aa3" }, "v2": { "apigentools_version": "1.6.6", - "regenerated": "2024-12-10 15:40:07.022407", - "spec_repo_commit": "aee36841" + "regenerated": "2024-12-10 16:50:50.872122", + "spec_repo_commit": "66a83aa3" } } } \ No newline at end of file diff --git a/content/en/api/v2/aws-integration/examples.json b/content/en/api/v2/aws-integration/examples.json index be963b2873bc3..4884a641fe674 100644 --- a/content/en/api/v2/aws-integration/examples.json +++ b/content/en/api/v2/aws-integration/examples.json @@ -7,7 +7,7 @@ { "attributes": { "account_tags": [ - "key:value" + "env:prod" ], "auth_config": { "access_key_id": "AKIAIOSFODNN7EXAMPLE", @@ -16,7 +16,7 @@ "aws_account_id": "123456789012", "aws_partition": "aws", "aws_regions": { - "include_all": false + "include_all": true }, "created_at": "2019-09-19T10:00:00.000Z", "logs_config": { @@ -31,19 +31,20 @@ }, "metrics_config": { "automute_enabled": true, - "collect_cloudwatch_alarms": true, - "collect_custom_metrics": true, + "collect_cloudwatch_alarms": false, + "collect_custom_metrics": false, "enabled": true, "namespace_filters": { "exclude_only": [ - "AWS/EC2" + "AWS/SQS", + "AWS/ElasticMapReduce" ] }, "tag_filters": [ { "namespace": "AWS/EC2", "tags": [ - "key:value" + "datadog:true" ] } ] @@ -51,7 +52,7 @@ "modified_at": "2019-09-19T10:00:00.000Z", "resources_config": { "cloud_security_posture_management_collection": false, - "extended_collection": false + "extended_collection": true }, "traces_config": { "xray_services": { @@ -64,7 +65,7 @@ } ] }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

List of AWS Account Integration Configs

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The AWS Account Integration Config

\n
\n
\n
\n
\n
\n

account_tags

\n
\n

[string]

\n

Tags to apply to all metrics in the account

\n
\n \n
\n
\n
\n
\n
\n

auth_config

\n
\n

 <oneOf>

\n

AWS Authentication config

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

AWS Authentication config for key-based account

\n
\n
\n
\n
\n
\n

access_key_id [required]

\n
\n

string

\n

AWS Access Key ID

\n
\n \n
\n
\n
\n
\n
\n

secret_access_key

\n
\n

string

\n

AWS Secret Access Key

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

AWS Authentication config for role-based account

\n
\n
\n
\n
\n
\n

external_id

\n
\n

string

\n

AWS IAM External ID for associated role

\n
\n \n
\n
\n
\n
\n
\n

role_name [required]

\n
\n

string

\n

AWS IAM Role name

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

aws_account_id [required]

\n
\n

string

\n

AWS Account ID

\n
\n \n
\n
\n
\n
\n
\n

aws_partition

\n
\n

enum

\n

AWS Account partition \nAllowed enum values: aws,aws-cn,aws-us-gov

default: aws

\n
\n \n
\n
\n
\n
\n
\n

aws_regions

\n
\n

 <oneOf>

\n

AWS Regions to collect data from

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

\n

Include all regions

\n
\n
\n
\n
\n
\n

include_all [required]

\n
\n

boolean

\n

Include all regions

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

\n

Include only these regions

\n
\n
\n
\n
\n
\n

include_only [required]

\n
\n

[string]

\n

Include only these regions

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp of when the account integration was created

\n
\n \n
\n
\n
\n
\n
\n

logs_config

\n
\n

object

\n

AWS Logs config

\n
\n
\n
\n
\n
\n

lambda_forwarder

\n
\n

object

\n

AWS Lambda forwarder

\n
\n
\n
\n
\n
\n

lambdas

\n
\n

[string]

\n

List of Datadog Lambda Log Forwarder ARNs

\n
\n \n
\n
\n
\n
\n
\n

sources

\n
\n

[string]

\n

List of AWS services that will send logs to the Datadog Lambda Log Forwarder

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

metrics_config

\n
\n

object

\n

AWS Metrics config

\n
\n
\n
\n
\n
\n

automute_enabled

\n
\n

boolean

\n

Enable EC2 automute for AWS metrics

\n
\n \n
\n
\n
\n
\n
\n

collect_cloudwatch_alarms

\n
\n

boolean

\n

Enable CloudWatch alarms collection

\n
\n \n
\n
\n
\n
\n
\n

collect_custom_metrics

\n
\n

boolean

\n

Enable custom metrics collection

\n
\n \n
\n
\n
\n
\n
\n

enabled

\n
\n

boolean

\n

Enable AWS metrics collection

\n
\n \n
\n
\n
\n
\n
\n

namespace_filters

\n
\n

 <oneOf>

\n

AWS Metrics namespace filters

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

\n

Exclude only these namespaces

\n
\n
\n
\n
\n
\n

exclude_only [required]

\n
\n

[string]

\n

Exclude only these namespaces

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

\n

Include only these namespaces

\n
\n
\n
\n
\n
\n

include_only [required]

\n
\n

[string]

\n

Include only these namespaces

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

tag_filters

\n
\n

[object]

\n

AWS Metrics tag filters list

\n
\n
\n
\n
\n
\n

namespace

\n
\n

string

\n

The AWS Namespace to apply the tag filters against

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

The tags to filter based on

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the account integration was updated

\n
\n \n
\n
\n
\n
\n
\n

resources_config

\n
\n

object

\n

AWS Resources config

\n
\n
\n
\n
\n
\n

cloud_security_posture_management_collection

\n
\n

boolean

\n

Whether Datadog collects cloud security posture management resources from your AWS account.

\n
\n \n
\n
\n
\n
\n
\n

extended_collection

\n
\n

boolean

\n

Whether Datadog collects additional attributes and configuration information about the resources in your AWS account. Required for cspm_resource_collection.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

traces_config

\n
\n

object

\n

AWS Traces config

\n
\n
\n
\n
\n
\n

xray_services

\n
\n

 <oneOf>

\n

AWS X-Ray services to collect traces from

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

\n

Include all services

\n
\n
\n
\n
\n
\n

include_all [required]

\n
\n

boolean

\n

Include all services

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

\n

Include only these services

\n
\n
\n
\n
\n
\n

include_only [required]

\n
\n

[string]

\n

Include only these services

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Unique Datadog ID of the AWS Account Integration Config

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

AWS Account resource type. \nAllowed enum values: account

default: account

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

List of AWS Account Integration Configs.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

AWS Account response attributes.

\n
\n
\n
\n
\n
\n

account_tags

\n
\n

[string]

\n

Tags to apply to all hosts and metrics reporting for this account. Defaults to [].

\n
\n \n
\n
\n
\n
\n
\n

auth_config

\n
\n

 <oneOf>

\n

AWS Authentication config.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

AWS Authentication config to integrate your account using an access key pair.

\n
\n
\n
\n
\n
\n

access_key_id [required]

\n
\n

string

\n

AWS Access Key ID.

\n
\n \n
\n
\n
\n
\n
\n

secret_access_key

\n
\n

string

\n

AWS Secret Access Key.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

AWS Authentication config to integrate your account using an IAM role.

\n
\n
\n
\n
\n
\n

external_id

\n
\n

string

\n

AWS IAM External ID for associated role.

\n
\n \n
\n
\n
\n
\n
\n

role_name [required]

\n
\n

string

\n

AWS IAM Role name.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

aws_account_id [required]

\n
\n

string

\n

AWS Account ID.

\n
\n \n
\n
\n
\n
\n
\n

aws_partition

\n
\n

enum

\n

AWS partition your AWS account is scoped to. Defaults to aws.\nSee Partitions in the AWS documentation for more information. \nAllowed enum values: aws,aws-cn,aws-us-gov

\n
\n \n
\n
\n
\n
\n
\n

aws_regions

\n
\n

 <oneOf>

\n

AWS Regions to collect data from. Defaults to include_all.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

\n

Include all regions. Defaults to true.

\n
\n
\n
\n
\n
\n

include_all [required]

\n
\n

boolean

\n

Include all regions.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

\n

Include only these regions.

\n
\n
\n
\n
\n
\n

include_only [required]

\n
\n

[string]

\n

Include only these regions.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp of when the account integration was created.

\n
\n \n
\n
\n
\n
\n
\n

logs_config

\n
\n

object

\n

AWS Logs Collection config.

\n
\n
\n
\n
\n
\n

lambda_forwarder

\n
\n

object

\n

Log Autosubscription configuration for Datadog Forwarder Lambda functions. Automatically set up triggers for existing\nand new logs for some services, ensuring no logs from new resources are missed and saving time spent on manual configuration.

\n
\n
\n
\n
\n
\n

lambdas

\n
\n

[string]

\n

List of Datadog Lambda Log Forwarder ARNs in your AWS account. Defaults to [].

\n
\n \n
\n
\n
\n
\n
\n

sources

\n
\n

[string]

\n

List of service IDs set to enable automatic log collection. Discover the list of available services with the\nGet list of AWS log ready services endpoint.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

metrics_config

\n
\n

object

\n

AWS Metrics Collection config.

\n
\n
\n
\n
\n
\n

automute_enabled

\n
\n

boolean

\n

Enable EC2 automute for AWS metrics. Defaults to true.

\n
\n \n
\n
\n
\n
\n
\n

collect_cloudwatch_alarms

\n
\n

boolean

\n

Enable CloudWatch alarms collection. Defaults to false.

\n
\n \n
\n
\n
\n
\n
\n

collect_custom_metrics

\n
\n

boolean

\n

Enable custom metrics collection. Defaults to false.

\n
\n \n
\n
\n
\n
\n
\n

enabled

\n
\n

boolean

\n

Enable AWS metrics collection. Defaults to true.

\n
\n \n
\n
\n
\n
\n
\n

namespace_filters

\n
\n

 <oneOf>

\n

AWS Metrics namespace filters. Defaults to exclude_only.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

\n

Exclude only these namespaces from metrics collection. Defaults to ["AWS/SQS", "AWS/ElasticMapReduce"].\nAWS/SQS and AWS/ElasticMapReduce are excluded by default to reduce your AWS CloudWatch costs from GetMetricData API calls.

\n
\n
\n
\n
\n
\n

exclude_only [required]

\n
\n

[string]

\n

Exclude only these namespaces from metrics collection. Defaults to ["AWS/SQS", "AWS/ElasticMapReduce"].\nAWS/SQS and AWS/ElasticMapReduce are excluded by default to reduce your AWS CloudWatch costs from GetMetricData API calls.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

\n

Include only these namespaces.

\n
\n
\n
\n
\n
\n

include_only [required]

\n
\n

[string]

\n

Include only these namespaces.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

tag_filters

\n
\n

[object]

\n

AWS Metrics collection tag filters list. Defaults to [].

\n
\n
\n
\n
\n
\n

namespace

\n
\n

string

\n

The AWS service for which the tag filters defined in tags will be applied.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

The AWS resource tags to filter on for the service specified by namespace.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the account integration was updated.

\n
\n \n
\n
\n
\n
\n
\n

resources_config

\n
\n

object

\n

AWS Resources Collection config.

\n
\n
\n
\n
\n
\n

cloud_security_posture_management_collection

\n
\n

boolean

\n

Enable Cloud Security Management to scan AWS resources for vulnerabilities, misconfigurations, identity risks, and compliance violations. Defaults to false. Requires extended_collection to be set to true.

\n
\n \n
\n
\n
\n
\n
\n

extended_collection

\n
\n

boolean

\n

Whether Datadog collects additional attributes and configuration information about the resources in your AWS account. Defaults to true. Required for cloud_security_posture_management_collection.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

traces_config

\n
\n

object

\n

AWS Traces Collection config.

\n
\n
\n
\n
\n
\n

xray_services

\n
\n

 <oneOf>

\n

AWS X-Ray services to collect traces from. Defaults to include_only.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

\n

Include all services.

\n
\n
\n
\n
\n
\n

include_all [required]

\n
\n

boolean

\n

Include all services.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

\n

Include only these services. Defaults to [].

\n
\n
\n
\n
\n
\n

include_only [required]

\n
\n

[string]

\n

Include only these services.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Unique Datadog ID of the AWS Account Integration Config.\nTo get the config ID for an account, use the List all AWS integrations\nendpoint and query by AWS Account ID.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

AWS Account resource type. \nAllowed enum values: account

default: account

\n
\n \n
\n
\n
\n
" }, "403": { "json": { @@ -96,7 +97,7 @@ "data": { "attributes": { "account_tags": [ - "key:value" + "env:prod" ], "auth_config": { "access_key_id": "AKIAIOSFODNN7EXAMPLE", @@ -105,7 +106,7 @@ "aws_account_id": "123456789012", "aws_partition": "aws", "aws_regions": { - "include_all": false + "include_all": true }, "created_at": "2019-09-19T10:00:00.000Z", "logs_config": { @@ -120,19 +121,20 @@ }, "metrics_config": { "automute_enabled": true, - "collect_cloudwatch_alarms": true, - "collect_custom_metrics": true, + "collect_cloudwatch_alarms": false, + "collect_custom_metrics": false, "enabled": true, "namespace_filters": { "exclude_only": [ - "AWS/EC2" + "AWS/SQS", + "AWS/ElasticMapReduce" ] }, "tag_filters": [ { "namespace": "AWS/EC2", "tags": [ - "key:value" + "datadog:true" ] } ] @@ -140,7 +142,7 @@ "modified_at": "2019-09-19T10:00:00.000Z", "resources_config": { "cloud_security_posture_management_collection": false, - "extended_collection": false + "extended_collection": true }, "traces_config": { "xray_services": { @@ -152,7 +154,7 @@ "type": "account" } }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

AWS Account Response body

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The AWS Account Integration Config

\n
\n
\n
\n
\n
\n

account_tags

\n
\n

[string]

\n

Tags to apply to all metrics in the account

\n
\n \n
\n
\n
\n
\n
\n

auth_config

\n
\n

 <oneOf>

\n

AWS Authentication config

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

AWS Authentication config for key-based account

\n
\n
\n
\n
\n
\n

access_key_id [required]

\n
\n

string

\n

AWS Access Key ID

\n
\n \n
\n
\n
\n
\n
\n

secret_access_key

\n
\n

string

\n

AWS Secret Access Key

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

AWS Authentication config for role-based account

\n
\n
\n
\n
\n
\n

external_id

\n
\n

string

\n

AWS IAM External ID for associated role

\n
\n \n
\n
\n
\n
\n
\n

role_name [required]

\n
\n

string

\n

AWS IAM Role name

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

aws_account_id [required]

\n
\n

string

\n

AWS Account ID

\n
\n \n
\n
\n
\n
\n
\n

aws_partition

\n
\n

enum

\n

AWS Account partition \nAllowed enum values: aws,aws-cn,aws-us-gov

default: aws

\n
\n \n
\n
\n
\n
\n
\n

aws_regions

\n
\n

 <oneOf>

\n

AWS Regions to collect data from

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

\n

Include all regions

\n
\n
\n
\n
\n
\n

include_all [required]

\n
\n

boolean

\n

Include all regions

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

\n

Include only these regions

\n
\n
\n
\n
\n
\n

include_only [required]

\n
\n

[string]

\n

Include only these regions

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp of when the account integration was created

\n
\n \n
\n
\n
\n
\n
\n

logs_config

\n
\n

object

\n

AWS Logs config

\n
\n
\n
\n
\n
\n

lambda_forwarder

\n
\n

object

\n

AWS Lambda forwarder

\n
\n
\n
\n
\n
\n

lambdas

\n
\n

[string]

\n

List of Datadog Lambda Log Forwarder ARNs

\n
\n \n
\n
\n
\n
\n
\n

sources

\n
\n

[string]

\n

List of AWS services that will send logs to the Datadog Lambda Log Forwarder

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

metrics_config

\n
\n

object

\n

AWS Metrics config

\n
\n
\n
\n
\n
\n

automute_enabled

\n
\n

boolean

\n

Enable EC2 automute for AWS metrics

\n
\n \n
\n
\n
\n
\n
\n

collect_cloudwatch_alarms

\n
\n

boolean

\n

Enable CloudWatch alarms collection

\n
\n \n
\n
\n
\n
\n
\n

collect_custom_metrics

\n
\n

boolean

\n

Enable custom metrics collection

\n
\n \n
\n
\n
\n
\n
\n

enabled

\n
\n

boolean

\n

Enable AWS metrics collection

\n
\n \n
\n
\n
\n
\n
\n

namespace_filters

\n
\n

 <oneOf>

\n

AWS Metrics namespace filters

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

\n

Exclude only these namespaces

\n
\n
\n
\n
\n
\n

exclude_only [required]

\n
\n

[string]

\n

Exclude only these namespaces

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

\n

Include only these namespaces

\n
\n
\n
\n
\n
\n

include_only [required]

\n
\n

[string]

\n

Include only these namespaces

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

tag_filters

\n
\n

[object]

\n

AWS Metrics tag filters list

\n
\n
\n
\n
\n
\n

namespace

\n
\n

string

\n

The AWS Namespace to apply the tag filters against

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

The tags to filter based on

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the account integration was updated

\n
\n \n
\n
\n
\n
\n
\n

resources_config

\n
\n

object

\n

AWS Resources config

\n
\n
\n
\n
\n
\n

cloud_security_posture_management_collection

\n
\n

boolean

\n

Whether Datadog collects cloud security posture management resources from your AWS account.

\n
\n \n
\n
\n
\n
\n
\n

extended_collection

\n
\n

boolean

\n

Whether Datadog collects additional attributes and configuration information about the resources in your AWS account. Required for cspm_resource_collection.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

traces_config

\n
\n

object

\n

AWS Traces config

\n
\n
\n
\n
\n
\n

xray_services

\n
\n

 <oneOf>

\n

AWS X-Ray services to collect traces from

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

\n

Include all services

\n
\n
\n
\n
\n
\n

include_all [required]

\n
\n

boolean

\n

Include all services

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

\n

Include only these services

\n
\n
\n
\n
\n
\n

include_only [required]

\n
\n

[string]

\n

Include only these services

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Unique Datadog ID of the AWS Account Integration Config

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

AWS Account resource type. \nAllowed enum values: account

default: account

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

AWS Account response data.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

AWS Account response attributes.

\n
\n
\n
\n
\n
\n

account_tags

\n
\n

[string]

\n

Tags to apply to all hosts and metrics reporting for this account. Defaults to [].

\n
\n \n
\n
\n
\n
\n
\n

auth_config

\n
\n

 <oneOf>

\n

AWS Authentication config.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

AWS Authentication config to integrate your account using an access key pair.

\n
\n
\n
\n
\n
\n

access_key_id [required]

\n
\n

string

\n

AWS Access Key ID.

\n
\n \n
\n
\n
\n
\n
\n

secret_access_key

\n
\n

string

\n

AWS Secret Access Key.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

AWS Authentication config to integrate your account using an IAM role.

\n
\n
\n
\n
\n
\n

external_id

\n
\n

string

\n

AWS IAM External ID for associated role.

\n
\n \n
\n
\n
\n
\n
\n

role_name [required]

\n
\n

string

\n

AWS IAM Role name.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

aws_account_id [required]

\n
\n

string

\n

AWS Account ID.

\n
\n \n
\n
\n
\n
\n
\n

aws_partition

\n
\n

enum

\n

AWS partition your AWS account is scoped to. Defaults to aws.\nSee Partitions in the AWS documentation for more information. \nAllowed enum values: aws,aws-cn,aws-us-gov

\n
\n \n
\n
\n
\n
\n
\n

aws_regions

\n
\n

 <oneOf>

\n

AWS Regions to collect data from. Defaults to include_all.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

\n

Include all regions. Defaults to true.

\n
\n
\n
\n
\n
\n

include_all [required]

\n
\n

boolean

\n

Include all regions.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

\n

Include only these regions.

\n
\n
\n
\n
\n
\n

include_only [required]

\n
\n

[string]

\n

Include only these regions.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp of when the account integration was created.

\n
\n \n
\n
\n
\n
\n
\n

logs_config

\n
\n

object

\n

AWS Logs Collection config.

\n
\n
\n
\n
\n
\n

lambda_forwarder

\n
\n

object

\n

Log Autosubscription configuration for Datadog Forwarder Lambda functions. Automatically set up triggers for existing\nand new logs for some services, ensuring no logs from new resources are missed and saving time spent on manual configuration.

\n
\n
\n
\n
\n
\n

lambdas

\n
\n

[string]

\n

List of Datadog Lambda Log Forwarder ARNs in your AWS account. Defaults to [].

\n
\n \n
\n
\n
\n
\n
\n

sources

\n
\n

[string]

\n

List of service IDs set to enable automatic log collection. Discover the list of available services with the\nGet list of AWS log ready services endpoint.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

metrics_config

\n
\n

object

\n

AWS Metrics Collection config.

\n
\n
\n
\n
\n
\n

automute_enabled

\n
\n

boolean

\n

Enable EC2 automute for AWS metrics. Defaults to true.

\n
\n \n
\n
\n
\n
\n
\n

collect_cloudwatch_alarms

\n
\n

boolean

\n

Enable CloudWatch alarms collection. Defaults to false.

\n
\n \n
\n
\n
\n
\n
\n

collect_custom_metrics

\n
\n

boolean

\n

Enable custom metrics collection. Defaults to false.

\n
\n \n
\n
\n
\n
\n
\n

enabled

\n
\n

boolean

\n

Enable AWS metrics collection. Defaults to true.

\n
\n \n
\n
\n
\n
\n
\n

namespace_filters

\n
\n

 <oneOf>

\n

AWS Metrics namespace filters. Defaults to exclude_only.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

\n

Exclude only these namespaces from metrics collection. Defaults to ["AWS/SQS", "AWS/ElasticMapReduce"].\nAWS/SQS and AWS/ElasticMapReduce are excluded by default to reduce your AWS CloudWatch costs from GetMetricData API calls.

\n
\n
\n
\n
\n
\n

exclude_only [required]

\n
\n

[string]

\n

Exclude only these namespaces from metrics collection. Defaults to ["AWS/SQS", "AWS/ElasticMapReduce"].\nAWS/SQS and AWS/ElasticMapReduce are excluded by default to reduce your AWS CloudWatch costs from GetMetricData API calls.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

\n

Include only these namespaces.

\n
\n
\n
\n
\n
\n

include_only [required]

\n
\n

[string]

\n

Include only these namespaces.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

tag_filters

\n
\n

[object]

\n

AWS Metrics collection tag filters list. Defaults to [].

\n
\n
\n
\n
\n
\n

namespace

\n
\n

string

\n

The AWS service for which the tag filters defined in tags will be applied.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

The AWS resource tags to filter on for the service specified by namespace.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the account integration was updated.

\n
\n \n
\n
\n
\n
\n
\n

resources_config

\n
\n

object

\n

AWS Resources Collection config.

\n
\n
\n
\n
\n
\n

cloud_security_posture_management_collection

\n
\n

boolean

\n

Enable Cloud Security Management to scan AWS resources for vulnerabilities, misconfigurations, identity risks, and compliance violations. Defaults to false. Requires extended_collection to be set to true.

\n
\n \n
\n
\n
\n
\n
\n

extended_collection

\n
\n

boolean

\n

Whether Datadog collects additional attributes and configuration information about the resources in your AWS account. Defaults to true. Required for cloud_security_posture_management_collection.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

traces_config

\n
\n

object

\n

AWS Traces Collection config.

\n
\n
\n
\n
\n
\n

xray_services

\n
\n

 <oneOf>

\n

AWS X-Ray services to collect traces from. Defaults to include_only.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

\n

Include all services.

\n
\n
\n
\n
\n
\n

include_all [required]

\n
\n

boolean

\n

Include all services.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

\n

Include only these services. Defaults to [].

\n
\n
\n
\n
\n
\n

include_only [required]

\n
\n

[string]

\n

Include only these services.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Unique Datadog ID of the AWS Account Integration Config.\nTo get the config ID for an account, use the List all AWS integrations\nendpoint and query by AWS Account ID.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

AWS Account resource type. \nAllowed enum values: account

default: account

\n
\n \n
\n
\n
\n
" }, "400": { "json": { @@ -202,7 +204,7 @@ "data": { "attributes": { "account_tags": [ - "key:value" + "env:prod" ], "auth_config": { "access_key_id": "AKIAIOSFODNN7EXAMPLE", @@ -211,7 +213,7 @@ "aws_account_id": "123456789012", "aws_partition": "aws", "aws_regions": { - "include_all": false + "include_all": true }, "logs_config": { "lambda_forwarder": { @@ -225,26 +227,27 @@ }, "metrics_config": { "automute_enabled": true, - "collect_cloudwatch_alarms": true, - "collect_custom_metrics": true, + "collect_cloudwatch_alarms": false, + "collect_custom_metrics": false, "enabled": true, "namespace_filters": { "exclude_only": [ - "AWS/EC2" + "AWS/SQS", + "AWS/ElasticMapReduce" ] }, "tag_filters": [ { "namespace": "AWS/EC2", "tags": [ - "key:value" + "datadog:true" ] } ] }, "resources_config": { "cloud_security_posture_management_collection": false, - "extended_collection": false + "extended_collection": true }, "traces_config": { "xray_services": { @@ -255,7 +258,7 @@ "type": "account" } }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

AWS Account Create Request data

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

The AWS Account Integration Config to be created

\n
\n
\n
\n
\n
\n

account_tags

\n
\n

[string]

\n

Tags to apply to all metrics in the account

\n
\n \n
\n
\n
\n
\n
\n

auth_config [required]

\n
\n

 <oneOf>

\n

AWS Authentication config

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

AWS Authentication config for key-based account

\n
\n
\n
\n
\n
\n

access_key_id [required]

\n
\n

string

\n

AWS Access Key ID

\n
\n \n
\n
\n
\n
\n
\n

secret_access_key

\n
\n

string

\n

AWS Secret Access Key

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

AWS Authentication config for role-based account

\n
\n
\n
\n
\n
\n

external_id

\n
\n

string

\n

AWS IAM External ID for associated role

\n
\n \n
\n
\n
\n
\n
\n

role_name [required]

\n
\n

string

\n

AWS IAM Role name

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

aws_account_id [required]

\n
\n

string

\n

AWS Account ID

\n
\n \n
\n
\n
\n
\n
\n

aws_partition [required]

\n
\n

enum

\n

AWS Account partition \nAllowed enum values: aws,aws-cn,aws-us-gov

default: aws

\n
\n \n
\n
\n
\n
\n
\n

aws_regions

\n
\n

 <oneOf>

\n

AWS Regions to collect data from

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

\n

Include all regions

\n
\n
\n
\n
\n
\n

include_all [required]

\n
\n

boolean

\n

Include all regions

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

\n

Include only these regions

\n
\n
\n
\n
\n
\n

include_only [required]

\n
\n

[string]

\n

Include only these regions

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

logs_config

\n
\n

object

\n

AWS Logs config

\n
\n
\n
\n
\n
\n

lambda_forwarder

\n
\n

object

\n

AWS Lambda forwarder

\n
\n
\n
\n
\n
\n

lambdas

\n
\n

[string]

\n

List of Datadog Lambda Log Forwarder ARNs

\n
\n \n
\n
\n
\n
\n
\n

sources

\n
\n

[string]

\n

List of AWS services that will send logs to the Datadog Lambda Log Forwarder

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

metrics_config

\n
\n

object

\n

AWS Metrics config

\n
\n
\n
\n
\n
\n

automute_enabled

\n
\n

boolean

\n

Enable EC2 automute for AWS metrics

\n
\n \n
\n
\n
\n
\n
\n

collect_cloudwatch_alarms

\n
\n

boolean

\n

Enable CloudWatch alarms collection

\n
\n \n
\n
\n
\n
\n
\n

collect_custom_metrics

\n
\n

boolean

\n

Enable custom metrics collection

\n
\n \n
\n
\n
\n
\n
\n

enabled

\n
\n

boolean

\n

Enable AWS metrics collection

\n
\n \n
\n
\n
\n
\n
\n

namespace_filters

\n
\n

 <oneOf>

\n

AWS Metrics namespace filters

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

\n

Exclude only these namespaces

\n
\n
\n
\n
\n
\n

exclude_only [required]

\n
\n

[string]

\n

Exclude only these namespaces

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

\n

Include only these namespaces

\n
\n
\n
\n
\n
\n

include_only [required]

\n
\n

[string]

\n

Include only these namespaces

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

tag_filters

\n
\n

[object]

\n

AWS Metrics tag filters list

\n
\n
\n
\n
\n
\n

namespace

\n
\n

string

\n

The AWS Namespace to apply the tag filters against

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

The tags to filter based on

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

resources_config

\n
\n

object

\n

AWS Resources config

\n
\n
\n
\n
\n
\n

cloud_security_posture_management_collection

\n
\n

boolean

\n

Whether Datadog collects cloud security posture management resources from your AWS account.

\n
\n \n
\n
\n
\n
\n
\n

extended_collection

\n
\n

boolean

\n

Whether Datadog collects additional attributes and configuration information about the resources in your AWS account. Required for cspm_resource_collection.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

traces_config

\n
\n

object

\n

AWS Traces config

\n
\n
\n
\n
\n
\n

xray_services

\n
\n

 <oneOf>

\n

AWS X-Ray services to collect traces from

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

\n

Include all services

\n
\n
\n
\n
\n
\n

include_all [required]

\n
\n

boolean

\n

Include all services

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

\n

Include only these services

\n
\n
\n
\n
\n
\n

include_only [required]

\n
\n

[string]

\n

Include only these services

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

AWS Account resource type. \nAllowed enum values: account

default: account

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

AWS Account Create Request data.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

The AWS Account Integration Config to be created.

\n
\n
\n
\n
\n
\n

account_tags

\n
\n

[string]

\n

Tags to apply to all hosts and metrics reporting for this account. Defaults to [].

\n
\n \n
\n
\n
\n
\n
\n

auth_config [required]

\n
\n

 <oneOf>

\n

AWS Authentication config.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

AWS Authentication config to integrate your account using an access key pair.

\n
\n
\n
\n
\n
\n

access_key_id [required]

\n
\n

string

\n

AWS Access Key ID.

\n
\n \n
\n
\n
\n
\n
\n

secret_access_key

\n
\n

string

\n

AWS Secret Access Key.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

AWS Authentication config to integrate your account using an IAM role.

\n
\n
\n
\n
\n
\n

external_id

\n
\n

string

\n

AWS IAM External ID for associated role.

\n
\n \n
\n
\n
\n
\n
\n

role_name [required]

\n
\n

string

\n

AWS IAM Role name.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

aws_account_id [required]

\n
\n

string

\n

AWS Account ID.

\n
\n \n
\n
\n
\n
\n
\n

aws_partition [required]

\n
\n

enum

\n

AWS partition your AWS account is scoped to. Defaults to aws.\nSee Partitions in the AWS documentation for more information. \nAllowed enum values: aws,aws-cn,aws-us-gov

\n
\n \n
\n
\n
\n
\n
\n

aws_regions

\n
\n

 <oneOf>

\n

AWS Regions to collect data from. Defaults to include_all.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

\n

Include all regions. Defaults to true.

\n
\n
\n
\n
\n
\n

include_all [required]

\n
\n

boolean

\n

Include all regions.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

\n

Include only these regions.

\n
\n
\n
\n
\n
\n

include_only [required]

\n
\n

[string]

\n

Include only these regions.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

logs_config

\n
\n

object

\n

AWS Logs Collection config.

\n
\n
\n
\n
\n
\n

lambda_forwarder

\n
\n

object

\n

Log Autosubscription configuration for Datadog Forwarder Lambda functions. Automatically set up triggers for existing\nand new logs for some services, ensuring no logs from new resources are missed and saving time spent on manual configuration.

\n
\n
\n
\n
\n
\n

lambdas

\n
\n

[string]

\n

List of Datadog Lambda Log Forwarder ARNs in your AWS account. Defaults to [].

\n
\n \n
\n
\n
\n
\n
\n

sources

\n
\n

[string]

\n

List of service IDs set to enable automatic log collection. Discover the list of available services with the\nGet list of AWS log ready services endpoint.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

metrics_config

\n
\n

object

\n

AWS Metrics Collection config.

\n
\n
\n
\n
\n
\n

automute_enabled

\n
\n

boolean

\n

Enable EC2 automute for AWS metrics. Defaults to true.

\n
\n \n
\n
\n
\n
\n
\n

collect_cloudwatch_alarms

\n
\n

boolean

\n

Enable CloudWatch alarms collection. Defaults to false.

\n
\n \n
\n
\n
\n
\n
\n

collect_custom_metrics

\n
\n

boolean

\n

Enable custom metrics collection. Defaults to false.

\n
\n \n
\n
\n
\n
\n
\n

enabled

\n
\n

boolean

\n

Enable AWS metrics collection. Defaults to true.

\n
\n \n
\n
\n
\n
\n
\n

namespace_filters

\n
\n

 <oneOf>

\n

AWS Metrics namespace filters. Defaults to exclude_only.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

\n

Exclude only these namespaces from metrics collection. Defaults to ["AWS/SQS", "AWS/ElasticMapReduce"].\nAWS/SQS and AWS/ElasticMapReduce are excluded by default to reduce your AWS CloudWatch costs from GetMetricData API calls.

\n
\n
\n
\n
\n
\n

exclude_only [required]

\n
\n

[string]

\n

Exclude only these namespaces from metrics collection. Defaults to ["AWS/SQS", "AWS/ElasticMapReduce"].\nAWS/SQS and AWS/ElasticMapReduce are excluded by default to reduce your AWS CloudWatch costs from GetMetricData API calls.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

\n

Include only these namespaces.

\n
\n
\n
\n
\n
\n

include_only [required]

\n
\n

[string]

\n

Include only these namespaces.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

tag_filters

\n
\n

[object]

\n

AWS Metrics collection tag filters list. Defaults to [].

\n
\n
\n
\n
\n
\n

namespace

\n
\n

string

\n

The AWS service for which the tag filters defined in tags will be applied.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

The AWS resource tags to filter on for the service specified by namespace.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

resources_config

\n
\n

object

\n

AWS Resources Collection config.

\n
\n
\n
\n
\n
\n

cloud_security_posture_management_collection

\n
\n

boolean

\n

Enable Cloud Security Management to scan AWS resources for vulnerabilities, misconfigurations, identity risks, and compliance violations. Defaults to false. Requires extended_collection to be set to true.

\n
\n \n
\n
\n
\n
\n
\n

extended_collection

\n
\n

boolean

\n

Whether Datadog collects additional attributes and configuration information about the resources in your AWS account. Defaults to true. Required for cloud_security_posture_management_collection.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

traces_config

\n
\n

object

\n

AWS Traces Collection config.

\n
\n
\n
\n
\n
\n

xray_services

\n
\n

 <oneOf>

\n

AWS X-Ray services to collect traces from. Defaults to include_only.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

\n

Include all services.

\n
\n
\n
\n
\n
\n

include_all [required]

\n
\n

boolean

\n

Include all services.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

\n

Include only these services. Defaults to [].

\n
\n
\n
\n
\n
\n

include_only [required]

\n
\n

[string]

\n

Include only these services.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

AWS Account resource type. \nAllowed enum values: account

default: account

\n
\n \n
\n
\n
\n
" } }, "DeleteAWSAccount": { @@ -306,7 +309,7 @@ "data": { "attributes": { "account_tags": [ - "key:value" + "env:prod" ], "auth_config": { "access_key_id": "AKIAIOSFODNN7EXAMPLE", @@ -315,7 +318,7 @@ "aws_account_id": "123456789012", "aws_partition": "aws", "aws_regions": { - "include_all": false + "include_all": true }, "created_at": "2019-09-19T10:00:00.000Z", "logs_config": { @@ -330,19 +333,20 @@ }, "metrics_config": { "automute_enabled": true, - "collect_cloudwatch_alarms": true, - "collect_custom_metrics": true, + "collect_cloudwatch_alarms": false, + "collect_custom_metrics": false, "enabled": true, "namespace_filters": { "exclude_only": [ - "AWS/EC2" + "AWS/SQS", + "AWS/ElasticMapReduce" ] }, "tag_filters": [ { "namespace": "AWS/EC2", "tags": [ - "key:value" + "datadog:true" ] } ] @@ -350,7 +354,7 @@ "modified_at": "2019-09-19T10:00:00.000Z", "resources_config": { "cloud_security_posture_management_collection": false, - "extended_collection": false + "extended_collection": true }, "traces_config": { "xray_services": { @@ -362,7 +366,7 @@ "type": "account" } }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

AWS Account Response body

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The AWS Account Integration Config

\n
\n
\n
\n
\n
\n

account_tags

\n
\n

[string]

\n

Tags to apply to all metrics in the account

\n
\n \n
\n
\n
\n
\n
\n

auth_config

\n
\n

 <oneOf>

\n

AWS Authentication config

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

AWS Authentication config for key-based account

\n
\n
\n
\n
\n
\n

access_key_id [required]

\n
\n

string

\n

AWS Access Key ID

\n
\n \n
\n
\n
\n
\n
\n

secret_access_key

\n
\n

string

\n

AWS Secret Access Key

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

AWS Authentication config for role-based account

\n
\n
\n
\n
\n
\n

external_id

\n
\n

string

\n

AWS IAM External ID for associated role

\n
\n \n
\n
\n
\n
\n
\n

role_name [required]

\n
\n

string

\n

AWS IAM Role name

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

aws_account_id [required]

\n
\n

string

\n

AWS Account ID

\n
\n \n
\n
\n
\n
\n
\n

aws_partition

\n
\n

enum

\n

AWS Account partition \nAllowed enum values: aws,aws-cn,aws-us-gov

default: aws

\n
\n \n
\n
\n
\n
\n
\n

aws_regions

\n
\n

 <oneOf>

\n

AWS Regions to collect data from

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

\n

Include all regions

\n
\n
\n
\n
\n
\n

include_all [required]

\n
\n

boolean

\n

Include all regions

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

\n

Include only these regions

\n
\n
\n
\n
\n
\n

include_only [required]

\n
\n

[string]

\n

Include only these regions

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp of when the account integration was created

\n
\n \n
\n
\n
\n
\n
\n

logs_config

\n
\n

object

\n

AWS Logs config

\n
\n
\n
\n
\n
\n

lambda_forwarder

\n
\n

object

\n

AWS Lambda forwarder

\n
\n
\n
\n
\n
\n

lambdas

\n
\n

[string]

\n

List of Datadog Lambda Log Forwarder ARNs

\n
\n \n
\n
\n
\n
\n
\n

sources

\n
\n

[string]

\n

List of AWS services that will send logs to the Datadog Lambda Log Forwarder

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

metrics_config

\n
\n

object

\n

AWS Metrics config

\n
\n
\n
\n
\n
\n

automute_enabled

\n
\n

boolean

\n

Enable EC2 automute for AWS metrics

\n
\n \n
\n
\n
\n
\n
\n

collect_cloudwatch_alarms

\n
\n

boolean

\n

Enable CloudWatch alarms collection

\n
\n \n
\n
\n
\n
\n
\n

collect_custom_metrics

\n
\n

boolean

\n

Enable custom metrics collection

\n
\n \n
\n
\n
\n
\n
\n

enabled

\n
\n

boolean

\n

Enable AWS metrics collection

\n
\n \n
\n
\n
\n
\n
\n

namespace_filters

\n
\n

 <oneOf>

\n

AWS Metrics namespace filters

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

\n

Exclude only these namespaces

\n
\n
\n
\n
\n
\n

exclude_only [required]

\n
\n

[string]

\n

Exclude only these namespaces

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

\n

Include only these namespaces

\n
\n
\n
\n
\n
\n

include_only [required]

\n
\n

[string]

\n

Include only these namespaces

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

tag_filters

\n
\n

[object]

\n

AWS Metrics tag filters list

\n
\n
\n
\n
\n
\n

namespace

\n
\n

string

\n

The AWS Namespace to apply the tag filters against

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

The tags to filter based on

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the account integration was updated

\n
\n \n
\n
\n
\n
\n
\n

resources_config

\n
\n

object

\n

AWS Resources config

\n
\n
\n
\n
\n
\n

cloud_security_posture_management_collection

\n
\n

boolean

\n

Whether Datadog collects cloud security posture management resources from your AWS account.

\n
\n \n
\n
\n
\n
\n
\n

extended_collection

\n
\n

boolean

\n

Whether Datadog collects additional attributes and configuration information about the resources in your AWS account. Required for cspm_resource_collection.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

traces_config

\n
\n

object

\n

AWS Traces config

\n
\n
\n
\n
\n
\n

xray_services

\n
\n

 <oneOf>

\n

AWS X-Ray services to collect traces from

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

\n

Include all services

\n
\n
\n
\n
\n
\n

include_all [required]

\n
\n

boolean

\n

Include all services

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

\n

Include only these services

\n
\n
\n
\n
\n
\n

include_only [required]

\n
\n

[string]

\n

Include only these services

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Unique Datadog ID of the AWS Account Integration Config

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

AWS Account resource type. \nAllowed enum values: account

default: account

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

AWS Account response data.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

AWS Account response attributes.

\n
\n
\n
\n
\n
\n

account_tags

\n
\n

[string]

\n

Tags to apply to all hosts and metrics reporting for this account. Defaults to [].

\n
\n \n
\n
\n
\n
\n
\n

auth_config

\n
\n

 <oneOf>

\n

AWS Authentication config.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

AWS Authentication config to integrate your account using an access key pair.

\n
\n
\n
\n
\n
\n

access_key_id [required]

\n
\n

string

\n

AWS Access Key ID.

\n
\n \n
\n
\n
\n
\n
\n

secret_access_key

\n
\n

string

\n

AWS Secret Access Key.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

AWS Authentication config to integrate your account using an IAM role.

\n
\n
\n
\n
\n
\n

external_id

\n
\n

string

\n

AWS IAM External ID for associated role.

\n
\n \n
\n
\n
\n
\n
\n

role_name [required]

\n
\n

string

\n

AWS IAM Role name.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

aws_account_id [required]

\n
\n

string

\n

AWS Account ID.

\n
\n \n
\n
\n
\n
\n
\n

aws_partition

\n
\n

enum

\n

AWS partition your AWS account is scoped to. Defaults to aws.\nSee Partitions in the AWS documentation for more information. \nAllowed enum values: aws,aws-cn,aws-us-gov

\n
\n \n
\n
\n
\n
\n
\n

aws_regions

\n
\n

 <oneOf>

\n

AWS Regions to collect data from. Defaults to include_all.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

\n

Include all regions. Defaults to true.

\n
\n
\n
\n
\n
\n

include_all [required]

\n
\n

boolean

\n

Include all regions.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

\n

Include only these regions.

\n
\n
\n
\n
\n
\n

include_only [required]

\n
\n

[string]

\n

Include only these regions.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp of when the account integration was created.

\n
\n \n
\n
\n
\n
\n
\n

logs_config

\n
\n

object

\n

AWS Logs Collection config.

\n
\n
\n
\n
\n
\n

lambda_forwarder

\n
\n

object

\n

Log Autosubscription configuration for Datadog Forwarder Lambda functions. Automatically set up triggers for existing\nand new logs for some services, ensuring no logs from new resources are missed and saving time spent on manual configuration.

\n
\n
\n
\n
\n
\n

lambdas

\n
\n

[string]

\n

List of Datadog Lambda Log Forwarder ARNs in your AWS account. Defaults to [].

\n
\n \n
\n
\n
\n
\n
\n

sources

\n
\n

[string]

\n

List of service IDs set to enable automatic log collection. Discover the list of available services with the\nGet list of AWS log ready services endpoint.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

metrics_config

\n
\n

object

\n

AWS Metrics Collection config.

\n
\n
\n
\n
\n
\n

automute_enabled

\n
\n

boolean

\n

Enable EC2 automute for AWS metrics. Defaults to true.

\n
\n \n
\n
\n
\n
\n
\n

collect_cloudwatch_alarms

\n
\n

boolean

\n

Enable CloudWatch alarms collection. Defaults to false.

\n
\n \n
\n
\n
\n
\n
\n

collect_custom_metrics

\n
\n

boolean

\n

Enable custom metrics collection. Defaults to false.

\n
\n \n
\n
\n
\n
\n
\n

enabled

\n
\n

boolean

\n

Enable AWS metrics collection. Defaults to true.

\n
\n \n
\n
\n
\n
\n
\n

namespace_filters

\n
\n

 <oneOf>

\n

AWS Metrics namespace filters. Defaults to exclude_only.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

\n

Exclude only these namespaces from metrics collection. Defaults to ["AWS/SQS", "AWS/ElasticMapReduce"].\nAWS/SQS and AWS/ElasticMapReduce are excluded by default to reduce your AWS CloudWatch costs from GetMetricData API calls.

\n
\n
\n
\n
\n
\n

exclude_only [required]

\n
\n

[string]

\n

Exclude only these namespaces from metrics collection. Defaults to ["AWS/SQS", "AWS/ElasticMapReduce"].\nAWS/SQS and AWS/ElasticMapReduce are excluded by default to reduce your AWS CloudWatch costs from GetMetricData API calls.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

\n

Include only these namespaces.

\n
\n
\n
\n
\n
\n

include_only [required]

\n
\n

[string]

\n

Include only these namespaces.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

tag_filters

\n
\n

[object]

\n

AWS Metrics collection tag filters list. Defaults to [].

\n
\n
\n
\n
\n
\n

namespace

\n
\n

string

\n

The AWS service for which the tag filters defined in tags will be applied.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

The AWS resource tags to filter on for the service specified by namespace.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the account integration was updated.

\n
\n \n
\n
\n
\n
\n
\n

resources_config

\n
\n

object

\n

AWS Resources Collection config.

\n
\n
\n
\n
\n
\n

cloud_security_posture_management_collection

\n
\n

boolean

\n

Enable Cloud Security Management to scan AWS resources for vulnerabilities, misconfigurations, identity risks, and compliance violations. Defaults to false. Requires extended_collection to be set to true.

\n
\n \n
\n
\n
\n
\n
\n

extended_collection

\n
\n

boolean

\n

Whether Datadog collects additional attributes and configuration information about the resources in your AWS account. Defaults to true. Required for cloud_security_posture_management_collection.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

traces_config

\n
\n

object

\n

AWS Traces Collection config.

\n
\n
\n
\n
\n
\n

xray_services

\n
\n

 <oneOf>

\n

AWS X-Ray services to collect traces from. Defaults to include_only.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

\n

Include all services.

\n
\n
\n
\n
\n
\n

include_all [required]

\n
\n

boolean

\n

Include all services.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

\n

Include only these services. Defaults to [].

\n
\n
\n
\n
\n
\n

include_only [required]

\n
\n

[string]

\n

Include only these services.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Unique Datadog ID of the AWS Account Integration Config.\nTo get the config ID for an account, use the List all AWS integrations\nendpoint and query by AWS Account ID.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

AWS Account resource type. \nAllowed enum values: account

default: account

\n
\n \n
\n
\n
\n
" }, "400": { "json": { @@ -410,7 +414,7 @@ "data": { "attributes": { "account_tags": [ - "key:value" + "env:prod" ], "auth_config": { "access_key_id": "AKIAIOSFODNN7EXAMPLE", @@ -419,7 +423,7 @@ "aws_account_id": "123456789012", "aws_partition": "aws", "aws_regions": { - "include_all": false + "include_all": true }, "created_at": "2019-09-19T10:00:00.000Z", "logs_config": { @@ -434,19 +438,20 @@ }, "metrics_config": { "automute_enabled": true, - "collect_cloudwatch_alarms": true, - "collect_custom_metrics": true, + "collect_cloudwatch_alarms": false, + "collect_custom_metrics": false, "enabled": true, "namespace_filters": { "exclude_only": [ - "AWS/EC2" + "AWS/SQS", + "AWS/ElasticMapReduce" ] }, "tag_filters": [ { "namespace": "AWS/EC2", "tags": [ - "key:value" + "datadog:true" ] } ] @@ -454,7 +459,7 @@ "modified_at": "2019-09-19T10:00:00.000Z", "resources_config": { "cloud_security_posture_management_collection": false, - "extended_collection": false + "extended_collection": true }, "traces_config": { "xray_services": { @@ -466,7 +471,7 @@ "type": "account" } }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

AWS Account Response body

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The AWS Account Integration Config

\n
\n
\n
\n
\n
\n

account_tags

\n
\n

[string]

\n

Tags to apply to all metrics in the account

\n
\n \n
\n
\n
\n
\n
\n

auth_config

\n
\n

 <oneOf>

\n

AWS Authentication config

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

AWS Authentication config for key-based account

\n
\n
\n
\n
\n
\n

access_key_id [required]

\n
\n

string

\n

AWS Access Key ID

\n
\n \n
\n
\n
\n
\n
\n

secret_access_key

\n
\n

string

\n

AWS Secret Access Key

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

AWS Authentication config for role-based account

\n
\n
\n
\n
\n
\n

external_id

\n
\n

string

\n

AWS IAM External ID for associated role

\n
\n \n
\n
\n
\n
\n
\n

role_name [required]

\n
\n

string

\n

AWS IAM Role name

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

aws_account_id [required]

\n
\n

string

\n

AWS Account ID

\n
\n \n
\n
\n
\n
\n
\n

aws_partition

\n
\n

enum

\n

AWS Account partition \nAllowed enum values: aws,aws-cn,aws-us-gov

default: aws

\n
\n \n
\n
\n
\n
\n
\n

aws_regions

\n
\n

 <oneOf>

\n

AWS Regions to collect data from

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

\n

Include all regions

\n
\n
\n
\n
\n
\n

include_all [required]

\n
\n

boolean

\n

Include all regions

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

\n

Include only these regions

\n
\n
\n
\n
\n
\n

include_only [required]

\n
\n

[string]

\n

Include only these regions

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp of when the account integration was created

\n
\n \n
\n
\n
\n
\n
\n

logs_config

\n
\n

object

\n

AWS Logs config

\n
\n
\n
\n
\n
\n

lambda_forwarder

\n
\n

object

\n

AWS Lambda forwarder

\n
\n
\n
\n
\n
\n

lambdas

\n
\n

[string]

\n

List of Datadog Lambda Log Forwarder ARNs

\n
\n \n
\n
\n
\n
\n
\n

sources

\n
\n

[string]

\n

List of AWS services that will send logs to the Datadog Lambda Log Forwarder

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

metrics_config

\n
\n

object

\n

AWS Metrics config

\n
\n
\n
\n
\n
\n

automute_enabled

\n
\n

boolean

\n

Enable EC2 automute for AWS metrics

\n
\n \n
\n
\n
\n
\n
\n

collect_cloudwatch_alarms

\n
\n

boolean

\n

Enable CloudWatch alarms collection

\n
\n \n
\n
\n
\n
\n
\n

collect_custom_metrics

\n
\n

boolean

\n

Enable custom metrics collection

\n
\n \n
\n
\n
\n
\n
\n

enabled

\n
\n

boolean

\n

Enable AWS metrics collection

\n
\n \n
\n
\n
\n
\n
\n

namespace_filters

\n
\n

 <oneOf>

\n

AWS Metrics namespace filters

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

\n

Exclude only these namespaces

\n
\n
\n
\n
\n
\n

exclude_only [required]

\n
\n

[string]

\n

Exclude only these namespaces

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

\n

Include only these namespaces

\n
\n
\n
\n
\n
\n

include_only [required]

\n
\n

[string]

\n

Include only these namespaces

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

tag_filters

\n
\n

[object]

\n

AWS Metrics tag filters list

\n
\n
\n
\n
\n
\n

namespace

\n
\n

string

\n

The AWS Namespace to apply the tag filters against

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

The tags to filter based on

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the account integration was updated

\n
\n \n
\n
\n
\n
\n
\n

resources_config

\n
\n

object

\n

AWS Resources config

\n
\n
\n
\n
\n
\n

cloud_security_posture_management_collection

\n
\n

boolean

\n

Whether Datadog collects cloud security posture management resources from your AWS account.

\n
\n \n
\n
\n
\n
\n
\n

extended_collection

\n
\n

boolean

\n

Whether Datadog collects additional attributes and configuration information about the resources in your AWS account. Required for cspm_resource_collection.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

traces_config

\n
\n

object

\n

AWS Traces config

\n
\n
\n
\n
\n
\n

xray_services

\n
\n

 <oneOf>

\n

AWS X-Ray services to collect traces from

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

\n

Include all services

\n
\n
\n
\n
\n
\n

include_all [required]

\n
\n

boolean

\n

Include all services

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

\n

Include only these services

\n
\n
\n
\n
\n
\n

include_only [required]

\n
\n

[string]

\n

Include only these services

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Unique Datadog ID of the AWS Account Integration Config

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

AWS Account resource type. \nAllowed enum values: account

default: account

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

AWS Account response data.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

AWS Account response attributes.

\n
\n
\n
\n
\n
\n

account_tags

\n
\n

[string]

\n

Tags to apply to all hosts and metrics reporting for this account. Defaults to [].

\n
\n \n
\n
\n
\n
\n
\n

auth_config

\n
\n

 <oneOf>

\n

AWS Authentication config.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

AWS Authentication config to integrate your account using an access key pair.

\n
\n
\n
\n
\n
\n

access_key_id [required]

\n
\n

string

\n

AWS Access Key ID.

\n
\n \n
\n
\n
\n
\n
\n

secret_access_key

\n
\n

string

\n

AWS Secret Access Key.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

AWS Authentication config to integrate your account using an IAM role.

\n
\n
\n
\n
\n
\n

external_id

\n
\n

string

\n

AWS IAM External ID for associated role.

\n
\n \n
\n
\n
\n
\n
\n

role_name [required]

\n
\n

string

\n

AWS IAM Role name.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

aws_account_id [required]

\n
\n

string

\n

AWS Account ID.

\n
\n \n
\n
\n
\n
\n
\n

aws_partition

\n
\n

enum

\n

AWS partition your AWS account is scoped to. Defaults to aws.\nSee Partitions in the AWS documentation for more information. \nAllowed enum values: aws,aws-cn,aws-us-gov

\n
\n \n
\n
\n
\n
\n
\n

aws_regions

\n
\n

 <oneOf>

\n

AWS Regions to collect data from. Defaults to include_all.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

\n

Include all regions. Defaults to true.

\n
\n
\n
\n
\n
\n

include_all [required]

\n
\n

boolean

\n

Include all regions.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

\n

Include only these regions.

\n
\n
\n
\n
\n
\n

include_only [required]

\n
\n

[string]

\n

Include only these regions.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp of when the account integration was created.

\n
\n \n
\n
\n
\n
\n
\n

logs_config

\n
\n

object

\n

AWS Logs Collection config.

\n
\n
\n
\n
\n
\n

lambda_forwarder

\n
\n

object

\n

Log Autosubscription configuration for Datadog Forwarder Lambda functions. Automatically set up triggers for existing\nand new logs for some services, ensuring no logs from new resources are missed and saving time spent on manual configuration.

\n
\n
\n
\n
\n
\n

lambdas

\n
\n

[string]

\n

List of Datadog Lambda Log Forwarder ARNs in your AWS account. Defaults to [].

\n
\n \n
\n
\n
\n
\n
\n

sources

\n
\n

[string]

\n

List of service IDs set to enable automatic log collection. Discover the list of available services with the\nGet list of AWS log ready services endpoint.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

metrics_config

\n
\n

object

\n

AWS Metrics Collection config.

\n
\n
\n
\n
\n
\n

automute_enabled

\n
\n

boolean

\n

Enable EC2 automute for AWS metrics. Defaults to true.

\n
\n \n
\n
\n
\n
\n
\n

collect_cloudwatch_alarms

\n
\n

boolean

\n

Enable CloudWatch alarms collection. Defaults to false.

\n
\n \n
\n
\n
\n
\n
\n

collect_custom_metrics

\n
\n

boolean

\n

Enable custom metrics collection. Defaults to false.

\n
\n \n
\n
\n
\n
\n
\n

enabled

\n
\n

boolean

\n

Enable AWS metrics collection. Defaults to true.

\n
\n \n
\n
\n
\n
\n
\n

namespace_filters

\n
\n

 <oneOf>

\n

AWS Metrics namespace filters. Defaults to exclude_only.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

\n

Exclude only these namespaces from metrics collection. Defaults to ["AWS/SQS", "AWS/ElasticMapReduce"].\nAWS/SQS and AWS/ElasticMapReduce are excluded by default to reduce your AWS CloudWatch costs from GetMetricData API calls.

\n
\n
\n
\n
\n
\n

exclude_only [required]

\n
\n

[string]

\n

Exclude only these namespaces from metrics collection. Defaults to ["AWS/SQS", "AWS/ElasticMapReduce"].\nAWS/SQS and AWS/ElasticMapReduce are excluded by default to reduce your AWS CloudWatch costs from GetMetricData API calls.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

\n

Include only these namespaces.

\n
\n
\n
\n
\n
\n

include_only [required]

\n
\n

[string]

\n

Include only these namespaces.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

tag_filters

\n
\n

[object]

\n

AWS Metrics collection tag filters list. Defaults to [].

\n
\n
\n
\n
\n
\n

namespace

\n
\n

string

\n

The AWS service for which the tag filters defined in tags will be applied.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

The AWS resource tags to filter on for the service specified by namespace.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the account integration was updated.

\n
\n \n
\n
\n
\n
\n
\n

resources_config

\n
\n

object

\n

AWS Resources Collection config.

\n
\n
\n
\n
\n
\n

cloud_security_posture_management_collection

\n
\n

boolean

\n

Enable Cloud Security Management to scan AWS resources for vulnerabilities, misconfigurations, identity risks, and compliance violations. Defaults to false. Requires extended_collection to be set to true.

\n
\n \n
\n
\n
\n
\n
\n

extended_collection

\n
\n

boolean

\n

Whether Datadog collects additional attributes and configuration information about the resources in your AWS account. Defaults to true. Required for cloud_security_posture_management_collection.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

traces_config

\n
\n

object

\n

AWS Traces Collection config.

\n
\n
\n
\n
\n
\n

xray_services

\n
\n

 <oneOf>

\n

AWS X-Ray services to collect traces from. Defaults to include_only.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

\n

Include all services.

\n
\n
\n
\n
\n
\n

include_all [required]

\n
\n

boolean

\n

Include all services.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

\n

Include only these services. Defaults to [].

\n
\n
\n
\n
\n
\n

include_only [required]

\n
\n

[string]

\n

Include only these services.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Unique Datadog ID of the AWS Account Integration Config.\nTo get the config ID for an account, use the List all AWS integrations\nendpoint and query by AWS Account ID.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

AWS Account resource type. \nAllowed enum values: account

default: account

\n
\n \n
\n
\n
\n
" }, "400": { "json": { @@ -514,7 +519,7 @@ "data": { "attributes": { "account_tags": [ - "key:value" + "env:prod" ], "auth_config": { "access_key_id": "AKIAIOSFODNN7EXAMPLE", @@ -523,7 +528,7 @@ "aws_account_id": "123456789012", "aws_partition": "aws", "aws_regions": { - "include_all": false + "include_all": true }, "logs_config": { "lambda_forwarder": { @@ -537,26 +542,27 @@ }, "metrics_config": { "automute_enabled": true, - "collect_cloudwatch_alarms": true, - "collect_custom_metrics": true, + "collect_cloudwatch_alarms": false, + "collect_custom_metrics": false, "enabled": true, "namespace_filters": { "exclude_only": [ - "AWS/EC2" + "AWS/SQS", + "AWS/ElasticMapReduce" ] }, "tag_filters": [ { "namespace": "AWS/EC2", "tags": [ - "key:value" + "datadog:true" ] } ] }, "resources_config": { "cloud_security_posture_management_collection": false, - "extended_collection": false + "extended_collection": true }, "traces_config": { "xray_services": { @@ -568,7 +574,7 @@ "type": "account" } }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

AWS Account Update Request data

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

The AWS Account Integration Config to be updated

\n
\n
\n
\n
\n
\n

account_tags

\n
\n

[string]

\n

Tags to apply to all metrics in the account

\n
\n \n
\n
\n
\n
\n
\n

auth_config

\n
\n

 <oneOf>

\n

AWS Authentication config

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

AWS Authentication config for key-based account

\n
\n
\n
\n
\n
\n

access_key_id [required]

\n
\n

string

\n

AWS Access Key ID

\n
\n \n
\n
\n
\n
\n
\n

secret_access_key

\n
\n

string

\n

AWS Secret Access Key

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

AWS Authentication config for role-based account

\n
\n
\n
\n
\n
\n

external_id

\n
\n

string

\n

AWS IAM External ID for associated role

\n
\n \n
\n
\n
\n
\n
\n

role_name [required]

\n
\n

string

\n

AWS IAM Role name

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

aws_account_id [required]

\n
\n

string

\n

AWS Account ID

\n
\n \n
\n
\n
\n
\n
\n

aws_partition

\n
\n

enum

\n

AWS Account partition \nAllowed enum values: aws,aws-cn,aws-us-gov

default: aws

\n
\n \n
\n
\n
\n
\n
\n

aws_regions

\n
\n

 <oneOf>

\n

AWS Regions to collect data from

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

\n

Include all regions

\n
\n
\n
\n
\n
\n

include_all [required]

\n
\n

boolean

\n

Include all regions

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

\n

Include only these regions

\n
\n
\n
\n
\n
\n

include_only [required]

\n
\n

[string]

\n

Include only these regions

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

logs_config

\n
\n

object

\n

AWS Logs config

\n
\n
\n
\n
\n
\n

lambda_forwarder

\n
\n

object

\n

AWS Lambda forwarder

\n
\n
\n
\n
\n
\n

lambdas

\n
\n

[string]

\n

List of Datadog Lambda Log Forwarder ARNs

\n
\n \n
\n
\n
\n
\n
\n

sources

\n
\n

[string]

\n

List of AWS services that will send logs to the Datadog Lambda Log Forwarder

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

metrics_config

\n
\n

object

\n

AWS Metrics config

\n
\n
\n
\n
\n
\n

automute_enabled

\n
\n

boolean

\n

Enable EC2 automute for AWS metrics

\n
\n \n
\n
\n
\n
\n
\n

collect_cloudwatch_alarms

\n
\n

boolean

\n

Enable CloudWatch alarms collection

\n
\n \n
\n
\n
\n
\n
\n

collect_custom_metrics

\n
\n

boolean

\n

Enable custom metrics collection

\n
\n \n
\n
\n
\n
\n
\n

enabled

\n
\n

boolean

\n

Enable AWS metrics collection

\n
\n \n
\n
\n
\n
\n
\n

namespace_filters

\n
\n

 <oneOf>

\n

AWS Metrics namespace filters

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

\n

Exclude only these namespaces

\n
\n
\n
\n
\n
\n

exclude_only [required]

\n
\n

[string]

\n

Exclude only these namespaces

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

\n

Include only these namespaces

\n
\n
\n
\n
\n
\n

include_only [required]

\n
\n

[string]

\n

Include only these namespaces

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

tag_filters

\n
\n

[object]

\n

AWS Metrics tag filters list

\n
\n
\n
\n
\n
\n

namespace

\n
\n

string

\n

The AWS Namespace to apply the tag filters against

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

The tags to filter based on

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

resources_config

\n
\n

object

\n

AWS Resources config

\n
\n
\n
\n
\n
\n

cloud_security_posture_management_collection

\n
\n

boolean

\n

Whether Datadog collects cloud security posture management resources from your AWS account.

\n
\n \n
\n
\n
\n
\n
\n

extended_collection

\n
\n

boolean

\n

Whether Datadog collects additional attributes and configuration information about the resources in your AWS account. Required for cspm_resource_collection.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

traces_config

\n
\n

object

\n

AWS Traces config

\n
\n
\n
\n
\n
\n

xray_services

\n
\n

 <oneOf>

\n

AWS X-Ray services to collect traces from

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

\n

Include all services

\n
\n
\n
\n
\n
\n

include_all [required]

\n
\n

boolean

\n

Include all services

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

\n

Include only these services

\n
\n
\n
\n
\n
\n

include_only [required]

\n
\n

[string]

\n

Include only these services

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

Unique Datadog ID of the AWS Account Integration Config

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

AWS Account resource type. \nAllowed enum values: account

default: account

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

AWS Account Update Request data.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

The AWS Account Integration Config to be updated.

\n
\n
\n
\n
\n
\n

account_tags

\n
\n

[string]

\n

Tags to apply to all hosts and metrics reporting for this account. Defaults to [].

\n
\n \n
\n
\n
\n
\n
\n

auth_config

\n
\n

 <oneOf>

\n

AWS Authentication config.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

AWS Authentication config to integrate your account using an access key pair.

\n
\n
\n
\n
\n
\n

access_key_id [required]

\n
\n

string

\n

AWS Access Key ID.

\n
\n \n
\n
\n
\n
\n
\n

secret_access_key

\n
\n

string

\n

AWS Secret Access Key.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

AWS Authentication config to integrate your account using an IAM role.

\n
\n
\n
\n
\n
\n

external_id

\n
\n

string

\n

AWS IAM External ID for associated role.

\n
\n \n
\n
\n
\n
\n
\n

role_name [required]

\n
\n

string

\n

AWS IAM Role name.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

aws_account_id [required]

\n
\n

string

\n

AWS Account ID.

\n
\n \n
\n
\n
\n
\n
\n

aws_partition

\n
\n

enum

\n

AWS partition your AWS account is scoped to. Defaults to aws.\nSee Partitions in the AWS documentation for more information. \nAllowed enum values: aws,aws-cn,aws-us-gov

\n
\n \n
\n
\n
\n
\n
\n

aws_regions

\n
\n

 <oneOf>

\n

AWS Regions to collect data from. Defaults to include_all.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

\n

Include all regions. Defaults to true.

\n
\n
\n
\n
\n
\n

include_all [required]

\n
\n

boolean

\n

Include all regions.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

\n

Include only these regions.

\n
\n
\n
\n
\n
\n

include_only [required]

\n
\n

[string]

\n

Include only these regions.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

logs_config

\n
\n

object

\n

AWS Logs Collection config.

\n
\n
\n
\n
\n
\n

lambda_forwarder

\n
\n

object

\n

Log Autosubscription configuration for Datadog Forwarder Lambda functions. Automatically set up triggers for existing\nand new logs for some services, ensuring no logs from new resources are missed and saving time spent on manual configuration.

\n
\n
\n
\n
\n
\n

lambdas

\n
\n

[string]

\n

List of Datadog Lambda Log Forwarder ARNs in your AWS account. Defaults to [].

\n
\n \n
\n
\n
\n
\n
\n

sources

\n
\n

[string]

\n

List of service IDs set to enable automatic log collection. Discover the list of available services with the\nGet list of AWS log ready services endpoint.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

metrics_config

\n
\n

object

\n

AWS Metrics Collection config.

\n
\n
\n
\n
\n
\n

automute_enabled

\n
\n

boolean

\n

Enable EC2 automute for AWS metrics. Defaults to true.

\n
\n \n
\n
\n
\n
\n
\n

collect_cloudwatch_alarms

\n
\n

boolean

\n

Enable CloudWatch alarms collection. Defaults to false.

\n
\n \n
\n
\n
\n
\n
\n

collect_custom_metrics

\n
\n

boolean

\n

Enable custom metrics collection. Defaults to false.

\n
\n \n
\n
\n
\n
\n
\n

enabled

\n
\n

boolean

\n

Enable AWS metrics collection. Defaults to true.

\n
\n \n
\n
\n
\n
\n
\n

namespace_filters

\n
\n

 <oneOf>

\n

AWS Metrics namespace filters. Defaults to exclude_only.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

\n

Exclude only these namespaces from metrics collection. Defaults to ["AWS/SQS", "AWS/ElasticMapReduce"].\nAWS/SQS and AWS/ElasticMapReduce are excluded by default to reduce your AWS CloudWatch costs from GetMetricData API calls.

\n
\n
\n
\n
\n
\n

exclude_only [required]

\n
\n

[string]

\n

Exclude only these namespaces from metrics collection. Defaults to ["AWS/SQS", "AWS/ElasticMapReduce"].\nAWS/SQS and AWS/ElasticMapReduce are excluded by default to reduce your AWS CloudWatch costs from GetMetricData API calls.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

\n

Include only these namespaces.

\n
\n
\n
\n
\n
\n

include_only [required]

\n
\n

[string]

\n

Include only these namespaces.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

tag_filters

\n
\n

[object]

\n

AWS Metrics collection tag filters list. Defaults to [].

\n
\n
\n
\n
\n
\n

namespace

\n
\n

string

\n

The AWS service for which the tag filters defined in tags will be applied.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

The AWS resource tags to filter on for the service specified by namespace.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

resources_config

\n
\n

object

\n

AWS Resources Collection config.

\n
\n
\n
\n
\n
\n

cloud_security_posture_management_collection

\n
\n

boolean

\n

Enable Cloud Security Management to scan AWS resources for vulnerabilities, misconfigurations, identity risks, and compliance violations. Defaults to false. Requires extended_collection to be set to true.

\n
\n \n
\n
\n
\n
\n
\n

extended_collection

\n
\n

boolean

\n

Whether Datadog collects additional attributes and configuration information about the resources in your AWS account. Defaults to true. Required for cloud_security_posture_management_collection.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

traces_config

\n
\n

object

\n

AWS Traces Collection config.

\n
\n
\n
\n
\n
\n

xray_services

\n
\n

 <oneOf>

\n

AWS X-Ray services to collect traces from. Defaults to include_only.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

\n

Include all services.

\n
\n
\n
\n
\n
\n

include_all [required]

\n
\n

boolean

\n

Include all services.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

\n

Include only these services. Defaults to [].

\n
\n
\n
\n
\n
\n

include_only [required]

\n
\n

[string]

\n

Include only these services.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

Unique Datadog ID of the AWS Account Integration Config.\nTo get the config ID for an account, use the List all AWS integrations\nendpoint and query by AWS Account ID.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

AWS Account resource type. \nAllowed enum values: account

default: account

\n
\n \n
\n
\n
\n
" } }, "ListAWSNamespaces": { @@ -585,7 +591,7 @@ "type": "namespaces" } }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

AWS Namespaces response body

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

AWS Namespaces response body

\n
\n
\n
\n
\n
\n

namespaces [required]

\n
\n

[string]

\n

AWS CloudWatch namespace

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The AWSNamespacesResponseData id.

default: namespaces

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The AWSNamespacesResponseData type. \nAllowed enum values: namespaces

default: namespaces

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

AWS Namespaces response data.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

AWS Namespaces response attributes.

\n
\n
\n
\n
\n
\n

namespaces [required]

\n
\n

[string]

\n

AWS CloudWatch namespace.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The AWSNamespacesResponseData id.

default: namespaces

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The AWSNamespacesResponseData type. \nAllowed enum values: namespaces

default: namespaces

\n
\n \n
\n
\n
\n
" }, "403": { "json": { @@ -622,7 +628,7 @@ "type": "external_id" } }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

AWS External ID response body

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

AWS External ID response body

\n
\n
\n
\n
\n
\n

external_id [required]

\n
\n

string

\n

AWS IAM External ID for associated role

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The AWSNewExternalIDResponseData id.

default: external_id

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The AWSNewExternalIDResponseData type. \nAllowed enum values: external_id

default: external_id

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

AWS External ID response body.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

AWS External ID response body.

\n
\n
\n
\n
\n
\n

external_id [required]

\n
\n

string

\n

AWS IAM External ID for associated role.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The AWSNewExternalIDResponseData id.

default: external_id

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The AWSNewExternalIDResponseData type. \nAllowed enum values: external_id

default: external_id

\n
\n \n
\n
\n
\n
" }, "403": { "json": { diff --git a/data/api/v2/full_spec.yaml b/data/api/v2/full_spec.yaml index 7539da2f989cd..0f3ca11202741 100644 --- a/data/api/v2/full_spec.yaml +++ b/data/api/v2/full_spec.yaml @@ -93,7 +93,11 @@ components: schema: $ref: '#/components/schemas/APIKeysSort' AWSAccountConfigIDPathParameter: - description: Unique Datadog ID of the AWS Account Integration Config + description: 'Unique Datadog ID of the AWS Account Integration Config. To get + the config ID for an account, use the + + [List all AWS integrations](https://docs.datadoghq.com/api/latest/aws-integration/#list-all-aws-integrations) + endpoint and query by AWS Account ID.' in: path name: aws_account_config_id required: true @@ -1046,11 +1050,15 @@ components: x-enum-varnames: - API_KEYS AWSAccountConfigID: - description: Unique Datadog ID of the AWS Account Integration Config + description: 'Unique Datadog ID of the AWS Account Integration Config. + + To get the config ID for an account, use the [List all AWS integrations](https://docs.datadoghq.com/api/latest/aws-integration/#list-all-aws-integrations) + + endpoint and query by AWS Account ID.' example: 00000000-abcd-0001-0000-000000000000 type: string AWSAccountCreateRequest: - description: AWS Account Create Request body + description: AWS Account Create Request body. properties: data: $ref: '#/components/schemas/AWSAccountCreateRequestData' @@ -1058,7 +1066,7 @@ components: - data type: object AWSAccountCreateRequestAttributes: - description: The AWS Account Integration Config to be created + description: The AWS Account Integration Config to be created. properties: account_tags: $ref: '#/components/schemas/AWSAccountTags' @@ -1084,7 +1092,7 @@ components: - auth_config type: object AWSAccountCreateRequestData: - description: AWS Account Create Request data + description: AWS Account Create Request data. properties: attributes: $ref: '#/components/schemas/AWSAccountCreateRequestAttributes' @@ -1095,12 +1103,14 @@ components: - type type: object AWSAccountID: - description: AWS Account ID + description: AWS Account ID. example: '123456789012' type: string AWSAccountPartition: - default: aws - description: AWS Account partition + description: 'AWS partition your AWS account is scoped to. Defaults to `aws`. + + See [Partitions](https://docs.aws.amazon.com/whitepapers/latest/aws-fault-isolation-boundaries/partitions.html) + in the AWS documentation for more information.' enum: - aws - aws-cn @@ -1112,7 +1122,7 @@ components: - AWS_CN - AWS_US_GOV AWSAccountResponse: - description: AWS Account response body + description: AWS Account response body. properties: data: $ref: '#/components/schemas/AWSAccountResponseData' @@ -1120,7 +1130,7 @@ components: - data type: object AWSAccountResponseAttributes: - description: The AWS Account Integration Config + description: AWS Account response attributes. properties: account_tags: $ref: '#/components/schemas/AWSAccountTags' @@ -1133,7 +1143,7 @@ components: aws_regions: $ref: '#/components/schemas/AWSRegions' created_at: - description: Timestamp of when the account integration was created + description: Timestamp of when the account integration was created. format: date-time readOnly: true type: string @@ -1142,7 +1152,7 @@ components: metrics_config: $ref: '#/components/schemas/AWSMetricsConfig' modified_at: - description: Timestamp of when the account integration was updated + description: Timestamp of when the account integration was updated. format: date-time readOnly: true type: string @@ -1154,7 +1164,7 @@ components: - aws_account_id type: object AWSAccountResponseData: - description: AWS Account Response body + description: AWS Account response data. properties: attributes: $ref: '#/components/schemas/AWSAccountResponseAttributes' @@ -1167,10 +1177,11 @@ components: - type type: object AWSAccountTags: - description: Tags to apply to all metrics in the account + description: Tags to apply to all hosts and metrics reporting for this account. + Defaults to `[]`. items: - description: Tag to apply to all metrics in the account - example: key:value + description: Tag in the form `key:value`. + example: env:prod type: string nullable: true type: array @@ -1184,7 +1195,7 @@ components: x-enum-varnames: - ACCOUNT AWSAccountUpdateRequest: - description: AWS Account Update Request body + description: AWS Account Update Request body. properties: data: $ref: '#/components/schemas/AWSAccountUpdateRequestData' @@ -1192,7 +1203,7 @@ components: - data type: object AWSAccountUpdateRequestAttributes: - description: The AWS Account Integration Config to be updated + description: The AWS Account Integration Config to be updated. properties: account_tags: $ref: '#/components/schemas/AWSAccountTags' @@ -1216,7 +1227,7 @@ components: - aws_account_id type: object AWSAccountUpdateRequestData: - description: AWS Account Update Request data + description: AWS Account Update Request data. properties: attributes: $ref: '#/components/schemas/AWSAccountUpdateRequestAttributes' @@ -1229,10 +1240,10 @@ components: - type type: object AWSAccountsResponse: - description: AWS Accounts response body + description: AWS Accounts response body. properties: data: - description: List of AWS Account Integration Configs + description: List of AWS Account Integration Configs. items: $ref: '#/components/schemas/AWSAccountResponseData' type: array @@ -1240,19 +1251,20 @@ components: - data type: object AWSAuthConfig: - description: AWS Authentication config + description: AWS Authentication config. oneOf: - $ref: '#/components/schemas/AWSAuthConfigKeys' - $ref: '#/components/schemas/AWSAuthConfigRole' AWSAuthConfigKeys: - description: AWS Authentication config for key-based account + description: AWS Authentication config to integrate your account using an access + key pair. properties: access_key_id: - description: AWS Access Key ID + description: AWS Access Key ID. example: AKIAIOSFODNN7EXAMPLE type: string secret_access_key: - description: AWS Secret Access Key + description: AWS Secret Access Key. example: wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY minLength: 1 type: string @@ -1261,13 +1273,14 @@ components: - access_key_id type: object AWSAuthConfigRole: - description: AWS Authentication config for role-based account + description: AWS Authentication config to integrate your account using an IAM + role. properties: external_id: - description: AWS IAM External ID for associated role + description: AWS IAM External ID for associated role. type: string role_name: - description: AWS IAM Role name + description: AWS IAM Role name. example: DatadogIntegrationRole maxLength: 576 minLength: 1 @@ -1276,24 +1289,32 @@ components: - role_name type: object AWSLambdaForwarderConfig: - description: AWS Lambda forwarder + description: 'Log Autosubscription configuration for Datadog Forwarder Lambda + functions. Automatically set up triggers for existing + + and new logs for some services, ensuring no logs from new resources are missed + and saving time spent on manual configuration.' properties: lambdas: - description: List of Datadog Lambda Log Forwarder ARNs + description: List of Datadog Lambda Log Forwarder ARNs in your AWS account. + Defaults to `[]`. items: example: arn:aws:lambda:us-east-1:123456789012:function:DatadogLambdaLogForwarder type: string type: array sources: - description: List of AWS services that will send logs to the Datadog Lambda - Log Forwarder + description: 'List of service IDs set to enable automatic log collection. + Discover the list of available services with the + + [Get list of AWS log ready services](https://docs.datadoghq.com/api/latest/aws-logs-integration/#get-list-of-aws-log-ready-services) + endpoint.' items: example: s3 type: string type: array type: object AWSLogsConfig: - description: AWS Logs config + description: AWS Logs Collection config. properties: lambda_forwarder: $ref: '#/components/schemas/AWSLambdaForwarderConfig' @@ -1346,55 +1367,64 @@ components: x-enum-varnames: - LOGS_SERVICES AWSMetricsConfig: - description: AWS Metrics config + description: AWS Metrics Collection config. properties: automute_enabled: - description: Enable EC2 automute for AWS metrics + description: Enable EC2 automute for AWS metrics. Defaults to `true`. example: true type: boolean collect_cloudwatch_alarms: - description: Enable CloudWatch alarms collection - example: true + description: Enable CloudWatch alarms collection. Defaults to `false`. + example: false type: boolean collect_custom_metrics: - description: Enable custom metrics collection - example: true + description: Enable custom metrics collection. Defaults to `false`. + example: false type: boolean enabled: - description: Enable AWS metrics collection + description: Enable AWS metrics collection. Defaults to `true`. example: true type: boolean namespace_filters: $ref: '#/components/schemas/AWSNamespaceFilters' tag_filters: - description: AWS Metrics tag filters list + description: AWS Metrics collection tag filters list. Defaults to `[]`. items: $ref: '#/components/schemas/AWSNamespaceTagFilter' type: array type: object AWSNamespaceFilters: - description: AWS Metrics namespace filters + description: AWS Metrics namespace filters. Defaults to `exclude_only`. oneOf: - $ref: '#/components/schemas/AWSNamespaceFiltersExcludeOnly' - $ref: '#/components/schemas/AWSNamespaceFiltersIncludeOnly' AWSNamespaceFiltersExcludeOnly: - description: Exclude only these namespaces + description: 'Exclude only these namespaces from metrics collection. Defaults + to `["AWS/SQS", "AWS/ElasticMapReduce"]`. + + `AWS/SQS` and `AWS/ElasticMapReduce` are excluded by default to reduce your + AWS CloudWatch costs from `GetMetricData` API calls.' properties: exclude_only: - description: Exclude only these namespaces + description: 'Exclude only these namespaces from metrics collection. Defaults + to `["AWS/SQS", "AWS/ElasticMapReduce"]`. + + `AWS/SQS` and `AWS/ElasticMapReduce` are excluded by default to reduce + your AWS CloudWatch costs from `GetMetricData` API calls.' example: - - AWS/EC2 + - AWS/SQS + - AWS/ElasticMapReduce items: - example: AWS/EC2 + example: AWS/SQS type: string type: array required: - exclude_only AWSNamespaceFiltersIncludeOnly: - description: Include only these namespaces + description: Include only these namespaces. properties: include_only: - description: Include only these namespaces + description: Include only these namespaces. example: - AWS/EC2 items: @@ -1404,22 +1434,36 @@ components: required: - include_only AWSNamespaceTagFilter: - description: AWS Metrics tag filters + description: 'AWS Metrics Collection tag filters list. Defaults to `[]`. + + The array of custom AWS resource tags (in the form `key:value`) defines a + filter that Datadog uses when collecting metrics from a specified service. + + Wildcards, such as `?` (match a single character) and `*` (match multiple + characters), and exclusion using `!` before the tag are supported. + + For EC2, only hosts that match one of the defined tags will be imported into + Datadog. The rest will be ignored. + + For example, `env:production,instance-type:c?.*,!region:us-east-1`.' properties: namespace: - description: The AWS Namespace to apply the tag filters against + description: The AWS service for which the tag filters defined in `tags` + will be applied. example: AWS/EC2 type: string tags: - description: The tags to filter based on + description: The AWS resource tags to filter on for the service specified + by `namespace`. items: - example: key:value + description: Tag in the form `key:value`. + example: datadog:true type: string nullable: true type: array type: object AWSNamespacesResponse: - description: AWS Namespaces response body + description: AWS Namespaces response body. properties: data: $ref: '#/components/schemas/AWSNamespacesResponseData' @@ -1427,10 +1471,10 @@ components: - data type: object AWSNamespacesResponseAttributes: - description: AWS Namespaces response body + description: AWS Namespaces response attributes. properties: namespaces: - description: AWS CloudWatch namespace + description: AWS CloudWatch namespace. example: - AWS/ApiGateway items: @@ -1441,7 +1485,7 @@ components: - namespaces type: object AWSNamespacesResponseData: - description: AWS Namespaces response body + description: AWS Namespaces response data. properties: attributes: $ref: '#/components/schemas/AWSNamespacesResponseAttributes' @@ -1466,7 +1510,7 @@ components: x-enum-varnames: - NAMESPACES AWSNewExternalIDResponse: - description: AWS External ID response body + description: AWS External ID response body. properties: data: $ref: '#/components/schemas/AWSNewExternalIDResponseData' @@ -1474,17 +1518,17 @@ components: - data type: object AWSNewExternalIDResponseAttributes: - description: AWS External ID response body + description: AWS External ID response body. properties: external_id: - description: AWS IAM External ID for associated role + description: AWS IAM External ID for associated role. example: acb8f6b8a844443dbb726d07dcb1a870 type: string required: - external_id type: object AWSNewExternalIDResponseData: - description: AWS External ID response body + description: AWS External ID response body. properties: attributes: $ref: '#/components/schemas/AWSNewExternalIDResponseAttributes' @@ -1509,24 +1553,24 @@ components: x-enum-varnames: - EXTERNAL_ID AWSRegions: - description: AWS Regions to collect data from + description: AWS Regions to collect data from. Defaults to `include_all`. oneOf: - $ref: '#/components/schemas/AWSRegionsIncludeAll' - $ref: '#/components/schemas/AWSRegionsIncludeOnly' AWSRegionsIncludeAll: - description: Include all regions + description: Include all regions. Defaults to `true`. properties: include_all: - description: Include all regions - example: false + description: Include all regions. + example: true type: boolean required: - include_all AWSRegionsIncludeOnly: - description: Include only these regions + description: Include only these regions. properties: include_only: - description: Include only these regions + description: Include only these regions. example: - us-east-1 items: @@ -1536,21 +1580,23 @@ components: required: - include_only AWSResourcesConfig: - description: AWS Resources config + description: AWS Resources Collection config. properties: cloud_security_posture_management_collection: - description: Whether Datadog collects cloud security posture management - resources from your AWS account. + description: Enable Cloud Security Management to scan AWS resources for + vulnerabilities, misconfigurations, identity risks, and compliance violations. + Defaults to `false`. Requires `extended_collection` to be set to `true`. example: false type: boolean extended_collection: description: Whether Datadog collects additional attributes and configuration - information about the resources in your AWS account. Required for `cspm_resource_collection`. - example: false + information about the resources in your AWS account. Defaults to `true`. + Required for `cloud_security_posture_management_collection`. + example: true type: boolean type: object AWSTracesConfig: - description: AWS Traces config + description: AWS Traces Collection config. properties: xray_services: $ref: '#/components/schemas/XRayServicesList' @@ -27967,20 +28013,20 @@ components: type: string type: object XRayServicesIncludeAll: - description: Include all services + description: Include all services. properties: include_all: - description: Include all services + description: Include all services. example: false type: boolean required: - include_all XRayServicesIncludeOnly: - description: Include only these services + description: Include only these services. Defaults to `[]`. nullable: true properties: include_only: - description: Include only these services + description: Include only these services. example: - AWS/AppSync items: @@ -27990,7 +28036,7 @@ components: required: - include_only XRayServicesList: - description: AWS X-Ray services to collect traces from + description: AWS X-Ray services to collect traces from. Defaults to `include_only`. oneOf: - $ref: '#/components/schemas/XRayServicesIncludeAll' - $ref: '#/components/schemas/XRayServicesIncludeOnly' @@ -33904,7 +33950,8 @@ paths: description: Get a list of AWS Account Integration Configs. operationId: ListAWSAccounts parameters: - - description: Optional query filter accounts by AWS Account ID + - description: Optional query parameter to filter accounts by AWS Account ID. + If not provided, all accounts are returned. example: '123456789012' in: query name: aws_account_id @@ -33932,7 +33979,7 @@ paths: - aws_configuration_read x-undo: type: safe - x-unstable: '**Note: This endpoint is in public beta. If you have any feedback, + x-unstable: '**Note: This endpoint is in Preview. If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).**' post: @@ -33997,12 +34044,12 @@ paths: - name: aws_account_config_id source: data.id type: unsafe - x-unstable: '**Note: This endpoint is in public beta. If you have any feedback, + x-unstable: '**Note: This endpoint is in Preview. If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).**' /api/v2/integration/aws/accounts/{aws_account_config_id}: delete: - description: Delete an AWS Account Integration Config + description: Delete an AWS Account Integration Config by config ID. operationId: DeleteAWSAccount parameters: - $ref: '#/components/parameters/AWSAccountConfigIDPathParameter' @@ -34027,11 +34074,11 @@ paths: - aws_configurations_manage x-undo: type: idempotent - x-unstable: '**Note: This endpoint is in public beta. If you have any feedback, + x-unstable: '**Note: This endpoint is in Preview. If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).**' get: - description: Get an AWS Account Integration Config + description: Get an AWS Account Integration Config by config ID. operationId: GetAWSAccount parameters: - $ref: '#/components/parameters/AWSAccountConfigIDPathParameter' @@ -34060,11 +34107,11 @@ paths: - aws_configuration_read x-undo: type: safe - x-unstable: '**Note: This endpoint is in public beta. If you have any feedback, + x-unstable: '**Note: This endpoint is in Preview. If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).**' patch: - description: Update an AWS Account Integration Config + description: Update an AWS Account Integration Config by config ID. operationId: UpdateAWSAccount parameters: - $ref: '#/components/parameters/AWSAccountConfigIDPathParameter' @@ -34100,7 +34147,7 @@ paths: - aws_configuration_edit x-undo: type: idempotent - x-unstable: '**Note: This endpoint is in public beta. If you have any feedback, + x-unstable: '**Note: This endpoint is in Preview. If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).**' /api/v2/integration/aws/available_namespaces: @@ -34129,7 +34176,7 @@ paths: - aws_configuration_read x-undo: type: safe - x-unstable: '**Note: This endpoint is in public beta. If you have any feedback, + x-unstable: '**Note: This endpoint is in Preview. If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).**' /api/v2/integration/aws/generate_new_external_id: @@ -34157,7 +34204,7 @@ paths: - aws_configuration_edit x-undo: type: safe - x-unstable: '**Note: This endpoint is in public beta. If you have any feedback, + x-unstable: '**Note: This endpoint is in Preview. If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).**' /api/v2/integration/aws/logs/services: diff --git a/data/api/v2/full_spec_deref.json b/data/api/v2/full_spec_deref.json index 1e7d966568549..1013a5ae92bed 100644 --- a/data/api/v2/full_spec_deref.json +++ b/data/api/v2/full_spec_deref.json @@ -135,7 +135,7 @@ } }, "AWSAccountConfigIDPathParameter": { - "description": "Unique Datadog ID of the AWS Account Integration Config", + "description": "Unique Datadog ID of the AWS Account Integration Config. To get the config ID for an account, use the\n[List all AWS integrations](https://docs.datadoghq.com/api/latest/aws-integration/#list-all-aws-integrations) endpoint and query by AWS Account ID.", "in": "path", "name": "aws_account_config_id", "required": true, @@ -3403,42 +3403,42 @@ ] }, "AWSAccountConfigID": { - "description": "Unique Datadog ID of the AWS Account Integration Config", + "description": "Unique Datadog ID of the AWS Account Integration Config.\nTo get the config ID for an account, use the [List all AWS integrations](https://docs.datadoghq.com/api/latest/aws-integration/#list-all-aws-integrations)\nendpoint and query by AWS Account ID.", "example": "00000000-abcd-0001-0000-000000000000", "type": "string" }, "AWSAccountCreateRequest": { - "description": "AWS Account Create Request body", + "description": "AWS Account Create Request body.", "properties": { "data": { - "description": "AWS Account Create Request data", + "description": "AWS Account Create Request data.", "properties": { "attributes": { - "description": "The AWS Account Integration Config to be created", + "description": "The AWS Account Integration Config to be created.", "properties": { "account_tags": { - "description": "Tags to apply to all metrics in the account", + "description": "Tags to apply to all hosts and metrics reporting for this account. Defaults to `[]`.", "items": { - "description": "Tag to apply to all metrics in the account", - "example": "key:value", + "description": "Tag in the form `key:value`.", + "example": "env:prod", "type": "string" }, "nullable": true, "type": "array" }, "auth_config": { - "description": "AWS Authentication config", + "description": "AWS Authentication config.", "oneOf": [ { - "description": "AWS Authentication config for key-based account", + "description": "AWS Authentication config to integrate your account using an access key pair.", "properties": { "access_key_id": { - "description": "AWS Access Key ID", + "description": "AWS Access Key ID.", "example": "AKIAIOSFODNN7EXAMPLE", "type": "string" }, "secret_access_key": { - "description": "AWS Secret Access Key", + "description": "AWS Secret Access Key.", "example": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY", "minLength": 1, "type": "string", @@ -3451,14 +3451,14 @@ "type": "object" }, { - "description": "AWS Authentication config for role-based account", + "description": "AWS Authentication config to integrate your account using an IAM role.", "properties": { "external_id": { - "description": "AWS IAM External ID for associated role", + "description": "AWS IAM External ID for associated role.", "type": "string" }, "role_name": { - "description": "AWS IAM Role name", + "description": "AWS IAM Role name.", "example": "DatadogIntegrationRole", "maxLength": 576, "minLength": 1, @@ -3473,13 +3473,12 @@ ] }, "aws_account_id": { - "description": "AWS Account ID", + "description": "AWS Account ID.", "example": "123456789012", "type": "string" }, "aws_partition": { - "default": "aws", - "description": "AWS Account partition", + "description": "AWS partition your AWS account is scoped to. Defaults to `aws`.\nSee [Partitions](https://docs.aws.amazon.com/whitepapers/latest/aws-fault-isolation-boundaries/partitions.html) in the AWS documentation for more information.", "enum": [ "aws", "aws-cn", @@ -3494,14 +3493,14 @@ ] }, "aws_regions": { - "description": "AWS Regions to collect data from", + "description": "AWS Regions to collect data from. Defaults to `include_all`.", "oneOf": [ { - "description": "Include all regions", + "description": "Include all regions. Defaults to `true`.", "properties": { "include_all": { - "description": "Include all regions", - "example": false, + "description": "Include all regions.", + "example": true, "type": "boolean" } }, @@ -3510,10 +3509,10 @@ ] }, { - "description": "Include only these regions", + "description": "Include only these regions.", "properties": { "include_only": { - "description": "Include only these regions", + "description": "Include only these regions.", "example": [ "us-east-1" ], @@ -3531,13 +3530,13 @@ ] }, "logs_config": { - "description": "AWS Logs config", + "description": "AWS Logs Collection config.", "properties": { "lambda_forwarder": { - "description": "AWS Lambda forwarder", + "description": "Log Autosubscription configuration for Datadog Forwarder Lambda functions. Automatically set up triggers for existing\nand new logs for some services, ensuring no logs from new resources are missed and saving time spent on manual configuration.", "properties": { "lambdas": { - "description": "List of Datadog Lambda Log Forwarder ARNs", + "description": "List of Datadog Lambda Log Forwarder ARNs in your AWS account. Defaults to `[]`.", "items": { "example": "arn:aws:lambda:us-east-1:123456789012:function:DatadogLambdaLogForwarder", "type": "string" @@ -3545,7 +3544,7 @@ "type": "array" }, "sources": { - "description": "List of AWS services that will send logs to the Datadog Lambda Log Forwarder", + "description": "List of service IDs set to enable automatic log collection. Discover the list of available services with the\n[Get list of AWS log ready services](https://docs.datadoghq.com/api/latest/aws-logs-integration/#get-list-of-aws-log-ready-services) endpoint.", "items": { "example": "s3", "type": "string" @@ -3559,41 +3558,42 @@ "type": "object" }, "metrics_config": { - "description": "AWS Metrics config", + "description": "AWS Metrics Collection config.", "properties": { "automute_enabled": { - "description": "Enable EC2 automute for AWS metrics", + "description": "Enable EC2 automute for AWS metrics. Defaults to `true`.", "example": true, "type": "boolean" }, "collect_cloudwatch_alarms": { - "description": "Enable CloudWatch alarms collection", - "example": true, + "description": "Enable CloudWatch alarms collection. Defaults to `false`.", + "example": false, "type": "boolean" }, "collect_custom_metrics": { - "description": "Enable custom metrics collection", - "example": true, + "description": "Enable custom metrics collection. Defaults to `false`.", + "example": false, "type": "boolean" }, "enabled": { - "description": "Enable AWS metrics collection", + "description": "Enable AWS metrics collection. Defaults to `true`.", "example": true, "type": "boolean" }, "namespace_filters": { - "description": "AWS Metrics namespace filters", + "description": "AWS Metrics namespace filters. Defaults to `exclude_only`.", "oneOf": [ { - "description": "Exclude only these namespaces", + "description": "Exclude only these namespaces from metrics collection. Defaults to `[\"AWS/SQS\", \"AWS/ElasticMapReduce\"]`.\n`AWS/SQS` and `AWS/ElasticMapReduce` are excluded by default to reduce your AWS CloudWatch costs from `GetMetricData` API calls.", "properties": { "exclude_only": { - "description": "Exclude only these namespaces", + "description": "Exclude only these namespaces from metrics collection. Defaults to `[\"AWS/SQS\", \"AWS/ElasticMapReduce\"]`.\n`AWS/SQS` and `AWS/ElasticMapReduce` are excluded by default to reduce your AWS CloudWatch costs from `GetMetricData` API calls.", "example": [ - "AWS/EC2" + "AWS/SQS", + "AWS/ElasticMapReduce" ], "items": { - "example": "AWS/EC2", + "example": "AWS/SQS", "type": "string" }, "type": "array" @@ -3604,10 +3604,10 @@ ] }, { - "description": "Include only these namespaces", + "description": "Include only these namespaces.", "properties": { "include_only": { - "description": "Include only these namespaces", + "description": "Include only these namespaces.", "example": [ "AWS/EC2" ], @@ -3625,19 +3625,20 @@ ] }, "tag_filters": { - "description": "AWS Metrics tag filters list", + "description": "AWS Metrics collection tag filters list. Defaults to `[]`.", "items": { - "description": "AWS Metrics tag filters", + "description": "AWS Metrics Collection tag filters list. Defaults to `[]`.\nThe array of custom AWS resource tags (in the form `key:value`) defines a filter that Datadog uses when collecting metrics from a specified service.\nWildcards, such as `?` (match a single character) and `*` (match multiple characters), and exclusion using `!` before the tag are supported.\nFor EC2, only hosts that match one of the defined tags will be imported into Datadog. The rest will be ignored.\nFor example, `env:production,instance-type:c?.*,!region:us-east-1`.", "properties": { "namespace": { - "description": "The AWS Namespace to apply the tag filters against", + "description": "The AWS service for which the tag filters defined in `tags` will be applied.", "example": "AWS/EC2", "type": "string" }, "tags": { - "description": "The tags to filter based on", + "description": "The AWS resource tags to filter on for the service specified by `namespace`.", "items": { - "example": "key:value", + "description": "Tag in the form `key:value`.", + "example": "datadog:true", "type": "string" }, "nullable": true, @@ -3652,32 +3653,32 @@ "type": "object" }, "resources_config": { - "description": "AWS Resources config", + "description": "AWS Resources Collection config.", "properties": { "cloud_security_posture_management_collection": { - "description": "Whether Datadog collects cloud security posture management resources from your AWS account.", + "description": "Enable Cloud Security Management to scan AWS resources for vulnerabilities, misconfigurations, identity risks, and compliance violations. Defaults to `false`. Requires `extended_collection` to be set to `true`.", "example": false, "type": "boolean" }, "extended_collection": { - "description": "Whether Datadog collects additional attributes and configuration information about the resources in your AWS account. Required for `cspm_resource_collection`.", - "example": false, + "description": "Whether Datadog collects additional attributes and configuration information about the resources in your AWS account. Defaults to `true`. Required for `cloud_security_posture_management_collection`.", + "example": true, "type": "boolean" } }, "type": "object" }, "traces_config": { - "description": "AWS Traces config", + "description": "AWS Traces Collection config.", "properties": { "xray_services": { - "description": "AWS X-Ray services to collect traces from", + "description": "AWS X-Ray services to collect traces from. Defaults to `include_only`.", "oneOf": [ { - "description": "Include all services", + "description": "Include all services.", "properties": { "include_all": { - "description": "Include all services", + "description": "Include all services.", "example": false, "type": "boolean" } @@ -3687,11 +3688,11 @@ ] }, { - "description": "Include only these services", + "description": "Include only these services. Defaults to `[]`.", "nullable": true, "properties": { "include_only": { - "description": "Include only these services", + "description": "Include only these services.", "example": [ "AWS/AppSync" ], @@ -3745,31 +3746,31 @@ "type": "object" }, "AWSAccountCreateRequestAttributes": { - "description": "The AWS Account Integration Config to be created", + "description": "The AWS Account Integration Config to be created.", "properties": { "account_tags": { - "description": "Tags to apply to all metrics in the account", + "description": "Tags to apply to all hosts and metrics reporting for this account. Defaults to `[]`.", "items": { - "description": "Tag to apply to all metrics in the account", - "example": "key:value", + "description": "Tag in the form `key:value`.", + "example": "env:prod", "type": "string" }, "nullable": true, "type": "array" }, "auth_config": { - "description": "AWS Authentication config", + "description": "AWS Authentication config.", "oneOf": [ { - "description": "AWS Authentication config for key-based account", + "description": "AWS Authentication config to integrate your account using an access key pair.", "properties": { "access_key_id": { - "description": "AWS Access Key ID", + "description": "AWS Access Key ID.", "example": "AKIAIOSFODNN7EXAMPLE", "type": "string" }, "secret_access_key": { - "description": "AWS Secret Access Key", + "description": "AWS Secret Access Key.", "example": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY", "minLength": 1, "type": "string", @@ -3782,14 +3783,14 @@ "type": "object" }, { - "description": "AWS Authentication config for role-based account", + "description": "AWS Authentication config to integrate your account using an IAM role.", "properties": { "external_id": { - "description": "AWS IAM External ID for associated role", + "description": "AWS IAM External ID for associated role.", "type": "string" }, "role_name": { - "description": "AWS IAM Role name", + "description": "AWS IAM Role name.", "example": "DatadogIntegrationRole", "maxLength": 576, "minLength": 1, @@ -3804,13 +3805,12 @@ ] }, "aws_account_id": { - "description": "AWS Account ID", + "description": "AWS Account ID.", "example": "123456789012", "type": "string" }, "aws_partition": { - "default": "aws", - "description": "AWS Account partition", + "description": "AWS partition your AWS account is scoped to. Defaults to `aws`.\nSee [Partitions](https://docs.aws.amazon.com/whitepapers/latest/aws-fault-isolation-boundaries/partitions.html) in the AWS documentation for more information.", "enum": [ "aws", "aws-cn", @@ -3825,14 +3825,14 @@ ] }, "aws_regions": { - "description": "AWS Regions to collect data from", + "description": "AWS Regions to collect data from. Defaults to `include_all`.", "oneOf": [ { - "description": "Include all regions", + "description": "Include all regions. Defaults to `true`.", "properties": { "include_all": { - "description": "Include all regions", - "example": false, + "description": "Include all regions.", + "example": true, "type": "boolean" } }, @@ -3841,10 +3841,10 @@ ] }, { - "description": "Include only these regions", + "description": "Include only these regions.", "properties": { "include_only": { - "description": "Include only these regions", + "description": "Include only these regions.", "example": [ "us-east-1" ], @@ -3862,13 +3862,13 @@ ] }, "logs_config": { - "description": "AWS Logs config", + "description": "AWS Logs Collection config.", "properties": { "lambda_forwarder": { - "description": "AWS Lambda forwarder", + "description": "Log Autosubscription configuration for Datadog Forwarder Lambda functions. Automatically set up triggers for existing\nand new logs for some services, ensuring no logs from new resources are missed and saving time spent on manual configuration.", "properties": { "lambdas": { - "description": "List of Datadog Lambda Log Forwarder ARNs", + "description": "List of Datadog Lambda Log Forwarder ARNs in your AWS account. Defaults to `[]`.", "items": { "example": "arn:aws:lambda:us-east-1:123456789012:function:DatadogLambdaLogForwarder", "type": "string" @@ -3876,7 +3876,7 @@ "type": "array" }, "sources": { - "description": "List of AWS services that will send logs to the Datadog Lambda Log Forwarder", + "description": "List of service IDs set to enable automatic log collection. Discover the list of available services with the\n[Get list of AWS log ready services](https://docs.datadoghq.com/api/latest/aws-logs-integration/#get-list-of-aws-log-ready-services) endpoint.", "items": { "example": "s3", "type": "string" @@ -3890,41 +3890,42 @@ "type": "object" }, "metrics_config": { - "description": "AWS Metrics config", + "description": "AWS Metrics Collection config.", "properties": { "automute_enabled": { - "description": "Enable EC2 automute for AWS metrics", + "description": "Enable EC2 automute for AWS metrics. Defaults to `true`.", "example": true, "type": "boolean" }, "collect_cloudwatch_alarms": { - "description": "Enable CloudWatch alarms collection", - "example": true, + "description": "Enable CloudWatch alarms collection. Defaults to `false`.", + "example": false, "type": "boolean" }, "collect_custom_metrics": { - "description": "Enable custom metrics collection", - "example": true, + "description": "Enable custom metrics collection. Defaults to `false`.", + "example": false, "type": "boolean" }, "enabled": { - "description": "Enable AWS metrics collection", + "description": "Enable AWS metrics collection. Defaults to `true`.", "example": true, "type": "boolean" }, "namespace_filters": { - "description": "AWS Metrics namespace filters", + "description": "AWS Metrics namespace filters. Defaults to `exclude_only`.", "oneOf": [ { - "description": "Exclude only these namespaces", + "description": "Exclude only these namespaces from metrics collection. Defaults to `[\"AWS/SQS\", \"AWS/ElasticMapReduce\"]`.\n`AWS/SQS` and `AWS/ElasticMapReduce` are excluded by default to reduce your AWS CloudWatch costs from `GetMetricData` API calls.", "properties": { "exclude_only": { - "description": "Exclude only these namespaces", + "description": "Exclude only these namespaces from metrics collection. Defaults to `[\"AWS/SQS\", \"AWS/ElasticMapReduce\"]`.\n`AWS/SQS` and `AWS/ElasticMapReduce` are excluded by default to reduce your AWS CloudWatch costs from `GetMetricData` API calls.", "example": [ - "AWS/EC2" + "AWS/SQS", + "AWS/ElasticMapReduce" ], "items": { - "example": "AWS/EC2", + "example": "AWS/SQS", "type": "string" }, "type": "array" @@ -3935,10 +3936,10 @@ ] }, { - "description": "Include only these namespaces", + "description": "Include only these namespaces.", "properties": { "include_only": { - "description": "Include only these namespaces", + "description": "Include only these namespaces.", "example": [ "AWS/EC2" ], @@ -3956,19 +3957,20 @@ ] }, "tag_filters": { - "description": "AWS Metrics tag filters list", + "description": "AWS Metrics collection tag filters list. Defaults to `[]`.", "items": { - "description": "AWS Metrics tag filters", + "description": "AWS Metrics Collection tag filters list. Defaults to `[]`.\nThe array of custom AWS resource tags (in the form `key:value`) defines a filter that Datadog uses when collecting metrics from a specified service.\nWildcards, such as `?` (match a single character) and `*` (match multiple characters), and exclusion using `!` before the tag are supported.\nFor EC2, only hosts that match one of the defined tags will be imported into Datadog. The rest will be ignored.\nFor example, `env:production,instance-type:c?.*,!region:us-east-1`.", "properties": { "namespace": { - "description": "The AWS Namespace to apply the tag filters against", + "description": "The AWS service for which the tag filters defined in `tags` will be applied.", "example": "AWS/EC2", "type": "string" }, "tags": { - "description": "The tags to filter based on", + "description": "The AWS resource tags to filter on for the service specified by `namespace`.", "items": { - "example": "key:value", + "description": "Tag in the form `key:value`.", + "example": "datadog:true", "type": "string" }, "nullable": true, @@ -3983,32 +3985,32 @@ "type": "object" }, "resources_config": { - "description": "AWS Resources config", + "description": "AWS Resources Collection config.", "properties": { "cloud_security_posture_management_collection": { - "description": "Whether Datadog collects cloud security posture management resources from your AWS account.", + "description": "Enable Cloud Security Management to scan AWS resources for vulnerabilities, misconfigurations, identity risks, and compliance violations. Defaults to `false`. Requires `extended_collection` to be set to `true`.", "example": false, "type": "boolean" }, "extended_collection": { - "description": "Whether Datadog collects additional attributes and configuration information about the resources in your AWS account. Required for `cspm_resource_collection`.", - "example": false, + "description": "Whether Datadog collects additional attributes and configuration information about the resources in your AWS account. Defaults to `true`. Required for `cloud_security_posture_management_collection`.", + "example": true, "type": "boolean" } }, "type": "object" }, "traces_config": { - "description": "AWS Traces config", + "description": "AWS Traces Collection config.", "properties": { "xray_services": { - "description": "AWS X-Ray services to collect traces from", + "description": "AWS X-Ray services to collect traces from. Defaults to `include_only`.", "oneOf": [ { - "description": "Include all services", + "description": "Include all services.", "properties": { "include_all": { - "description": "Include all services", + "description": "Include all services.", "example": false, "type": "boolean" } @@ -4018,11 +4020,11 @@ ] }, { - "description": "Include only these services", + "description": "Include only these services. Defaults to `[]`.", "nullable": true, "properties": { "include_only": { - "description": "Include only these services", + "description": "Include only these services.", "example": [ "AWS/AppSync" ], @@ -4051,34 +4053,34 @@ "type": "object" }, "AWSAccountCreateRequestData": { - "description": "AWS Account Create Request data", + "description": "AWS Account Create Request data.", "properties": { "attributes": { - "description": "The AWS Account Integration Config to be created", + "description": "The AWS Account Integration Config to be created.", "properties": { "account_tags": { - "description": "Tags to apply to all metrics in the account", + "description": "Tags to apply to all hosts and metrics reporting for this account. Defaults to `[]`.", "items": { - "description": "Tag to apply to all metrics in the account", - "example": "key:value", + "description": "Tag in the form `key:value`.", + "example": "env:prod", "type": "string" }, "nullable": true, "type": "array" }, "auth_config": { - "description": "AWS Authentication config", + "description": "AWS Authentication config.", "oneOf": [ { - "description": "AWS Authentication config for key-based account", + "description": "AWS Authentication config to integrate your account using an access key pair.", "properties": { "access_key_id": { - "description": "AWS Access Key ID", + "description": "AWS Access Key ID.", "example": "AKIAIOSFODNN7EXAMPLE", "type": "string" }, "secret_access_key": { - "description": "AWS Secret Access Key", + "description": "AWS Secret Access Key.", "example": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY", "minLength": 1, "type": "string", @@ -4091,14 +4093,14 @@ "type": "object" }, { - "description": "AWS Authentication config for role-based account", + "description": "AWS Authentication config to integrate your account using an IAM role.", "properties": { "external_id": { - "description": "AWS IAM External ID for associated role", + "description": "AWS IAM External ID for associated role.", "type": "string" }, "role_name": { - "description": "AWS IAM Role name", + "description": "AWS IAM Role name.", "example": "DatadogIntegrationRole", "maxLength": 576, "minLength": 1, @@ -4113,13 +4115,12 @@ ] }, "aws_account_id": { - "description": "AWS Account ID", + "description": "AWS Account ID.", "example": "123456789012", "type": "string" }, "aws_partition": { - "default": "aws", - "description": "AWS Account partition", + "description": "AWS partition your AWS account is scoped to. Defaults to `aws`.\nSee [Partitions](https://docs.aws.amazon.com/whitepapers/latest/aws-fault-isolation-boundaries/partitions.html) in the AWS documentation for more information.", "enum": [ "aws", "aws-cn", @@ -4134,14 +4135,14 @@ ] }, "aws_regions": { - "description": "AWS Regions to collect data from", + "description": "AWS Regions to collect data from. Defaults to `include_all`.", "oneOf": [ { - "description": "Include all regions", + "description": "Include all regions. Defaults to `true`.", "properties": { "include_all": { - "description": "Include all regions", - "example": false, + "description": "Include all regions.", + "example": true, "type": "boolean" } }, @@ -4150,10 +4151,10 @@ ] }, { - "description": "Include only these regions", + "description": "Include only these regions.", "properties": { "include_only": { - "description": "Include only these regions", + "description": "Include only these regions.", "example": [ "us-east-1" ], @@ -4171,13 +4172,13 @@ ] }, "logs_config": { - "description": "AWS Logs config", + "description": "AWS Logs Collection config.", "properties": { "lambda_forwarder": { - "description": "AWS Lambda forwarder", + "description": "Log Autosubscription configuration for Datadog Forwarder Lambda functions. Automatically set up triggers for existing\nand new logs for some services, ensuring no logs from new resources are missed and saving time spent on manual configuration.", "properties": { "lambdas": { - "description": "List of Datadog Lambda Log Forwarder ARNs", + "description": "List of Datadog Lambda Log Forwarder ARNs in your AWS account. Defaults to `[]`.", "items": { "example": "arn:aws:lambda:us-east-1:123456789012:function:DatadogLambdaLogForwarder", "type": "string" @@ -4185,7 +4186,7 @@ "type": "array" }, "sources": { - "description": "List of AWS services that will send logs to the Datadog Lambda Log Forwarder", + "description": "List of service IDs set to enable automatic log collection. Discover the list of available services with the\n[Get list of AWS log ready services](https://docs.datadoghq.com/api/latest/aws-logs-integration/#get-list-of-aws-log-ready-services) endpoint.", "items": { "example": "s3", "type": "string" @@ -4199,41 +4200,42 @@ "type": "object" }, "metrics_config": { - "description": "AWS Metrics config", + "description": "AWS Metrics Collection config.", "properties": { "automute_enabled": { - "description": "Enable EC2 automute for AWS metrics", + "description": "Enable EC2 automute for AWS metrics. Defaults to `true`.", "example": true, "type": "boolean" }, "collect_cloudwatch_alarms": { - "description": "Enable CloudWatch alarms collection", - "example": true, + "description": "Enable CloudWatch alarms collection. Defaults to `false`.", + "example": false, "type": "boolean" }, "collect_custom_metrics": { - "description": "Enable custom metrics collection", - "example": true, + "description": "Enable custom metrics collection. Defaults to `false`.", + "example": false, "type": "boolean" }, "enabled": { - "description": "Enable AWS metrics collection", + "description": "Enable AWS metrics collection. Defaults to `true`.", "example": true, "type": "boolean" }, "namespace_filters": { - "description": "AWS Metrics namespace filters", + "description": "AWS Metrics namespace filters. Defaults to `exclude_only`.", "oneOf": [ { - "description": "Exclude only these namespaces", + "description": "Exclude only these namespaces from metrics collection. Defaults to `[\"AWS/SQS\", \"AWS/ElasticMapReduce\"]`.\n`AWS/SQS` and `AWS/ElasticMapReduce` are excluded by default to reduce your AWS CloudWatch costs from `GetMetricData` API calls.", "properties": { "exclude_only": { - "description": "Exclude only these namespaces", + "description": "Exclude only these namespaces from metrics collection. Defaults to `[\"AWS/SQS\", \"AWS/ElasticMapReduce\"]`.\n`AWS/SQS` and `AWS/ElasticMapReduce` are excluded by default to reduce your AWS CloudWatch costs from `GetMetricData` API calls.", "example": [ - "AWS/EC2" + "AWS/SQS", + "AWS/ElasticMapReduce" ], "items": { - "example": "AWS/EC2", + "example": "AWS/SQS", "type": "string" }, "type": "array" @@ -4244,10 +4246,10 @@ ] }, { - "description": "Include only these namespaces", + "description": "Include only these namespaces.", "properties": { "include_only": { - "description": "Include only these namespaces", + "description": "Include only these namespaces.", "example": [ "AWS/EC2" ], @@ -4265,19 +4267,20 @@ ] }, "tag_filters": { - "description": "AWS Metrics tag filters list", + "description": "AWS Metrics collection tag filters list. Defaults to `[]`.", "items": { - "description": "AWS Metrics tag filters", + "description": "AWS Metrics Collection tag filters list. Defaults to `[]`.\nThe array of custom AWS resource tags (in the form `key:value`) defines a filter that Datadog uses when collecting metrics from a specified service.\nWildcards, such as `?` (match a single character) and `*` (match multiple characters), and exclusion using `!` before the tag are supported.\nFor EC2, only hosts that match one of the defined tags will be imported into Datadog. The rest will be ignored.\nFor example, `env:production,instance-type:c?.*,!region:us-east-1`.", "properties": { "namespace": { - "description": "The AWS Namespace to apply the tag filters against", + "description": "The AWS service for which the tag filters defined in `tags` will be applied.", "example": "AWS/EC2", "type": "string" }, "tags": { - "description": "The tags to filter based on", + "description": "The AWS resource tags to filter on for the service specified by `namespace`.", "items": { - "example": "key:value", + "description": "Tag in the form `key:value`.", + "example": "datadog:true", "type": "string" }, "nullable": true, @@ -4292,32 +4295,32 @@ "type": "object" }, "resources_config": { - "description": "AWS Resources config", + "description": "AWS Resources Collection config.", "properties": { "cloud_security_posture_management_collection": { - "description": "Whether Datadog collects cloud security posture management resources from your AWS account.", + "description": "Enable Cloud Security Management to scan AWS resources for vulnerabilities, misconfigurations, identity risks, and compliance violations. Defaults to `false`. Requires `extended_collection` to be set to `true`.", "example": false, "type": "boolean" }, "extended_collection": { - "description": "Whether Datadog collects additional attributes and configuration information about the resources in your AWS account. Required for `cspm_resource_collection`.", - "example": false, + "description": "Whether Datadog collects additional attributes and configuration information about the resources in your AWS account. Defaults to `true`. Required for `cloud_security_posture_management_collection`.", + "example": true, "type": "boolean" } }, "type": "object" }, "traces_config": { - "description": "AWS Traces config", + "description": "AWS Traces Collection config.", "properties": { "xray_services": { - "description": "AWS X-Ray services to collect traces from", + "description": "AWS X-Ray services to collect traces from. Defaults to `include_only`.", "oneOf": [ { - "description": "Include all services", + "description": "Include all services.", "properties": { "include_all": { - "description": "Include all services", + "description": "Include all services.", "example": false, "type": "boolean" } @@ -4327,11 +4330,11 @@ ] }, { - "description": "Include only these services", + "description": "Include only these services. Defaults to `[]`.", "nullable": true, "properties": { "include_only": { - "description": "Include only these services", + "description": "Include only these services.", "example": [ "AWS/AppSync" ], @@ -4379,13 +4382,12 @@ "type": "object" }, "AWSAccountID": { - "description": "AWS Account ID", + "description": "AWS Account ID.", "example": "123456789012", "type": "string" }, "AWSAccountPartition": { - "default": "aws", - "description": "AWS Account partition", + "description": "AWS partition your AWS account is scoped to. Defaults to `aws`.\nSee [Partitions](https://docs.aws.amazon.com/whitepapers/latest/aws-fault-isolation-boundaries/partitions.html) in the AWS documentation for more information.", "enum": [ "aws", "aws-cn", @@ -4400,37 +4402,37 @@ ] }, "AWSAccountResponse": { - "description": "AWS Account response body", + "description": "AWS Account response body.", "properties": { "data": { - "description": "AWS Account Response body", + "description": "AWS Account response data.", "properties": { "attributes": { - "description": "The AWS Account Integration Config", + "description": "AWS Account response attributes.", "properties": { "account_tags": { - "description": "Tags to apply to all metrics in the account", + "description": "Tags to apply to all hosts and metrics reporting for this account. Defaults to `[]`.", "items": { - "description": "Tag to apply to all metrics in the account", - "example": "key:value", + "description": "Tag in the form `key:value`.", + "example": "env:prod", "type": "string" }, "nullable": true, "type": "array" }, "auth_config": { - "description": "AWS Authentication config", + "description": "AWS Authentication config.", "oneOf": [ { - "description": "AWS Authentication config for key-based account", + "description": "AWS Authentication config to integrate your account using an access key pair.", "properties": { "access_key_id": { - "description": "AWS Access Key ID", + "description": "AWS Access Key ID.", "example": "AKIAIOSFODNN7EXAMPLE", "type": "string" }, "secret_access_key": { - "description": "AWS Secret Access Key", + "description": "AWS Secret Access Key.", "example": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY", "minLength": 1, "type": "string", @@ -4443,14 +4445,14 @@ "type": "object" }, { - "description": "AWS Authentication config for role-based account", + "description": "AWS Authentication config to integrate your account using an IAM role.", "properties": { "external_id": { - "description": "AWS IAM External ID for associated role", + "description": "AWS IAM External ID for associated role.", "type": "string" }, "role_name": { - "description": "AWS IAM Role name", + "description": "AWS IAM Role name.", "example": "DatadogIntegrationRole", "maxLength": 576, "minLength": 1, @@ -4465,13 +4467,12 @@ ] }, "aws_account_id": { - "description": "AWS Account ID", + "description": "AWS Account ID.", "example": "123456789012", "type": "string" }, "aws_partition": { - "default": "aws", - "description": "AWS Account partition", + "description": "AWS partition your AWS account is scoped to. Defaults to `aws`.\nSee [Partitions](https://docs.aws.amazon.com/whitepapers/latest/aws-fault-isolation-boundaries/partitions.html) in the AWS documentation for more information.", "enum": [ "aws", "aws-cn", @@ -4486,14 +4487,14 @@ ] }, "aws_regions": { - "description": "AWS Regions to collect data from", + "description": "AWS Regions to collect data from. Defaults to `include_all`.", "oneOf": [ { - "description": "Include all regions", + "description": "Include all regions. Defaults to `true`.", "properties": { "include_all": { - "description": "Include all regions", - "example": false, + "description": "Include all regions.", + "example": true, "type": "boolean" } }, @@ -4502,10 +4503,10 @@ ] }, { - "description": "Include only these regions", + "description": "Include only these regions.", "properties": { "include_only": { - "description": "Include only these regions", + "description": "Include only these regions.", "example": [ "us-east-1" ], @@ -4523,19 +4524,19 @@ ] }, "created_at": { - "description": "Timestamp of when the account integration was created", + "description": "Timestamp of when the account integration was created.", "format": "date-time", "readOnly": true, "type": "string" }, "logs_config": { - "description": "AWS Logs config", + "description": "AWS Logs Collection config.", "properties": { "lambda_forwarder": { - "description": "AWS Lambda forwarder", + "description": "Log Autosubscription configuration for Datadog Forwarder Lambda functions. Automatically set up triggers for existing\nand new logs for some services, ensuring no logs from new resources are missed and saving time spent on manual configuration.", "properties": { "lambdas": { - "description": "List of Datadog Lambda Log Forwarder ARNs", + "description": "List of Datadog Lambda Log Forwarder ARNs in your AWS account. Defaults to `[]`.", "items": { "example": "arn:aws:lambda:us-east-1:123456789012:function:DatadogLambdaLogForwarder", "type": "string" @@ -4543,7 +4544,7 @@ "type": "array" }, "sources": { - "description": "List of AWS services that will send logs to the Datadog Lambda Log Forwarder", + "description": "List of service IDs set to enable automatic log collection. Discover the list of available services with the\n[Get list of AWS log ready services](https://docs.datadoghq.com/api/latest/aws-logs-integration/#get-list-of-aws-log-ready-services) endpoint.", "items": { "example": "s3", "type": "string" @@ -4557,41 +4558,42 @@ "type": "object" }, "metrics_config": { - "description": "AWS Metrics config", + "description": "AWS Metrics Collection config.", "properties": { "automute_enabled": { - "description": "Enable EC2 automute for AWS metrics", + "description": "Enable EC2 automute for AWS metrics. Defaults to `true`.", "example": true, "type": "boolean" }, "collect_cloudwatch_alarms": { - "description": "Enable CloudWatch alarms collection", - "example": true, + "description": "Enable CloudWatch alarms collection. Defaults to `false`.", + "example": false, "type": "boolean" }, "collect_custom_metrics": { - "description": "Enable custom metrics collection", - "example": true, + "description": "Enable custom metrics collection. Defaults to `false`.", + "example": false, "type": "boolean" }, "enabled": { - "description": "Enable AWS metrics collection", + "description": "Enable AWS metrics collection. Defaults to `true`.", "example": true, "type": "boolean" }, "namespace_filters": { - "description": "AWS Metrics namespace filters", + "description": "AWS Metrics namespace filters. Defaults to `exclude_only`.", "oneOf": [ { - "description": "Exclude only these namespaces", + "description": "Exclude only these namespaces from metrics collection. Defaults to `[\"AWS/SQS\", \"AWS/ElasticMapReduce\"]`.\n`AWS/SQS` and `AWS/ElasticMapReduce` are excluded by default to reduce your AWS CloudWatch costs from `GetMetricData` API calls.", "properties": { "exclude_only": { - "description": "Exclude only these namespaces", + "description": "Exclude only these namespaces from metrics collection. Defaults to `[\"AWS/SQS\", \"AWS/ElasticMapReduce\"]`.\n`AWS/SQS` and `AWS/ElasticMapReduce` are excluded by default to reduce your AWS CloudWatch costs from `GetMetricData` API calls.", "example": [ - "AWS/EC2" + "AWS/SQS", + "AWS/ElasticMapReduce" ], "items": { - "example": "AWS/EC2", + "example": "AWS/SQS", "type": "string" }, "type": "array" @@ -4602,10 +4604,10 @@ ] }, { - "description": "Include only these namespaces", + "description": "Include only these namespaces.", "properties": { "include_only": { - "description": "Include only these namespaces", + "description": "Include only these namespaces.", "example": [ "AWS/EC2" ], @@ -4623,19 +4625,20 @@ ] }, "tag_filters": { - "description": "AWS Metrics tag filters list", + "description": "AWS Metrics collection tag filters list. Defaults to `[]`.", "items": { - "description": "AWS Metrics tag filters", + "description": "AWS Metrics Collection tag filters list. Defaults to `[]`.\nThe array of custom AWS resource tags (in the form `key:value`) defines a filter that Datadog uses when collecting metrics from a specified service.\nWildcards, such as `?` (match a single character) and `*` (match multiple characters), and exclusion using `!` before the tag are supported.\nFor EC2, only hosts that match one of the defined tags will be imported into Datadog. The rest will be ignored.\nFor example, `env:production,instance-type:c?.*,!region:us-east-1`.", "properties": { "namespace": { - "description": "The AWS Namespace to apply the tag filters against", + "description": "The AWS service for which the tag filters defined in `tags` will be applied.", "example": "AWS/EC2", "type": "string" }, "tags": { - "description": "The tags to filter based on", + "description": "The AWS resource tags to filter on for the service specified by `namespace`.", "items": { - "example": "key:value", + "description": "Tag in the form `key:value`.", + "example": "datadog:true", "type": "string" }, "nullable": true, @@ -4650,38 +4653,38 @@ "type": "object" }, "modified_at": { - "description": "Timestamp of when the account integration was updated", + "description": "Timestamp of when the account integration was updated.", "format": "date-time", "readOnly": true, "type": "string" }, "resources_config": { - "description": "AWS Resources config", + "description": "AWS Resources Collection config.", "properties": { "cloud_security_posture_management_collection": { - "description": "Whether Datadog collects cloud security posture management resources from your AWS account.", + "description": "Enable Cloud Security Management to scan AWS resources for vulnerabilities, misconfigurations, identity risks, and compliance violations. Defaults to `false`. Requires `extended_collection` to be set to `true`.", "example": false, "type": "boolean" }, "extended_collection": { - "description": "Whether Datadog collects additional attributes and configuration information about the resources in your AWS account. Required for `cspm_resource_collection`.", - "example": false, + "description": "Whether Datadog collects additional attributes and configuration information about the resources in your AWS account. Defaults to `true`. Required for `cloud_security_posture_management_collection`.", + "example": true, "type": "boolean" } }, "type": "object" }, "traces_config": { - "description": "AWS Traces config", + "description": "AWS Traces Collection config.", "properties": { "xray_services": { - "description": "AWS X-Ray services to collect traces from", + "description": "AWS X-Ray services to collect traces from. Defaults to `include_only`.", "oneOf": [ { - "description": "Include all services", + "description": "Include all services.", "properties": { "include_all": { - "description": "Include all services", + "description": "Include all services.", "example": false, "type": "boolean" } @@ -4691,11 +4694,11 @@ ] }, { - "description": "Include only these services", + "description": "Include only these services. Defaults to `[]`.", "nullable": true, "properties": { "include_only": { - "description": "Include only these services", + "description": "Include only these services.", "example": [ "AWS/AppSync" ], @@ -4722,7 +4725,7 @@ "type": "object" }, "id": { - "description": "Unique Datadog ID of the AWS Account Integration Config", + "description": "Unique Datadog ID of the AWS Account Integration Config.\nTo get the config ID for an account, use the [List all AWS integrations](https://docs.datadoghq.com/api/latest/aws-integration/#list-all-aws-integrations)\nendpoint and query by AWS Account ID.", "example": "00000000-abcd-0001-0000-000000000000", "type": "string" }, @@ -4752,31 +4755,31 @@ "type": "object" }, "AWSAccountResponseAttributes": { - "description": "The AWS Account Integration Config", + "description": "AWS Account response attributes.", "properties": { "account_tags": { - "description": "Tags to apply to all metrics in the account", + "description": "Tags to apply to all hosts and metrics reporting for this account. Defaults to `[]`.", "items": { - "description": "Tag to apply to all metrics in the account", - "example": "key:value", + "description": "Tag in the form `key:value`.", + "example": "env:prod", "type": "string" }, "nullable": true, "type": "array" }, "auth_config": { - "description": "AWS Authentication config", + "description": "AWS Authentication config.", "oneOf": [ { - "description": "AWS Authentication config for key-based account", + "description": "AWS Authentication config to integrate your account using an access key pair.", "properties": { "access_key_id": { - "description": "AWS Access Key ID", + "description": "AWS Access Key ID.", "example": "AKIAIOSFODNN7EXAMPLE", "type": "string" }, "secret_access_key": { - "description": "AWS Secret Access Key", + "description": "AWS Secret Access Key.", "example": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY", "minLength": 1, "type": "string", @@ -4789,14 +4792,14 @@ "type": "object" }, { - "description": "AWS Authentication config for role-based account", + "description": "AWS Authentication config to integrate your account using an IAM role.", "properties": { "external_id": { - "description": "AWS IAM External ID for associated role", + "description": "AWS IAM External ID for associated role.", "type": "string" }, "role_name": { - "description": "AWS IAM Role name", + "description": "AWS IAM Role name.", "example": "DatadogIntegrationRole", "maxLength": 576, "minLength": 1, @@ -4811,13 +4814,12 @@ ] }, "aws_account_id": { - "description": "AWS Account ID", + "description": "AWS Account ID.", "example": "123456789012", "type": "string" }, "aws_partition": { - "default": "aws", - "description": "AWS Account partition", + "description": "AWS partition your AWS account is scoped to. Defaults to `aws`.\nSee [Partitions](https://docs.aws.amazon.com/whitepapers/latest/aws-fault-isolation-boundaries/partitions.html) in the AWS documentation for more information.", "enum": [ "aws", "aws-cn", @@ -4832,14 +4834,14 @@ ] }, "aws_regions": { - "description": "AWS Regions to collect data from", + "description": "AWS Regions to collect data from. Defaults to `include_all`.", "oneOf": [ { - "description": "Include all regions", + "description": "Include all regions. Defaults to `true`.", "properties": { "include_all": { - "description": "Include all regions", - "example": false, + "description": "Include all regions.", + "example": true, "type": "boolean" } }, @@ -4848,10 +4850,10 @@ ] }, { - "description": "Include only these regions", + "description": "Include only these regions.", "properties": { "include_only": { - "description": "Include only these regions", + "description": "Include only these regions.", "example": [ "us-east-1" ], @@ -4869,19 +4871,19 @@ ] }, "created_at": { - "description": "Timestamp of when the account integration was created", + "description": "Timestamp of when the account integration was created.", "format": "date-time", "readOnly": true, "type": "string" }, "logs_config": { - "description": "AWS Logs config", + "description": "AWS Logs Collection config.", "properties": { "lambda_forwarder": { - "description": "AWS Lambda forwarder", + "description": "Log Autosubscription configuration for Datadog Forwarder Lambda functions. Automatically set up triggers for existing\nand new logs for some services, ensuring no logs from new resources are missed and saving time spent on manual configuration.", "properties": { "lambdas": { - "description": "List of Datadog Lambda Log Forwarder ARNs", + "description": "List of Datadog Lambda Log Forwarder ARNs in your AWS account. Defaults to `[]`.", "items": { "example": "arn:aws:lambda:us-east-1:123456789012:function:DatadogLambdaLogForwarder", "type": "string" @@ -4889,7 +4891,7 @@ "type": "array" }, "sources": { - "description": "List of AWS services that will send logs to the Datadog Lambda Log Forwarder", + "description": "List of service IDs set to enable automatic log collection. Discover the list of available services with the\n[Get list of AWS log ready services](https://docs.datadoghq.com/api/latest/aws-logs-integration/#get-list-of-aws-log-ready-services) endpoint.", "items": { "example": "s3", "type": "string" @@ -4903,41 +4905,42 @@ "type": "object" }, "metrics_config": { - "description": "AWS Metrics config", + "description": "AWS Metrics Collection config.", "properties": { "automute_enabled": { - "description": "Enable EC2 automute for AWS metrics", + "description": "Enable EC2 automute for AWS metrics. Defaults to `true`.", "example": true, "type": "boolean" }, "collect_cloudwatch_alarms": { - "description": "Enable CloudWatch alarms collection", - "example": true, + "description": "Enable CloudWatch alarms collection. Defaults to `false`.", + "example": false, "type": "boolean" }, "collect_custom_metrics": { - "description": "Enable custom metrics collection", - "example": true, + "description": "Enable custom metrics collection. Defaults to `false`.", + "example": false, "type": "boolean" }, "enabled": { - "description": "Enable AWS metrics collection", + "description": "Enable AWS metrics collection. Defaults to `true`.", "example": true, "type": "boolean" }, "namespace_filters": { - "description": "AWS Metrics namespace filters", + "description": "AWS Metrics namespace filters. Defaults to `exclude_only`.", "oneOf": [ { - "description": "Exclude only these namespaces", + "description": "Exclude only these namespaces from metrics collection. Defaults to `[\"AWS/SQS\", \"AWS/ElasticMapReduce\"]`.\n`AWS/SQS` and `AWS/ElasticMapReduce` are excluded by default to reduce your AWS CloudWatch costs from `GetMetricData` API calls.", "properties": { "exclude_only": { - "description": "Exclude only these namespaces", + "description": "Exclude only these namespaces from metrics collection. Defaults to `[\"AWS/SQS\", \"AWS/ElasticMapReduce\"]`.\n`AWS/SQS` and `AWS/ElasticMapReduce` are excluded by default to reduce your AWS CloudWatch costs from `GetMetricData` API calls.", "example": [ - "AWS/EC2" + "AWS/SQS", + "AWS/ElasticMapReduce" ], "items": { - "example": "AWS/EC2", + "example": "AWS/SQS", "type": "string" }, "type": "array" @@ -4948,10 +4951,10 @@ ] }, { - "description": "Include only these namespaces", + "description": "Include only these namespaces.", "properties": { "include_only": { - "description": "Include only these namespaces", + "description": "Include only these namespaces.", "example": [ "AWS/EC2" ], @@ -4969,19 +4972,20 @@ ] }, "tag_filters": { - "description": "AWS Metrics tag filters list", + "description": "AWS Metrics collection tag filters list. Defaults to `[]`.", "items": { - "description": "AWS Metrics tag filters", + "description": "AWS Metrics Collection tag filters list. Defaults to `[]`.\nThe array of custom AWS resource tags (in the form `key:value`) defines a filter that Datadog uses when collecting metrics from a specified service.\nWildcards, such as `?` (match a single character) and `*` (match multiple characters), and exclusion using `!` before the tag are supported.\nFor EC2, only hosts that match one of the defined tags will be imported into Datadog. The rest will be ignored.\nFor example, `env:production,instance-type:c?.*,!region:us-east-1`.", "properties": { "namespace": { - "description": "The AWS Namespace to apply the tag filters against", + "description": "The AWS service for which the tag filters defined in `tags` will be applied.", "example": "AWS/EC2", "type": "string" }, "tags": { - "description": "The tags to filter based on", + "description": "The AWS resource tags to filter on for the service specified by `namespace`.", "items": { - "example": "key:value", + "description": "Tag in the form `key:value`.", + "example": "datadog:true", "type": "string" }, "nullable": true, @@ -4996,38 +5000,38 @@ "type": "object" }, "modified_at": { - "description": "Timestamp of when the account integration was updated", + "description": "Timestamp of when the account integration was updated.", "format": "date-time", "readOnly": true, "type": "string" }, "resources_config": { - "description": "AWS Resources config", + "description": "AWS Resources Collection config.", "properties": { "cloud_security_posture_management_collection": { - "description": "Whether Datadog collects cloud security posture management resources from your AWS account.", + "description": "Enable Cloud Security Management to scan AWS resources for vulnerabilities, misconfigurations, identity risks, and compliance violations. Defaults to `false`. Requires `extended_collection` to be set to `true`.", "example": false, "type": "boolean" }, "extended_collection": { - "description": "Whether Datadog collects additional attributes and configuration information about the resources in your AWS account. Required for `cspm_resource_collection`.", - "example": false, + "description": "Whether Datadog collects additional attributes and configuration information about the resources in your AWS account. Defaults to `true`. Required for `cloud_security_posture_management_collection`.", + "example": true, "type": "boolean" } }, "type": "object" }, "traces_config": { - "description": "AWS Traces config", + "description": "AWS Traces Collection config.", "properties": { "xray_services": { - "description": "AWS X-Ray services to collect traces from", + "description": "AWS X-Ray services to collect traces from. Defaults to `include_only`.", "oneOf": [ { - "description": "Include all services", + "description": "Include all services.", "properties": { "include_all": { - "description": "Include all services", + "description": "Include all services.", "example": false, "type": "boolean" } @@ -5037,11 +5041,11 @@ ] }, { - "description": "Include only these services", + "description": "Include only these services. Defaults to `[]`.", "nullable": true, "properties": { "include_only": { - "description": "Include only these services", + "description": "Include only these services.", "example": [ "AWS/AppSync" ], @@ -5068,34 +5072,34 @@ "type": "object" }, "AWSAccountResponseData": { - "description": "AWS Account Response body", + "description": "AWS Account response data.", "properties": { "attributes": { - "description": "The AWS Account Integration Config", + "description": "AWS Account response attributes.", "properties": { "account_tags": { - "description": "Tags to apply to all metrics in the account", + "description": "Tags to apply to all hosts and metrics reporting for this account. Defaults to `[]`.", "items": { - "description": "Tag to apply to all metrics in the account", - "example": "key:value", + "description": "Tag in the form `key:value`.", + "example": "env:prod", "type": "string" }, "nullable": true, "type": "array" }, "auth_config": { - "description": "AWS Authentication config", + "description": "AWS Authentication config.", "oneOf": [ { - "description": "AWS Authentication config for key-based account", + "description": "AWS Authentication config to integrate your account using an access key pair.", "properties": { "access_key_id": { - "description": "AWS Access Key ID", + "description": "AWS Access Key ID.", "example": "AKIAIOSFODNN7EXAMPLE", "type": "string" }, "secret_access_key": { - "description": "AWS Secret Access Key", + "description": "AWS Secret Access Key.", "example": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY", "minLength": 1, "type": "string", @@ -5108,14 +5112,14 @@ "type": "object" }, { - "description": "AWS Authentication config for role-based account", + "description": "AWS Authentication config to integrate your account using an IAM role.", "properties": { "external_id": { - "description": "AWS IAM External ID for associated role", + "description": "AWS IAM External ID for associated role.", "type": "string" }, "role_name": { - "description": "AWS IAM Role name", + "description": "AWS IAM Role name.", "example": "DatadogIntegrationRole", "maxLength": 576, "minLength": 1, @@ -5130,13 +5134,12 @@ ] }, "aws_account_id": { - "description": "AWS Account ID", + "description": "AWS Account ID.", "example": "123456789012", "type": "string" }, "aws_partition": { - "default": "aws", - "description": "AWS Account partition", + "description": "AWS partition your AWS account is scoped to. Defaults to `aws`.\nSee [Partitions](https://docs.aws.amazon.com/whitepapers/latest/aws-fault-isolation-boundaries/partitions.html) in the AWS documentation for more information.", "enum": [ "aws", "aws-cn", @@ -5151,14 +5154,14 @@ ] }, "aws_regions": { - "description": "AWS Regions to collect data from", + "description": "AWS Regions to collect data from. Defaults to `include_all`.", "oneOf": [ { - "description": "Include all regions", + "description": "Include all regions. Defaults to `true`.", "properties": { "include_all": { - "description": "Include all regions", - "example": false, + "description": "Include all regions.", + "example": true, "type": "boolean" } }, @@ -5167,10 +5170,10 @@ ] }, { - "description": "Include only these regions", + "description": "Include only these regions.", "properties": { "include_only": { - "description": "Include only these regions", + "description": "Include only these regions.", "example": [ "us-east-1" ], @@ -5188,19 +5191,19 @@ ] }, "created_at": { - "description": "Timestamp of when the account integration was created", + "description": "Timestamp of when the account integration was created.", "format": "date-time", "readOnly": true, "type": "string" }, "logs_config": { - "description": "AWS Logs config", + "description": "AWS Logs Collection config.", "properties": { "lambda_forwarder": { - "description": "AWS Lambda forwarder", + "description": "Log Autosubscription configuration for Datadog Forwarder Lambda functions. Automatically set up triggers for existing\nand new logs for some services, ensuring no logs from new resources are missed and saving time spent on manual configuration.", "properties": { "lambdas": { - "description": "List of Datadog Lambda Log Forwarder ARNs", + "description": "List of Datadog Lambda Log Forwarder ARNs in your AWS account. Defaults to `[]`.", "items": { "example": "arn:aws:lambda:us-east-1:123456789012:function:DatadogLambdaLogForwarder", "type": "string" @@ -5208,7 +5211,7 @@ "type": "array" }, "sources": { - "description": "List of AWS services that will send logs to the Datadog Lambda Log Forwarder", + "description": "List of service IDs set to enable automatic log collection. Discover the list of available services with the\n[Get list of AWS log ready services](https://docs.datadoghq.com/api/latest/aws-logs-integration/#get-list-of-aws-log-ready-services) endpoint.", "items": { "example": "s3", "type": "string" @@ -5222,41 +5225,42 @@ "type": "object" }, "metrics_config": { - "description": "AWS Metrics config", + "description": "AWS Metrics Collection config.", "properties": { "automute_enabled": { - "description": "Enable EC2 automute for AWS metrics", + "description": "Enable EC2 automute for AWS metrics. Defaults to `true`.", "example": true, "type": "boolean" }, "collect_cloudwatch_alarms": { - "description": "Enable CloudWatch alarms collection", - "example": true, + "description": "Enable CloudWatch alarms collection. Defaults to `false`.", + "example": false, "type": "boolean" }, "collect_custom_metrics": { - "description": "Enable custom metrics collection", - "example": true, + "description": "Enable custom metrics collection. Defaults to `false`.", + "example": false, "type": "boolean" }, "enabled": { - "description": "Enable AWS metrics collection", + "description": "Enable AWS metrics collection. Defaults to `true`.", "example": true, "type": "boolean" }, "namespace_filters": { - "description": "AWS Metrics namespace filters", + "description": "AWS Metrics namespace filters. Defaults to `exclude_only`.", "oneOf": [ { - "description": "Exclude only these namespaces", + "description": "Exclude only these namespaces from metrics collection. Defaults to `[\"AWS/SQS\", \"AWS/ElasticMapReduce\"]`.\n`AWS/SQS` and `AWS/ElasticMapReduce` are excluded by default to reduce your AWS CloudWatch costs from `GetMetricData` API calls.", "properties": { "exclude_only": { - "description": "Exclude only these namespaces", + "description": "Exclude only these namespaces from metrics collection. Defaults to `[\"AWS/SQS\", \"AWS/ElasticMapReduce\"]`.\n`AWS/SQS` and `AWS/ElasticMapReduce` are excluded by default to reduce your AWS CloudWatch costs from `GetMetricData` API calls.", "example": [ - "AWS/EC2" + "AWS/SQS", + "AWS/ElasticMapReduce" ], "items": { - "example": "AWS/EC2", + "example": "AWS/SQS", "type": "string" }, "type": "array" @@ -5267,10 +5271,10 @@ ] }, { - "description": "Include only these namespaces", + "description": "Include only these namespaces.", "properties": { "include_only": { - "description": "Include only these namespaces", + "description": "Include only these namespaces.", "example": [ "AWS/EC2" ], @@ -5288,19 +5292,20 @@ ] }, "tag_filters": { - "description": "AWS Metrics tag filters list", + "description": "AWS Metrics collection tag filters list. Defaults to `[]`.", "items": { - "description": "AWS Metrics tag filters", + "description": "AWS Metrics Collection tag filters list. Defaults to `[]`.\nThe array of custom AWS resource tags (in the form `key:value`) defines a filter that Datadog uses when collecting metrics from a specified service.\nWildcards, such as `?` (match a single character) and `*` (match multiple characters), and exclusion using `!` before the tag are supported.\nFor EC2, only hosts that match one of the defined tags will be imported into Datadog. The rest will be ignored.\nFor example, `env:production,instance-type:c?.*,!region:us-east-1`.", "properties": { "namespace": { - "description": "The AWS Namespace to apply the tag filters against", + "description": "The AWS service for which the tag filters defined in `tags` will be applied.", "example": "AWS/EC2", "type": "string" }, "tags": { - "description": "The tags to filter based on", + "description": "The AWS resource tags to filter on for the service specified by `namespace`.", "items": { - "example": "key:value", + "description": "Tag in the form `key:value`.", + "example": "datadog:true", "type": "string" }, "nullable": true, @@ -5315,38 +5320,38 @@ "type": "object" }, "modified_at": { - "description": "Timestamp of when the account integration was updated", + "description": "Timestamp of when the account integration was updated.", "format": "date-time", "readOnly": true, "type": "string" }, "resources_config": { - "description": "AWS Resources config", + "description": "AWS Resources Collection config.", "properties": { "cloud_security_posture_management_collection": { - "description": "Whether Datadog collects cloud security posture management resources from your AWS account.", + "description": "Enable Cloud Security Management to scan AWS resources for vulnerabilities, misconfigurations, identity risks, and compliance violations. Defaults to `false`. Requires `extended_collection` to be set to `true`.", "example": false, "type": "boolean" }, "extended_collection": { - "description": "Whether Datadog collects additional attributes and configuration information about the resources in your AWS account. Required for `cspm_resource_collection`.", - "example": false, + "description": "Whether Datadog collects additional attributes and configuration information about the resources in your AWS account. Defaults to `true`. Required for `cloud_security_posture_management_collection`.", + "example": true, "type": "boolean" } }, "type": "object" }, "traces_config": { - "description": "AWS Traces config", + "description": "AWS Traces Collection config.", "properties": { "xray_services": { - "description": "AWS X-Ray services to collect traces from", + "description": "AWS X-Ray services to collect traces from. Defaults to `include_only`.", "oneOf": [ { - "description": "Include all services", + "description": "Include all services.", "properties": { "include_all": { - "description": "Include all services", + "description": "Include all services.", "example": false, "type": "boolean" } @@ -5356,11 +5361,11 @@ ] }, { - "description": "Include only these services", + "description": "Include only these services. Defaults to `[]`.", "nullable": true, "properties": { "include_only": { - "description": "Include only these services", + "description": "Include only these services.", "example": [ "AWS/AppSync" ], @@ -5387,7 +5392,7 @@ "type": "object" }, "id": { - "description": "Unique Datadog ID of the AWS Account Integration Config", + "description": "Unique Datadog ID of the AWS Account Integration Config.\nTo get the config ID for an account, use the [List all AWS integrations](https://docs.datadoghq.com/api/latest/aws-integration/#list-all-aws-integrations)\nendpoint and query by AWS Account ID.", "example": "00000000-abcd-0001-0000-000000000000", "type": "string" }, @@ -5411,10 +5416,10 @@ "type": "object" }, "AWSAccountTags": { - "description": "Tags to apply to all metrics in the account", + "description": "Tags to apply to all hosts and metrics reporting for this account. Defaults to `[]`.", "items": { - "description": "Tag to apply to all metrics in the account", - "example": "key:value", + "description": "Tag in the form `key:value`.", + "example": "env:prod", "type": "string" }, "nullable": true, @@ -5433,37 +5438,37 @@ ] }, "AWSAccountUpdateRequest": { - "description": "AWS Account Update Request body", + "description": "AWS Account Update Request body.", "properties": { "data": { - "description": "AWS Account Update Request data", + "description": "AWS Account Update Request data.", "properties": { "attributes": { - "description": "The AWS Account Integration Config to be updated", + "description": "The AWS Account Integration Config to be updated.", "properties": { "account_tags": { - "description": "Tags to apply to all metrics in the account", + "description": "Tags to apply to all hosts and metrics reporting for this account. Defaults to `[]`.", "items": { - "description": "Tag to apply to all metrics in the account", - "example": "key:value", + "description": "Tag in the form `key:value`.", + "example": "env:prod", "type": "string" }, "nullable": true, "type": "array" }, "auth_config": { - "description": "AWS Authentication config", + "description": "AWS Authentication config.", "oneOf": [ { - "description": "AWS Authentication config for key-based account", + "description": "AWS Authentication config to integrate your account using an access key pair.", "properties": { "access_key_id": { - "description": "AWS Access Key ID", + "description": "AWS Access Key ID.", "example": "AKIAIOSFODNN7EXAMPLE", "type": "string" }, "secret_access_key": { - "description": "AWS Secret Access Key", + "description": "AWS Secret Access Key.", "example": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY", "minLength": 1, "type": "string", @@ -5476,14 +5481,14 @@ "type": "object" }, { - "description": "AWS Authentication config for role-based account", + "description": "AWS Authentication config to integrate your account using an IAM role.", "properties": { "external_id": { - "description": "AWS IAM External ID for associated role", + "description": "AWS IAM External ID for associated role.", "type": "string" }, "role_name": { - "description": "AWS IAM Role name", + "description": "AWS IAM Role name.", "example": "DatadogIntegrationRole", "maxLength": 576, "minLength": 1, @@ -5498,13 +5503,12 @@ ] }, "aws_account_id": { - "description": "AWS Account ID", + "description": "AWS Account ID.", "example": "123456789012", "type": "string" }, "aws_partition": { - "default": "aws", - "description": "AWS Account partition", + "description": "AWS partition your AWS account is scoped to. Defaults to `aws`.\nSee [Partitions](https://docs.aws.amazon.com/whitepapers/latest/aws-fault-isolation-boundaries/partitions.html) in the AWS documentation for more information.", "enum": [ "aws", "aws-cn", @@ -5519,14 +5523,14 @@ ] }, "aws_regions": { - "description": "AWS Regions to collect data from", + "description": "AWS Regions to collect data from. Defaults to `include_all`.", "oneOf": [ { - "description": "Include all regions", + "description": "Include all regions. Defaults to `true`.", "properties": { "include_all": { - "description": "Include all regions", - "example": false, + "description": "Include all regions.", + "example": true, "type": "boolean" } }, @@ -5535,10 +5539,10 @@ ] }, { - "description": "Include only these regions", + "description": "Include only these regions.", "properties": { "include_only": { - "description": "Include only these regions", + "description": "Include only these regions.", "example": [ "us-east-1" ], @@ -5556,13 +5560,13 @@ ] }, "logs_config": { - "description": "AWS Logs config", + "description": "AWS Logs Collection config.", "properties": { "lambda_forwarder": { - "description": "AWS Lambda forwarder", + "description": "Log Autosubscription configuration for Datadog Forwarder Lambda functions. Automatically set up triggers for existing\nand new logs for some services, ensuring no logs from new resources are missed and saving time spent on manual configuration.", "properties": { "lambdas": { - "description": "List of Datadog Lambda Log Forwarder ARNs", + "description": "List of Datadog Lambda Log Forwarder ARNs in your AWS account. Defaults to `[]`.", "items": { "example": "arn:aws:lambda:us-east-1:123456789012:function:DatadogLambdaLogForwarder", "type": "string" @@ -5570,7 +5574,7 @@ "type": "array" }, "sources": { - "description": "List of AWS services that will send logs to the Datadog Lambda Log Forwarder", + "description": "List of service IDs set to enable automatic log collection. Discover the list of available services with the\n[Get list of AWS log ready services](https://docs.datadoghq.com/api/latest/aws-logs-integration/#get-list-of-aws-log-ready-services) endpoint.", "items": { "example": "s3", "type": "string" @@ -5584,41 +5588,42 @@ "type": "object" }, "metrics_config": { - "description": "AWS Metrics config", + "description": "AWS Metrics Collection config.", "properties": { "automute_enabled": { - "description": "Enable EC2 automute for AWS metrics", + "description": "Enable EC2 automute for AWS metrics. Defaults to `true`.", "example": true, "type": "boolean" }, "collect_cloudwatch_alarms": { - "description": "Enable CloudWatch alarms collection", - "example": true, + "description": "Enable CloudWatch alarms collection. Defaults to `false`.", + "example": false, "type": "boolean" }, "collect_custom_metrics": { - "description": "Enable custom metrics collection", - "example": true, + "description": "Enable custom metrics collection. Defaults to `false`.", + "example": false, "type": "boolean" }, "enabled": { - "description": "Enable AWS metrics collection", + "description": "Enable AWS metrics collection. Defaults to `true`.", "example": true, "type": "boolean" }, "namespace_filters": { - "description": "AWS Metrics namespace filters", + "description": "AWS Metrics namespace filters. Defaults to `exclude_only`.", "oneOf": [ { - "description": "Exclude only these namespaces", + "description": "Exclude only these namespaces from metrics collection. Defaults to `[\"AWS/SQS\", \"AWS/ElasticMapReduce\"]`.\n`AWS/SQS` and `AWS/ElasticMapReduce` are excluded by default to reduce your AWS CloudWatch costs from `GetMetricData` API calls.", "properties": { "exclude_only": { - "description": "Exclude only these namespaces", + "description": "Exclude only these namespaces from metrics collection. Defaults to `[\"AWS/SQS\", \"AWS/ElasticMapReduce\"]`.\n`AWS/SQS` and `AWS/ElasticMapReduce` are excluded by default to reduce your AWS CloudWatch costs from `GetMetricData` API calls.", "example": [ - "AWS/EC2" + "AWS/SQS", + "AWS/ElasticMapReduce" ], "items": { - "example": "AWS/EC2", + "example": "AWS/SQS", "type": "string" }, "type": "array" @@ -5629,10 +5634,10 @@ ] }, { - "description": "Include only these namespaces", + "description": "Include only these namespaces.", "properties": { "include_only": { - "description": "Include only these namespaces", + "description": "Include only these namespaces.", "example": [ "AWS/EC2" ], @@ -5650,19 +5655,20 @@ ] }, "tag_filters": { - "description": "AWS Metrics tag filters list", + "description": "AWS Metrics collection tag filters list. Defaults to `[]`.", "items": { - "description": "AWS Metrics tag filters", + "description": "AWS Metrics Collection tag filters list. Defaults to `[]`.\nThe array of custom AWS resource tags (in the form `key:value`) defines a filter that Datadog uses when collecting metrics from a specified service.\nWildcards, such as `?` (match a single character) and `*` (match multiple characters), and exclusion using `!` before the tag are supported.\nFor EC2, only hosts that match one of the defined tags will be imported into Datadog. The rest will be ignored.\nFor example, `env:production,instance-type:c?.*,!region:us-east-1`.", "properties": { "namespace": { - "description": "The AWS Namespace to apply the tag filters against", + "description": "The AWS service for which the tag filters defined in `tags` will be applied.", "example": "AWS/EC2", "type": "string" }, "tags": { - "description": "The tags to filter based on", + "description": "The AWS resource tags to filter on for the service specified by `namespace`.", "items": { - "example": "key:value", + "description": "Tag in the form `key:value`.", + "example": "datadog:true", "type": "string" }, "nullable": true, @@ -5677,32 +5683,32 @@ "type": "object" }, "resources_config": { - "description": "AWS Resources config", + "description": "AWS Resources Collection config.", "properties": { "cloud_security_posture_management_collection": { - "description": "Whether Datadog collects cloud security posture management resources from your AWS account.", + "description": "Enable Cloud Security Management to scan AWS resources for vulnerabilities, misconfigurations, identity risks, and compliance violations. Defaults to `false`. Requires `extended_collection` to be set to `true`.", "example": false, "type": "boolean" }, "extended_collection": { - "description": "Whether Datadog collects additional attributes and configuration information about the resources in your AWS account. Required for `cspm_resource_collection`.", - "example": false, + "description": "Whether Datadog collects additional attributes and configuration information about the resources in your AWS account. Defaults to `true`. Required for `cloud_security_posture_management_collection`.", + "example": true, "type": "boolean" } }, "type": "object" }, "traces_config": { - "description": "AWS Traces config", + "description": "AWS Traces Collection config.", "properties": { "xray_services": { - "description": "AWS X-Ray services to collect traces from", + "description": "AWS X-Ray services to collect traces from. Defaults to `include_only`.", "oneOf": [ { - "description": "Include all services", + "description": "Include all services.", "properties": { "include_all": { - "description": "Include all services", + "description": "Include all services.", "example": false, "type": "boolean" } @@ -5712,11 +5718,11 @@ ] }, { - "description": "Include only these services", + "description": "Include only these services. Defaults to `[]`.", "nullable": true, "properties": { "include_only": { - "description": "Include only these services", + "description": "Include only these services.", "example": [ "AWS/AppSync" ], @@ -5743,7 +5749,7 @@ "type": "object" }, "id": { - "description": "Unique Datadog ID of the AWS Account Integration Config", + "description": "Unique Datadog ID of the AWS Account Integration Config.\nTo get the config ID for an account, use the [List all AWS integrations](https://docs.datadoghq.com/api/latest/aws-integration/#list-all-aws-integrations)\nendpoint and query by AWS Account ID.", "example": "00000000-abcd-0001-0000-000000000000", "type": "string" }, @@ -5773,31 +5779,31 @@ "type": "object" }, "AWSAccountUpdateRequestAttributes": { - "description": "The AWS Account Integration Config to be updated", + "description": "The AWS Account Integration Config to be updated.", "properties": { "account_tags": { - "description": "Tags to apply to all metrics in the account", + "description": "Tags to apply to all hosts and metrics reporting for this account. Defaults to `[]`.", "items": { - "description": "Tag to apply to all metrics in the account", - "example": "key:value", + "description": "Tag in the form `key:value`.", + "example": "env:prod", "type": "string" }, "nullable": true, "type": "array" }, "auth_config": { - "description": "AWS Authentication config", + "description": "AWS Authentication config.", "oneOf": [ { - "description": "AWS Authentication config for key-based account", + "description": "AWS Authentication config to integrate your account using an access key pair.", "properties": { "access_key_id": { - "description": "AWS Access Key ID", + "description": "AWS Access Key ID.", "example": "AKIAIOSFODNN7EXAMPLE", "type": "string" }, "secret_access_key": { - "description": "AWS Secret Access Key", + "description": "AWS Secret Access Key.", "example": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY", "minLength": 1, "type": "string", @@ -5810,14 +5816,14 @@ "type": "object" }, { - "description": "AWS Authentication config for role-based account", + "description": "AWS Authentication config to integrate your account using an IAM role.", "properties": { "external_id": { - "description": "AWS IAM External ID for associated role", + "description": "AWS IAM External ID for associated role.", "type": "string" }, "role_name": { - "description": "AWS IAM Role name", + "description": "AWS IAM Role name.", "example": "DatadogIntegrationRole", "maxLength": 576, "minLength": 1, @@ -5832,13 +5838,12 @@ ] }, "aws_account_id": { - "description": "AWS Account ID", + "description": "AWS Account ID.", "example": "123456789012", "type": "string" }, "aws_partition": { - "default": "aws", - "description": "AWS Account partition", + "description": "AWS partition your AWS account is scoped to. Defaults to `aws`.\nSee [Partitions](https://docs.aws.amazon.com/whitepapers/latest/aws-fault-isolation-boundaries/partitions.html) in the AWS documentation for more information.", "enum": [ "aws", "aws-cn", @@ -5853,14 +5858,14 @@ ] }, "aws_regions": { - "description": "AWS Regions to collect data from", + "description": "AWS Regions to collect data from. Defaults to `include_all`.", "oneOf": [ { - "description": "Include all regions", + "description": "Include all regions. Defaults to `true`.", "properties": { "include_all": { - "description": "Include all regions", - "example": false, + "description": "Include all regions.", + "example": true, "type": "boolean" } }, @@ -5869,10 +5874,10 @@ ] }, { - "description": "Include only these regions", + "description": "Include only these regions.", "properties": { "include_only": { - "description": "Include only these regions", + "description": "Include only these regions.", "example": [ "us-east-1" ], @@ -5890,13 +5895,13 @@ ] }, "logs_config": { - "description": "AWS Logs config", + "description": "AWS Logs Collection config.", "properties": { "lambda_forwarder": { - "description": "AWS Lambda forwarder", + "description": "Log Autosubscription configuration for Datadog Forwarder Lambda functions. Automatically set up triggers for existing\nand new logs for some services, ensuring no logs from new resources are missed and saving time spent on manual configuration.", "properties": { "lambdas": { - "description": "List of Datadog Lambda Log Forwarder ARNs", + "description": "List of Datadog Lambda Log Forwarder ARNs in your AWS account. Defaults to `[]`.", "items": { "example": "arn:aws:lambda:us-east-1:123456789012:function:DatadogLambdaLogForwarder", "type": "string" @@ -5904,7 +5909,7 @@ "type": "array" }, "sources": { - "description": "List of AWS services that will send logs to the Datadog Lambda Log Forwarder", + "description": "List of service IDs set to enable automatic log collection. Discover the list of available services with the\n[Get list of AWS log ready services](https://docs.datadoghq.com/api/latest/aws-logs-integration/#get-list-of-aws-log-ready-services) endpoint.", "items": { "example": "s3", "type": "string" @@ -5918,41 +5923,42 @@ "type": "object" }, "metrics_config": { - "description": "AWS Metrics config", + "description": "AWS Metrics Collection config.", "properties": { "automute_enabled": { - "description": "Enable EC2 automute for AWS metrics", + "description": "Enable EC2 automute for AWS metrics. Defaults to `true`.", "example": true, "type": "boolean" }, "collect_cloudwatch_alarms": { - "description": "Enable CloudWatch alarms collection", - "example": true, + "description": "Enable CloudWatch alarms collection. Defaults to `false`.", + "example": false, "type": "boolean" }, "collect_custom_metrics": { - "description": "Enable custom metrics collection", - "example": true, + "description": "Enable custom metrics collection. Defaults to `false`.", + "example": false, "type": "boolean" }, "enabled": { - "description": "Enable AWS metrics collection", + "description": "Enable AWS metrics collection. Defaults to `true`.", "example": true, "type": "boolean" }, "namespace_filters": { - "description": "AWS Metrics namespace filters", + "description": "AWS Metrics namespace filters. Defaults to `exclude_only`.", "oneOf": [ { - "description": "Exclude only these namespaces", + "description": "Exclude only these namespaces from metrics collection. Defaults to `[\"AWS/SQS\", \"AWS/ElasticMapReduce\"]`.\n`AWS/SQS` and `AWS/ElasticMapReduce` are excluded by default to reduce your AWS CloudWatch costs from `GetMetricData` API calls.", "properties": { "exclude_only": { - "description": "Exclude only these namespaces", + "description": "Exclude only these namespaces from metrics collection. Defaults to `[\"AWS/SQS\", \"AWS/ElasticMapReduce\"]`.\n`AWS/SQS` and `AWS/ElasticMapReduce` are excluded by default to reduce your AWS CloudWatch costs from `GetMetricData` API calls.", "example": [ - "AWS/EC2" + "AWS/SQS", + "AWS/ElasticMapReduce" ], "items": { - "example": "AWS/EC2", + "example": "AWS/SQS", "type": "string" }, "type": "array" @@ -5963,10 +5969,10 @@ ] }, { - "description": "Include only these namespaces", + "description": "Include only these namespaces.", "properties": { "include_only": { - "description": "Include only these namespaces", + "description": "Include only these namespaces.", "example": [ "AWS/EC2" ], @@ -5984,19 +5990,20 @@ ] }, "tag_filters": { - "description": "AWS Metrics tag filters list", + "description": "AWS Metrics collection tag filters list. Defaults to `[]`.", "items": { - "description": "AWS Metrics tag filters", + "description": "AWS Metrics Collection tag filters list. Defaults to `[]`.\nThe array of custom AWS resource tags (in the form `key:value`) defines a filter that Datadog uses when collecting metrics from a specified service.\nWildcards, such as `?` (match a single character) and `*` (match multiple characters), and exclusion using `!` before the tag are supported.\nFor EC2, only hosts that match one of the defined tags will be imported into Datadog. The rest will be ignored.\nFor example, `env:production,instance-type:c?.*,!region:us-east-1`.", "properties": { "namespace": { - "description": "The AWS Namespace to apply the tag filters against", + "description": "The AWS service for which the tag filters defined in `tags` will be applied.", "example": "AWS/EC2", "type": "string" }, "tags": { - "description": "The tags to filter based on", + "description": "The AWS resource tags to filter on for the service specified by `namespace`.", "items": { - "example": "key:value", + "description": "Tag in the form `key:value`.", + "example": "datadog:true", "type": "string" }, "nullable": true, @@ -6011,32 +6018,32 @@ "type": "object" }, "resources_config": { - "description": "AWS Resources config", + "description": "AWS Resources Collection config.", "properties": { "cloud_security_posture_management_collection": { - "description": "Whether Datadog collects cloud security posture management resources from your AWS account.", + "description": "Enable Cloud Security Management to scan AWS resources for vulnerabilities, misconfigurations, identity risks, and compliance violations. Defaults to `false`. Requires `extended_collection` to be set to `true`.", "example": false, "type": "boolean" }, "extended_collection": { - "description": "Whether Datadog collects additional attributes and configuration information about the resources in your AWS account. Required for `cspm_resource_collection`.", - "example": false, + "description": "Whether Datadog collects additional attributes and configuration information about the resources in your AWS account. Defaults to `true`. Required for `cloud_security_posture_management_collection`.", + "example": true, "type": "boolean" } }, "type": "object" }, "traces_config": { - "description": "AWS Traces config", + "description": "AWS Traces Collection config.", "properties": { "xray_services": { - "description": "AWS X-Ray services to collect traces from", + "description": "AWS X-Ray services to collect traces from. Defaults to `include_only`.", "oneOf": [ { - "description": "Include all services", + "description": "Include all services.", "properties": { "include_all": { - "description": "Include all services", + "description": "Include all services.", "example": false, "type": "boolean" } @@ -6046,11 +6053,11 @@ ] }, { - "description": "Include only these services", + "description": "Include only these services. Defaults to `[]`.", "nullable": true, "properties": { "include_only": { - "description": "Include only these services", + "description": "Include only these services.", "example": [ "AWS/AppSync" ], @@ -6077,34 +6084,34 @@ "type": "object" }, "AWSAccountUpdateRequestData": { - "description": "AWS Account Update Request data", + "description": "AWS Account Update Request data.", "properties": { "attributes": { - "description": "The AWS Account Integration Config to be updated", + "description": "The AWS Account Integration Config to be updated.", "properties": { "account_tags": { - "description": "Tags to apply to all metrics in the account", + "description": "Tags to apply to all hosts and metrics reporting for this account. Defaults to `[]`.", "items": { - "description": "Tag to apply to all metrics in the account", - "example": "key:value", + "description": "Tag in the form `key:value`.", + "example": "env:prod", "type": "string" }, "nullable": true, "type": "array" }, "auth_config": { - "description": "AWS Authentication config", + "description": "AWS Authentication config.", "oneOf": [ { - "description": "AWS Authentication config for key-based account", + "description": "AWS Authentication config to integrate your account using an access key pair.", "properties": { "access_key_id": { - "description": "AWS Access Key ID", + "description": "AWS Access Key ID.", "example": "AKIAIOSFODNN7EXAMPLE", "type": "string" }, "secret_access_key": { - "description": "AWS Secret Access Key", + "description": "AWS Secret Access Key.", "example": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY", "minLength": 1, "type": "string", @@ -6117,14 +6124,14 @@ "type": "object" }, { - "description": "AWS Authentication config for role-based account", + "description": "AWS Authentication config to integrate your account using an IAM role.", "properties": { "external_id": { - "description": "AWS IAM External ID for associated role", + "description": "AWS IAM External ID for associated role.", "type": "string" }, "role_name": { - "description": "AWS IAM Role name", + "description": "AWS IAM Role name.", "example": "DatadogIntegrationRole", "maxLength": 576, "minLength": 1, @@ -6139,13 +6146,12 @@ ] }, "aws_account_id": { - "description": "AWS Account ID", + "description": "AWS Account ID.", "example": "123456789012", "type": "string" }, "aws_partition": { - "default": "aws", - "description": "AWS Account partition", + "description": "AWS partition your AWS account is scoped to. Defaults to `aws`.\nSee [Partitions](https://docs.aws.amazon.com/whitepapers/latest/aws-fault-isolation-boundaries/partitions.html) in the AWS documentation for more information.", "enum": [ "aws", "aws-cn", @@ -6160,14 +6166,14 @@ ] }, "aws_regions": { - "description": "AWS Regions to collect data from", + "description": "AWS Regions to collect data from. Defaults to `include_all`.", "oneOf": [ { - "description": "Include all regions", + "description": "Include all regions. Defaults to `true`.", "properties": { "include_all": { - "description": "Include all regions", - "example": false, + "description": "Include all regions.", + "example": true, "type": "boolean" } }, @@ -6176,10 +6182,10 @@ ] }, { - "description": "Include only these regions", + "description": "Include only these regions.", "properties": { "include_only": { - "description": "Include only these regions", + "description": "Include only these regions.", "example": [ "us-east-1" ], @@ -6197,13 +6203,13 @@ ] }, "logs_config": { - "description": "AWS Logs config", + "description": "AWS Logs Collection config.", "properties": { "lambda_forwarder": { - "description": "AWS Lambda forwarder", + "description": "Log Autosubscription configuration for Datadog Forwarder Lambda functions. Automatically set up triggers for existing\nand new logs for some services, ensuring no logs from new resources are missed and saving time spent on manual configuration.", "properties": { "lambdas": { - "description": "List of Datadog Lambda Log Forwarder ARNs", + "description": "List of Datadog Lambda Log Forwarder ARNs in your AWS account. Defaults to `[]`.", "items": { "example": "arn:aws:lambda:us-east-1:123456789012:function:DatadogLambdaLogForwarder", "type": "string" @@ -6211,7 +6217,7 @@ "type": "array" }, "sources": { - "description": "List of AWS services that will send logs to the Datadog Lambda Log Forwarder", + "description": "List of service IDs set to enable automatic log collection. Discover the list of available services with the\n[Get list of AWS log ready services](https://docs.datadoghq.com/api/latest/aws-logs-integration/#get-list-of-aws-log-ready-services) endpoint.", "items": { "example": "s3", "type": "string" @@ -6225,41 +6231,42 @@ "type": "object" }, "metrics_config": { - "description": "AWS Metrics config", + "description": "AWS Metrics Collection config.", "properties": { "automute_enabled": { - "description": "Enable EC2 automute for AWS metrics", + "description": "Enable EC2 automute for AWS metrics. Defaults to `true`.", "example": true, "type": "boolean" }, "collect_cloudwatch_alarms": { - "description": "Enable CloudWatch alarms collection", - "example": true, + "description": "Enable CloudWatch alarms collection. Defaults to `false`.", + "example": false, "type": "boolean" }, "collect_custom_metrics": { - "description": "Enable custom metrics collection", - "example": true, + "description": "Enable custom metrics collection. Defaults to `false`.", + "example": false, "type": "boolean" }, "enabled": { - "description": "Enable AWS metrics collection", + "description": "Enable AWS metrics collection. Defaults to `true`.", "example": true, "type": "boolean" }, "namespace_filters": { - "description": "AWS Metrics namespace filters", + "description": "AWS Metrics namespace filters. Defaults to `exclude_only`.", "oneOf": [ { - "description": "Exclude only these namespaces", + "description": "Exclude only these namespaces from metrics collection. Defaults to `[\"AWS/SQS\", \"AWS/ElasticMapReduce\"]`.\n`AWS/SQS` and `AWS/ElasticMapReduce` are excluded by default to reduce your AWS CloudWatch costs from `GetMetricData` API calls.", "properties": { "exclude_only": { - "description": "Exclude only these namespaces", + "description": "Exclude only these namespaces from metrics collection. Defaults to `[\"AWS/SQS\", \"AWS/ElasticMapReduce\"]`.\n`AWS/SQS` and `AWS/ElasticMapReduce` are excluded by default to reduce your AWS CloudWatch costs from `GetMetricData` API calls.", "example": [ - "AWS/EC2" + "AWS/SQS", + "AWS/ElasticMapReduce" ], "items": { - "example": "AWS/EC2", + "example": "AWS/SQS", "type": "string" }, "type": "array" @@ -6270,10 +6277,10 @@ ] }, { - "description": "Include only these namespaces", + "description": "Include only these namespaces.", "properties": { "include_only": { - "description": "Include only these namespaces", + "description": "Include only these namespaces.", "example": [ "AWS/EC2" ], @@ -6291,19 +6298,20 @@ ] }, "tag_filters": { - "description": "AWS Metrics tag filters list", + "description": "AWS Metrics collection tag filters list. Defaults to `[]`.", "items": { - "description": "AWS Metrics tag filters", + "description": "AWS Metrics Collection tag filters list. Defaults to `[]`.\nThe array of custom AWS resource tags (in the form `key:value`) defines a filter that Datadog uses when collecting metrics from a specified service.\nWildcards, such as `?` (match a single character) and `*` (match multiple characters), and exclusion using `!` before the tag are supported.\nFor EC2, only hosts that match one of the defined tags will be imported into Datadog. The rest will be ignored.\nFor example, `env:production,instance-type:c?.*,!region:us-east-1`.", "properties": { "namespace": { - "description": "The AWS Namespace to apply the tag filters against", + "description": "The AWS service for which the tag filters defined in `tags` will be applied.", "example": "AWS/EC2", "type": "string" }, "tags": { - "description": "The tags to filter based on", + "description": "The AWS resource tags to filter on for the service specified by `namespace`.", "items": { - "example": "key:value", + "description": "Tag in the form `key:value`.", + "example": "datadog:true", "type": "string" }, "nullable": true, @@ -6318,32 +6326,32 @@ "type": "object" }, "resources_config": { - "description": "AWS Resources config", + "description": "AWS Resources Collection config.", "properties": { "cloud_security_posture_management_collection": { - "description": "Whether Datadog collects cloud security posture management resources from your AWS account.", + "description": "Enable Cloud Security Management to scan AWS resources for vulnerabilities, misconfigurations, identity risks, and compliance violations. Defaults to `false`. Requires `extended_collection` to be set to `true`.", "example": false, "type": "boolean" }, "extended_collection": { - "description": "Whether Datadog collects additional attributes and configuration information about the resources in your AWS account. Required for `cspm_resource_collection`.", - "example": false, + "description": "Whether Datadog collects additional attributes and configuration information about the resources in your AWS account. Defaults to `true`. Required for `cloud_security_posture_management_collection`.", + "example": true, "type": "boolean" } }, "type": "object" }, "traces_config": { - "description": "AWS Traces config", + "description": "AWS Traces Collection config.", "properties": { "xray_services": { - "description": "AWS X-Ray services to collect traces from", + "description": "AWS X-Ray services to collect traces from. Defaults to `include_only`.", "oneOf": [ { - "description": "Include all services", + "description": "Include all services.", "properties": { "include_all": { - "description": "Include all services", + "description": "Include all services.", "example": false, "type": "boolean" } @@ -6353,11 +6361,11 @@ ] }, { - "description": "Include only these services", + "description": "Include only these services. Defaults to `[]`.", "nullable": true, "properties": { "include_only": { - "description": "Include only these services", + "description": "Include only these services.", "example": [ "AWS/AppSync" ], @@ -6384,7 +6392,7 @@ "type": "object" }, "id": { - "description": "Unique Datadog ID of the AWS Account Integration Config", + "description": "Unique Datadog ID of the AWS Account Integration Config.\nTo get the config ID for an account, use the [List all AWS integrations](https://docs.datadoghq.com/api/latest/aws-integration/#list-all-aws-integrations)\nendpoint and query by AWS Account ID.", "example": "00000000-abcd-0001-0000-000000000000", "type": "string" }, @@ -6408,39 +6416,39 @@ "type": "object" }, "AWSAccountsResponse": { - "description": "AWS Accounts response body", + "description": "AWS Accounts response body.", "properties": { "data": { - "description": "List of AWS Account Integration Configs", + "description": "List of AWS Account Integration Configs.", "items": { - "description": "AWS Account Response body", + "description": "AWS Account response data.", "properties": { "attributes": { - "description": "The AWS Account Integration Config", + "description": "AWS Account response attributes.", "properties": { "account_tags": { - "description": "Tags to apply to all metrics in the account", + "description": "Tags to apply to all hosts and metrics reporting for this account. Defaults to `[]`.", "items": { - "description": "Tag to apply to all metrics in the account", - "example": "key:value", + "description": "Tag in the form `key:value`.", + "example": "env:prod", "type": "string" }, "nullable": true, "type": "array" }, "auth_config": { - "description": "AWS Authentication config", + "description": "AWS Authentication config.", "oneOf": [ { - "description": "AWS Authentication config for key-based account", + "description": "AWS Authentication config to integrate your account using an access key pair.", "properties": { "access_key_id": { - "description": "AWS Access Key ID", + "description": "AWS Access Key ID.", "example": "AKIAIOSFODNN7EXAMPLE", "type": "string" }, "secret_access_key": { - "description": "AWS Secret Access Key", + "description": "AWS Secret Access Key.", "example": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY", "minLength": 1, "type": "string", @@ -6453,14 +6461,14 @@ "type": "object" }, { - "description": "AWS Authentication config for role-based account", + "description": "AWS Authentication config to integrate your account using an IAM role.", "properties": { "external_id": { - "description": "AWS IAM External ID for associated role", + "description": "AWS IAM External ID for associated role.", "type": "string" }, "role_name": { - "description": "AWS IAM Role name", + "description": "AWS IAM Role name.", "example": "DatadogIntegrationRole", "maxLength": 576, "minLength": 1, @@ -6475,13 +6483,12 @@ ] }, "aws_account_id": { - "description": "AWS Account ID", + "description": "AWS Account ID.", "example": "123456789012", "type": "string" }, "aws_partition": { - "default": "aws", - "description": "AWS Account partition", + "description": "AWS partition your AWS account is scoped to. Defaults to `aws`.\nSee [Partitions](https://docs.aws.amazon.com/whitepapers/latest/aws-fault-isolation-boundaries/partitions.html) in the AWS documentation for more information.", "enum": [ "aws", "aws-cn", @@ -6496,14 +6503,14 @@ ] }, "aws_regions": { - "description": "AWS Regions to collect data from", + "description": "AWS Regions to collect data from. Defaults to `include_all`.", "oneOf": [ { - "description": "Include all regions", + "description": "Include all regions. Defaults to `true`.", "properties": { "include_all": { - "description": "Include all regions", - "example": false, + "description": "Include all regions.", + "example": true, "type": "boolean" } }, @@ -6512,10 +6519,10 @@ ] }, { - "description": "Include only these regions", + "description": "Include only these regions.", "properties": { "include_only": { - "description": "Include only these regions", + "description": "Include only these regions.", "example": [ "us-east-1" ], @@ -6533,19 +6540,19 @@ ] }, "created_at": { - "description": "Timestamp of when the account integration was created", + "description": "Timestamp of when the account integration was created.", "format": "date-time", "readOnly": true, "type": "string" }, "logs_config": { - "description": "AWS Logs config", + "description": "AWS Logs Collection config.", "properties": { "lambda_forwarder": { - "description": "AWS Lambda forwarder", + "description": "Log Autosubscription configuration for Datadog Forwarder Lambda functions. Automatically set up triggers for existing\nand new logs for some services, ensuring no logs from new resources are missed and saving time spent on manual configuration.", "properties": { "lambdas": { - "description": "List of Datadog Lambda Log Forwarder ARNs", + "description": "List of Datadog Lambda Log Forwarder ARNs in your AWS account. Defaults to `[]`.", "items": { "example": "arn:aws:lambda:us-east-1:123456789012:function:DatadogLambdaLogForwarder", "type": "string" @@ -6553,7 +6560,7 @@ "type": "array" }, "sources": { - "description": "List of AWS services that will send logs to the Datadog Lambda Log Forwarder", + "description": "List of service IDs set to enable automatic log collection. Discover the list of available services with the\n[Get list of AWS log ready services](https://docs.datadoghq.com/api/latest/aws-logs-integration/#get-list-of-aws-log-ready-services) endpoint.", "items": { "example": "s3", "type": "string" @@ -6567,41 +6574,42 @@ "type": "object" }, "metrics_config": { - "description": "AWS Metrics config", + "description": "AWS Metrics Collection config.", "properties": { "automute_enabled": { - "description": "Enable EC2 automute for AWS metrics", + "description": "Enable EC2 automute for AWS metrics. Defaults to `true`.", "example": true, "type": "boolean" }, "collect_cloudwatch_alarms": { - "description": "Enable CloudWatch alarms collection", - "example": true, + "description": "Enable CloudWatch alarms collection. Defaults to `false`.", + "example": false, "type": "boolean" }, "collect_custom_metrics": { - "description": "Enable custom metrics collection", - "example": true, + "description": "Enable custom metrics collection. Defaults to `false`.", + "example": false, "type": "boolean" }, "enabled": { - "description": "Enable AWS metrics collection", + "description": "Enable AWS metrics collection. Defaults to `true`.", "example": true, "type": "boolean" }, "namespace_filters": { - "description": "AWS Metrics namespace filters", + "description": "AWS Metrics namespace filters. Defaults to `exclude_only`.", "oneOf": [ { - "description": "Exclude only these namespaces", + "description": "Exclude only these namespaces from metrics collection. Defaults to `[\"AWS/SQS\", \"AWS/ElasticMapReduce\"]`.\n`AWS/SQS` and `AWS/ElasticMapReduce` are excluded by default to reduce your AWS CloudWatch costs from `GetMetricData` API calls.", "properties": { "exclude_only": { - "description": "Exclude only these namespaces", + "description": "Exclude only these namespaces from metrics collection. Defaults to `[\"AWS/SQS\", \"AWS/ElasticMapReduce\"]`.\n`AWS/SQS` and `AWS/ElasticMapReduce` are excluded by default to reduce your AWS CloudWatch costs from `GetMetricData` API calls.", "example": [ - "AWS/EC2" + "AWS/SQS", + "AWS/ElasticMapReduce" ], "items": { - "example": "AWS/EC2", + "example": "AWS/SQS", "type": "string" }, "type": "array" @@ -6612,10 +6620,10 @@ ] }, { - "description": "Include only these namespaces", + "description": "Include only these namespaces.", "properties": { "include_only": { - "description": "Include only these namespaces", + "description": "Include only these namespaces.", "example": [ "AWS/EC2" ], @@ -6633,19 +6641,20 @@ ] }, "tag_filters": { - "description": "AWS Metrics tag filters list", + "description": "AWS Metrics collection tag filters list. Defaults to `[]`.", "items": { - "description": "AWS Metrics tag filters", + "description": "AWS Metrics Collection tag filters list. Defaults to `[]`.\nThe array of custom AWS resource tags (in the form `key:value`) defines a filter that Datadog uses when collecting metrics from a specified service.\nWildcards, such as `?` (match a single character) and `*` (match multiple characters), and exclusion using `!` before the tag are supported.\nFor EC2, only hosts that match one of the defined tags will be imported into Datadog. The rest will be ignored.\nFor example, `env:production,instance-type:c?.*,!region:us-east-1`.", "properties": { "namespace": { - "description": "The AWS Namespace to apply the tag filters against", + "description": "The AWS service for which the tag filters defined in `tags` will be applied.", "example": "AWS/EC2", "type": "string" }, "tags": { - "description": "The tags to filter based on", + "description": "The AWS resource tags to filter on for the service specified by `namespace`.", "items": { - "example": "key:value", + "description": "Tag in the form `key:value`.", + "example": "datadog:true", "type": "string" }, "nullable": true, @@ -6660,38 +6669,38 @@ "type": "object" }, "modified_at": { - "description": "Timestamp of when the account integration was updated", + "description": "Timestamp of when the account integration was updated.", "format": "date-time", "readOnly": true, "type": "string" }, "resources_config": { - "description": "AWS Resources config", + "description": "AWS Resources Collection config.", "properties": { "cloud_security_posture_management_collection": { - "description": "Whether Datadog collects cloud security posture management resources from your AWS account.", + "description": "Enable Cloud Security Management to scan AWS resources for vulnerabilities, misconfigurations, identity risks, and compliance violations. Defaults to `false`. Requires `extended_collection` to be set to `true`.", "example": false, "type": "boolean" }, "extended_collection": { - "description": "Whether Datadog collects additional attributes and configuration information about the resources in your AWS account. Required for `cspm_resource_collection`.", - "example": false, + "description": "Whether Datadog collects additional attributes and configuration information about the resources in your AWS account. Defaults to `true`. Required for `cloud_security_posture_management_collection`.", + "example": true, "type": "boolean" } }, "type": "object" }, "traces_config": { - "description": "AWS Traces config", + "description": "AWS Traces Collection config.", "properties": { "xray_services": { - "description": "AWS X-Ray services to collect traces from", + "description": "AWS X-Ray services to collect traces from. Defaults to `include_only`.", "oneOf": [ { - "description": "Include all services", + "description": "Include all services.", "properties": { "include_all": { - "description": "Include all services", + "description": "Include all services.", "example": false, "type": "boolean" } @@ -6701,11 +6710,11 @@ ] }, { - "description": "Include only these services", + "description": "Include only these services. Defaults to `[]`.", "nullable": true, "properties": { "include_only": { - "description": "Include only these services", + "description": "Include only these services.", "example": [ "AWS/AppSync" ], @@ -6732,7 +6741,7 @@ "type": "object" }, "id": { - "description": "Unique Datadog ID of the AWS Account Integration Config", + "description": "Unique Datadog ID of the AWS Account Integration Config.\nTo get the config ID for an account, use the [List all AWS integrations](https://docs.datadoghq.com/api/latest/aws-integration/#list-all-aws-integrations)\nendpoint and query by AWS Account ID.", "example": "00000000-abcd-0001-0000-000000000000", "type": "string" }, @@ -6764,18 +6773,18 @@ "type": "object" }, "AWSAuthConfig": { - "description": "AWS Authentication config", + "description": "AWS Authentication config.", "oneOf": [ { - "description": "AWS Authentication config for key-based account", + "description": "AWS Authentication config to integrate your account using an access key pair.", "properties": { "access_key_id": { - "description": "AWS Access Key ID", + "description": "AWS Access Key ID.", "example": "AKIAIOSFODNN7EXAMPLE", "type": "string" }, "secret_access_key": { - "description": "AWS Secret Access Key", + "description": "AWS Secret Access Key.", "example": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY", "minLength": 1, "type": "string", @@ -6788,14 +6797,14 @@ "type": "object" }, { - "description": "AWS Authentication config for role-based account", + "description": "AWS Authentication config to integrate your account using an IAM role.", "properties": { "external_id": { - "description": "AWS IAM External ID for associated role", + "description": "AWS IAM External ID for associated role.", "type": "string" }, "role_name": { - "description": "AWS IAM Role name", + "description": "AWS IAM Role name.", "example": "DatadogIntegrationRole", "maxLength": 576, "minLength": 1, @@ -6810,15 +6819,15 @@ ] }, "AWSAuthConfigKeys": { - "description": "AWS Authentication config for key-based account", + "description": "AWS Authentication config to integrate your account using an access key pair.", "properties": { "access_key_id": { - "description": "AWS Access Key ID", + "description": "AWS Access Key ID.", "example": "AKIAIOSFODNN7EXAMPLE", "type": "string" }, "secret_access_key": { - "description": "AWS Secret Access Key", + "description": "AWS Secret Access Key.", "example": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY", "minLength": 1, "type": "string", @@ -6831,14 +6840,14 @@ "type": "object" }, "AWSAuthConfigRole": { - "description": "AWS Authentication config for role-based account", + "description": "AWS Authentication config to integrate your account using an IAM role.", "properties": { "external_id": { - "description": "AWS IAM External ID for associated role", + "description": "AWS IAM External ID for associated role.", "type": "string" }, "role_name": { - "description": "AWS IAM Role name", + "description": "AWS IAM Role name.", "example": "DatadogIntegrationRole", "maxLength": 576, "minLength": 1, @@ -6851,10 +6860,10 @@ "type": "object" }, "AWSLambdaForwarderConfig": { - "description": "AWS Lambda forwarder", + "description": "Log Autosubscription configuration for Datadog Forwarder Lambda functions. Automatically set up triggers for existing\nand new logs for some services, ensuring no logs from new resources are missed and saving time spent on manual configuration.", "properties": { "lambdas": { - "description": "List of Datadog Lambda Log Forwarder ARNs", + "description": "List of Datadog Lambda Log Forwarder ARNs in your AWS account. Defaults to `[]`.", "items": { "example": "arn:aws:lambda:us-east-1:123456789012:function:DatadogLambdaLogForwarder", "type": "string" @@ -6862,7 +6871,7 @@ "type": "array" }, "sources": { - "description": "List of AWS services that will send logs to the Datadog Lambda Log Forwarder", + "description": "List of service IDs set to enable automatic log collection. Discover the list of available services with the\n[Get list of AWS log ready services](https://docs.datadoghq.com/api/latest/aws-logs-integration/#get-list-of-aws-log-ready-services) endpoint.", "items": { "example": "s3", "type": "string" @@ -6873,13 +6882,13 @@ "type": "object" }, "AWSLogsConfig": { - "description": "AWS Logs config", + "description": "AWS Logs Collection config.", "properties": { "lambda_forwarder": { - "description": "AWS Lambda forwarder", + "description": "Log Autosubscription configuration for Datadog Forwarder Lambda functions. Automatically set up triggers for existing\nand new logs for some services, ensuring no logs from new resources are missed and saving time spent on manual configuration.", "properties": { "lambdas": { - "description": "List of Datadog Lambda Log Forwarder ARNs", + "description": "List of Datadog Lambda Log Forwarder ARNs in your AWS account. Defaults to `[]`.", "items": { "example": "arn:aws:lambda:us-east-1:123456789012:function:DatadogLambdaLogForwarder", "type": "string" @@ -6887,7 +6896,7 @@ "type": "array" }, "sources": { - "description": "List of AWS services that will send logs to the Datadog Lambda Log Forwarder", + "description": "List of service IDs set to enable automatic log collection. Discover the list of available services with the\n[Get list of AWS log ready services](https://docs.datadoghq.com/api/latest/aws-logs-integration/#get-list-of-aws-log-ready-services) endpoint.", "items": { "example": "s3", "type": "string" @@ -7038,41 +7047,42 @@ ] }, "AWSMetricsConfig": { - "description": "AWS Metrics config", + "description": "AWS Metrics Collection config.", "properties": { "automute_enabled": { - "description": "Enable EC2 automute for AWS metrics", + "description": "Enable EC2 automute for AWS metrics. Defaults to `true`.", "example": true, "type": "boolean" }, "collect_cloudwatch_alarms": { - "description": "Enable CloudWatch alarms collection", - "example": true, + "description": "Enable CloudWatch alarms collection. Defaults to `false`.", + "example": false, "type": "boolean" }, "collect_custom_metrics": { - "description": "Enable custom metrics collection", - "example": true, + "description": "Enable custom metrics collection. Defaults to `false`.", + "example": false, "type": "boolean" }, "enabled": { - "description": "Enable AWS metrics collection", + "description": "Enable AWS metrics collection. Defaults to `true`.", "example": true, "type": "boolean" }, "namespace_filters": { - "description": "AWS Metrics namespace filters", + "description": "AWS Metrics namespace filters. Defaults to `exclude_only`.", "oneOf": [ { - "description": "Exclude only these namespaces", + "description": "Exclude only these namespaces from metrics collection. Defaults to `[\"AWS/SQS\", \"AWS/ElasticMapReduce\"]`.\n`AWS/SQS` and `AWS/ElasticMapReduce` are excluded by default to reduce your AWS CloudWatch costs from `GetMetricData` API calls.", "properties": { "exclude_only": { - "description": "Exclude only these namespaces", + "description": "Exclude only these namespaces from metrics collection. Defaults to `[\"AWS/SQS\", \"AWS/ElasticMapReduce\"]`.\n`AWS/SQS` and `AWS/ElasticMapReduce` are excluded by default to reduce your AWS CloudWatch costs from `GetMetricData` API calls.", "example": [ - "AWS/EC2" + "AWS/SQS", + "AWS/ElasticMapReduce" ], "items": { - "example": "AWS/EC2", + "example": "AWS/SQS", "type": "string" }, "type": "array" @@ -7083,10 +7093,10 @@ ] }, { - "description": "Include only these namespaces", + "description": "Include only these namespaces.", "properties": { "include_only": { - "description": "Include only these namespaces", + "description": "Include only these namespaces.", "example": [ "AWS/EC2" ], @@ -7104,19 +7114,20 @@ ] }, "tag_filters": { - "description": "AWS Metrics tag filters list", + "description": "AWS Metrics collection tag filters list. Defaults to `[]`.", "items": { - "description": "AWS Metrics tag filters", + "description": "AWS Metrics Collection tag filters list. Defaults to `[]`.\nThe array of custom AWS resource tags (in the form `key:value`) defines a filter that Datadog uses when collecting metrics from a specified service.\nWildcards, such as `?` (match a single character) and `*` (match multiple characters), and exclusion using `!` before the tag are supported.\nFor EC2, only hosts that match one of the defined tags will be imported into Datadog. The rest will be ignored.\nFor example, `env:production,instance-type:c?.*,!region:us-east-1`.", "properties": { "namespace": { - "description": "The AWS Namespace to apply the tag filters against", + "description": "The AWS service for which the tag filters defined in `tags` will be applied.", "example": "AWS/EC2", "type": "string" }, "tags": { - "description": "The tags to filter based on", + "description": "The AWS resource tags to filter on for the service specified by `namespace`.", "items": { - "example": "key:value", + "description": "Tag in the form `key:value`.", + "example": "datadog:true", "type": "string" }, "nullable": true, @@ -7131,18 +7142,19 @@ "type": "object" }, "AWSNamespaceFilters": { - "description": "AWS Metrics namespace filters", + "description": "AWS Metrics namespace filters. Defaults to `exclude_only`.", "oneOf": [ { - "description": "Exclude only these namespaces", + "description": "Exclude only these namespaces from metrics collection. Defaults to `[\"AWS/SQS\", \"AWS/ElasticMapReduce\"]`.\n`AWS/SQS` and `AWS/ElasticMapReduce` are excluded by default to reduce your AWS CloudWatch costs from `GetMetricData` API calls.", "properties": { "exclude_only": { - "description": "Exclude only these namespaces", + "description": "Exclude only these namespaces from metrics collection. Defaults to `[\"AWS/SQS\", \"AWS/ElasticMapReduce\"]`.\n`AWS/SQS` and `AWS/ElasticMapReduce` are excluded by default to reduce your AWS CloudWatch costs from `GetMetricData` API calls.", "example": [ - "AWS/EC2" + "AWS/SQS", + "AWS/ElasticMapReduce" ], "items": { - "example": "AWS/EC2", + "example": "AWS/SQS", "type": "string" }, "type": "array" @@ -7153,10 +7165,10 @@ ] }, { - "description": "Include only these namespaces", + "description": "Include only these namespaces.", "properties": { "include_only": { - "description": "Include only these namespaces", + "description": "Include only these namespaces.", "example": [ "AWS/EC2" ], @@ -7174,15 +7186,16 @@ ] }, "AWSNamespaceFiltersExcludeOnly": { - "description": "Exclude only these namespaces", + "description": "Exclude only these namespaces from metrics collection. Defaults to `[\"AWS/SQS\", \"AWS/ElasticMapReduce\"]`.\n`AWS/SQS` and `AWS/ElasticMapReduce` are excluded by default to reduce your AWS CloudWatch costs from `GetMetricData` API calls.", "properties": { "exclude_only": { - "description": "Exclude only these namespaces", + "description": "Exclude only these namespaces from metrics collection. Defaults to `[\"AWS/SQS\", \"AWS/ElasticMapReduce\"]`.\n`AWS/SQS` and `AWS/ElasticMapReduce` are excluded by default to reduce your AWS CloudWatch costs from `GetMetricData` API calls.", "example": [ - "AWS/EC2" + "AWS/SQS", + "AWS/ElasticMapReduce" ], "items": { - "example": "AWS/EC2", + "example": "AWS/SQS", "type": "string" }, "type": "array" @@ -7193,10 +7206,10 @@ ] }, "AWSNamespaceFiltersIncludeOnly": { - "description": "Include only these namespaces", + "description": "Include only these namespaces.", "properties": { "include_only": { - "description": "Include only these namespaces", + "description": "Include only these namespaces.", "example": [ "AWS/EC2" ], @@ -7212,17 +7225,18 @@ ] }, "AWSNamespaceTagFilter": { - "description": "AWS Metrics tag filters", + "description": "AWS Metrics Collection tag filters list. Defaults to `[]`.\nThe array of custom AWS resource tags (in the form `key:value`) defines a filter that Datadog uses when collecting metrics from a specified service.\nWildcards, such as `?` (match a single character) and `*` (match multiple characters), and exclusion using `!` before the tag are supported.\nFor EC2, only hosts that match one of the defined tags will be imported into Datadog. The rest will be ignored.\nFor example, `env:production,instance-type:c?.*,!region:us-east-1`.", "properties": { "namespace": { - "description": "The AWS Namespace to apply the tag filters against", + "description": "The AWS service for which the tag filters defined in `tags` will be applied.", "example": "AWS/EC2", "type": "string" }, "tags": { - "description": "The tags to filter based on", + "description": "The AWS resource tags to filter on for the service specified by `namespace`.", "items": { - "example": "key:value", + "description": "Tag in the form `key:value`.", + "example": "datadog:true", "type": "string" }, "nullable": true, @@ -7232,16 +7246,16 @@ "type": "object" }, "AWSNamespacesResponse": { - "description": "AWS Namespaces response body", + "description": "AWS Namespaces response body.", "properties": { "data": { - "description": "AWS Namespaces response body", + "description": "AWS Namespaces response data.", "properties": { "attributes": { - "description": "AWS Namespaces response body", + "description": "AWS Namespaces response attributes.", "properties": { "namespaces": { - "description": "AWS CloudWatch namespace", + "description": "AWS CloudWatch namespace.", "example": [ "AWS/ApiGateway" ], @@ -7289,10 +7303,10 @@ "type": "object" }, "AWSNamespacesResponseAttributes": { - "description": "AWS Namespaces response body", + "description": "AWS Namespaces response attributes.", "properties": { "namespaces": { - "description": "AWS CloudWatch namespace", + "description": "AWS CloudWatch namespace.", "example": [ "AWS/ApiGateway" ], @@ -7309,13 +7323,13 @@ "type": "object" }, "AWSNamespacesResponseData": { - "description": "AWS Namespaces response body", + "description": "AWS Namespaces response data.", "properties": { "attributes": { - "description": "AWS Namespaces response body", + "description": "AWS Namespaces response attributes.", "properties": { "namespaces": { - "description": "AWS CloudWatch namespace", + "description": "AWS CloudWatch namespace.", "example": [ "AWS/ApiGateway" ], @@ -7369,16 +7383,16 @@ ] }, "AWSNewExternalIDResponse": { - "description": "AWS External ID response body", + "description": "AWS External ID response body.", "properties": { "data": { - "description": "AWS External ID response body", + "description": "AWS External ID response body.", "properties": { "attributes": { - "description": "AWS External ID response body", + "description": "AWS External ID response body.", "properties": { "external_id": { - "description": "AWS IAM External ID for associated role", + "description": "AWS IAM External ID for associated role.", "example": "acb8f6b8a844443dbb726d07dcb1a870", "type": "string" } @@ -7420,10 +7434,10 @@ "type": "object" }, "AWSNewExternalIDResponseAttributes": { - "description": "AWS External ID response body", + "description": "AWS External ID response body.", "properties": { "external_id": { - "description": "AWS IAM External ID for associated role", + "description": "AWS IAM External ID for associated role.", "example": "acb8f6b8a844443dbb726d07dcb1a870", "type": "string" } @@ -7434,13 +7448,13 @@ "type": "object" }, "AWSNewExternalIDResponseData": { - "description": "AWS External ID response body", + "description": "AWS External ID response body.", "properties": { "attributes": { - "description": "AWS External ID response body", + "description": "AWS External ID response body.", "properties": { "external_id": { - "description": "AWS IAM External ID for associated role", + "description": "AWS IAM External ID for associated role.", "example": "acb8f6b8a844443dbb726d07dcb1a870", "type": "string" } @@ -7488,14 +7502,14 @@ ] }, "AWSRegions": { - "description": "AWS Regions to collect data from", + "description": "AWS Regions to collect data from. Defaults to `include_all`.", "oneOf": [ { - "description": "Include all regions", + "description": "Include all regions. Defaults to `true`.", "properties": { "include_all": { - "description": "Include all regions", - "example": false, + "description": "Include all regions.", + "example": true, "type": "boolean" } }, @@ -7504,10 +7518,10 @@ ] }, { - "description": "Include only these regions", + "description": "Include only these regions.", "properties": { "include_only": { - "description": "Include only these regions", + "description": "Include only these regions.", "example": [ "us-east-1" ], @@ -7525,11 +7539,11 @@ ] }, "AWSRegionsIncludeAll": { - "description": "Include all regions", + "description": "Include all regions. Defaults to `true`.", "properties": { "include_all": { - "description": "Include all regions", - "example": false, + "description": "Include all regions.", + "example": true, "type": "boolean" } }, @@ -7538,10 +7552,10 @@ ] }, "AWSRegionsIncludeOnly": { - "description": "Include only these regions", + "description": "Include only these regions.", "properties": { "include_only": { - "description": "Include only these regions", + "description": "Include only these regions.", "example": [ "us-east-1" ], @@ -7557,32 +7571,32 @@ ] }, "AWSResourcesConfig": { - "description": "AWS Resources config", + "description": "AWS Resources Collection config.", "properties": { "cloud_security_posture_management_collection": { - "description": "Whether Datadog collects cloud security posture management resources from your AWS account.", + "description": "Enable Cloud Security Management to scan AWS resources for vulnerabilities, misconfigurations, identity risks, and compliance violations. Defaults to `false`. Requires `extended_collection` to be set to `true`.", "example": false, "type": "boolean" }, "extended_collection": { - "description": "Whether Datadog collects additional attributes and configuration information about the resources in your AWS account. Required for `cspm_resource_collection`.", - "example": false, + "description": "Whether Datadog collects additional attributes and configuration information about the resources in your AWS account. Defaults to `true`. Required for `cloud_security_posture_management_collection`.", + "example": true, "type": "boolean" } }, "type": "object" }, "AWSTracesConfig": { - "description": "AWS Traces config", + "description": "AWS Traces Collection config.", "properties": { "xray_services": { - "description": "AWS X-Ray services to collect traces from", + "description": "AWS X-Ray services to collect traces from. Defaults to `include_only`.", "oneOf": [ { - "description": "Include all services", + "description": "Include all services.", "properties": { "include_all": { - "description": "Include all services", + "description": "Include all services.", "example": false, "type": "boolean" } @@ -7592,11 +7606,11 @@ ] }, { - "description": "Include only these services", + "description": "Include only these services. Defaults to `[]`.", "nullable": true, "properties": { "include_only": { - "description": "Include only these services", + "description": "Include only these services.", "example": [ "AWS/AppSync" ], @@ -184196,10 +184210,10 @@ "type": "object" }, "XRayServicesIncludeAll": { - "description": "Include all services", + "description": "Include all services.", "properties": { "include_all": { - "description": "Include all services", + "description": "Include all services.", "example": false, "type": "boolean" } @@ -184209,11 +184223,11 @@ ] }, "XRayServicesIncludeOnly": { - "description": "Include only these services", + "description": "Include only these services. Defaults to `[]`.", "nullable": true, "properties": { "include_only": { - "description": "Include only these services", + "description": "Include only these services.", "example": [ "AWS/AppSync" ], @@ -184229,13 +184243,13 @@ ] }, "XRayServicesList": { - "description": "AWS X-Ray services to collect traces from", + "description": "AWS X-Ray services to collect traces from. Defaults to `include_only`.", "oneOf": [ { - "description": "Include all services", + "description": "Include all services.", "properties": { "include_all": { - "description": "Include all services", + "description": "Include all services.", "example": false, "type": "boolean" } @@ -184245,11 +184259,11 @@ ] }, { - "description": "Include only these services", + "description": "Include only these services. Defaults to `[]`.", "nullable": true, "properties": { "include_only": { - "description": "Include only these services", + "description": "Include only these services.", "example": [ "AWS/AppSync" ], @@ -246401,7 +246415,7 @@ "operationId": "ListAWSAccounts", "parameters": [ { - "description": "Optional query filter accounts by AWS Account ID", + "description": "Optional query parameter to filter accounts by AWS Account ID. If not provided, all accounts are returned.", "example": "123456789012", "in": "query", "name": "aws_account_id", @@ -246416,39 +246430,39 @@ "content": { "application/json": { "schema": { - "description": "AWS Accounts response body", + "description": "AWS Accounts response body.", "properties": { "data": { - "description": "List of AWS Account Integration Configs", + "description": "List of AWS Account Integration Configs.", "items": { - "description": "AWS Account Response body", + "description": "AWS Account response data.", "properties": { "attributes": { - "description": "The AWS Account Integration Config", + "description": "AWS Account response attributes.", "properties": { "account_tags": { - "description": "Tags to apply to all metrics in the account", + "description": "Tags to apply to all hosts and metrics reporting for this account. Defaults to `[]`.", "items": { - "description": "Tag to apply to all metrics in the account", - "example": "key:value", + "description": "Tag in the form `key:value`.", + "example": "env:prod", "type": "string" }, "nullable": true, "type": "array" }, "auth_config": { - "description": "AWS Authentication config", + "description": "AWS Authentication config.", "oneOf": [ { - "description": "AWS Authentication config for key-based account", + "description": "AWS Authentication config to integrate your account using an access key pair.", "properties": { "access_key_id": { - "description": "AWS Access Key ID", + "description": "AWS Access Key ID.", "example": "AKIAIOSFODNN7EXAMPLE", "type": "string" }, "secret_access_key": { - "description": "AWS Secret Access Key", + "description": "AWS Secret Access Key.", "example": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY", "minLength": 1, "type": "string", @@ -246461,14 +246475,14 @@ "type": "object" }, { - "description": "AWS Authentication config for role-based account", + "description": "AWS Authentication config to integrate your account using an IAM role.", "properties": { "external_id": { - "description": "AWS IAM External ID for associated role", + "description": "AWS IAM External ID for associated role.", "type": "string" }, "role_name": { - "description": "AWS IAM Role name", + "description": "AWS IAM Role name.", "example": "DatadogIntegrationRole", "maxLength": 576, "minLength": 1, @@ -246483,13 +246497,12 @@ ] }, "aws_account_id": { - "description": "AWS Account ID", + "description": "AWS Account ID.", "example": "123456789012", "type": "string" }, "aws_partition": { - "default": "aws", - "description": "AWS Account partition", + "description": "AWS partition your AWS account is scoped to. Defaults to `aws`.\nSee [Partitions](https://docs.aws.amazon.com/whitepapers/latest/aws-fault-isolation-boundaries/partitions.html) in the AWS documentation for more information.", "enum": [ "aws", "aws-cn", @@ -246504,14 +246517,14 @@ ] }, "aws_regions": { - "description": "AWS Regions to collect data from", + "description": "AWS Regions to collect data from. Defaults to `include_all`.", "oneOf": [ { - "description": "Include all regions", + "description": "Include all regions. Defaults to `true`.", "properties": { "include_all": { - "description": "Include all regions", - "example": false, + "description": "Include all regions.", + "example": true, "type": "boolean" } }, @@ -246520,10 +246533,10 @@ ] }, { - "description": "Include only these regions", + "description": "Include only these regions.", "properties": { "include_only": { - "description": "Include only these regions", + "description": "Include only these regions.", "example": [ "us-east-1" ], @@ -246541,19 +246554,19 @@ ] }, "created_at": { - "description": "Timestamp of when the account integration was created", + "description": "Timestamp of when the account integration was created.", "format": "date-time", "readOnly": true, "type": "string" }, "logs_config": { - "description": "AWS Logs config", + "description": "AWS Logs Collection config.", "properties": { "lambda_forwarder": { - "description": "AWS Lambda forwarder", + "description": "Log Autosubscription configuration for Datadog Forwarder Lambda functions. Automatically set up triggers for existing\nand new logs for some services, ensuring no logs from new resources are missed and saving time spent on manual configuration.", "properties": { "lambdas": { - "description": "List of Datadog Lambda Log Forwarder ARNs", + "description": "List of Datadog Lambda Log Forwarder ARNs in your AWS account. Defaults to `[]`.", "items": { "example": "arn:aws:lambda:us-east-1:123456789012:function:DatadogLambdaLogForwarder", "type": "string" @@ -246561,7 +246574,7 @@ "type": "array" }, "sources": { - "description": "List of AWS services that will send logs to the Datadog Lambda Log Forwarder", + "description": "List of service IDs set to enable automatic log collection. Discover the list of available services with the\n[Get list of AWS log ready services](https://docs.datadoghq.com/api/latest/aws-logs-integration/#get-list-of-aws-log-ready-services) endpoint.", "items": { "example": "s3", "type": "string" @@ -246575,41 +246588,42 @@ "type": "object" }, "metrics_config": { - "description": "AWS Metrics config", + "description": "AWS Metrics Collection config.", "properties": { "automute_enabled": { - "description": "Enable EC2 automute for AWS metrics", + "description": "Enable EC2 automute for AWS metrics. Defaults to `true`.", "example": true, "type": "boolean" }, "collect_cloudwatch_alarms": { - "description": "Enable CloudWatch alarms collection", - "example": true, + "description": "Enable CloudWatch alarms collection. Defaults to `false`.", + "example": false, "type": "boolean" }, "collect_custom_metrics": { - "description": "Enable custom metrics collection", - "example": true, + "description": "Enable custom metrics collection. Defaults to `false`.", + "example": false, "type": "boolean" }, "enabled": { - "description": "Enable AWS metrics collection", + "description": "Enable AWS metrics collection. Defaults to `true`.", "example": true, "type": "boolean" }, "namespace_filters": { - "description": "AWS Metrics namespace filters", + "description": "AWS Metrics namespace filters. Defaults to `exclude_only`.", "oneOf": [ { - "description": "Exclude only these namespaces", + "description": "Exclude only these namespaces from metrics collection. Defaults to `[\"AWS/SQS\", \"AWS/ElasticMapReduce\"]`.\n`AWS/SQS` and `AWS/ElasticMapReduce` are excluded by default to reduce your AWS CloudWatch costs from `GetMetricData` API calls.", "properties": { "exclude_only": { - "description": "Exclude only these namespaces", + "description": "Exclude only these namespaces from metrics collection. Defaults to `[\"AWS/SQS\", \"AWS/ElasticMapReduce\"]`.\n`AWS/SQS` and `AWS/ElasticMapReduce` are excluded by default to reduce your AWS CloudWatch costs from `GetMetricData` API calls.", "example": [ - "AWS/EC2" + "AWS/SQS", + "AWS/ElasticMapReduce" ], "items": { - "example": "AWS/EC2", + "example": "AWS/SQS", "type": "string" }, "type": "array" @@ -246620,10 +246634,10 @@ ] }, { - "description": "Include only these namespaces", + "description": "Include only these namespaces.", "properties": { "include_only": { - "description": "Include only these namespaces", + "description": "Include only these namespaces.", "example": [ "AWS/EC2" ], @@ -246641,19 +246655,20 @@ ] }, "tag_filters": { - "description": "AWS Metrics tag filters list", + "description": "AWS Metrics collection tag filters list. Defaults to `[]`.", "items": { - "description": "AWS Metrics tag filters", + "description": "AWS Metrics Collection tag filters list. Defaults to `[]`.\nThe array of custom AWS resource tags (in the form `key:value`) defines a filter that Datadog uses when collecting metrics from a specified service.\nWildcards, such as `?` (match a single character) and `*` (match multiple characters), and exclusion using `!` before the tag are supported.\nFor EC2, only hosts that match one of the defined tags will be imported into Datadog. The rest will be ignored.\nFor example, `env:production,instance-type:c?.*,!region:us-east-1`.", "properties": { "namespace": { - "description": "The AWS Namespace to apply the tag filters against", + "description": "The AWS service for which the tag filters defined in `tags` will be applied.", "example": "AWS/EC2", "type": "string" }, "tags": { - "description": "The tags to filter based on", + "description": "The AWS resource tags to filter on for the service specified by `namespace`.", "items": { - "example": "key:value", + "description": "Tag in the form `key:value`.", + "example": "datadog:true", "type": "string" }, "nullable": true, @@ -246668,38 +246683,38 @@ "type": "object" }, "modified_at": { - "description": "Timestamp of when the account integration was updated", + "description": "Timestamp of when the account integration was updated.", "format": "date-time", "readOnly": true, "type": "string" }, "resources_config": { - "description": "AWS Resources config", + "description": "AWS Resources Collection config.", "properties": { "cloud_security_posture_management_collection": { - "description": "Whether Datadog collects cloud security posture management resources from your AWS account.", + "description": "Enable Cloud Security Management to scan AWS resources for vulnerabilities, misconfigurations, identity risks, and compliance violations. Defaults to `false`. Requires `extended_collection` to be set to `true`.", "example": false, "type": "boolean" }, "extended_collection": { - "description": "Whether Datadog collects additional attributes and configuration information about the resources in your AWS account. Required for `cspm_resource_collection`.", - "example": false, + "description": "Whether Datadog collects additional attributes and configuration information about the resources in your AWS account. Defaults to `true`. Required for `cloud_security_posture_management_collection`.", + "example": true, "type": "boolean" } }, "type": "object" }, "traces_config": { - "description": "AWS Traces config", + "description": "AWS Traces Collection config.", "properties": { "xray_services": { - "description": "AWS X-Ray services to collect traces from", + "description": "AWS X-Ray services to collect traces from. Defaults to `include_only`.", "oneOf": [ { - "description": "Include all services", + "description": "Include all services.", "properties": { "include_all": { - "description": "Include all services", + "description": "Include all services.", "example": false, "type": "boolean" } @@ -246709,11 +246724,11 @@ ] }, { - "description": "Include only these services", + "description": "Include only these services. Defaults to `[]`.", "nullable": true, "properties": { "include_only": { - "description": "Include only these services", + "description": "Include only these services.", "example": [ "AWS/AppSync" ], @@ -246740,7 +246755,7 @@ "type": "object" }, "id": { - "description": "Unique Datadog ID of the AWS Account Integration Config", + "description": "Unique Datadog ID of the AWS Account Integration Config.\nTo get the config ID for an account, use the [List all AWS integrations](https://docs.datadoghq.com/api/latest/aws-integration/#list-all-aws-integrations)\nendpoint and query by AWS Account ID.", "example": "00000000-abcd-0001-0000-000000000000", "type": "string" }, @@ -246846,7 +246861,7 @@ "x-undo": { "type": "safe" }, - "x-unstable": "**Note: This endpoint is in public beta. If you have any feedback,\ncontact [Datadog support](https://docs.datadoghq.com/help/).**" + "x-unstable": "**Note: This endpoint is in Preview. If you have any feedback,\ncontact [Datadog support](https://docs.datadoghq.com/help/).**" }, "post": { "description": "Create a new AWS Account Integration Config.", @@ -246855,37 +246870,37 @@ "content": { "application/json": { "schema": { - "description": "AWS Account Create Request body", + "description": "AWS Account Create Request body.", "properties": { "data": { - "description": "AWS Account Create Request data", + "description": "AWS Account Create Request data.", "properties": { "attributes": { - "description": "The AWS Account Integration Config to be created", + "description": "The AWS Account Integration Config to be created.", "properties": { "account_tags": { - "description": "Tags to apply to all metrics in the account", + "description": "Tags to apply to all hosts and metrics reporting for this account. Defaults to `[]`.", "items": { - "description": "Tag to apply to all metrics in the account", - "example": "key:value", + "description": "Tag in the form `key:value`.", + "example": "env:prod", "type": "string" }, "nullable": true, "type": "array" }, "auth_config": { - "description": "AWS Authentication config", + "description": "AWS Authentication config.", "oneOf": [ { - "description": "AWS Authentication config for key-based account", + "description": "AWS Authentication config to integrate your account using an access key pair.", "properties": { "access_key_id": { - "description": "AWS Access Key ID", + "description": "AWS Access Key ID.", "example": "AKIAIOSFODNN7EXAMPLE", "type": "string" }, "secret_access_key": { - "description": "AWS Secret Access Key", + "description": "AWS Secret Access Key.", "example": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY", "minLength": 1, "type": "string", @@ -246898,14 +246913,14 @@ "type": "object" }, { - "description": "AWS Authentication config for role-based account", + "description": "AWS Authentication config to integrate your account using an IAM role.", "properties": { "external_id": { - "description": "AWS IAM External ID for associated role", + "description": "AWS IAM External ID for associated role.", "type": "string" }, "role_name": { - "description": "AWS IAM Role name", + "description": "AWS IAM Role name.", "example": "DatadogIntegrationRole", "maxLength": 576, "minLength": 1, @@ -246920,13 +246935,12 @@ ] }, "aws_account_id": { - "description": "AWS Account ID", + "description": "AWS Account ID.", "example": "123456789012", "type": "string" }, "aws_partition": { - "default": "aws", - "description": "AWS Account partition", + "description": "AWS partition your AWS account is scoped to. Defaults to `aws`.\nSee [Partitions](https://docs.aws.amazon.com/whitepapers/latest/aws-fault-isolation-boundaries/partitions.html) in the AWS documentation for more information.", "enum": [ "aws", "aws-cn", @@ -246941,14 +246955,14 @@ ] }, "aws_regions": { - "description": "AWS Regions to collect data from", + "description": "AWS Regions to collect data from. Defaults to `include_all`.", "oneOf": [ { - "description": "Include all regions", + "description": "Include all regions. Defaults to `true`.", "properties": { "include_all": { - "description": "Include all regions", - "example": false, + "description": "Include all regions.", + "example": true, "type": "boolean" } }, @@ -246957,10 +246971,10 @@ ] }, { - "description": "Include only these regions", + "description": "Include only these regions.", "properties": { "include_only": { - "description": "Include only these regions", + "description": "Include only these regions.", "example": [ "us-east-1" ], @@ -246978,13 +246992,13 @@ ] }, "logs_config": { - "description": "AWS Logs config", + "description": "AWS Logs Collection config.", "properties": { "lambda_forwarder": { - "description": "AWS Lambda forwarder", + "description": "Log Autosubscription configuration for Datadog Forwarder Lambda functions. Automatically set up triggers for existing\nand new logs for some services, ensuring no logs from new resources are missed and saving time spent on manual configuration.", "properties": { "lambdas": { - "description": "List of Datadog Lambda Log Forwarder ARNs", + "description": "List of Datadog Lambda Log Forwarder ARNs in your AWS account. Defaults to `[]`.", "items": { "example": "arn:aws:lambda:us-east-1:123456789012:function:DatadogLambdaLogForwarder", "type": "string" @@ -246992,7 +247006,7 @@ "type": "array" }, "sources": { - "description": "List of AWS services that will send logs to the Datadog Lambda Log Forwarder", + "description": "List of service IDs set to enable automatic log collection. Discover the list of available services with the\n[Get list of AWS log ready services](https://docs.datadoghq.com/api/latest/aws-logs-integration/#get-list-of-aws-log-ready-services) endpoint.", "items": { "example": "s3", "type": "string" @@ -247006,41 +247020,42 @@ "type": "object" }, "metrics_config": { - "description": "AWS Metrics config", + "description": "AWS Metrics Collection config.", "properties": { "automute_enabled": { - "description": "Enable EC2 automute for AWS metrics", + "description": "Enable EC2 automute for AWS metrics. Defaults to `true`.", "example": true, "type": "boolean" }, "collect_cloudwatch_alarms": { - "description": "Enable CloudWatch alarms collection", - "example": true, + "description": "Enable CloudWatch alarms collection. Defaults to `false`.", + "example": false, "type": "boolean" }, "collect_custom_metrics": { - "description": "Enable custom metrics collection", - "example": true, + "description": "Enable custom metrics collection. Defaults to `false`.", + "example": false, "type": "boolean" }, "enabled": { - "description": "Enable AWS metrics collection", + "description": "Enable AWS metrics collection. Defaults to `true`.", "example": true, "type": "boolean" }, "namespace_filters": { - "description": "AWS Metrics namespace filters", + "description": "AWS Metrics namespace filters. Defaults to `exclude_only`.", "oneOf": [ { - "description": "Exclude only these namespaces", + "description": "Exclude only these namespaces from metrics collection. Defaults to `[\"AWS/SQS\", \"AWS/ElasticMapReduce\"]`.\n`AWS/SQS` and `AWS/ElasticMapReduce` are excluded by default to reduce your AWS CloudWatch costs from `GetMetricData` API calls.", "properties": { "exclude_only": { - "description": "Exclude only these namespaces", + "description": "Exclude only these namespaces from metrics collection. Defaults to `[\"AWS/SQS\", \"AWS/ElasticMapReduce\"]`.\n`AWS/SQS` and `AWS/ElasticMapReduce` are excluded by default to reduce your AWS CloudWatch costs from `GetMetricData` API calls.", "example": [ - "AWS/EC2" + "AWS/SQS", + "AWS/ElasticMapReduce" ], "items": { - "example": "AWS/EC2", + "example": "AWS/SQS", "type": "string" }, "type": "array" @@ -247051,10 +247066,10 @@ ] }, { - "description": "Include only these namespaces", + "description": "Include only these namespaces.", "properties": { "include_only": { - "description": "Include only these namespaces", + "description": "Include only these namespaces.", "example": [ "AWS/EC2" ], @@ -247072,19 +247087,20 @@ ] }, "tag_filters": { - "description": "AWS Metrics tag filters list", + "description": "AWS Metrics collection tag filters list. Defaults to `[]`.", "items": { - "description": "AWS Metrics tag filters", + "description": "AWS Metrics Collection tag filters list. Defaults to `[]`.\nThe array of custom AWS resource tags (in the form `key:value`) defines a filter that Datadog uses when collecting metrics from a specified service.\nWildcards, such as `?` (match a single character) and `*` (match multiple characters), and exclusion using `!` before the tag are supported.\nFor EC2, only hosts that match one of the defined tags will be imported into Datadog. The rest will be ignored.\nFor example, `env:production,instance-type:c?.*,!region:us-east-1`.", "properties": { "namespace": { - "description": "The AWS Namespace to apply the tag filters against", + "description": "The AWS service for which the tag filters defined in `tags` will be applied.", "example": "AWS/EC2", "type": "string" }, "tags": { - "description": "The tags to filter based on", + "description": "The AWS resource tags to filter on for the service specified by `namespace`.", "items": { - "example": "key:value", + "description": "Tag in the form `key:value`.", + "example": "datadog:true", "type": "string" }, "nullable": true, @@ -247099,32 +247115,32 @@ "type": "object" }, "resources_config": { - "description": "AWS Resources config", + "description": "AWS Resources Collection config.", "properties": { "cloud_security_posture_management_collection": { - "description": "Whether Datadog collects cloud security posture management resources from your AWS account.", + "description": "Enable Cloud Security Management to scan AWS resources for vulnerabilities, misconfigurations, identity risks, and compliance violations. Defaults to `false`. Requires `extended_collection` to be set to `true`.", "example": false, "type": "boolean" }, "extended_collection": { - "description": "Whether Datadog collects additional attributes and configuration information about the resources in your AWS account. Required for `cspm_resource_collection`.", - "example": false, + "description": "Whether Datadog collects additional attributes and configuration information about the resources in your AWS account. Defaults to `true`. Required for `cloud_security_posture_management_collection`.", + "example": true, "type": "boolean" } }, "type": "object" }, "traces_config": { - "description": "AWS Traces config", + "description": "AWS Traces Collection config.", "properties": { "xray_services": { - "description": "AWS X-Ray services to collect traces from", + "description": "AWS X-Ray services to collect traces from. Defaults to `include_only`.", "oneOf": [ { - "description": "Include all services", + "description": "Include all services.", "properties": { "include_all": { - "description": "Include all services", + "description": "Include all services.", "example": false, "type": "boolean" } @@ -247134,11 +247150,11 @@ ] }, { - "description": "Include only these services", + "description": "Include only these services. Defaults to `[]`.", "nullable": true, "properties": { "include_only": { - "description": "Include only these services", + "description": "Include only these services.", "example": [ "AWS/AppSync" ], @@ -247200,37 +247216,37 @@ "content": { "application/json": { "schema": { - "description": "AWS Account response body", + "description": "AWS Account response body.", "properties": { "data": { - "description": "AWS Account Response body", + "description": "AWS Account response data.", "properties": { "attributes": { - "description": "The AWS Account Integration Config", + "description": "AWS Account response attributes.", "properties": { "account_tags": { - "description": "Tags to apply to all metrics in the account", + "description": "Tags to apply to all hosts and metrics reporting for this account. Defaults to `[]`.", "items": { - "description": "Tag to apply to all metrics in the account", - "example": "key:value", + "description": "Tag in the form `key:value`.", + "example": "env:prod", "type": "string" }, "nullable": true, "type": "array" }, "auth_config": { - "description": "AWS Authentication config", + "description": "AWS Authentication config.", "oneOf": [ { - "description": "AWS Authentication config for key-based account", + "description": "AWS Authentication config to integrate your account using an access key pair.", "properties": { "access_key_id": { - "description": "AWS Access Key ID", + "description": "AWS Access Key ID.", "example": "AKIAIOSFODNN7EXAMPLE", "type": "string" }, "secret_access_key": { - "description": "AWS Secret Access Key", + "description": "AWS Secret Access Key.", "example": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY", "minLength": 1, "type": "string", @@ -247243,14 +247259,14 @@ "type": "object" }, { - "description": "AWS Authentication config for role-based account", + "description": "AWS Authentication config to integrate your account using an IAM role.", "properties": { "external_id": { - "description": "AWS IAM External ID for associated role", + "description": "AWS IAM External ID for associated role.", "type": "string" }, "role_name": { - "description": "AWS IAM Role name", + "description": "AWS IAM Role name.", "example": "DatadogIntegrationRole", "maxLength": 576, "minLength": 1, @@ -247265,13 +247281,12 @@ ] }, "aws_account_id": { - "description": "AWS Account ID", + "description": "AWS Account ID.", "example": "123456789012", "type": "string" }, "aws_partition": { - "default": "aws", - "description": "AWS Account partition", + "description": "AWS partition your AWS account is scoped to. Defaults to `aws`.\nSee [Partitions](https://docs.aws.amazon.com/whitepapers/latest/aws-fault-isolation-boundaries/partitions.html) in the AWS documentation for more information.", "enum": [ "aws", "aws-cn", @@ -247286,14 +247301,14 @@ ] }, "aws_regions": { - "description": "AWS Regions to collect data from", + "description": "AWS Regions to collect data from. Defaults to `include_all`.", "oneOf": [ { - "description": "Include all regions", + "description": "Include all regions. Defaults to `true`.", "properties": { "include_all": { - "description": "Include all regions", - "example": false, + "description": "Include all regions.", + "example": true, "type": "boolean" } }, @@ -247302,10 +247317,10 @@ ] }, { - "description": "Include only these regions", + "description": "Include only these regions.", "properties": { "include_only": { - "description": "Include only these regions", + "description": "Include only these regions.", "example": [ "us-east-1" ], @@ -247323,19 +247338,19 @@ ] }, "created_at": { - "description": "Timestamp of when the account integration was created", + "description": "Timestamp of when the account integration was created.", "format": "date-time", "readOnly": true, "type": "string" }, "logs_config": { - "description": "AWS Logs config", + "description": "AWS Logs Collection config.", "properties": { "lambda_forwarder": { - "description": "AWS Lambda forwarder", + "description": "Log Autosubscription configuration for Datadog Forwarder Lambda functions. Automatically set up triggers for existing\nand new logs for some services, ensuring no logs from new resources are missed and saving time spent on manual configuration.", "properties": { "lambdas": { - "description": "List of Datadog Lambda Log Forwarder ARNs", + "description": "List of Datadog Lambda Log Forwarder ARNs in your AWS account. Defaults to `[]`.", "items": { "example": "arn:aws:lambda:us-east-1:123456789012:function:DatadogLambdaLogForwarder", "type": "string" @@ -247343,7 +247358,7 @@ "type": "array" }, "sources": { - "description": "List of AWS services that will send logs to the Datadog Lambda Log Forwarder", + "description": "List of service IDs set to enable automatic log collection. Discover the list of available services with the\n[Get list of AWS log ready services](https://docs.datadoghq.com/api/latest/aws-logs-integration/#get-list-of-aws-log-ready-services) endpoint.", "items": { "example": "s3", "type": "string" @@ -247357,41 +247372,42 @@ "type": "object" }, "metrics_config": { - "description": "AWS Metrics config", + "description": "AWS Metrics Collection config.", "properties": { "automute_enabled": { - "description": "Enable EC2 automute for AWS metrics", + "description": "Enable EC2 automute for AWS metrics. Defaults to `true`.", "example": true, "type": "boolean" }, "collect_cloudwatch_alarms": { - "description": "Enable CloudWatch alarms collection", - "example": true, + "description": "Enable CloudWatch alarms collection. Defaults to `false`.", + "example": false, "type": "boolean" }, "collect_custom_metrics": { - "description": "Enable custom metrics collection", - "example": true, + "description": "Enable custom metrics collection. Defaults to `false`.", + "example": false, "type": "boolean" }, "enabled": { - "description": "Enable AWS metrics collection", + "description": "Enable AWS metrics collection. Defaults to `true`.", "example": true, "type": "boolean" }, "namespace_filters": { - "description": "AWS Metrics namespace filters", + "description": "AWS Metrics namespace filters. Defaults to `exclude_only`.", "oneOf": [ { - "description": "Exclude only these namespaces", + "description": "Exclude only these namespaces from metrics collection. Defaults to `[\"AWS/SQS\", \"AWS/ElasticMapReduce\"]`.\n`AWS/SQS` and `AWS/ElasticMapReduce` are excluded by default to reduce your AWS CloudWatch costs from `GetMetricData` API calls.", "properties": { "exclude_only": { - "description": "Exclude only these namespaces", + "description": "Exclude only these namespaces from metrics collection. Defaults to `[\"AWS/SQS\", \"AWS/ElasticMapReduce\"]`.\n`AWS/SQS` and `AWS/ElasticMapReduce` are excluded by default to reduce your AWS CloudWatch costs from `GetMetricData` API calls.", "example": [ - "AWS/EC2" + "AWS/SQS", + "AWS/ElasticMapReduce" ], "items": { - "example": "AWS/EC2", + "example": "AWS/SQS", "type": "string" }, "type": "array" @@ -247402,10 +247418,10 @@ ] }, { - "description": "Include only these namespaces", + "description": "Include only these namespaces.", "properties": { "include_only": { - "description": "Include only these namespaces", + "description": "Include only these namespaces.", "example": [ "AWS/EC2" ], @@ -247423,19 +247439,20 @@ ] }, "tag_filters": { - "description": "AWS Metrics tag filters list", + "description": "AWS Metrics collection tag filters list. Defaults to `[]`.", "items": { - "description": "AWS Metrics tag filters", + "description": "AWS Metrics Collection tag filters list. Defaults to `[]`.\nThe array of custom AWS resource tags (in the form `key:value`) defines a filter that Datadog uses when collecting metrics from a specified service.\nWildcards, such as `?` (match a single character) and `*` (match multiple characters), and exclusion using `!` before the tag are supported.\nFor EC2, only hosts that match one of the defined tags will be imported into Datadog. The rest will be ignored.\nFor example, `env:production,instance-type:c?.*,!region:us-east-1`.", "properties": { "namespace": { - "description": "The AWS Namespace to apply the tag filters against", + "description": "The AWS service for which the tag filters defined in `tags` will be applied.", "example": "AWS/EC2", "type": "string" }, "tags": { - "description": "The tags to filter based on", + "description": "The AWS resource tags to filter on for the service specified by `namespace`.", "items": { - "example": "key:value", + "description": "Tag in the form `key:value`.", + "example": "datadog:true", "type": "string" }, "nullable": true, @@ -247450,38 +247467,38 @@ "type": "object" }, "modified_at": { - "description": "Timestamp of when the account integration was updated", + "description": "Timestamp of when the account integration was updated.", "format": "date-time", "readOnly": true, "type": "string" }, "resources_config": { - "description": "AWS Resources config", + "description": "AWS Resources Collection config.", "properties": { "cloud_security_posture_management_collection": { - "description": "Whether Datadog collects cloud security posture management resources from your AWS account.", + "description": "Enable Cloud Security Management to scan AWS resources for vulnerabilities, misconfigurations, identity risks, and compliance violations. Defaults to `false`. Requires `extended_collection` to be set to `true`.", "example": false, "type": "boolean" }, "extended_collection": { - "description": "Whether Datadog collects additional attributes and configuration information about the resources in your AWS account. Required for `cspm_resource_collection`.", - "example": false, + "description": "Whether Datadog collects additional attributes and configuration information about the resources in your AWS account. Defaults to `true`. Required for `cloud_security_posture_management_collection`.", + "example": true, "type": "boolean" } }, "type": "object" }, "traces_config": { - "description": "AWS Traces config", + "description": "AWS Traces Collection config.", "properties": { "xray_services": { - "description": "AWS X-Ray services to collect traces from", + "description": "AWS X-Ray services to collect traces from. Defaults to `include_only`.", "oneOf": [ { - "description": "Include all services", + "description": "Include all services.", "properties": { "include_all": { - "description": "Include all services", + "description": "Include all services.", "example": false, "type": "boolean" } @@ -247491,11 +247508,11 @@ ] }, { - "description": "Include only these services", + "description": "Include only these services. Defaults to `[]`.", "nullable": true, "properties": { "include_only": { - "description": "Include only these services", + "description": "Include only these services.", "example": [ "AWS/AppSync" ], @@ -247522,7 +247539,7 @@ "type": "object" }, "id": { - "description": "Unique Datadog ID of the AWS Account Integration Config", + "description": "Unique Datadog ID of the AWS Account Integration Config.\nTo get the config ID for an account, use the [List all AWS integrations](https://docs.datadoghq.com/api/latest/aws-integration/#list-all-aws-integrations)\nendpoint and query by AWS Account ID.", "example": "00000000-abcd-0001-0000-000000000000", "type": "string" }, @@ -247701,16 +247718,16 @@ ], "type": "unsafe" }, - "x-unstable": "**Note: This endpoint is in public beta. If you have any feedback,\ncontact [Datadog support](https://docs.datadoghq.com/help/).**" + "x-unstable": "**Note: This endpoint is in Preview. If you have any feedback,\ncontact [Datadog support](https://docs.datadoghq.com/help/).**" } }, "/api/v2/integration/aws/accounts/{aws_account_config_id}": { "delete": { - "description": "Delete an AWS Account Integration Config", + "description": "Delete an AWS Account Integration Config by config ID.", "operationId": "DeleteAWSAccount", "parameters": [ { - "description": "Unique Datadog ID of the AWS Account Integration Config", + "description": "Unique Datadog ID of the AWS Account Integration Config. To get the config ID for an account, use the\n[List all AWS integrations](https://docs.datadoghq.com/api/latest/aws-integration/#list-all-aws-integrations) endpoint and query by AWS Account ID.", "in": "path", "name": "aws_account_config_id", "required": true, @@ -247850,14 +247867,14 @@ "x-undo": { "type": "idempotent" }, - "x-unstable": "**Note: This endpoint is in public beta. If you have any feedback,\ncontact [Datadog support](https://docs.datadoghq.com/help/).**" + "x-unstable": "**Note: This endpoint is in Preview. If you have any feedback,\ncontact [Datadog support](https://docs.datadoghq.com/help/).**" }, "get": { - "description": "Get an AWS Account Integration Config", + "description": "Get an AWS Account Integration Config by config ID.", "operationId": "GetAWSAccount", "parameters": [ { - "description": "Unique Datadog ID of the AWS Account Integration Config", + "description": "Unique Datadog ID of the AWS Account Integration Config. To get the config ID for an account, use the\n[List all AWS integrations](https://docs.datadoghq.com/api/latest/aws-integration/#list-all-aws-integrations) endpoint and query by AWS Account ID.", "in": "path", "name": "aws_account_config_id", "required": true, @@ -247871,37 +247888,37 @@ "content": { "application/json": { "schema": { - "description": "AWS Account response body", + "description": "AWS Account response body.", "properties": { "data": { - "description": "AWS Account Response body", + "description": "AWS Account response data.", "properties": { "attributes": { - "description": "The AWS Account Integration Config", + "description": "AWS Account response attributes.", "properties": { "account_tags": { - "description": "Tags to apply to all metrics in the account", + "description": "Tags to apply to all hosts and metrics reporting for this account. Defaults to `[]`.", "items": { - "description": "Tag to apply to all metrics in the account", - "example": "key:value", + "description": "Tag in the form `key:value`.", + "example": "env:prod", "type": "string" }, "nullable": true, "type": "array" }, "auth_config": { - "description": "AWS Authentication config", + "description": "AWS Authentication config.", "oneOf": [ { - "description": "AWS Authentication config for key-based account", + "description": "AWS Authentication config to integrate your account using an access key pair.", "properties": { "access_key_id": { - "description": "AWS Access Key ID", + "description": "AWS Access Key ID.", "example": "AKIAIOSFODNN7EXAMPLE", "type": "string" }, "secret_access_key": { - "description": "AWS Secret Access Key", + "description": "AWS Secret Access Key.", "example": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY", "minLength": 1, "type": "string", @@ -247914,14 +247931,14 @@ "type": "object" }, { - "description": "AWS Authentication config for role-based account", + "description": "AWS Authentication config to integrate your account using an IAM role.", "properties": { "external_id": { - "description": "AWS IAM External ID for associated role", + "description": "AWS IAM External ID for associated role.", "type": "string" }, "role_name": { - "description": "AWS IAM Role name", + "description": "AWS IAM Role name.", "example": "DatadogIntegrationRole", "maxLength": 576, "minLength": 1, @@ -247936,13 +247953,12 @@ ] }, "aws_account_id": { - "description": "AWS Account ID", + "description": "AWS Account ID.", "example": "123456789012", "type": "string" }, "aws_partition": { - "default": "aws", - "description": "AWS Account partition", + "description": "AWS partition your AWS account is scoped to. Defaults to `aws`.\nSee [Partitions](https://docs.aws.amazon.com/whitepapers/latest/aws-fault-isolation-boundaries/partitions.html) in the AWS documentation for more information.", "enum": [ "aws", "aws-cn", @@ -247957,14 +247973,14 @@ ] }, "aws_regions": { - "description": "AWS Regions to collect data from", + "description": "AWS Regions to collect data from. Defaults to `include_all`.", "oneOf": [ { - "description": "Include all regions", + "description": "Include all regions. Defaults to `true`.", "properties": { "include_all": { - "description": "Include all regions", - "example": false, + "description": "Include all regions.", + "example": true, "type": "boolean" } }, @@ -247973,10 +247989,10 @@ ] }, { - "description": "Include only these regions", + "description": "Include only these regions.", "properties": { "include_only": { - "description": "Include only these regions", + "description": "Include only these regions.", "example": [ "us-east-1" ], @@ -247994,19 +248010,19 @@ ] }, "created_at": { - "description": "Timestamp of when the account integration was created", + "description": "Timestamp of when the account integration was created.", "format": "date-time", "readOnly": true, "type": "string" }, "logs_config": { - "description": "AWS Logs config", + "description": "AWS Logs Collection config.", "properties": { "lambda_forwarder": { - "description": "AWS Lambda forwarder", + "description": "Log Autosubscription configuration for Datadog Forwarder Lambda functions. Automatically set up triggers for existing\nand new logs for some services, ensuring no logs from new resources are missed and saving time spent on manual configuration.", "properties": { "lambdas": { - "description": "List of Datadog Lambda Log Forwarder ARNs", + "description": "List of Datadog Lambda Log Forwarder ARNs in your AWS account. Defaults to `[]`.", "items": { "example": "arn:aws:lambda:us-east-1:123456789012:function:DatadogLambdaLogForwarder", "type": "string" @@ -248014,7 +248030,7 @@ "type": "array" }, "sources": { - "description": "List of AWS services that will send logs to the Datadog Lambda Log Forwarder", + "description": "List of service IDs set to enable automatic log collection. Discover the list of available services with the\n[Get list of AWS log ready services](https://docs.datadoghq.com/api/latest/aws-logs-integration/#get-list-of-aws-log-ready-services) endpoint.", "items": { "example": "s3", "type": "string" @@ -248028,41 +248044,42 @@ "type": "object" }, "metrics_config": { - "description": "AWS Metrics config", + "description": "AWS Metrics Collection config.", "properties": { "automute_enabled": { - "description": "Enable EC2 automute for AWS metrics", + "description": "Enable EC2 automute for AWS metrics. Defaults to `true`.", "example": true, "type": "boolean" }, "collect_cloudwatch_alarms": { - "description": "Enable CloudWatch alarms collection", - "example": true, + "description": "Enable CloudWatch alarms collection. Defaults to `false`.", + "example": false, "type": "boolean" }, "collect_custom_metrics": { - "description": "Enable custom metrics collection", - "example": true, + "description": "Enable custom metrics collection. Defaults to `false`.", + "example": false, "type": "boolean" }, "enabled": { - "description": "Enable AWS metrics collection", + "description": "Enable AWS metrics collection. Defaults to `true`.", "example": true, "type": "boolean" }, "namespace_filters": { - "description": "AWS Metrics namespace filters", + "description": "AWS Metrics namespace filters. Defaults to `exclude_only`.", "oneOf": [ { - "description": "Exclude only these namespaces", + "description": "Exclude only these namespaces from metrics collection. Defaults to `[\"AWS/SQS\", \"AWS/ElasticMapReduce\"]`.\n`AWS/SQS` and `AWS/ElasticMapReduce` are excluded by default to reduce your AWS CloudWatch costs from `GetMetricData` API calls.", "properties": { "exclude_only": { - "description": "Exclude only these namespaces", + "description": "Exclude only these namespaces from metrics collection. Defaults to `[\"AWS/SQS\", \"AWS/ElasticMapReduce\"]`.\n`AWS/SQS` and `AWS/ElasticMapReduce` are excluded by default to reduce your AWS CloudWatch costs from `GetMetricData` API calls.", "example": [ - "AWS/EC2" + "AWS/SQS", + "AWS/ElasticMapReduce" ], "items": { - "example": "AWS/EC2", + "example": "AWS/SQS", "type": "string" }, "type": "array" @@ -248073,10 +248090,10 @@ ] }, { - "description": "Include only these namespaces", + "description": "Include only these namespaces.", "properties": { "include_only": { - "description": "Include only these namespaces", + "description": "Include only these namespaces.", "example": [ "AWS/EC2" ], @@ -248094,19 +248111,20 @@ ] }, "tag_filters": { - "description": "AWS Metrics tag filters list", + "description": "AWS Metrics collection tag filters list. Defaults to `[]`.", "items": { - "description": "AWS Metrics tag filters", + "description": "AWS Metrics Collection tag filters list. Defaults to `[]`.\nThe array of custom AWS resource tags (in the form `key:value`) defines a filter that Datadog uses when collecting metrics from a specified service.\nWildcards, such as `?` (match a single character) and `*` (match multiple characters), and exclusion using `!` before the tag are supported.\nFor EC2, only hosts that match one of the defined tags will be imported into Datadog. The rest will be ignored.\nFor example, `env:production,instance-type:c?.*,!region:us-east-1`.", "properties": { "namespace": { - "description": "The AWS Namespace to apply the tag filters against", + "description": "The AWS service for which the tag filters defined in `tags` will be applied.", "example": "AWS/EC2", "type": "string" }, "tags": { - "description": "The tags to filter based on", + "description": "The AWS resource tags to filter on for the service specified by `namespace`.", "items": { - "example": "key:value", + "description": "Tag in the form `key:value`.", + "example": "datadog:true", "type": "string" }, "nullable": true, @@ -248121,38 +248139,38 @@ "type": "object" }, "modified_at": { - "description": "Timestamp of when the account integration was updated", + "description": "Timestamp of when the account integration was updated.", "format": "date-time", "readOnly": true, "type": "string" }, "resources_config": { - "description": "AWS Resources config", + "description": "AWS Resources Collection config.", "properties": { "cloud_security_posture_management_collection": { - "description": "Whether Datadog collects cloud security posture management resources from your AWS account.", + "description": "Enable Cloud Security Management to scan AWS resources for vulnerabilities, misconfigurations, identity risks, and compliance violations. Defaults to `false`. Requires `extended_collection` to be set to `true`.", "example": false, "type": "boolean" }, "extended_collection": { - "description": "Whether Datadog collects additional attributes and configuration information about the resources in your AWS account. Required for `cspm_resource_collection`.", - "example": false, + "description": "Whether Datadog collects additional attributes and configuration information about the resources in your AWS account. Defaults to `true`. Required for `cloud_security_posture_management_collection`.", + "example": true, "type": "boolean" } }, "type": "object" }, "traces_config": { - "description": "AWS Traces config", + "description": "AWS Traces Collection config.", "properties": { "xray_services": { - "description": "AWS X-Ray services to collect traces from", + "description": "AWS X-Ray services to collect traces from. Defaults to `include_only`.", "oneOf": [ { - "description": "Include all services", + "description": "Include all services.", "properties": { "include_all": { - "description": "Include all services", + "description": "Include all services.", "example": false, "type": "boolean" } @@ -248162,11 +248180,11 @@ ] }, { - "description": "Include only these services", + "description": "Include only these services. Defaults to `[]`.", "nullable": true, "properties": { "include_only": { - "description": "Include only these services", + "description": "Include only these services.", "example": [ "AWS/AppSync" ], @@ -248193,7 +248211,7 @@ "type": "object" }, "id": { - "description": "Unique Datadog ID of the AWS Account Integration Config", + "description": "Unique Datadog ID of the AWS Account Integration Config.\nTo get the config ID for an account, use the [List all AWS integrations](https://docs.datadoghq.com/api/latest/aws-integration/#list-all-aws-integrations)\nendpoint and query by AWS Account ID.", "example": "00000000-abcd-0001-0000-000000000000", "type": "string" }, @@ -248353,14 +248371,14 @@ "x-undo": { "type": "safe" }, - "x-unstable": "**Note: This endpoint is in public beta. If you have any feedback,\ncontact [Datadog support](https://docs.datadoghq.com/help/).**" + "x-unstable": "**Note: This endpoint is in Preview. If you have any feedback,\ncontact [Datadog support](https://docs.datadoghq.com/help/).**" }, "patch": { - "description": "Update an AWS Account Integration Config", + "description": "Update an AWS Account Integration Config by config ID.", "operationId": "UpdateAWSAccount", "parameters": [ { - "description": "Unique Datadog ID of the AWS Account Integration Config", + "description": "Unique Datadog ID of the AWS Account Integration Config. To get the config ID for an account, use the\n[List all AWS integrations](https://docs.datadoghq.com/api/latest/aws-integration/#list-all-aws-integrations) endpoint and query by AWS Account ID.", "in": "path", "name": "aws_account_config_id", "required": true, @@ -248373,37 +248391,37 @@ "content": { "application/json": { "schema": { - "description": "AWS Account Update Request body", + "description": "AWS Account Update Request body.", "properties": { "data": { - "description": "AWS Account Update Request data", + "description": "AWS Account Update Request data.", "properties": { "attributes": { - "description": "The AWS Account Integration Config to be updated", + "description": "The AWS Account Integration Config to be updated.", "properties": { "account_tags": { - "description": "Tags to apply to all metrics in the account", + "description": "Tags to apply to all hosts and metrics reporting for this account. Defaults to `[]`.", "items": { - "description": "Tag to apply to all metrics in the account", - "example": "key:value", + "description": "Tag in the form `key:value`.", + "example": "env:prod", "type": "string" }, "nullable": true, "type": "array" }, "auth_config": { - "description": "AWS Authentication config", + "description": "AWS Authentication config.", "oneOf": [ { - "description": "AWS Authentication config for key-based account", + "description": "AWS Authentication config to integrate your account using an access key pair.", "properties": { "access_key_id": { - "description": "AWS Access Key ID", + "description": "AWS Access Key ID.", "example": "AKIAIOSFODNN7EXAMPLE", "type": "string" }, "secret_access_key": { - "description": "AWS Secret Access Key", + "description": "AWS Secret Access Key.", "example": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY", "minLength": 1, "type": "string", @@ -248416,14 +248434,14 @@ "type": "object" }, { - "description": "AWS Authentication config for role-based account", + "description": "AWS Authentication config to integrate your account using an IAM role.", "properties": { "external_id": { - "description": "AWS IAM External ID for associated role", + "description": "AWS IAM External ID for associated role.", "type": "string" }, "role_name": { - "description": "AWS IAM Role name", + "description": "AWS IAM Role name.", "example": "DatadogIntegrationRole", "maxLength": 576, "minLength": 1, @@ -248438,13 +248456,12 @@ ] }, "aws_account_id": { - "description": "AWS Account ID", + "description": "AWS Account ID.", "example": "123456789012", "type": "string" }, "aws_partition": { - "default": "aws", - "description": "AWS Account partition", + "description": "AWS partition your AWS account is scoped to. Defaults to `aws`.\nSee [Partitions](https://docs.aws.amazon.com/whitepapers/latest/aws-fault-isolation-boundaries/partitions.html) in the AWS documentation for more information.", "enum": [ "aws", "aws-cn", @@ -248459,14 +248476,14 @@ ] }, "aws_regions": { - "description": "AWS Regions to collect data from", + "description": "AWS Regions to collect data from. Defaults to `include_all`.", "oneOf": [ { - "description": "Include all regions", + "description": "Include all regions. Defaults to `true`.", "properties": { "include_all": { - "description": "Include all regions", - "example": false, + "description": "Include all regions.", + "example": true, "type": "boolean" } }, @@ -248475,10 +248492,10 @@ ] }, { - "description": "Include only these regions", + "description": "Include only these regions.", "properties": { "include_only": { - "description": "Include only these regions", + "description": "Include only these regions.", "example": [ "us-east-1" ], @@ -248496,13 +248513,13 @@ ] }, "logs_config": { - "description": "AWS Logs config", + "description": "AWS Logs Collection config.", "properties": { "lambda_forwarder": { - "description": "AWS Lambda forwarder", + "description": "Log Autosubscription configuration for Datadog Forwarder Lambda functions. Automatically set up triggers for existing\nand new logs for some services, ensuring no logs from new resources are missed and saving time spent on manual configuration.", "properties": { "lambdas": { - "description": "List of Datadog Lambda Log Forwarder ARNs", + "description": "List of Datadog Lambda Log Forwarder ARNs in your AWS account. Defaults to `[]`.", "items": { "example": "arn:aws:lambda:us-east-1:123456789012:function:DatadogLambdaLogForwarder", "type": "string" @@ -248510,7 +248527,7 @@ "type": "array" }, "sources": { - "description": "List of AWS services that will send logs to the Datadog Lambda Log Forwarder", + "description": "List of service IDs set to enable automatic log collection. Discover the list of available services with the\n[Get list of AWS log ready services](https://docs.datadoghq.com/api/latest/aws-logs-integration/#get-list-of-aws-log-ready-services) endpoint.", "items": { "example": "s3", "type": "string" @@ -248524,41 +248541,42 @@ "type": "object" }, "metrics_config": { - "description": "AWS Metrics config", + "description": "AWS Metrics Collection config.", "properties": { "automute_enabled": { - "description": "Enable EC2 automute for AWS metrics", + "description": "Enable EC2 automute for AWS metrics. Defaults to `true`.", "example": true, "type": "boolean" }, "collect_cloudwatch_alarms": { - "description": "Enable CloudWatch alarms collection", - "example": true, + "description": "Enable CloudWatch alarms collection. Defaults to `false`.", + "example": false, "type": "boolean" }, "collect_custom_metrics": { - "description": "Enable custom metrics collection", - "example": true, + "description": "Enable custom metrics collection. Defaults to `false`.", + "example": false, "type": "boolean" }, "enabled": { - "description": "Enable AWS metrics collection", + "description": "Enable AWS metrics collection. Defaults to `true`.", "example": true, "type": "boolean" }, "namespace_filters": { - "description": "AWS Metrics namespace filters", + "description": "AWS Metrics namespace filters. Defaults to `exclude_only`.", "oneOf": [ { - "description": "Exclude only these namespaces", + "description": "Exclude only these namespaces from metrics collection. Defaults to `[\"AWS/SQS\", \"AWS/ElasticMapReduce\"]`.\n`AWS/SQS` and `AWS/ElasticMapReduce` are excluded by default to reduce your AWS CloudWatch costs from `GetMetricData` API calls.", "properties": { "exclude_only": { - "description": "Exclude only these namespaces", + "description": "Exclude only these namespaces from metrics collection. Defaults to `[\"AWS/SQS\", \"AWS/ElasticMapReduce\"]`.\n`AWS/SQS` and `AWS/ElasticMapReduce` are excluded by default to reduce your AWS CloudWatch costs from `GetMetricData` API calls.", "example": [ - "AWS/EC2" + "AWS/SQS", + "AWS/ElasticMapReduce" ], "items": { - "example": "AWS/EC2", + "example": "AWS/SQS", "type": "string" }, "type": "array" @@ -248569,10 +248587,10 @@ ] }, { - "description": "Include only these namespaces", + "description": "Include only these namespaces.", "properties": { "include_only": { - "description": "Include only these namespaces", + "description": "Include only these namespaces.", "example": [ "AWS/EC2" ], @@ -248590,19 +248608,20 @@ ] }, "tag_filters": { - "description": "AWS Metrics tag filters list", + "description": "AWS Metrics collection tag filters list. Defaults to `[]`.", "items": { - "description": "AWS Metrics tag filters", + "description": "AWS Metrics Collection tag filters list. Defaults to `[]`.\nThe array of custom AWS resource tags (in the form `key:value`) defines a filter that Datadog uses when collecting metrics from a specified service.\nWildcards, such as `?` (match a single character) and `*` (match multiple characters), and exclusion using `!` before the tag are supported.\nFor EC2, only hosts that match one of the defined tags will be imported into Datadog. The rest will be ignored.\nFor example, `env:production,instance-type:c?.*,!region:us-east-1`.", "properties": { "namespace": { - "description": "The AWS Namespace to apply the tag filters against", + "description": "The AWS service for which the tag filters defined in `tags` will be applied.", "example": "AWS/EC2", "type": "string" }, "tags": { - "description": "The tags to filter based on", + "description": "The AWS resource tags to filter on for the service specified by `namespace`.", "items": { - "example": "key:value", + "description": "Tag in the form `key:value`.", + "example": "datadog:true", "type": "string" }, "nullable": true, @@ -248617,32 +248636,32 @@ "type": "object" }, "resources_config": { - "description": "AWS Resources config", + "description": "AWS Resources Collection config.", "properties": { "cloud_security_posture_management_collection": { - "description": "Whether Datadog collects cloud security posture management resources from your AWS account.", + "description": "Enable Cloud Security Management to scan AWS resources for vulnerabilities, misconfigurations, identity risks, and compliance violations. Defaults to `false`. Requires `extended_collection` to be set to `true`.", "example": false, "type": "boolean" }, "extended_collection": { - "description": "Whether Datadog collects additional attributes and configuration information about the resources in your AWS account. Required for `cspm_resource_collection`.", - "example": false, + "description": "Whether Datadog collects additional attributes and configuration information about the resources in your AWS account. Defaults to `true`. Required for `cloud_security_posture_management_collection`.", + "example": true, "type": "boolean" } }, "type": "object" }, "traces_config": { - "description": "AWS Traces config", + "description": "AWS Traces Collection config.", "properties": { "xray_services": { - "description": "AWS X-Ray services to collect traces from", + "description": "AWS X-Ray services to collect traces from. Defaults to `include_only`.", "oneOf": [ { - "description": "Include all services", + "description": "Include all services.", "properties": { "include_all": { - "description": "Include all services", + "description": "Include all services.", "example": false, "type": "boolean" } @@ -248652,11 +248671,11 @@ ] }, { - "description": "Include only these services", + "description": "Include only these services. Defaults to `[]`.", "nullable": true, "properties": { "include_only": { - "description": "Include only these services", + "description": "Include only these services.", "example": [ "AWS/AppSync" ], @@ -248683,7 +248702,7 @@ "type": "object" }, "id": { - "description": "Unique Datadog ID of the AWS Account Integration Config", + "description": "Unique Datadog ID of the AWS Account Integration Config.\nTo get the config ID for an account, use the [List all AWS integrations](https://docs.datadoghq.com/api/latest/aws-integration/#list-all-aws-integrations)\nendpoint and query by AWS Account ID.", "example": "00000000-abcd-0001-0000-000000000000", "type": "string" }, @@ -248721,37 +248740,37 @@ "content": { "application/json": { "schema": { - "description": "AWS Account response body", + "description": "AWS Account response body.", "properties": { "data": { - "description": "AWS Account Response body", + "description": "AWS Account response data.", "properties": { "attributes": { - "description": "The AWS Account Integration Config", + "description": "AWS Account response attributes.", "properties": { "account_tags": { - "description": "Tags to apply to all metrics in the account", + "description": "Tags to apply to all hosts and metrics reporting for this account. Defaults to `[]`.", "items": { - "description": "Tag to apply to all metrics in the account", - "example": "key:value", + "description": "Tag in the form `key:value`.", + "example": "env:prod", "type": "string" }, "nullable": true, "type": "array" }, "auth_config": { - "description": "AWS Authentication config", + "description": "AWS Authentication config.", "oneOf": [ { - "description": "AWS Authentication config for key-based account", + "description": "AWS Authentication config to integrate your account using an access key pair.", "properties": { "access_key_id": { - "description": "AWS Access Key ID", + "description": "AWS Access Key ID.", "example": "AKIAIOSFODNN7EXAMPLE", "type": "string" }, "secret_access_key": { - "description": "AWS Secret Access Key", + "description": "AWS Secret Access Key.", "example": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY", "minLength": 1, "type": "string", @@ -248764,14 +248783,14 @@ "type": "object" }, { - "description": "AWS Authentication config for role-based account", + "description": "AWS Authentication config to integrate your account using an IAM role.", "properties": { "external_id": { - "description": "AWS IAM External ID for associated role", + "description": "AWS IAM External ID for associated role.", "type": "string" }, "role_name": { - "description": "AWS IAM Role name", + "description": "AWS IAM Role name.", "example": "DatadogIntegrationRole", "maxLength": 576, "minLength": 1, @@ -248786,13 +248805,12 @@ ] }, "aws_account_id": { - "description": "AWS Account ID", + "description": "AWS Account ID.", "example": "123456789012", "type": "string" }, "aws_partition": { - "default": "aws", - "description": "AWS Account partition", + "description": "AWS partition your AWS account is scoped to. Defaults to `aws`.\nSee [Partitions](https://docs.aws.amazon.com/whitepapers/latest/aws-fault-isolation-boundaries/partitions.html) in the AWS documentation for more information.", "enum": [ "aws", "aws-cn", @@ -248807,14 +248825,14 @@ ] }, "aws_regions": { - "description": "AWS Regions to collect data from", + "description": "AWS Regions to collect data from. Defaults to `include_all`.", "oneOf": [ { - "description": "Include all regions", + "description": "Include all regions. Defaults to `true`.", "properties": { "include_all": { - "description": "Include all regions", - "example": false, + "description": "Include all regions.", + "example": true, "type": "boolean" } }, @@ -248823,10 +248841,10 @@ ] }, { - "description": "Include only these regions", + "description": "Include only these regions.", "properties": { "include_only": { - "description": "Include only these regions", + "description": "Include only these regions.", "example": [ "us-east-1" ], @@ -248844,19 +248862,19 @@ ] }, "created_at": { - "description": "Timestamp of when the account integration was created", + "description": "Timestamp of when the account integration was created.", "format": "date-time", "readOnly": true, "type": "string" }, "logs_config": { - "description": "AWS Logs config", + "description": "AWS Logs Collection config.", "properties": { "lambda_forwarder": { - "description": "AWS Lambda forwarder", + "description": "Log Autosubscription configuration for Datadog Forwarder Lambda functions. Automatically set up triggers for existing\nand new logs for some services, ensuring no logs from new resources are missed and saving time spent on manual configuration.", "properties": { "lambdas": { - "description": "List of Datadog Lambda Log Forwarder ARNs", + "description": "List of Datadog Lambda Log Forwarder ARNs in your AWS account. Defaults to `[]`.", "items": { "example": "arn:aws:lambda:us-east-1:123456789012:function:DatadogLambdaLogForwarder", "type": "string" @@ -248864,7 +248882,7 @@ "type": "array" }, "sources": { - "description": "List of AWS services that will send logs to the Datadog Lambda Log Forwarder", + "description": "List of service IDs set to enable automatic log collection. Discover the list of available services with the\n[Get list of AWS log ready services](https://docs.datadoghq.com/api/latest/aws-logs-integration/#get-list-of-aws-log-ready-services) endpoint.", "items": { "example": "s3", "type": "string" @@ -248878,41 +248896,42 @@ "type": "object" }, "metrics_config": { - "description": "AWS Metrics config", + "description": "AWS Metrics Collection config.", "properties": { "automute_enabled": { - "description": "Enable EC2 automute for AWS metrics", + "description": "Enable EC2 automute for AWS metrics. Defaults to `true`.", "example": true, "type": "boolean" }, "collect_cloudwatch_alarms": { - "description": "Enable CloudWatch alarms collection", - "example": true, + "description": "Enable CloudWatch alarms collection. Defaults to `false`.", + "example": false, "type": "boolean" }, "collect_custom_metrics": { - "description": "Enable custom metrics collection", - "example": true, + "description": "Enable custom metrics collection. Defaults to `false`.", + "example": false, "type": "boolean" }, "enabled": { - "description": "Enable AWS metrics collection", + "description": "Enable AWS metrics collection. Defaults to `true`.", "example": true, "type": "boolean" }, "namespace_filters": { - "description": "AWS Metrics namespace filters", + "description": "AWS Metrics namespace filters. Defaults to `exclude_only`.", "oneOf": [ { - "description": "Exclude only these namespaces", + "description": "Exclude only these namespaces from metrics collection. Defaults to `[\"AWS/SQS\", \"AWS/ElasticMapReduce\"]`.\n`AWS/SQS` and `AWS/ElasticMapReduce` are excluded by default to reduce your AWS CloudWatch costs from `GetMetricData` API calls.", "properties": { "exclude_only": { - "description": "Exclude only these namespaces", + "description": "Exclude only these namespaces from metrics collection. Defaults to `[\"AWS/SQS\", \"AWS/ElasticMapReduce\"]`.\n`AWS/SQS` and `AWS/ElasticMapReduce` are excluded by default to reduce your AWS CloudWatch costs from `GetMetricData` API calls.", "example": [ - "AWS/EC2" + "AWS/SQS", + "AWS/ElasticMapReduce" ], "items": { - "example": "AWS/EC2", + "example": "AWS/SQS", "type": "string" }, "type": "array" @@ -248923,10 +248942,10 @@ ] }, { - "description": "Include only these namespaces", + "description": "Include only these namespaces.", "properties": { "include_only": { - "description": "Include only these namespaces", + "description": "Include only these namespaces.", "example": [ "AWS/EC2" ], @@ -248944,19 +248963,20 @@ ] }, "tag_filters": { - "description": "AWS Metrics tag filters list", + "description": "AWS Metrics collection tag filters list. Defaults to `[]`.", "items": { - "description": "AWS Metrics tag filters", + "description": "AWS Metrics Collection tag filters list. Defaults to `[]`.\nThe array of custom AWS resource tags (in the form `key:value`) defines a filter that Datadog uses when collecting metrics from a specified service.\nWildcards, such as `?` (match a single character) and `*` (match multiple characters), and exclusion using `!` before the tag are supported.\nFor EC2, only hosts that match one of the defined tags will be imported into Datadog. The rest will be ignored.\nFor example, `env:production,instance-type:c?.*,!region:us-east-1`.", "properties": { "namespace": { - "description": "The AWS Namespace to apply the tag filters against", + "description": "The AWS service for which the tag filters defined in `tags` will be applied.", "example": "AWS/EC2", "type": "string" }, "tags": { - "description": "The tags to filter based on", + "description": "The AWS resource tags to filter on for the service specified by `namespace`.", "items": { - "example": "key:value", + "description": "Tag in the form `key:value`.", + "example": "datadog:true", "type": "string" }, "nullable": true, @@ -248971,38 +248991,38 @@ "type": "object" }, "modified_at": { - "description": "Timestamp of when the account integration was updated", + "description": "Timestamp of when the account integration was updated.", "format": "date-time", "readOnly": true, "type": "string" }, "resources_config": { - "description": "AWS Resources config", + "description": "AWS Resources Collection config.", "properties": { "cloud_security_posture_management_collection": { - "description": "Whether Datadog collects cloud security posture management resources from your AWS account.", + "description": "Enable Cloud Security Management to scan AWS resources for vulnerabilities, misconfigurations, identity risks, and compliance violations. Defaults to `false`. Requires `extended_collection` to be set to `true`.", "example": false, "type": "boolean" }, "extended_collection": { - "description": "Whether Datadog collects additional attributes and configuration information about the resources in your AWS account. Required for `cspm_resource_collection`.", - "example": false, + "description": "Whether Datadog collects additional attributes and configuration information about the resources in your AWS account. Defaults to `true`. Required for `cloud_security_posture_management_collection`.", + "example": true, "type": "boolean" } }, "type": "object" }, "traces_config": { - "description": "AWS Traces config", + "description": "AWS Traces Collection config.", "properties": { "xray_services": { - "description": "AWS X-Ray services to collect traces from", + "description": "AWS X-Ray services to collect traces from. Defaults to `include_only`.", "oneOf": [ { - "description": "Include all services", + "description": "Include all services.", "properties": { "include_all": { - "description": "Include all services", + "description": "Include all services.", "example": false, "type": "boolean" } @@ -249012,11 +249032,11 @@ ] }, { - "description": "Include only these services", + "description": "Include only these services. Defaults to `[]`.", "nullable": true, "properties": { "include_only": { - "description": "Include only these services", + "description": "Include only these services.", "example": [ "AWS/AppSync" ], @@ -249043,7 +249063,7 @@ "type": "object" }, "id": { - "description": "Unique Datadog ID of the AWS Account Integration Config", + "description": "Unique Datadog ID of the AWS Account Integration Config.\nTo get the config ID for an account, use the [List all AWS integrations](https://docs.datadoghq.com/api/latest/aws-integration/#list-all-aws-integrations)\nendpoint and query by AWS Account ID.", "example": "00000000-abcd-0001-0000-000000000000", "type": "string" }, @@ -249204,7 +249224,7 @@ "x-undo": { "type": "idempotent" }, - "x-unstable": "**Note: This endpoint is in public beta. If you have any feedback,\ncontact [Datadog support](https://docs.datadoghq.com/help/).**" + "x-unstable": "**Note: This endpoint is in Preview. If you have any feedback,\ncontact [Datadog support](https://docs.datadoghq.com/help/).**" } }, "/api/v2/integration/aws/available_namespaces": { @@ -249216,16 +249236,16 @@ "content": { "application/json": { "schema": { - "description": "AWS Namespaces response body", + "description": "AWS Namespaces response body.", "properties": { "data": { - "description": "AWS Namespaces response body", + "description": "AWS Namespaces response data.", "properties": { "attributes": { - "description": "AWS Namespaces response body", + "description": "AWS Namespaces response attributes.", "properties": { "namespaces": { - "description": "AWS CloudWatch namespace", + "description": "AWS CloudWatch namespace.", "example": [ "AWS/ApiGateway" ], @@ -249347,7 +249367,7 @@ "x-undo": { "type": "safe" }, - "x-unstable": "**Note: This endpoint is in public beta. If you have any feedback,\ncontact [Datadog support](https://docs.datadoghq.com/help/).**" + "x-unstable": "**Note: This endpoint is in Preview. If you have any feedback,\ncontact [Datadog support](https://docs.datadoghq.com/help/).**" } }, "/api/v2/integration/aws/generate_new_external_id": { @@ -249359,16 +249379,16 @@ "content": { "application/json": { "schema": { - "description": "AWS External ID response body", + "description": "AWS External ID response body.", "properties": { "data": { - "description": "AWS External ID response body", + "description": "AWS External ID response body.", "properties": { "attributes": { - "description": "AWS External ID response body", + "description": "AWS External ID response body.", "properties": { "external_id": { - "description": "AWS IAM External ID for associated role", + "description": "AWS IAM External ID for associated role.", "example": "acb8f6b8a844443dbb726d07dcb1a870", "type": "string" } @@ -249484,7 +249504,7 @@ "x-undo": { "type": "safe" }, - "x-unstable": "**Note: This endpoint is in public beta. If you have any feedback,\ncontact [Datadog support](https://docs.datadoghq.com/help/).**" + "x-unstable": "**Note: This endpoint is in Preview. If you have any feedback,\ncontact [Datadog support](https://docs.datadoghq.com/help/).**" } }, "/api/v2/integration/aws/logs/services": { diff --git a/data/api/v2/translate_actions.json b/data/api/v2/translate_actions.json index d3c527e8d51e7..5662ea21c541e 100644 --- a/data/api/v2/translate_actions.json +++ b/data/api/v2/translate_actions.json @@ -587,21 +587,21 @@ "description": "Create a new AWS Account Integration Config.", "summary": "Create an AWS integration", "request_description": "", - "request_schema_description": "AWS Account Create Request body" + "request_schema_description": "AWS Account Create Request body." }, "DeleteAWSAccount": { - "description": "Delete an AWS Account Integration Config", + "description": "Delete an AWS Account Integration Config by config ID.", "summary": "Delete an AWS integration" }, "GetAWSAccount": { - "description": "Get an AWS Account Integration Config", + "description": "Get an AWS Account Integration Config by config ID.", "summary": "Get an AWS integration by config ID" }, "UpdateAWSAccount": { - "description": "Update an AWS Account Integration Config", + "description": "Update an AWS Account Integration Config by config ID.", "summary": "Update an AWS integration", "request_description": "", - "request_schema_description": "AWS Account Update Request body" + "request_schema_description": "AWS Account Update Request body." }, "ListAWSNamespaces": { "description": "Get a list of available AWS CloudWatch namespaces that can send metrics to Datadog.", diff --git a/static/resources/json/full_spec_v2.json b/static/resources/json/full_spec_v2.json index 1e7d966568549..1013a5ae92bed 100644 --- a/static/resources/json/full_spec_v2.json +++ b/static/resources/json/full_spec_v2.json @@ -135,7 +135,7 @@ } }, "AWSAccountConfigIDPathParameter": { - "description": "Unique Datadog ID of the AWS Account Integration Config", + "description": "Unique Datadog ID of the AWS Account Integration Config. To get the config ID for an account, use the\n[List all AWS integrations](https://docs.datadoghq.com/api/latest/aws-integration/#list-all-aws-integrations) endpoint and query by AWS Account ID.", "in": "path", "name": "aws_account_config_id", "required": true, @@ -3403,42 +3403,42 @@ ] }, "AWSAccountConfigID": { - "description": "Unique Datadog ID of the AWS Account Integration Config", + "description": "Unique Datadog ID of the AWS Account Integration Config.\nTo get the config ID for an account, use the [List all AWS integrations](https://docs.datadoghq.com/api/latest/aws-integration/#list-all-aws-integrations)\nendpoint and query by AWS Account ID.", "example": "00000000-abcd-0001-0000-000000000000", "type": "string" }, "AWSAccountCreateRequest": { - "description": "AWS Account Create Request body", + "description": "AWS Account Create Request body.", "properties": { "data": { - "description": "AWS Account Create Request data", + "description": "AWS Account Create Request data.", "properties": { "attributes": { - "description": "The AWS Account Integration Config to be created", + "description": "The AWS Account Integration Config to be created.", "properties": { "account_tags": { - "description": "Tags to apply to all metrics in the account", + "description": "Tags to apply to all hosts and metrics reporting for this account. Defaults to `[]`.", "items": { - "description": "Tag to apply to all metrics in the account", - "example": "key:value", + "description": "Tag in the form `key:value`.", + "example": "env:prod", "type": "string" }, "nullable": true, "type": "array" }, "auth_config": { - "description": "AWS Authentication config", + "description": "AWS Authentication config.", "oneOf": [ { - "description": "AWS Authentication config for key-based account", + "description": "AWS Authentication config to integrate your account using an access key pair.", "properties": { "access_key_id": { - "description": "AWS Access Key ID", + "description": "AWS Access Key ID.", "example": "AKIAIOSFODNN7EXAMPLE", "type": "string" }, "secret_access_key": { - "description": "AWS Secret Access Key", + "description": "AWS Secret Access Key.", "example": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY", "minLength": 1, "type": "string", @@ -3451,14 +3451,14 @@ "type": "object" }, { - "description": "AWS Authentication config for role-based account", + "description": "AWS Authentication config to integrate your account using an IAM role.", "properties": { "external_id": { - "description": "AWS IAM External ID for associated role", + "description": "AWS IAM External ID for associated role.", "type": "string" }, "role_name": { - "description": "AWS IAM Role name", + "description": "AWS IAM Role name.", "example": "DatadogIntegrationRole", "maxLength": 576, "minLength": 1, @@ -3473,13 +3473,12 @@ ] }, "aws_account_id": { - "description": "AWS Account ID", + "description": "AWS Account ID.", "example": "123456789012", "type": "string" }, "aws_partition": { - "default": "aws", - "description": "AWS Account partition", + "description": "AWS partition your AWS account is scoped to. Defaults to `aws`.\nSee [Partitions](https://docs.aws.amazon.com/whitepapers/latest/aws-fault-isolation-boundaries/partitions.html) in the AWS documentation for more information.", "enum": [ "aws", "aws-cn", @@ -3494,14 +3493,14 @@ ] }, "aws_regions": { - "description": "AWS Regions to collect data from", + "description": "AWS Regions to collect data from. Defaults to `include_all`.", "oneOf": [ { - "description": "Include all regions", + "description": "Include all regions. Defaults to `true`.", "properties": { "include_all": { - "description": "Include all regions", - "example": false, + "description": "Include all regions.", + "example": true, "type": "boolean" } }, @@ -3510,10 +3509,10 @@ ] }, { - "description": "Include only these regions", + "description": "Include only these regions.", "properties": { "include_only": { - "description": "Include only these regions", + "description": "Include only these regions.", "example": [ "us-east-1" ], @@ -3531,13 +3530,13 @@ ] }, "logs_config": { - "description": "AWS Logs config", + "description": "AWS Logs Collection config.", "properties": { "lambda_forwarder": { - "description": "AWS Lambda forwarder", + "description": "Log Autosubscription configuration for Datadog Forwarder Lambda functions. Automatically set up triggers for existing\nand new logs for some services, ensuring no logs from new resources are missed and saving time spent on manual configuration.", "properties": { "lambdas": { - "description": "List of Datadog Lambda Log Forwarder ARNs", + "description": "List of Datadog Lambda Log Forwarder ARNs in your AWS account. Defaults to `[]`.", "items": { "example": "arn:aws:lambda:us-east-1:123456789012:function:DatadogLambdaLogForwarder", "type": "string" @@ -3545,7 +3544,7 @@ "type": "array" }, "sources": { - "description": "List of AWS services that will send logs to the Datadog Lambda Log Forwarder", + "description": "List of service IDs set to enable automatic log collection. Discover the list of available services with the\n[Get list of AWS log ready services](https://docs.datadoghq.com/api/latest/aws-logs-integration/#get-list-of-aws-log-ready-services) endpoint.", "items": { "example": "s3", "type": "string" @@ -3559,41 +3558,42 @@ "type": "object" }, "metrics_config": { - "description": "AWS Metrics config", + "description": "AWS Metrics Collection config.", "properties": { "automute_enabled": { - "description": "Enable EC2 automute for AWS metrics", + "description": "Enable EC2 automute for AWS metrics. Defaults to `true`.", "example": true, "type": "boolean" }, "collect_cloudwatch_alarms": { - "description": "Enable CloudWatch alarms collection", - "example": true, + "description": "Enable CloudWatch alarms collection. Defaults to `false`.", + "example": false, "type": "boolean" }, "collect_custom_metrics": { - "description": "Enable custom metrics collection", - "example": true, + "description": "Enable custom metrics collection. Defaults to `false`.", + "example": false, "type": "boolean" }, "enabled": { - "description": "Enable AWS metrics collection", + "description": "Enable AWS metrics collection. Defaults to `true`.", "example": true, "type": "boolean" }, "namespace_filters": { - "description": "AWS Metrics namespace filters", + "description": "AWS Metrics namespace filters. Defaults to `exclude_only`.", "oneOf": [ { - "description": "Exclude only these namespaces", + "description": "Exclude only these namespaces from metrics collection. Defaults to `[\"AWS/SQS\", \"AWS/ElasticMapReduce\"]`.\n`AWS/SQS` and `AWS/ElasticMapReduce` are excluded by default to reduce your AWS CloudWatch costs from `GetMetricData` API calls.", "properties": { "exclude_only": { - "description": "Exclude only these namespaces", + "description": "Exclude only these namespaces from metrics collection. Defaults to `[\"AWS/SQS\", \"AWS/ElasticMapReduce\"]`.\n`AWS/SQS` and `AWS/ElasticMapReduce` are excluded by default to reduce your AWS CloudWatch costs from `GetMetricData` API calls.", "example": [ - "AWS/EC2" + "AWS/SQS", + "AWS/ElasticMapReduce" ], "items": { - "example": "AWS/EC2", + "example": "AWS/SQS", "type": "string" }, "type": "array" @@ -3604,10 +3604,10 @@ ] }, { - "description": "Include only these namespaces", + "description": "Include only these namespaces.", "properties": { "include_only": { - "description": "Include only these namespaces", + "description": "Include only these namespaces.", "example": [ "AWS/EC2" ], @@ -3625,19 +3625,20 @@ ] }, "tag_filters": { - "description": "AWS Metrics tag filters list", + "description": "AWS Metrics collection tag filters list. Defaults to `[]`.", "items": { - "description": "AWS Metrics tag filters", + "description": "AWS Metrics Collection tag filters list. Defaults to `[]`.\nThe array of custom AWS resource tags (in the form `key:value`) defines a filter that Datadog uses when collecting metrics from a specified service.\nWildcards, such as `?` (match a single character) and `*` (match multiple characters), and exclusion using `!` before the tag are supported.\nFor EC2, only hosts that match one of the defined tags will be imported into Datadog. The rest will be ignored.\nFor example, `env:production,instance-type:c?.*,!region:us-east-1`.", "properties": { "namespace": { - "description": "The AWS Namespace to apply the tag filters against", + "description": "The AWS service for which the tag filters defined in `tags` will be applied.", "example": "AWS/EC2", "type": "string" }, "tags": { - "description": "The tags to filter based on", + "description": "The AWS resource tags to filter on for the service specified by `namespace`.", "items": { - "example": "key:value", + "description": "Tag in the form `key:value`.", + "example": "datadog:true", "type": "string" }, "nullable": true, @@ -3652,32 +3653,32 @@ "type": "object" }, "resources_config": { - "description": "AWS Resources config", + "description": "AWS Resources Collection config.", "properties": { "cloud_security_posture_management_collection": { - "description": "Whether Datadog collects cloud security posture management resources from your AWS account.", + "description": "Enable Cloud Security Management to scan AWS resources for vulnerabilities, misconfigurations, identity risks, and compliance violations. Defaults to `false`. Requires `extended_collection` to be set to `true`.", "example": false, "type": "boolean" }, "extended_collection": { - "description": "Whether Datadog collects additional attributes and configuration information about the resources in your AWS account. Required for `cspm_resource_collection`.", - "example": false, + "description": "Whether Datadog collects additional attributes and configuration information about the resources in your AWS account. Defaults to `true`. Required for `cloud_security_posture_management_collection`.", + "example": true, "type": "boolean" } }, "type": "object" }, "traces_config": { - "description": "AWS Traces config", + "description": "AWS Traces Collection config.", "properties": { "xray_services": { - "description": "AWS X-Ray services to collect traces from", + "description": "AWS X-Ray services to collect traces from. Defaults to `include_only`.", "oneOf": [ { - "description": "Include all services", + "description": "Include all services.", "properties": { "include_all": { - "description": "Include all services", + "description": "Include all services.", "example": false, "type": "boolean" } @@ -3687,11 +3688,11 @@ ] }, { - "description": "Include only these services", + "description": "Include only these services. Defaults to `[]`.", "nullable": true, "properties": { "include_only": { - "description": "Include only these services", + "description": "Include only these services.", "example": [ "AWS/AppSync" ], @@ -3745,31 +3746,31 @@ "type": "object" }, "AWSAccountCreateRequestAttributes": { - "description": "The AWS Account Integration Config to be created", + "description": "The AWS Account Integration Config to be created.", "properties": { "account_tags": { - "description": "Tags to apply to all metrics in the account", + "description": "Tags to apply to all hosts and metrics reporting for this account. Defaults to `[]`.", "items": { - "description": "Tag to apply to all metrics in the account", - "example": "key:value", + "description": "Tag in the form `key:value`.", + "example": "env:prod", "type": "string" }, "nullable": true, "type": "array" }, "auth_config": { - "description": "AWS Authentication config", + "description": "AWS Authentication config.", "oneOf": [ { - "description": "AWS Authentication config for key-based account", + "description": "AWS Authentication config to integrate your account using an access key pair.", "properties": { "access_key_id": { - "description": "AWS Access Key ID", + "description": "AWS Access Key ID.", "example": "AKIAIOSFODNN7EXAMPLE", "type": "string" }, "secret_access_key": { - "description": "AWS Secret Access Key", + "description": "AWS Secret Access Key.", "example": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY", "minLength": 1, "type": "string", @@ -3782,14 +3783,14 @@ "type": "object" }, { - "description": "AWS Authentication config for role-based account", + "description": "AWS Authentication config to integrate your account using an IAM role.", "properties": { "external_id": { - "description": "AWS IAM External ID for associated role", + "description": "AWS IAM External ID for associated role.", "type": "string" }, "role_name": { - "description": "AWS IAM Role name", + "description": "AWS IAM Role name.", "example": "DatadogIntegrationRole", "maxLength": 576, "minLength": 1, @@ -3804,13 +3805,12 @@ ] }, "aws_account_id": { - "description": "AWS Account ID", + "description": "AWS Account ID.", "example": "123456789012", "type": "string" }, "aws_partition": { - "default": "aws", - "description": "AWS Account partition", + "description": "AWS partition your AWS account is scoped to. Defaults to `aws`.\nSee [Partitions](https://docs.aws.amazon.com/whitepapers/latest/aws-fault-isolation-boundaries/partitions.html) in the AWS documentation for more information.", "enum": [ "aws", "aws-cn", @@ -3825,14 +3825,14 @@ ] }, "aws_regions": { - "description": "AWS Regions to collect data from", + "description": "AWS Regions to collect data from. Defaults to `include_all`.", "oneOf": [ { - "description": "Include all regions", + "description": "Include all regions. Defaults to `true`.", "properties": { "include_all": { - "description": "Include all regions", - "example": false, + "description": "Include all regions.", + "example": true, "type": "boolean" } }, @@ -3841,10 +3841,10 @@ ] }, { - "description": "Include only these regions", + "description": "Include only these regions.", "properties": { "include_only": { - "description": "Include only these regions", + "description": "Include only these regions.", "example": [ "us-east-1" ], @@ -3862,13 +3862,13 @@ ] }, "logs_config": { - "description": "AWS Logs config", + "description": "AWS Logs Collection config.", "properties": { "lambda_forwarder": { - "description": "AWS Lambda forwarder", + "description": "Log Autosubscription configuration for Datadog Forwarder Lambda functions. Automatically set up triggers for existing\nand new logs for some services, ensuring no logs from new resources are missed and saving time spent on manual configuration.", "properties": { "lambdas": { - "description": "List of Datadog Lambda Log Forwarder ARNs", + "description": "List of Datadog Lambda Log Forwarder ARNs in your AWS account. Defaults to `[]`.", "items": { "example": "arn:aws:lambda:us-east-1:123456789012:function:DatadogLambdaLogForwarder", "type": "string" @@ -3876,7 +3876,7 @@ "type": "array" }, "sources": { - "description": "List of AWS services that will send logs to the Datadog Lambda Log Forwarder", + "description": "List of service IDs set to enable automatic log collection. Discover the list of available services with the\n[Get list of AWS log ready services](https://docs.datadoghq.com/api/latest/aws-logs-integration/#get-list-of-aws-log-ready-services) endpoint.", "items": { "example": "s3", "type": "string" @@ -3890,41 +3890,42 @@ "type": "object" }, "metrics_config": { - "description": "AWS Metrics config", + "description": "AWS Metrics Collection config.", "properties": { "automute_enabled": { - "description": "Enable EC2 automute for AWS metrics", + "description": "Enable EC2 automute for AWS metrics. Defaults to `true`.", "example": true, "type": "boolean" }, "collect_cloudwatch_alarms": { - "description": "Enable CloudWatch alarms collection", - "example": true, + "description": "Enable CloudWatch alarms collection. Defaults to `false`.", + "example": false, "type": "boolean" }, "collect_custom_metrics": { - "description": "Enable custom metrics collection", - "example": true, + "description": "Enable custom metrics collection. Defaults to `false`.", + "example": false, "type": "boolean" }, "enabled": { - "description": "Enable AWS metrics collection", + "description": "Enable AWS metrics collection. Defaults to `true`.", "example": true, "type": "boolean" }, "namespace_filters": { - "description": "AWS Metrics namespace filters", + "description": "AWS Metrics namespace filters. Defaults to `exclude_only`.", "oneOf": [ { - "description": "Exclude only these namespaces", + "description": "Exclude only these namespaces from metrics collection. Defaults to `[\"AWS/SQS\", \"AWS/ElasticMapReduce\"]`.\n`AWS/SQS` and `AWS/ElasticMapReduce` are excluded by default to reduce your AWS CloudWatch costs from `GetMetricData` API calls.", "properties": { "exclude_only": { - "description": "Exclude only these namespaces", + "description": "Exclude only these namespaces from metrics collection. Defaults to `[\"AWS/SQS\", \"AWS/ElasticMapReduce\"]`.\n`AWS/SQS` and `AWS/ElasticMapReduce` are excluded by default to reduce your AWS CloudWatch costs from `GetMetricData` API calls.", "example": [ - "AWS/EC2" + "AWS/SQS", + "AWS/ElasticMapReduce" ], "items": { - "example": "AWS/EC2", + "example": "AWS/SQS", "type": "string" }, "type": "array" @@ -3935,10 +3936,10 @@ ] }, { - "description": "Include only these namespaces", + "description": "Include only these namespaces.", "properties": { "include_only": { - "description": "Include only these namespaces", + "description": "Include only these namespaces.", "example": [ "AWS/EC2" ], @@ -3956,19 +3957,20 @@ ] }, "tag_filters": { - "description": "AWS Metrics tag filters list", + "description": "AWS Metrics collection tag filters list. Defaults to `[]`.", "items": { - "description": "AWS Metrics tag filters", + "description": "AWS Metrics Collection tag filters list. Defaults to `[]`.\nThe array of custom AWS resource tags (in the form `key:value`) defines a filter that Datadog uses when collecting metrics from a specified service.\nWildcards, such as `?` (match a single character) and `*` (match multiple characters), and exclusion using `!` before the tag are supported.\nFor EC2, only hosts that match one of the defined tags will be imported into Datadog. The rest will be ignored.\nFor example, `env:production,instance-type:c?.*,!region:us-east-1`.", "properties": { "namespace": { - "description": "The AWS Namespace to apply the tag filters against", + "description": "The AWS service for which the tag filters defined in `tags` will be applied.", "example": "AWS/EC2", "type": "string" }, "tags": { - "description": "The tags to filter based on", + "description": "The AWS resource tags to filter on for the service specified by `namespace`.", "items": { - "example": "key:value", + "description": "Tag in the form `key:value`.", + "example": "datadog:true", "type": "string" }, "nullable": true, @@ -3983,32 +3985,32 @@ "type": "object" }, "resources_config": { - "description": "AWS Resources config", + "description": "AWS Resources Collection config.", "properties": { "cloud_security_posture_management_collection": { - "description": "Whether Datadog collects cloud security posture management resources from your AWS account.", + "description": "Enable Cloud Security Management to scan AWS resources for vulnerabilities, misconfigurations, identity risks, and compliance violations. Defaults to `false`. Requires `extended_collection` to be set to `true`.", "example": false, "type": "boolean" }, "extended_collection": { - "description": "Whether Datadog collects additional attributes and configuration information about the resources in your AWS account. Required for `cspm_resource_collection`.", - "example": false, + "description": "Whether Datadog collects additional attributes and configuration information about the resources in your AWS account. Defaults to `true`. Required for `cloud_security_posture_management_collection`.", + "example": true, "type": "boolean" } }, "type": "object" }, "traces_config": { - "description": "AWS Traces config", + "description": "AWS Traces Collection config.", "properties": { "xray_services": { - "description": "AWS X-Ray services to collect traces from", + "description": "AWS X-Ray services to collect traces from. Defaults to `include_only`.", "oneOf": [ { - "description": "Include all services", + "description": "Include all services.", "properties": { "include_all": { - "description": "Include all services", + "description": "Include all services.", "example": false, "type": "boolean" } @@ -4018,11 +4020,11 @@ ] }, { - "description": "Include only these services", + "description": "Include only these services. Defaults to `[]`.", "nullable": true, "properties": { "include_only": { - "description": "Include only these services", + "description": "Include only these services.", "example": [ "AWS/AppSync" ], @@ -4051,34 +4053,34 @@ "type": "object" }, "AWSAccountCreateRequestData": { - "description": "AWS Account Create Request data", + "description": "AWS Account Create Request data.", "properties": { "attributes": { - "description": "The AWS Account Integration Config to be created", + "description": "The AWS Account Integration Config to be created.", "properties": { "account_tags": { - "description": "Tags to apply to all metrics in the account", + "description": "Tags to apply to all hosts and metrics reporting for this account. Defaults to `[]`.", "items": { - "description": "Tag to apply to all metrics in the account", - "example": "key:value", + "description": "Tag in the form `key:value`.", + "example": "env:prod", "type": "string" }, "nullable": true, "type": "array" }, "auth_config": { - "description": "AWS Authentication config", + "description": "AWS Authentication config.", "oneOf": [ { - "description": "AWS Authentication config for key-based account", + "description": "AWS Authentication config to integrate your account using an access key pair.", "properties": { "access_key_id": { - "description": "AWS Access Key ID", + "description": "AWS Access Key ID.", "example": "AKIAIOSFODNN7EXAMPLE", "type": "string" }, "secret_access_key": { - "description": "AWS Secret Access Key", + "description": "AWS Secret Access Key.", "example": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY", "minLength": 1, "type": "string", @@ -4091,14 +4093,14 @@ "type": "object" }, { - "description": "AWS Authentication config for role-based account", + "description": "AWS Authentication config to integrate your account using an IAM role.", "properties": { "external_id": { - "description": "AWS IAM External ID for associated role", + "description": "AWS IAM External ID for associated role.", "type": "string" }, "role_name": { - "description": "AWS IAM Role name", + "description": "AWS IAM Role name.", "example": "DatadogIntegrationRole", "maxLength": 576, "minLength": 1, @@ -4113,13 +4115,12 @@ ] }, "aws_account_id": { - "description": "AWS Account ID", + "description": "AWS Account ID.", "example": "123456789012", "type": "string" }, "aws_partition": { - "default": "aws", - "description": "AWS Account partition", + "description": "AWS partition your AWS account is scoped to. Defaults to `aws`.\nSee [Partitions](https://docs.aws.amazon.com/whitepapers/latest/aws-fault-isolation-boundaries/partitions.html) in the AWS documentation for more information.", "enum": [ "aws", "aws-cn", @@ -4134,14 +4135,14 @@ ] }, "aws_regions": { - "description": "AWS Regions to collect data from", + "description": "AWS Regions to collect data from. Defaults to `include_all`.", "oneOf": [ { - "description": "Include all regions", + "description": "Include all regions. Defaults to `true`.", "properties": { "include_all": { - "description": "Include all regions", - "example": false, + "description": "Include all regions.", + "example": true, "type": "boolean" } }, @@ -4150,10 +4151,10 @@ ] }, { - "description": "Include only these regions", + "description": "Include only these regions.", "properties": { "include_only": { - "description": "Include only these regions", + "description": "Include only these regions.", "example": [ "us-east-1" ], @@ -4171,13 +4172,13 @@ ] }, "logs_config": { - "description": "AWS Logs config", + "description": "AWS Logs Collection config.", "properties": { "lambda_forwarder": { - "description": "AWS Lambda forwarder", + "description": "Log Autosubscription configuration for Datadog Forwarder Lambda functions. Automatically set up triggers for existing\nand new logs for some services, ensuring no logs from new resources are missed and saving time spent on manual configuration.", "properties": { "lambdas": { - "description": "List of Datadog Lambda Log Forwarder ARNs", + "description": "List of Datadog Lambda Log Forwarder ARNs in your AWS account. Defaults to `[]`.", "items": { "example": "arn:aws:lambda:us-east-1:123456789012:function:DatadogLambdaLogForwarder", "type": "string" @@ -4185,7 +4186,7 @@ "type": "array" }, "sources": { - "description": "List of AWS services that will send logs to the Datadog Lambda Log Forwarder", + "description": "List of service IDs set to enable automatic log collection. Discover the list of available services with the\n[Get list of AWS log ready services](https://docs.datadoghq.com/api/latest/aws-logs-integration/#get-list-of-aws-log-ready-services) endpoint.", "items": { "example": "s3", "type": "string" @@ -4199,41 +4200,42 @@ "type": "object" }, "metrics_config": { - "description": "AWS Metrics config", + "description": "AWS Metrics Collection config.", "properties": { "automute_enabled": { - "description": "Enable EC2 automute for AWS metrics", + "description": "Enable EC2 automute for AWS metrics. Defaults to `true`.", "example": true, "type": "boolean" }, "collect_cloudwatch_alarms": { - "description": "Enable CloudWatch alarms collection", - "example": true, + "description": "Enable CloudWatch alarms collection. Defaults to `false`.", + "example": false, "type": "boolean" }, "collect_custom_metrics": { - "description": "Enable custom metrics collection", - "example": true, + "description": "Enable custom metrics collection. Defaults to `false`.", + "example": false, "type": "boolean" }, "enabled": { - "description": "Enable AWS metrics collection", + "description": "Enable AWS metrics collection. Defaults to `true`.", "example": true, "type": "boolean" }, "namespace_filters": { - "description": "AWS Metrics namespace filters", + "description": "AWS Metrics namespace filters. Defaults to `exclude_only`.", "oneOf": [ { - "description": "Exclude only these namespaces", + "description": "Exclude only these namespaces from metrics collection. Defaults to `[\"AWS/SQS\", \"AWS/ElasticMapReduce\"]`.\n`AWS/SQS` and `AWS/ElasticMapReduce` are excluded by default to reduce your AWS CloudWatch costs from `GetMetricData` API calls.", "properties": { "exclude_only": { - "description": "Exclude only these namespaces", + "description": "Exclude only these namespaces from metrics collection. Defaults to `[\"AWS/SQS\", \"AWS/ElasticMapReduce\"]`.\n`AWS/SQS` and `AWS/ElasticMapReduce` are excluded by default to reduce your AWS CloudWatch costs from `GetMetricData` API calls.", "example": [ - "AWS/EC2" + "AWS/SQS", + "AWS/ElasticMapReduce" ], "items": { - "example": "AWS/EC2", + "example": "AWS/SQS", "type": "string" }, "type": "array" @@ -4244,10 +4246,10 @@ ] }, { - "description": "Include only these namespaces", + "description": "Include only these namespaces.", "properties": { "include_only": { - "description": "Include only these namespaces", + "description": "Include only these namespaces.", "example": [ "AWS/EC2" ], @@ -4265,19 +4267,20 @@ ] }, "tag_filters": { - "description": "AWS Metrics tag filters list", + "description": "AWS Metrics collection tag filters list. Defaults to `[]`.", "items": { - "description": "AWS Metrics tag filters", + "description": "AWS Metrics Collection tag filters list. Defaults to `[]`.\nThe array of custom AWS resource tags (in the form `key:value`) defines a filter that Datadog uses when collecting metrics from a specified service.\nWildcards, such as `?` (match a single character) and `*` (match multiple characters), and exclusion using `!` before the tag are supported.\nFor EC2, only hosts that match one of the defined tags will be imported into Datadog. The rest will be ignored.\nFor example, `env:production,instance-type:c?.*,!region:us-east-1`.", "properties": { "namespace": { - "description": "The AWS Namespace to apply the tag filters against", + "description": "The AWS service for which the tag filters defined in `tags` will be applied.", "example": "AWS/EC2", "type": "string" }, "tags": { - "description": "The tags to filter based on", + "description": "The AWS resource tags to filter on for the service specified by `namespace`.", "items": { - "example": "key:value", + "description": "Tag in the form `key:value`.", + "example": "datadog:true", "type": "string" }, "nullable": true, @@ -4292,32 +4295,32 @@ "type": "object" }, "resources_config": { - "description": "AWS Resources config", + "description": "AWS Resources Collection config.", "properties": { "cloud_security_posture_management_collection": { - "description": "Whether Datadog collects cloud security posture management resources from your AWS account.", + "description": "Enable Cloud Security Management to scan AWS resources for vulnerabilities, misconfigurations, identity risks, and compliance violations. Defaults to `false`. Requires `extended_collection` to be set to `true`.", "example": false, "type": "boolean" }, "extended_collection": { - "description": "Whether Datadog collects additional attributes and configuration information about the resources in your AWS account. Required for `cspm_resource_collection`.", - "example": false, + "description": "Whether Datadog collects additional attributes and configuration information about the resources in your AWS account. Defaults to `true`. Required for `cloud_security_posture_management_collection`.", + "example": true, "type": "boolean" } }, "type": "object" }, "traces_config": { - "description": "AWS Traces config", + "description": "AWS Traces Collection config.", "properties": { "xray_services": { - "description": "AWS X-Ray services to collect traces from", + "description": "AWS X-Ray services to collect traces from. Defaults to `include_only`.", "oneOf": [ { - "description": "Include all services", + "description": "Include all services.", "properties": { "include_all": { - "description": "Include all services", + "description": "Include all services.", "example": false, "type": "boolean" } @@ -4327,11 +4330,11 @@ ] }, { - "description": "Include only these services", + "description": "Include only these services. Defaults to `[]`.", "nullable": true, "properties": { "include_only": { - "description": "Include only these services", + "description": "Include only these services.", "example": [ "AWS/AppSync" ], @@ -4379,13 +4382,12 @@ "type": "object" }, "AWSAccountID": { - "description": "AWS Account ID", + "description": "AWS Account ID.", "example": "123456789012", "type": "string" }, "AWSAccountPartition": { - "default": "aws", - "description": "AWS Account partition", + "description": "AWS partition your AWS account is scoped to. Defaults to `aws`.\nSee [Partitions](https://docs.aws.amazon.com/whitepapers/latest/aws-fault-isolation-boundaries/partitions.html) in the AWS documentation for more information.", "enum": [ "aws", "aws-cn", @@ -4400,37 +4402,37 @@ ] }, "AWSAccountResponse": { - "description": "AWS Account response body", + "description": "AWS Account response body.", "properties": { "data": { - "description": "AWS Account Response body", + "description": "AWS Account response data.", "properties": { "attributes": { - "description": "The AWS Account Integration Config", + "description": "AWS Account response attributes.", "properties": { "account_tags": { - "description": "Tags to apply to all metrics in the account", + "description": "Tags to apply to all hosts and metrics reporting for this account. Defaults to `[]`.", "items": { - "description": "Tag to apply to all metrics in the account", - "example": "key:value", + "description": "Tag in the form `key:value`.", + "example": "env:prod", "type": "string" }, "nullable": true, "type": "array" }, "auth_config": { - "description": "AWS Authentication config", + "description": "AWS Authentication config.", "oneOf": [ { - "description": "AWS Authentication config for key-based account", + "description": "AWS Authentication config to integrate your account using an access key pair.", "properties": { "access_key_id": { - "description": "AWS Access Key ID", + "description": "AWS Access Key ID.", "example": "AKIAIOSFODNN7EXAMPLE", "type": "string" }, "secret_access_key": { - "description": "AWS Secret Access Key", + "description": "AWS Secret Access Key.", "example": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY", "minLength": 1, "type": "string", @@ -4443,14 +4445,14 @@ "type": "object" }, { - "description": "AWS Authentication config for role-based account", + "description": "AWS Authentication config to integrate your account using an IAM role.", "properties": { "external_id": { - "description": "AWS IAM External ID for associated role", + "description": "AWS IAM External ID for associated role.", "type": "string" }, "role_name": { - "description": "AWS IAM Role name", + "description": "AWS IAM Role name.", "example": "DatadogIntegrationRole", "maxLength": 576, "minLength": 1, @@ -4465,13 +4467,12 @@ ] }, "aws_account_id": { - "description": "AWS Account ID", + "description": "AWS Account ID.", "example": "123456789012", "type": "string" }, "aws_partition": { - "default": "aws", - "description": "AWS Account partition", + "description": "AWS partition your AWS account is scoped to. Defaults to `aws`.\nSee [Partitions](https://docs.aws.amazon.com/whitepapers/latest/aws-fault-isolation-boundaries/partitions.html) in the AWS documentation for more information.", "enum": [ "aws", "aws-cn", @@ -4486,14 +4487,14 @@ ] }, "aws_regions": { - "description": "AWS Regions to collect data from", + "description": "AWS Regions to collect data from. Defaults to `include_all`.", "oneOf": [ { - "description": "Include all regions", + "description": "Include all regions. Defaults to `true`.", "properties": { "include_all": { - "description": "Include all regions", - "example": false, + "description": "Include all regions.", + "example": true, "type": "boolean" } }, @@ -4502,10 +4503,10 @@ ] }, { - "description": "Include only these regions", + "description": "Include only these regions.", "properties": { "include_only": { - "description": "Include only these regions", + "description": "Include only these regions.", "example": [ "us-east-1" ], @@ -4523,19 +4524,19 @@ ] }, "created_at": { - "description": "Timestamp of when the account integration was created", + "description": "Timestamp of when the account integration was created.", "format": "date-time", "readOnly": true, "type": "string" }, "logs_config": { - "description": "AWS Logs config", + "description": "AWS Logs Collection config.", "properties": { "lambda_forwarder": { - "description": "AWS Lambda forwarder", + "description": "Log Autosubscription configuration for Datadog Forwarder Lambda functions. Automatically set up triggers for existing\nand new logs for some services, ensuring no logs from new resources are missed and saving time spent on manual configuration.", "properties": { "lambdas": { - "description": "List of Datadog Lambda Log Forwarder ARNs", + "description": "List of Datadog Lambda Log Forwarder ARNs in your AWS account. Defaults to `[]`.", "items": { "example": "arn:aws:lambda:us-east-1:123456789012:function:DatadogLambdaLogForwarder", "type": "string" @@ -4543,7 +4544,7 @@ "type": "array" }, "sources": { - "description": "List of AWS services that will send logs to the Datadog Lambda Log Forwarder", + "description": "List of service IDs set to enable automatic log collection. Discover the list of available services with the\n[Get list of AWS log ready services](https://docs.datadoghq.com/api/latest/aws-logs-integration/#get-list-of-aws-log-ready-services) endpoint.", "items": { "example": "s3", "type": "string" @@ -4557,41 +4558,42 @@ "type": "object" }, "metrics_config": { - "description": "AWS Metrics config", + "description": "AWS Metrics Collection config.", "properties": { "automute_enabled": { - "description": "Enable EC2 automute for AWS metrics", + "description": "Enable EC2 automute for AWS metrics. Defaults to `true`.", "example": true, "type": "boolean" }, "collect_cloudwatch_alarms": { - "description": "Enable CloudWatch alarms collection", - "example": true, + "description": "Enable CloudWatch alarms collection. Defaults to `false`.", + "example": false, "type": "boolean" }, "collect_custom_metrics": { - "description": "Enable custom metrics collection", - "example": true, + "description": "Enable custom metrics collection. Defaults to `false`.", + "example": false, "type": "boolean" }, "enabled": { - "description": "Enable AWS metrics collection", + "description": "Enable AWS metrics collection. Defaults to `true`.", "example": true, "type": "boolean" }, "namespace_filters": { - "description": "AWS Metrics namespace filters", + "description": "AWS Metrics namespace filters. Defaults to `exclude_only`.", "oneOf": [ { - "description": "Exclude only these namespaces", + "description": "Exclude only these namespaces from metrics collection. Defaults to `[\"AWS/SQS\", \"AWS/ElasticMapReduce\"]`.\n`AWS/SQS` and `AWS/ElasticMapReduce` are excluded by default to reduce your AWS CloudWatch costs from `GetMetricData` API calls.", "properties": { "exclude_only": { - "description": "Exclude only these namespaces", + "description": "Exclude only these namespaces from metrics collection. Defaults to `[\"AWS/SQS\", \"AWS/ElasticMapReduce\"]`.\n`AWS/SQS` and `AWS/ElasticMapReduce` are excluded by default to reduce your AWS CloudWatch costs from `GetMetricData` API calls.", "example": [ - "AWS/EC2" + "AWS/SQS", + "AWS/ElasticMapReduce" ], "items": { - "example": "AWS/EC2", + "example": "AWS/SQS", "type": "string" }, "type": "array" @@ -4602,10 +4604,10 @@ ] }, { - "description": "Include only these namespaces", + "description": "Include only these namespaces.", "properties": { "include_only": { - "description": "Include only these namespaces", + "description": "Include only these namespaces.", "example": [ "AWS/EC2" ], @@ -4623,19 +4625,20 @@ ] }, "tag_filters": { - "description": "AWS Metrics tag filters list", + "description": "AWS Metrics collection tag filters list. Defaults to `[]`.", "items": { - "description": "AWS Metrics tag filters", + "description": "AWS Metrics Collection tag filters list. Defaults to `[]`.\nThe array of custom AWS resource tags (in the form `key:value`) defines a filter that Datadog uses when collecting metrics from a specified service.\nWildcards, such as `?` (match a single character) and `*` (match multiple characters), and exclusion using `!` before the tag are supported.\nFor EC2, only hosts that match one of the defined tags will be imported into Datadog. The rest will be ignored.\nFor example, `env:production,instance-type:c?.*,!region:us-east-1`.", "properties": { "namespace": { - "description": "The AWS Namespace to apply the tag filters against", + "description": "The AWS service for which the tag filters defined in `tags` will be applied.", "example": "AWS/EC2", "type": "string" }, "tags": { - "description": "The tags to filter based on", + "description": "The AWS resource tags to filter on for the service specified by `namespace`.", "items": { - "example": "key:value", + "description": "Tag in the form `key:value`.", + "example": "datadog:true", "type": "string" }, "nullable": true, @@ -4650,38 +4653,38 @@ "type": "object" }, "modified_at": { - "description": "Timestamp of when the account integration was updated", + "description": "Timestamp of when the account integration was updated.", "format": "date-time", "readOnly": true, "type": "string" }, "resources_config": { - "description": "AWS Resources config", + "description": "AWS Resources Collection config.", "properties": { "cloud_security_posture_management_collection": { - "description": "Whether Datadog collects cloud security posture management resources from your AWS account.", + "description": "Enable Cloud Security Management to scan AWS resources for vulnerabilities, misconfigurations, identity risks, and compliance violations. Defaults to `false`. Requires `extended_collection` to be set to `true`.", "example": false, "type": "boolean" }, "extended_collection": { - "description": "Whether Datadog collects additional attributes and configuration information about the resources in your AWS account. Required for `cspm_resource_collection`.", - "example": false, + "description": "Whether Datadog collects additional attributes and configuration information about the resources in your AWS account. Defaults to `true`. Required for `cloud_security_posture_management_collection`.", + "example": true, "type": "boolean" } }, "type": "object" }, "traces_config": { - "description": "AWS Traces config", + "description": "AWS Traces Collection config.", "properties": { "xray_services": { - "description": "AWS X-Ray services to collect traces from", + "description": "AWS X-Ray services to collect traces from. Defaults to `include_only`.", "oneOf": [ { - "description": "Include all services", + "description": "Include all services.", "properties": { "include_all": { - "description": "Include all services", + "description": "Include all services.", "example": false, "type": "boolean" } @@ -4691,11 +4694,11 @@ ] }, { - "description": "Include only these services", + "description": "Include only these services. Defaults to `[]`.", "nullable": true, "properties": { "include_only": { - "description": "Include only these services", + "description": "Include only these services.", "example": [ "AWS/AppSync" ], @@ -4722,7 +4725,7 @@ "type": "object" }, "id": { - "description": "Unique Datadog ID of the AWS Account Integration Config", + "description": "Unique Datadog ID of the AWS Account Integration Config.\nTo get the config ID for an account, use the [List all AWS integrations](https://docs.datadoghq.com/api/latest/aws-integration/#list-all-aws-integrations)\nendpoint and query by AWS Account ID.", "example": "00000000-abcd-0001-0000-000000000000", "type": "string" }, @@ -4752,31 +4755,31 @@ "type": "object" }, "AWSAccountResponseAttributes": { - "description": "The AWS Account Integration Config", + "description": "AWS Account response attributes.", "properties": { "account_tags": { - "description": "Tags to apply to all metrics in the account", + "description": "Tags to apply to all hosts and metrics reporting for this account. Defaults to `[]`.", "items": { - "description": "Tag to apply to all metrics in the account", - "example": "key:value", + "description": "Tag in the form `key:value`.", + "example": "env:prod", "type": "string" }, "nullable": true, "type": "array" }, "auth_config": { - "description": "AWS Authentication config", + "description": "AWS Authentication config.", "oneOf": [ { - "description": "AWS Authentication config for key-based account", + "description": "AWS Authentication config to integrate your account using an access key pair.", "properties": { "access_key_id": { - "description": "AWS Access Key ID", + "description": "AWS Access Key ID.", "example": "AKIAIOSFODNN7EXAMPLE", "type": "string" }, "secret_access_key": { - "description": "AWS Secret Access Key", + "description": "AWS Secret Access Key.", "example": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY", "minLength": 1, "type": "string", @@ -4789,14 +4792,14 @@ "type": "object" }, { - "description": "AWS Authentication config for role-based account", + "description": "AWS Authentication config to integrate your account using an IAM role.", "properties": { "external_id": { - "description": "AWS IAM External ID for associated role", + "description": "AWS IAM External ID for associated role.", "type": "string" }, "role_name": { - "description": "AWS IAM Role name", + "description": "AWS IAM Role name.", "example": "DatadogIntegrationRole", "maxLength": 576, "minLength": 1, @@ -4811,13 +4814,12 @@ ] }, "aws_account_id": { - "description": "AWS Account ID", + "description": "AWS Account ID.", "example": "123456789012", "type": "string" }, "aws_partition": { - "default": "aws", - "description": "AWS Account partition", + "description": "AWS partition your AWS account is scoped to. Defaults to `aws`.\nSee [Partitions](https://docs.aws.amazon.com/whitepapers/latest/aws-fault-isolation-boundaries/partitions.html) in the AWS documentation for more information.", "enum": [ "aws", "aws-cn", @@ -4832,14 +4834,14 @@ ] }, "aws_regions": { - "description": "AWS Regions to collect data from", + "description": "AWS Regions to collect data from. Defaults to `include_all`.", "oneOf": [ { - "description": "Include all regions", + "description": "Include all regions. Defaults to `true`.", "properties": { "include_all": { - "description": "Include all regions", - "example": false, + "description": "Include all regions.", + "example": true, "type": "boolean" } }, @@ -4848,10 +4850,10 @@ ] }, { - "description": "Include only these regions", + "description": "Include only these regions.", "properties": { "include_only": { - "description": "Include only these regions", + "description": "Include only these regions.", "example": [ "us-east-1" ], @@ -4869,19 +4871,19 @@ ] }, "created_at": { - "description": "Timestamp of when the account integration was created", + "description": "Timestamp of when the account integration was created.", "format": "date-time", "readOnly": true, "type": "string" }, "logs_config": { - "description": "AWS Logs config", + "description": "AWS Logs Collection config.", "properties": { "lambda_forwarder": { - "description": "AWS Lambda forwarder", + "description": "Log Autosubscription configuration for Datadog Forwarder Lambda functions. Automatically set up triggers for existing\nand new logs for some services, ensuring no logs from new resources are missed and saving time spent on manual configuration.", "properties": { "lambdas": { - "description": "List of Datadog Lambda Log Forwarder ARNs", + "description": "List of Datadog Lambda Log Forwarder ARNs in your AWS account. Defaults to `[]`.", "items": { "example": "arn:aws:lambda:us-east-1:123456789012:function:DatadogLambdaLogForwarder", "type": "string" @@ -4889,7 +4891,7 @@ "type": "array" }, "sources": { - "description": "List of AWS services that will send logs to the Datadog Lambda Log Forwarder", + "description": "List of service IDs set to enable automatic log collection. Discover the list of available services with the\n[Get list of AWS log ready services](https://docs.datadoghq.com/api/latest/aws-logs-integration/#get-list-of-aws-log-ready-services) endpoint.", "items": { "example": "s3", "type": "string" @@ -4903,41 +4905,42 @@ "type": "object" }, "metrics_config": { - "description": "AWS Metrics config", + "description": "AWS Metrics Collection config.", "properties": { "automute_enabled": { - "description": "Enable EC2 automute for AWS metrics", + "description": "Enable EC2 automute for AWS metrics. Defaults to `true`.", "example": true, "type": "boolean" }, "collect_cloudwatch_alarms": { - "description": "Enable CloudWatch alarms collection", - "example": true, + "description": "Enable CloudWatch alarms collection. Defaults to `false`.", + "example": false, "type": "boolean" }, "collect_custom_metrics": { - "description": "Enable custom metrics collection", - "example": true, + "description": "Enable custom metrics collection. Defaults to `false`.", + "example": false, "type": "boolean" }, "enabled": { - "description": "Enable AWS metrics collection", + "description": "Enable AWS metrics collection. Defaults to `true`.", "example": true, "type": "boolean" }, "namespace_filters": { - "description": "AWS Metrics namespace filters", + "description": "AWS Metrics namespace filters. Defaults to `exclude_only`.", "oneOf": [ { - "description": "Exclude only these namespaces", + "description": "Exclude only these namespaces from metrics collection. Defaults to `[\"AWS/SQS\", \"AWS/ElasticMapReduce\"]`.\n`AWS/SQS` and `AWS/ElasticMapReduce` are excluded by default to reduce your AWS CloudWatch costs from `GetMetricData` API calls.", "properties": { "exclude_only": { - "description": "Exclude only these namespaces", + "description": "Exclude only these namespaces from metrics collection. Defaults to `[\"AWS/SQS\", \"AWS/ElasticMapReduce\"]`.\n`AWS/SQS` and `AWS/ElasticMapReduce` are excluded by default to reduce your AWS CloudWatch costs from `GetMetricData` API calls.", "example": [ - "AWS/EC2" + "AWS/SQS", + "AWS/ElasticMapReduce" ], "items": { - "example": "AWS/EC2", + "example": "AWS/SQS", "type": "string" }, "type": "array" @@ -4948,10 +4951,10 @@ ] }, { - "description": "Include only these namespaces", + "description": "Include only these namespaces.", "properties": { "include_only": { - "description": "Include only these namespaces", + "description": "Include only these namespaces.", "example": [ "AWS/EC2" ], @@ -4969,19 +4972,20 @@ ] }, "tag_filters": { - "description": "AWS Metrics tag filters list", + "description": "AWS Metrics collection tag filters list. Defaults to `[]`.", "items": { - "description": "AWS Metrics tag filters", + "description": "AWS Metrics Collection tag filters list. Defaults to `[]`.\nThe array of custom AWS resource tags (in the form `key:value`) defines a filter that Datadog uses when collecting metrics from a specified service.\nWildcards, such as `?` (match a single character) and `*` (match multiple characters), and exclusion using `!` before the tag are supported.\nFor EC2, only hosts that match one of the defined tags will be imported into Datadog. The rest will be ignored.\nFor example, `env:production,instance-type:c?.*,!region:us-east-1`.", "properties": { "namespace": { - "description": "The AWS Namespace to apply the tag filters against", + "description": "The AWS service for which the tag filters defined in `tags` will be applied.", "example": "AWS/EC2", "type": "string" }, "tags": { - "description": "The tags to filter based on", + "description": "The AWS resource tags to filter on for the service specified by `namespace`.", "items": { - "example": "key:value", + "description": "Tag in the form `key:value`.", + "example": "datadog:true", "type": "string" }, "nullable": true, @@ -4996,38 +5000,38 @@ "type": "object" }, "modified_at": { - "description": "Timestamp of when the account integration was updated", + "description": "Timestamp of when the account integration was updated.", "format": "date-time", "readOnly": true, "type": "string" }, "resources_config": { - "description": "AWS Resources config", + "description": "AWS Resources Collection config.", "properties": { "cloud_security_posture_management_collection": { - "description": "Whether Datadog collects cloud security posture management resources from your AWS account.", + "description": "Enable Cloud Security Management to scan AWS resources for vulnerabilities, misconfigurations, identity risks, and compliance violations. Defaults to `false`. Requires `extended_collection` to be set to `true`.", "example": false, "type": "boolean" }, "extended_collection": { - "description": "Whether Datadog collects additional attributes and configuration information about the resources in your AWS account. Required for `cspm_resource_collection`.", - "example": false, + "description": "Whether Datadog collects additional attributes and configuration information about the resources in your AWS account. Defaults to `true`. Required for `cloud_security_posture_management_collection`.", + "example": true, "type": "boolean" } }, "type": "object" }, "traces_config": { - "description": "AWS Traces config", + "description": "AWS Traces Collection config.", "properties": { "xray_services": { - "description": "AWS X-Ray services to collect traces from", + "description": "AWS X-Ray services to collect traces from. Defaults to `include_only`.", "oneOf": [ { - "description": "Include all services", + "description": "Include all services.", "properties": { "include_all": { - "description": "Include all services", + "description": "Include all services.", "example": false, "type": "boolean" } @@ -5037,11 +5041,11 @@ ] }, { - "description": "Include only these services", + "description": "Include only these services. Defaults to `[]`.", "nullable": true, "properties": { "include_only": { - "description": "Include only these services", + "description": "Include only these services.", "example": [ "AWS/AppSync" ], @@ -5068,34 +5072,34 @@ "type": "object" }, "AWSAccountResponseData": { - "description": "AWS Account Response body", + "description": "AWS Account response data.", "properties": { "attributes": { - "description": "The AWS Account Integration Config", + "description": "AWS Account response attributes.", "properties": { "account_tags": { - "description": "Tags to apply to all metrics in the account", + "description": "Tags to apply to all hosts and metrics reporting for this account. Defaults to `[]`.", "items": { - "description": "Tag to apply to all metrics in the account", - "example": "key:value", + "description": "Tag in the form `key:value`.", + "example": "env:prod", "type": "string" }, "nullable": true, "type": "array" }, "auth_config": { - "description": "AWS Authentication config", + "description": "AWS Authentication config.", "oneOf": [ { - "description": "AWS Authentication config for key-based account", + "description": "AWS Authentication config to integrate your account using an access key pair.", "properties": { "access_key_id": { - "description": "AWS Access Key ID", + "description": "AWS Access Key ID.", "example": "AKIAIOSFODNN7EXAMPLE", "type": "string" }, "secret_access_key": { - "description": "AWS Secret Access Key", + "description": "AWS Secret Access Key.", "example": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY", "minLength": 1, "type": "string", @@ -5108,14 +5112,14 @@ "type": "object" }, { - "description": "AWS Authentication config for role-based account", + "description": "AWS Authentication config to integrate your account using an IAM role.", "properties": { "external_id": { - "description": "AWS IAM External ID for associated role", + "description": "AWS IAM External ID for associated role.", "type": "string" }, "role_name": { - "description": "AWS IAM Role name", + "description": "AWS IAM Role name.", "example": "DatadogIntegrationRole", "maxLength": 576, "minLength": 1, @@ -5130,13 +5134,12 @@ ] }, "aws_account_id": { - "description": "AWS Account ID", + "description": "AWS Account ID.", "example": "123456789012", "type": "string" }, "aws_partition": { - "default": "aws", - "description": "AWS Account partition", + "description": "AWS partition your AWS account is scoped to. Defaults to `aws`.\nSee [Partitions](https://docs.aws.amazon.com/whitepapers/latest/aws-fault-isolation-boundaries/partitions.html) in the AWS documentation for more information.", "enum": [ "aws", "aws-cn", @@ -5151,14 +5154,14 @@ ] }, "aws_regions": { - "description": "AWS Regions to collect data from", + "description": "AWS Regions to collect data from. Defaults to `include_all`.", "oneOf": [ { - "description": "Include all regions", + "description": "Include all regions. Defaults to `true`.", "properties": { "include_all": { - "description": "Include all regions", - "example": false, + "description": "Include all regions.", + "example": true, "type": "boolean" } }, @@ -5167,10 +5170,10 @@ ] }, { - "description": "Include only these regions", + "description": "Include only these regions.", "properties": { "include_only": { - "description": "Include only these regions", + "description": "Include only these regions.", "example": [ "us-east-1" ], @@ -5188,19 +5191,19 @@ ] }, "created_at": { - "description": "Timestamp of when the account integration was created", + "description": "Timestamp of when the account integration was created.", "format": "date-time", "readOnly": true, "type": "string" }, "logs_config": { - "description": "AWS Logs config", + "description": "AWS Logs Collection config.", "properties": { "lambda_forwarder": { - "description": "AWS Lambda forwarder", + "description": "Log Autosubscription configuration for Datadog Forwarder Lambda functions. Automatically set up triggers for existing\nand new logs for some services, ensuring no logs from new resources are missed and saving time spent on manual configuration.", "properties": { "lambdas": { - "description": "List of Datadog Lambda Log Forwarder ARNs", + "description": "List of Datadog Lambda Log Forwarder ARNs in your AWS account. Defaults to `[]`.", "items": { "example": "arn:aws:lambda:us-east-1:123456789012:function:DatadogLambdaLogForwarder", "type": "string" @@ -5208,7 +5211,7 @@ "type": "array" }, "sources": { - "description": "List of AWS services that will send logs to the Datadog Lambda Log Forwarder", + "description": "List of service IDs set to enable automatic log collection. Discover the list of available services with the\n[Get list of AWS log ready services](https://docs.datadoghq.com/api/latest/aws-logs-integration/#get-list-of-aws-log-ready-services) endpoint.", "items": { "example": "s3", "type": "string" @@ -5222,41 +5225,42 @@ "type": "object" }, "metrics_config": { - "description": "AWS Metrics config", + "description": "AWS Metrics Collection config.", "properties": { "automute_enabled": { - "description": "Enable EC2 automute for AWS metrics", + "description": "Enable EC2 automute for AWS metrics. Defaults to `true`.", "example": true, "type": "boolean" }, "collect_cloudwatch_alarms": { - "description": "Enable CloudWatch alarms collection", - "example": true, + "description": "Enable CloudWatch alarms collection. Defaults to `false`.", + "example": false, "type": "boolean" }, "collect_custom_metrics": { - "description": "Enable custom metrics collection", - "example": true, + "description": "Enable custom metrics collection. Defaults to `false`.", + "example": false, "type": "boolean" }, "enabled": { - "description": "Enable AWS metrics collection", + "description": "Enable AWS metrics collection. Defaults to `true`.", "example": true, "type": "boolean" }, "namespace_filters": { - "description": "AWS Metrics namespace filters", + "description": "AWS Metrics namespace filters. Defaults to `exclude_only`.", "oneOf": [ { - "description": "Exclude only these namespaces", + "description": "Exclude only these namespaces from metrics collection. Defaults to `[\"AWS/SQS\", \"AWS/ElasticMapReduce\"]`.\n`AWS/SQS` and `AWS/ElasticMapReduce` are excluded by default to reduce your AWS CloudWatch costs from `GetMetricData` API calls.", "properties": { "exclude_only": { - "description": "Exclude only these namespaces", + "description": "Exclude only these namespaces from metrics collection. Defaults to `[\"AWS/SQS\", \"AWS/ElasticMapReduce\"]`.\n`AWS/SQS` and `AWS/ElasticMapReduce` are excluded by default to reduce your AWS CloudWatch costs from `GetMetricData` API calls.", "example": [ - "AWS/EC2" + "AWS/SQS", + "AWS/ElasticMapReduce" ], "items": { - "example": "AWS/EC2", + "example": "AWS/SQS", "type": "string" }, "type": "array" @@ -5267,10 +5271,10 @@ ] }, { - "description": "Include only these namespaces", + "description": "Include only these namespaces.", "properties": { "include_only": { - "description": "Include only these namespaces", + "description": "Include only these namespaces.", "example": [ "AWS/EC2" ], @@ -5288,19 +5292,20 @@ ] }, "tag_filters": { - "description": "AWS Metrics tag filters list", + "description": "AWS Metrics collection tag filters list. Defaults to `[]`.", "items": { - "description": "AWS Metrics tag filters", + "description": "AWS Metrics Collection tag filters list. Defaults to `[]`.\nThe array of custom AWS resource tags (in the form `key:value`) defines a filter that Datadog uses when collecting metrics from a specified service.\nWildcards, such as `?` (match a single character) and `*` (match multiple characters), and exclusion using `!` before the tag are supported.\nFor EC2, only hosts that match one of the defined tags will be imported into Datadog. The rest will be ignored.\nFor example, `env:production,instance-type:c?.*,!region:us-east-1`.", "properties": { "namespace": { - "description": "The AWS Namespace to apply the tag filters against", + "description": "The AWS service for which the tag filters defined in `tags` will be applied.", "example": "AWS/EC2", "type": "string" }, "tags": { - "description": "The tags to filter based on", + "description": "The AWS resource tags to filter on for the service specified by `namespace`.", "items": { - "example": "key:value", + "description": "Tag in the form `key:value`.", + "example": "datadog:true", "type": "string" }, "nullable": true, @@ -5315,38 +5320,38 @@ "type": "object" }, "modified_at": { - "description": "Timestamp of when the account integration was updated", + "description": "Timestamp of when the account integration was updated.", "format": "date-time", "readOnly": true, "type": "string" }, "resources_config": { - "description": "AWS Resources config", + "description": "AWS Resources Collection config.", "properties": { "cloud_security_posture_management_collection": { - "description": "Whether Datadog collects cloud security posture management resources from your AWS account.", + "description": "Enable Cloud Security Management to scan AWS resources for vulnerabilities, misconfigurations, identity risks, and compliance violations. Defaults to `false`. Requires `extended_collection` to be set to `true`.", "example": false, "type": "boolean" }, "extended_collection": { - "description": "Whether Datadog collects additional attributes and configuration information about the resources in your AWS account. Required for `cspm_resource_collection`.", - "example": false, + "description": "Whether Datadog collects additional attributes and configuration information about the resources in your AWS account. Defaults to `true`. Required for `cloud_security_posture_management_collection`.", + "example": true, "type": "boolean" } }, "type": "object" }, "traces_config": { - "description": "AWS Traces config", + "description": "AWS Traces Collection config.", "properties": { "xray_services": { - "description": "AWS X-Ray services to collect traces from", + "description": "AWS X-Ray services to collect traces from. Defaults to `include_only`.", "oneOf": [ { - "description": "Include all services", + "description": "Include all services.", "properties": { "include_all": { - "description": "Include all services", + "description": "Include all services.", "example": false, "type": "boolean" } @@ -5356,11 +5361,11 @@ ] }, { - "description": "Include only these services", + "description": "Include only these services. Defaults to `[]`.", "nullable": true, "properties": { "include_only": { - "description": "Include only these services", + "description": "Include only these services.", "example": [ "AWS/AppSync" ], @@ -5387,7 +5392,7 @@ "type": "object" }, "id": { - "description": "Unique Datadog ID of the AWS Account Integration Config", + "description": "Unique Datadog ID of the AWS Account Integration Config.\nTo get the config ID for an account, use the [List all AWS integrations](https://docs.datadoghq.com/api/latest/aws-integration/#list-all-aws-integrations)\nendpoint and query by AWS Account ID.", "example": "00000000-abcd-0001-0000-000000000000", "type": "string" }, @@ -5411,10 +5416,10 @@ "type": "object" }, "AWSAccountTags": { - "description": "Tags to apply to all metrics in the account", + "description": "Tags to apply to all hosts and metrics reporting for this account. Defaults to `[]`.", "items": { - "description": "Tag to apply to all metrics in the account", - "example": "key:value", + "description": "Tag in the form `key:value`.", + "example": "env:prod", "type": "string" }, "nullable": true, @@ -5433,37 +5438,37 @@ ] }, "AWSAccountUpdateRequest": { - "description": "AWS Account Update Request body", + "description": "AWS Account Update Request body.", "properties": { "data": { - "description": "AWS Account Update Request data", + "description": "AWS Account Update Request data.", "properties": { "attributes": { - "description": "The AWS Account Integration Config to be updated", + "description": "The AWS Account Integration Config to be updated.", "properties": { "account_tags": { - "description": "Tags to apply to all metrics in the account", + "description": "Tags to apply to all hosts and metrics reporting for this account. Defaults to `[]`.", "items": { - "description": "Tag to apply to all metrics in the account", - "example": "key:value", + "description": "Tag in the form `key:value`.", + "example": "env:prod", "type": "string" }, "nullable": true, "type": "array" }, "auth_config": { - "description": "AWS Authentication config", + "description": "AWS Authentication config.", "oneOf": [ { - "description": "AWS Authentication config for key-based account", + "description": "AWS Authentication config to integrate your account using an access key pair.", "properties": { "access_key_id": { - "description": "AWS Access Key ID", + "description": "AWS Access Key ID.", "example": "AKIAIOSFODNN7EXAMPLE", "type": "string" }, "secret_access_key": { - "description": "AWS Secret Access Key", + "description": "AWS Secret Access Key.", "example": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY", "minLength": 1, "type": "string", @@ -5476,14 +5481,14 @@ "type": "object" }, { - "description": "AWS Authentication config for role-based account", + "description": "AWS Authentication config to integrate your account using an IAM role.", "properties": { "external_id": { - "description": "AWS IAM External ID for associated role", + "description": "AWS IAM External ID for associated role.", "type": "string" }, "role_name": { - "description": "AWS IAM Role name", + "description": "AWS IAM Role name.", "example": "DatadogIntegrationRole", "maxLength": 576, "minLength": 1, @@ -5498,13 +5503,12 @@ ] }, "aws_account_id": { - "description": "AWS Account ID", + "description": "AWS Account ID.", "example": "123456789012", "type": "string" }, "aws_partition": { - "default": "aws", - "description": "AWS Account partition", + "description": "AWS partition your AWS account is scoped to. Defaults to `aws`.\nSee [Partitions](https://docs.aws.amazon.com/whitepapers/latest/aws-fault-isolation-boundaries/partitions.html) in the AWS documentation for more information.", "enum": [ "aws", "aws-cn", @@ -5519,14 +5523,14 @@ ] }, "aws_regions": { - "description": "AWS Regions to collect data from", + "description": "AWS Regions to collect data from. Defaults to `include_all`.", "oneOf": [ { - "description": "Include all regions", + "description": "Include all regions. Defaults to `true`.", "properties": { "include_all": { - "description": "Include all regions", - "example": false, + "description": "Include all regions.", + "example": true, "type": "boolean" } }, @@ -5535,10 +5539,10 @@ ] }, { - "description": "Include only these regions", + "description": "Include only these regions.", "properties": { "include_only": { - "description": "Include only these regions", + "description": "Include only these regions.", "example": [ "us-east-1" ], @@ -5556,13 +5560,13 @@ ] }, "logs_config": { - "description": "AWS Logs config", + "description": "AWS Logs Collection config.", "properties": { "lambda_forwarder": { - "description": "AWS Lambda forwarder", + "description": "Log Autosubscription configuration for Datadog Forwarder Lambda functions. Automatically set up triggers for existing\nand new logs for some services, ensuring no logs from new resources are missed and saving time spent on manual configuration.", "properties": { "lambdas": { - "description": "List of Datadog Lambda Log Forwarder ARNs", + "description": "List of Datadog Lambda Log Forwarder ARNs in your AWS account. Defaults to `[]`.", "items": { "example": "arn:aws:lambda:us-east-1:123456789012:function:DatadogLambdaLogForwarder", "type": "string" @@ -5570,7 +5574,7 @@ "type": "array" }, "sources": { - "description": "List of AWS services that will send logs to the Datadog Lambda Log Forwarder", + "description": "List of service IDs set to enable automatic log collection. Discover the list of available services with the\n[Get list of AWS log ready services](https://docs.datadoghq.com/api/latest/aws-logs-integration/#get-list-of-aws-log-ready-services) endpoint.", "items": { "example": "s3", "type": "string" @@ -5584,41 +5588,42 @@ "type": "object" }, "metrics_config": { - "description": "AWS Metrics config", + "description": "AWS Metrics Collection config.", "properties": { "automute_enabled": { - "description": "Enable EC2 automute for AWS metrics", + "description": "Enable EC2 automute for AWS metrics. Defaults to `true`.", "example": true, "type": "boolean" }, "collect_cloudwatch_alarms": { - "description": "Enable CloudWatch alarms collection", - "example": true, + "description": "Enable CloudWatch alarms collection. Defaults to `false`.", + "example": false, "type": "boolean" }, "collect_custom_metrics": { - "description": "Enable custom metrics collection", - "example": true, + "description": "Enable custom metrics collection. Defaults to `false`.", + "example": false, "type": "boolean" }, "enabled": { - "description": "Enable AWS metrics collection", + "description": "Enable AWS metrics collection. Defaults to `true`.", "example": true, "type": "boolean" }, "namespace_filters": { - "description": "AWS Metrics namespace filters", + "description": "AWS Metrics namespace filters. Defaults to `exclude_only`.", "oneOf": [ { - "description": "Exclude only these namespaces", + "description": "Exclude only these namespaces from metrics collection. Defaults to `[\"AWS/SQS\", \"AWS/ElasticMapReduce\"]`.\n`AWS/SQS` and `AWS/ElasticMapReduce` are excluded by default to reduce your AWS CloudWatch costs from `GetMetricData` API calls.", "properties": { "exclude_only": { - "description": "Exclude only these namespaces", + "description": "Exclude only these namespaces from metrics collection. Defaults to `[\"AWS/SQS\", \"AWS/ElasticMapReduce\"]`.\n`AWS/SQS` and `AWS/ElasticMapReduce` are excluded by default to reduce your AWS CloudWatch costs from `GetMetricData` API calls.", "example": [ - "AWS/EC2" + "AWS/SQS", + "AWS/ElasticMapReduce" ], "items": { - "example": "AWS/EC2", + "example": "AWS/SQS", "type": "string" }, "type": "array" @@ -5629,10 +5634,10 @@ ] }, { - "description": "Include only these namespaces", + "description": "Include only these namespaces.", "properties": { "include_only": { - "description": "Include only these namespaces", + "description": "Include only these namespaces.", "example": [ "AWS/EC2" ], @@ -5650,19 +5655,20 @@ ] }, "tag_filters": { - "description": "AWS Metrics tag filters list", + "description": "AWS Metrics collection tag filters list. Defaults to `[]`.", "items": { - "description": "AWS Metrics tag filters", + "description": "AWS Metrics Collection tag filters list. Defaults to `[]`.\nThe array of custom AWS resource tags (in the form `key:value`) defines a filter that Datadog uses when collecting metrics from a specified service.\nWildcards, such as `?` (match a single character) and `*` (match multiple characters), and exclusion using `!` before the tag are supported.\nFor EC2, only hosts that match one of the defined tags will be imported into Datadog. The rest will be ignored.\nFor example, `env:production,instance-type:c?.*,!region:us-east-1`.", "properties": { "namespace": { - "description": "The AWS Namespace to apply the tag filters against", + "description": "The AWS service for which the tag filters defined in `tags` will be applied.", "example": "AWS/EC2", "type": "string" }, "tags": { - "description": "The tags to filter based on", + "description": "The AWS resource tags to filter on for the service specified by `namespace`.", "items": { - "example": "key:value", + "description": "Tag in the form `key:value`.", + "example": "datadog:true", "type": "string" }, "nullable": true, @@ -5677,32 +5683,32 @@ "type": "object" }, "resources_config": { - "description": "AWS Resources config", + "description": "AWS Resources Collection config.", "properties": { "cloud_security_posture_management_collection": { - "description": "Whether Datadog collects cloud security posture management resources from your AWS account.", + "description": "Enable Cloud Security Management to scan AWS resources for vulnerabilities, misconfigurations, identity risks, and compliance violations. Defaults to `false`. Requires `extended_collection` to be set to `true`.", "example": false, "type": "boolean" }, "extended_collection": { - "description": "Whether Datadog collects additional attributes and configuration information about the resources in your AWS account. Required for `cspm_resource_collection`.", - "example": false, + "description": "Whether Datadog collects additional attributes and configuration information about the resources in your AWS account. Defaults to `true`. Required for `cloud_security_posture_management_collection`.", + "example": true, "type": "boolean" } }, "type": "object" }, "traces_config": { - "description": "AWS Traces config", + "description": "AWS Traces Collection config.", "properties": { "xray_services": { - "description": "AWS X-Ray services to collect traces from", + "description": "AWS X-Ray services to collect traces from. Defaults to `include_only`.", "oneOf": [ { - "description": "Include all services", + "description": "Include all services.", "properties": { "include_all": { - "description": "Include all services", + "description": "Include all services.", "example": false, "type": "boolean" } @@ -5712,11 +5718,11 @@ ] }, { - "description": "Include only these services", + "description": "Include only these services. Defaults to `[]`.", "nullable": true, "properties": { "include_only": { - "description": "Include only these services", + "description": "Include only these services.", "example": [ "AWS/AppSync" ], @@ -5743,7 +5749,7 @@ "type": "object" }, "id": { - "description": "Unique Datadog ID of the AWS Account Integration Config", + "description": "Unique Datadog ID of the AWS Account Integration Config.\nTo get the config ID for an account, use the [List all AWS integrations](https://docs.datadoghq.com/api/latest/aws-integration/#list-all-aws-integrations)\nendpoint and query by AWS Account ID.", "example": "00000000-abcd-0001-0000-000000000000", "type": "string" }, @@ -5773,31 +5779,31 @@ "type": "object" }, "AWSAccountUpdateRequestAttributes": { - "description": "The AWS Account Integration Config to be updated", + "description": "The AWS Account Integration Config to be updated.", "properties": { "account_tags": { - "description": "Tags to apply to all metrics in the account", + "description": "Tags to apply to all hosts and metrics reporting for this account. Defaults to `[]`.", "items": { - "description": "Tag to apply to all metrics in the account", - "example": "key:value", + "description": "Tag in the form `key:value`.", + "example": "env:prod", "type": "string" }, "nullable": true, "type": "array" }, "auth_config": { - "description": "AWS Authentication config", + "description": "AWS Authentication config.", "oneOf": [ { - "description": "AWS Authentication config for key-based account", + "description": "AWS Authentication config to integrate your account using an access key pair.", "properties": { "access_key_id": { - "description": "AWS Access Key ID", + "description": "AWS Access Key ID.", "example": "AKIAIOSFODNN7EXAMPLE", "type": "string" }, "secret_access_key": { - "description": "AWS Secret Access Key", + "description": "AWS Secret Access Key.", "example": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY", "minLength": 1, "type": "string", @@ -5810,14 +5816,14 @@ "type": "object" }, { - "description": "AWS Authentication config for role-based account", + "description": "AWS Authentication config to integrate your account using an IAM role.", "properties": { "external_id": { - "description": "AWS IAM External ID for associated role", + "description": "AWS IAM External ID for associated role.", "type": "string" }, "role_name": { - "description": "AWS IAM Role name", + "description": "AWS IAM Role name.", "example": "DatadogIntegrationRole", "maxLength": 576, "minLength": 1, @@ -5832,13 +5838,12 @@ ] }, "aws_account_id": { - "description": "AWS Account ID", + "description": "AWS Account ID.", "example": "123456789012", "type": "string" }, "aws_partition": { - "default": "aws", - "description": "AWS Account partition", + "description": "AWS partition your AWS account is scoped to. Defaults to `aws`.\nSee [Partitions](https://docs.aws.amazon.com/whitepapers/latest/aws-fault-isolation-boundaries/partitions.html) in the AWS documentation for more information.", "enum": [ "aws", "aws-cn", @@ -5853,14 +5858,14 @@ ] }, "aws_regions": { - "description": "AWS Regions to collect data from", + "description": "AWS Regions to collect data from. Defaults to `include_all`.", "oneOf": [ { - "description": "Include all regions", + "description": "Include all regions. Defaults to `true`.", "properties": { "include_all": { - "description": "Include all regions", - "example": false, + "description": "Include all regions.", + "example": true, "type": "boolean" } }, @@ -5869,10 +5874,10 @@ ] }, { - "description": "Include only these regions", + "description": "Include only these regions.", "properties": { "include_only": { - "description": "Include only these regions", + "description": "Include only these regions.", "example": [ "us-east-1" ], @@ -5890,13 +5895,13 @@ ] }, "logs_config": { - "description": "AWS Logs config", + "description": "AWS Logs Collection config.", "properties": { "lambda_forwarder": { - "description": "AWS Lambda forwarder", + "description": "Log Autosubscription configuration for Datadog Forwarder Lambda functions. Automatically set up triggers for existing\nand new logs for some services, ensuring no logs from new resources are missed and saving time spent on manual configuration.", "properties": { "lambdas": { - "description": "List of Datadog Lambda Log Forwarder ARNs", + "description": "List of Datadog Lambda Log Forwarder ARNs in your AWS account. Defaults to `[]`.", "items": { "example": "arn:aws:lambda:us-east-1:123456789012:function:DatadogLambdaLogForwarder", "type": "string" @@ -5904,7 +5909,7 @@ "type": "array" }, "sources": { - "description": "List of AWS services that will send logs to the Datadog Lambda Log Forwarder", + "description": "List of service IDs set to enable automatic log collection. Discover the list of available services with the\n[Get list of AWS log ready services](https://docs.datadoghq.com/api/latest/aws-logs-integration/#get-list-of-aws-log-ready-services) endpoint.", "items": { "example": "s3", "type": "string" @@ -5918,41 +5923,42 @@ "type": "object" }, "metrics_config": { - "description": "AWS Metrics config", + "description": "AWS Metrics Collection config.", "properties": { "automute_enabled": { - "description": "Enable EC2 automute for AWS metrics", + "description": "Enable EC2 automute for AWS metrics. Defaults to `true`.", "example": true, "type": "boolean" }, "collect_cloudwatch_alarms": { - "description": "Enable CloudWatch alarms collection", - "example": true, + "description": "Enable CloudWatch alarms collection. Defaults to `false`.", + "example": false, "type": "boolean" }, "collect_custom_metrics": { - "description": "Enable custom metrics collection", - "example": true, + "description": "Enable custom metrics collection. Defaults to `false`.", + "example": false, "type": "boolean" }, "enabled": { - "description": "Enable AWS metrics collection", + "description": "Enable AWS metrics collection. Defaults to `true`.", "example": true, "type": "boolean" }, "namespace_filters": { - "description": "AWS Metrics namespace filters", + "description": "AWS Metrics namespace filters. Defaults to `exclude_only`.", "oneOf": [ { - "description": "Exclude only these namespaces", + "description": "Exclude only these namespaces from metrics collection. Defaults to `[\"AWS/SQS\", \"AWS/ElasticMapReduce\"]`.\n`AWS/SQS` and `AWS/ElasticMapReduce` are excluded by default to reduce your AWS CloudWatch costs from `GetMetricData` API calls.", "properties": { "exclude_only": { - "description": "Exclude only these namespaces", + "description": "Exclude only these namespaces from metrics collection. Defaults to `[\"AWS/SQS\", \"AWS/ElasticMapReduce\"]`.\n`AWS/SQS` and `AWS/ElasticMapReduce` are excluded by default to reduce your AWS CloudWatch costs from `GetMetricData` API calls.", "example": [ - "AWS/EC2" + "AWS/SQS", + "AWS/ElasticMapReduce" ], "items": { - "example": "AWS/EC2", + "example": "AWS/SQS", "type": "string" }, "type": "array" @@ -5963,10 +5969,10 @@ ] }, { - "description": "Include only these namespaces", + "description": "Include only these namespaces.", "properties": { "include_only": { - "description": "Include only these namespaces", + "description": "Include only these namespaces.", "example": [ "AWS/EC2" ], @@ -5984,19 +5990,20 @@ ] }, "tag_filters": { - "description": "AWS Metrics tag filters list", + "description": "AWS Metrics collection tag filters list. Defaults to `[]`.", "items": { - "description": "AWS Metrics tag filters", + "description": "AWS Metrics Collection tag filters list. Defaults to `[]`.\nThe array of custom AWS resource tags (in the form `key:value`) defines a filter that Datadog uses when collecting metrics from a specified service.\nWildcards, such as `?` (match a single character) and `*` (match multiple characters), and exclusion using `!` before the tag are supported.\nFor EC2, only hosts that match one of the defined tags will be imported into Datadog. The rest will be ignored.\nFor example, `env:production,instance-type:c?.*,!region:us-east-1`.", "properties": { "namespace": { - "description": "The AWS Namespace to apply the tag filters against", + "description": "The AWS service for which the tag filters defined in `tags` will be applied.", "example": "AWS/EC2", "type": "string" }, "tags": { - "description": "The tags to filter based on", + "description": "The AWS resource tags to filter on for the service specified by `namespace`.", "items": { - "example": "key:value", + "description": "Tag in the form `key:value`.", + "example": "datadog:true", "type": "string" }, "nullable": true, @@ -6011,32 +6018,32 @@ "type": "object" }, "resources_config": { - "description": "AWS Resources config", + "description": "AWS Resources Collection config.", "properties": { "cloud_security_posture_management_collection": { - "description": "Whether Datadog collects cloud security posture management resources from your AWS account.", + "description": "Enable Cloud Security Management to scan AWS resources for vulnerabilities, misconfigurations, identity risks, and compliance violations. Defaults to `false`. Requires `extended_collection` to be set to `true`.", "example": false, "type": "boolean" }, "extended_collection": { - "description": "Whether Datadog collects additional attributes and configuration information about the resources in your AWS account. Required for `cspm_resource_collection`.", - "example": false, + "description": "Whether Datadog collects additional attributes and configuration information about the resources in your AWS account. Defaults to `true`. Required for `cloud_security_posture_management_collection`.", + "example": true, "type": "boolean" } }, "type": "object" }, "traces_config": { - "description": "AWS Traces config", + "description": "AWS Traces Collection config.", "properties": { "xray_services": { - "description": "AWS X-Ray services to collect traces from", + "description": "AWS X-Ray services to collect traces from. Defaults to `include_only`.", "oneOf": [ { - "description": "Include all services", + "description": "Include all services.", "properties": { "include_all": { - "description": "Include all services", + "description": "Include all services.", "example": false, "type": "boolean" } @@ -6046,11 +6053,11 @@ ] }, { - "description": "Include only these services", + "description": "Include only these services. Defaults to `[]`.", "nullable": true, "properties": { "include_only": { - "description": "Include only these services", + "description": "Include only these services.", "example": [ "AWS/AppSync" ], @@ -6077,34 +6084,34 @@ "type": "object" }, "AWSAccountUpdateRequestData": { - "description": "AWS Account Update Request data", + "description": "AWS Account Update Request data.", "properties": { "attributes": { - "description": "The AWS Account Integration Config to be updated", + "description": "The AWS Account Integration Config to be updated.", "properties": { "account_tags": { - "description": "Tags to apply to all metrics in the account", + "description": "Tags to apply to all hosts and metrics reporting for this account. Defaults to `[]`.", "items": { - "description": "Tag to apply to all metrics in the account", - "example": "key:value", + "description": "Tag in the form `key:value`.", + "example": "env:prod", "type": "string" }, "nullable": true, "type": "array" }, "auth_config": { - "description": "AWS Authentication config", + "description": "AWS Authentication config.", "oneOf": [ { - "description": "AWS Authentication config for key-based account", + "description": "AWS Authentication config to integrate your account using an access key pair.", "properties": { "access_key_id": { - "description": "AWS Access Key ID", + "description": "AWS Access Key ID.", "example": "AKIAIOSFODNN7EXAMPLE", "type": "string" }, "secret_access_key": { - "description": "AWS Secret Access Key", + "description": "AWS Secret Access Key.", "example": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY", "minLength": 1, "type": "string", @@ -6117,14 +6124,14 @@ "type": "object" }, { - "description": "AWS Authentication config for role-based account", + "description": "AWS Authentication config to integrate your account using an IAM role.", "properties": { "external_id": { - "description": "AWS IAM External ID for associated role", + "description": "AWS IAM External ID for associated role.", "type": "string" }, "role_name": { - "description": "AWS IAM Role name", + "description": "AWS IAM Role name.", "example": "DatadogIntegrationRole", "maxLength": 576, "minLength": 1, @@ -6139,13 +6146,12 @@ ] }, "aws_account_id": { - "description": "AWS Account ID", + "description": "AWS Account ID.", "example": "123456789012", "type": "string" }, "aws_partition": { - "default": "aws", - "description": "AWS Account partition", + "description": "AWS partition your AWS account is scoped to. Defaults to `aws`.\nSee [Partitions](https://docs.aws.amazon.com/whitepapers/latest/aws-fault-isolation-boundaries/partitions.html) in the AWS documentation for more information.", "enum": [ "aws", "aws-cn", @@ -6160,14 +6166,14 @@ ] }, "aws_regions": { - "description": "AWS Regions to collect data from", + "description": "AWS Regions to collect data from. Defaults to `include_all`.", "oneOf": [ { - "description": "Include all regions", + "description": "Include all regions. Defaults to `true`.", "properties": { "include_all": { - "description": "Include all regions", - "example": false, + "description": "Include all regions.", + "example": true, "type": "boolean" } }, @@ -6176,10 +6182,10 @@ ] }, { - "description": "Include only these regions", + "description": "Include only these regions.", "properties": { "include_only": { - "description": "Include only these regions", + "description": "Include only these regions.", "example": [ "us-east-1" ], @@ -6197,13 +6203,13 @@ ] }, "logs_config": { - "description": "AWS Logs config", + "description": "AWS Logs Collection config.", "properties": { "lambda_forwarder": { - "description": "AWS Lambda forwarder", + "description": "Log Autosubscription configuration for Datadog Forwarder Lambda functions. Automatically set up triggers for existing\nand new logs for some services, ensuring no logs from new resources are missed and saving time spent on manual configuration.", "properties": { "lambdas": { - "description": "List of Datadog Lambda Log Forwarder ARNs", + "description": "List of Datadog Lambda Log Forwarder ARNs in your AWS account. Defaults to `[]`.", "items": { "example": "arn:aws:lambda:us-east-1:123456789012:function:DatadogLambdaLogForwarder", "type": "string" @@ -6211,7 +6217,7 @@ "type": "array" }, "sources": { - "description": "List of AWS services that will send logs to the Datadog Lambda Log Forwarder", + "description": "List of service IDs set to enable automatic log collection. Discover the list of available services with the\n[Get list of AWS log ready services](https://docs.datadoghq.com/api/latest/aws-logs-integration/#get-list-of-aws-log-ready-services) endpoint.", "items": { "example": "s3", "type": "string" @@ -6225,41 +6231,42 @@ "type": "object" }, "metrics_config": { - "description": "AWS Metrics config", + "description": "AWS Metrics Collection config.", "properties": { "automute_enabled": { - "description": "Enable EC2 automute for AWS metrics", + "description": "Enable EC2 automute for AWS metrics. Defaults to `true`.", "example": true, "type": "boolean" }, "collect_cloudwatch_alarms": { - "description": "Enable CloudWatch alarms collection", - "example": true, + "description": "Enable CloudWatch alarms collection. Defaults to `false`.", + "example": false, "type": "boolean" }, "collect_custom_metrics": { - "description": "Enable custom metrics collection", - "example": true, + "description": "Enable custom metrics collection. Defaults to `false`.", + "example": false, "type": "boolean" }, "enabled": { - "description": "Enable AWS metrics collection", + "description": "Enable AWS metrics collection. Defaults to `true`.", "example": true, "type": "boolean" }, "namespace_filters": { - "description": "AWS Metrics namespace filters", + "description": "AWS Metrics namespace filters. Defaults to `exclude_only`.", "oneOf": [ { - "description": "Exclude only these namespaces", + "description": "Exclude only these namespaces from metrics collection. Defaults to `[\"AWS/SQS\", \"AWS/ElasticMapReduce\"]`.\n`AWS/SQS` and `AWS/ElasticMapReduce` are excluded by default to reduce your AWS CloudWatch costs from `GetMetricData` API calls.", "properties": { "exclude_only": { - "description": "Exclude only these namespaces", + "description": "Exclude only these namespaces from metrics collection. Defaults to `[\"AWS/SQS\", \"AWS/ElasticMapReduce\"]`.\n`AWS/SQS` and `AWS/ElasticMapReduce` are excluded by default to reduce your AWS CloudWatch costs from `GetMetricData` API calls.", "example": [ - "AWS/EC2" + "AWS/SQS", + "AWS/ElasticMapReduce" ], "items": { - "example": "AWS/EC2", + "example": "AWS/SQS", "type": "string" }, "type": "array" @@ -6270,10 +6277,10 @@ ] }, { - "description": "Include only these namespaces", + "description": "Include only these namespaces.", "properties": { "include_only": { - "description": "Include only these namespaces", + "description": "Include only these namespaces.", "example": [ "AWS/EC2" ], @@ -6291,19 +6298,20 @@ ] }, "tag_filters": { - "description": "AWS Metrics tag filters list", + "description": "AWS Metrics collection tag filters list. Defaults to `[]`.", "items": { - "description": "AWS Metrics tag filters", + "description": "AWS Metrics Collection tag filters list. Defaults to `[]`.\nThe array of custom AWS resource tags (in the form `key:value`) defines a filter that Datadog uses when collecting metrics from a specified service.\nWildcards, such as `?` (match a single character) and `*` (match multiple characters), and exclusion using `!` before the tag are supported.\nFor EC2, only hosts that match one of the defined tags will be imported into Datadog. The rest will be ignored.\nFor example, `env:production,instance-type:c?.*,!region:us-east-1`.", "properties": { "namespace": { - "description": "The AWS Namespace to apply the tag filters against", + "description": "The AWS service for which the tag filters defined in `tags` will be applied.", "example": "AWS/EC2", "type": "string" }, "tags": { - "description": "The tags to filter based on", + "description": "The AWS resource tags to filter on for the service specified by `namespace`.", "items": { - "example": "key:value", + "description": "Tag in the form `key:value`.", + "example": "datadog:true", "type": "string" }, "nullable": true, @@ -6318,32 +6326,32 @@ "type": "object" }, "resources_config": { - "description": "AWS Resources config", + "description": "AWS Resources Collection config.", "properties": { "cloud_security_posture_management_collection": { - "description": "Whether Datadog collects cloud security posture management resources from your AWS account.", + "description": "Enable Cloud Security Management to scan AWS resources for vulnerabilities, misconfigurations, identity risks, and compliance violations. Defaults to `false`. Requires `extended_collection` to be set to `true`.", "example": false, "type": "boolean" }, "extended_collection": { - "description": "Whether Datadog collects additional attributes and configuration information about the resources in your AWS account. Required for `cspm_resource_collection`.", - "example": false, + "description": "Whether Datadog collects additional attributes and configuration information about the resources in your AWS account. Defaults to `true`. Required for `cloud_security_posture_management_collection`.", + "example": true, "type": "boolean" } }, "type": "object" }, "traces_config": { - "description": "AWS Traces config", + "description": "AWS Traces Collection config.", "properties": { "xray_services": { - "description": "AWS X-Ray services to collect traces from", + "description": "AWS X-Ray services to collect traces from. Defaults to `include_only`.", "oneOf": [ { - "description": "Include all services", + "description": "Include all services.", "properties": { "include_all": { - "description": "Include all services", + "description": "Include all services.", "example": false, "type": "boolean" } @@ -6353,11 +6361,11 @@ ] }, { - "description": "Include only these services", + "description": "Include only these services. Defaults to `[]`.", "nullable": true, "properties": { "include_only": { - "description": "Include only these services", + "description": "Include only these services.", "example": [ "AWS/AppSync" ], @@ -6384,7 +6392,7 @@ "type": "object" }, "id": { - "description": "Unique Datadog ID of the AWS Account Integration Config", + "description": "Unique Datadog ID of the AWS Account Integration Config.\nTo get the config ID for an account, use the [List all AWS integrations](https://docs.datadoghq.com/api/latest/aws-integration/#list-all-aws-integrations)\nendpoint and query by AWS Account ID.", "example": "00000000-abcd-0001-0000-000000000000", "type": "string" }, @@ -6408,39 +6416,39 @@ "type": "object" }, "AWSAccountsResponse": { - "description": "AWS Accounts response body", + "description": "AWS Accounts response body.", "properties": { "data": { - "description": "List of AWS Account Integration Configs", + "description": "List of AWS Account Integration Configs.", "items": { - "description": "AWS Account Response body", + "description": "AWS Account response data.", "properties": { "attributes": { - "description": "The AWS Account Integration Config", + "description": "AWS Account response attributes.", "properties": { "account_tags": { - "description": "Tags to apply to all metrics in the account", + "description": "Tags to apply to all hosts and metrics reporting for this account. Defaults to `[]`.", "items": { - "description": "Tag to apply to all metrics in the account", - "example": "key:value", + "description": "Tag in the form `key:value`.", + "example": "env:prod", "type": "string" }, "nullable": true, "type": "array" }, "auth_config": { - "description": "AWS Authentication config", + "description": "AWS Authentication config.", "oneOf": [ { - "description": "AWS Authentication config for key-based account", + "description": "AWS Authentication config to integrate your account using an access key pair.", "properties": { "access_key_id": { - "description": "AWS Access Key ID", + "description": "AWS Access Key ID.", "example": "AKIAIOSFODNN7EXAMPLE", "type": "string" }, "secret_access_key": { - "description": "AWS Secret Access Key", + "description": "AWS Secret Access Key.", "example": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY", "minLength": 1, "type": "string", @@ -6453,14 +6461,14 @@ "type": "object" }, { - "description": "AWS Authentication config for role-based account", + "description": "AWS Authentication config to integrate your account using an IAM role.", "properties": { "external_id": { - "description": "AWS IAM External ID for associated role", + "description": "AWS IAM External ID for associated role.", "type": "string" }, "role_name": { - "description": "AWS IAM Role name", + "description": "AWS IAM Role name.", "example": "DatadogIntegrationRole", "maxLength": 576, "minLength": 1, @@ -6475,13 +6483,12 @@ ] }, "aws_account_id": { - "description": "AWS Account ID", + "description": "AWS Account ID.", "example": "123456789012", "type": "string" }, "aws_partition": { - "default": "aws", - "description": "AWS Account partition", + "description": "AWS partition your AWS account is scoped to. Defaults to `aws`.\nSee [Partitions](https://docs.aws.amazon.com/whitepapers/latest/aws-fault-isolation-boundaries/partitions.html) in the AWS documentation for more information.", "enum": [ "aws", "aws-cn", @@ -6496,14 +6503,14 @@ ] }, "aws_regions": { - "description": "AWS Regions to collect data from", + "description": "AWS Regions to collect data from. Defaults to `include_all`.", "oneOf": [ { - "description": "Include all regions", + "description": "Include all regions. Defaults to `true`.", "properties": { "include_all": { - "description": "Include all regions", - "example": false, + "description": "Include all regions.", + "example": true, "type": "boolean" } }, @@ -6512,10 +6519,10 @@ ] }, { - "description": "Include only these regions", + "description": "Include only these regions.", "properties": { "include_only": { - "description": "Include only these regions", + "description": "Include only these regions.", "example": [ "us-east-1" ], @@ -6533,19 +6540,19 @@ ] }, "created_at": { - "description": "Timestamp of when the account integration was created", + "description": "Timestamp of when the account integration was created.", "format": "date-time", "readOnly": true, "type": "string" }, "logs_config": { - "description": "AWS Logs config", + "description": "AWS Logs Collection config.", "properties": { "lambda_forwarder": { - "description": "AWS Lambda forwarder", + "description": "Log Autosubscription configuration for Datadog Forwarder Lambda functions. Automatically set up triggers for existing\nand new logs for some services, ensuring no logs from new resources are missed and saving time spent on manual configuration.", "properties": { "lambdas": { - "description": "List of Datadog Lambda Log Forwarder ARNs", + "description": "List of Datadog Lambda Log Forwarder ARNs in your AWS account. Defaults to `[]`.", "items": { "example": "arn:aws:lambda:us-east-1:123456789012:function:DatadogLambdaLogForwarder", "type": "string" @@ -6553,7 +6560,7 @@ "type": "array" }, "sources": { - "description": "List of AWS services that will send logs to the Datadog Lambda Log Forwarder", + "description": "List of service IDs set to enable automatic log collection. Discover the list of available services with the\n[Get list of AWS log ready services](https://docs.datadoghq.com/api/latest/aws-logs-integration/#get-list-of-aws-log-ready-services) endpoint.", "items": { "example": "s3", "type": "string" @@ -6567,41 +6574,42 @@ "type": "object" }, "metrics_config": { - "description": "AWS Metrics config", + "description": "AWS Metrics Collection config.", "properties": { "automute_enabled": { - "description": "Enable EC2 automute for AWS metrics", + "description": "Enable EC2 automute for AWS metrics. Defaults to `true`.", "example": true, "type": "boolean" }, "collect_cloudwatch_alarms": { - "description": "Enable CloudWatch alarms collection", - "example": true, + "description": "Enable CloudWatch alarms collection. Defaults to `false`.", + "example": false, "type": "boolean" }, "collect_custom_metrics": { - "description": "Enable custom metrics collection", - "example": true, + "description": "Enable custom metrics collection. Defaults to `false`.", + "example": false, "type": "boolean" }, "enabled": { - "description": "Enable AWS metrics collection", + "description": "Enable AWS metrics collection. Defaults to `true`.", "example": true, "type": "boolean" }, "namespace_filters": { - "description": "AWS Metrics namespace filters", + "description": "AWS Metrics namespace filters. Defaults to `exclude_only`.", "oneOf": [ { - "description": "Exclude only these namespaces", + "description": "Exclude only these namespaces from metrics collection. Defaults to `[\"AWS/SQS\", \"AWS/ElasticMapReduce\"]`.\n`AWS/SQS` and `AWS/ElasticMapReduce` are excluded by default to reduce your AWS CloudWatch costs from `GetMetricData` API calls.", "properties": { "exclude_only": { - "description": "Exclude only these namespaces", + "description": "Exclude only these namespaces from metrics collection. Defaults to `[\"AWS/SQS\", \"AWS/ElasticMapReduce\"]`.\n`AWS/SQS` and `AWS/ElasticMapReduce` are excluded by default to reduce your AWS CloudWatch costs from `GetMetricData` API calls.", "example": [ - "AWS/EC2" + "AWS/SQS", + "AWS/ElasticMapReduce" ], "items": { - "example": "AWS/EC2", + "example": "AWS/SQS", "type": "string" }, "type": "array" @@ -6612,10 +6620,10 @@ ] }, { - "description": "Include only these namespaces", + "description": "Include only these namespaces.", "properties": { "include_only": { - "description": "Include only these namespaces", + "description": "Include only these namespaces.", "example": [ "AWS/EC2" ], @@ -6633,19 +6641,20 @@ ] }, "tag_filters": { - "description": "AWS Metrics tag filters list", + "description": "AWS Metrics collection tag filters list. Defaults to `[]`.", "items": { - "description": "AWS Metrics tag filters", + "description": "AWS Metrics Collection tag filters list. Defaults to `[]`.\nThe array of custom AWS resource tags (in the form `key:value`) defines a filter that Datadog uses when collecting metrics from a specified service.\nWildcards, such as `?` (match a single character) and `*` (match multiple characters), and exclusion using `!` before the tag are supported.\nFor EC2, only hosts that match one of the defined tags will be imported into Datadog. The rest will be ignored.\nFor example, `env:production,instance-type:c?.*,!region:us-east-1`.", "properties": { "namespace": { - "description": "The AWS Namespace to apply the tag filters against", + "description": "The AWS service for which the tag filters defined in `tags` will be applied.", "example": "AWS/EC2", "type": "string" }, "tags": { - "description": "The tags to filter based on", + "description": "The AWS resource tags to filter on for the service specified by `namespace`.", "items": { - "example": "key:value", + "description": "Tag in the form `key:value`.", + "example": "datadog:true", "type": "string" }, "nullable": true, @@ -6660,38 +6669,38 @@ "type": "object" }, "modified_at": { - "description": "Timestamp of when the account integration was updated", + "description": "Timestamp of when the account integration was updated.", "format": "date-time", "readOnly": true, "type": "string" }, "resources_config": { - "description": "AWS Resources config", + "description": "AWS Resources Collection config.", "properties": { "cloud_security_posture_management_collection": { - "description": "Whether Datadog collects cloud security posture management resources from your AWS account.", + "description": "Enable Cloud Security Management to scan AWS resources for vulnerabilities, misconfigurations, identity risks, and compliance violations. Defaults to `false`. Requires `extended_collection` to be set to `true`.", "example": false, "type": "boolean" }, "extended_collection": { - "description": "Whether Datadog collects additional attributes and configuration information about the resources in your AWS account. Required for `cspm_resource_collection`.", - "example": false, + "description": "Whether Datadog collects additional attributes and configuration information about the resources in your AWS account. Defaults to `true`. Required for `cloud_security_posture_management_collection`.", + "example": true, "type": "boolean" } }, "type": "object" }, "traces_config": { - "description": "AWS Traces config", + "description": "AWS Traces Collection config.", "properties": { "xray_services": { - "description": "AWS X-Ray services to collect traces from", + "description": "AWS X-Ray services to collect traces from. Defaults to `include_only`.", "oneOf": [ { - "description": "Include all services", + "description": "Include all services.", "properties": { "include_all": { - "description": "Include all services", + "description": "Include all services.", "example": false, "type": "boolean" } @@ -6701,11 +6710,11 @@ ] }, { - "description": "Include only these services", + "description": "Include only these services. Defaults to `[]`.", "nullable": true, "properties": { "include_only": { - "description": "Include only these services", + "description": "Include only these services.", "example": [ "AWS/AppSync" ], @@ -6732,7 +6741,7 @@ "type": "object" }, "id": { - "description": "Unique Datadog ID of the AWS Account Integration Config", + "description": "Unique Datadog ID of the AWS Account Integration Config.\nTo get the config ID for an account, use the [List all AWS integrations](https://docs.datadoghq.com/api/latest/aws-integration/#list-all-aws-integrations)\nendpoint and query by AWS Account ID.", "example": "00000000-abcd-0001-0000-000000000000", "type": "string" }, @@ -6764,18 +6773,18 @@ "type": "object" }, "AWSAuthConfig": { - "description": "AWS Authentication config", + "description": "AWS Authentication config.", "oneOf": [ { - "description": "AWS Authentication config for key-based account", + "description": "AWS Authentication config to integrate your account using an access key pair.", "properties": { "access_key_id": { - "description": "AWS Access Key ID", + "description": "AWS Access Key ID.", "example": "AKIAIOSFODNN7EXAMPLE", "type": "string" }, "secret_access_key": { - "description": "AWS Secret Access Key", + "description": "AWS Secret Access Key.", "example": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY", "minLength": 1, "type": "string", @@ -6788,14 +6797,14 @@ "type": "object" }, { - "description": "AWS Authentication config for role-based account", + "description": "AWS Authentication config to integrate your account using an IAM role.", "properties": { "external_id": { - "description": "AWS IAM External ID for associated role", + "description": "AWS IAM External ID for associated role.", "type": "string" }, "role_name": { - "description": "AWS IAM Role name", + "description": "AWS IAM Role name.", "example": "DatadogIntegrationRole", "maxLength": 576, "minLength": 1, @@ -6810,15 +6819,15 @@ ] }, "AWSAuthConfigKeys": { - "description": "AWS Authentication config for key-based account", + "description": "AWS Authentication config to integrate your account using an access key pair.", "properties": { "access_key_id": { - "description": "AWS Access Key ID", + "description": "AWS Access Key ID.", "example": "AKIAIOSFODNN7EXAMPLE", "type": "string" }, "secret_access_key": { - "description": "AWS Secret Access Key", + "description": "AWS Secret Access Key.", "example": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY", "minLength": 1, "type": "string", @@ -6831,14 +6840,14 @@ "type": "object" }, "AWSAuthConfigRole": { - "description": "AWS Authentication config for role-based account", + "description": "AWS Authentication config to integrate your account using an IAM role.", "properties": { "external_id": { - "description": "AWS IAM External ID for associated role", + "description": "AWS IAM External ID for associated role.", "type": "string" }, "role_name": { - "description": "AWS IAM Role name", + "description": "AWS IAM Role name.", "example": "DatadogIntegrationRole", "maxLength": 576, "minLength": 1, @@ -6851,10 +6860,10 @@ "type": "object" }, "AWSLambdaForwarderConfig": { - "description": "AWS Lambda forwarder", + "description": "Log Autosubscription configuration for Datadog Forwarder Lambda functions. Automatically set up triggers for existing\nand new logs for some services, ensuring no logs from new resources are missed and saving time spent on manual configuration.", "properties": { "lambdas": { - "description": "List of Datadog Lambda Log Forwarder ARNs", + "description": "List of Datadog Lambda Log Forwarder ARNs in your AWS account. Defaults to `[]`.", "items": { "example": "arn:aws:lambda:us-east-1:123456789012:function:DatadogLambdaLogForwarder", "type": "string" @@ -6862,7 +6871,7 @@ "type": "array" }, "sources": { - "description": "List of AWS services that will send logs to the Datadog Lambda Log Forwarder", + "description": "List of service IDs set to enable automatic log collection. Discover the list of available services with the\n[Get list of AWS log ready services](https://docs.datadoghq.com/api/latest/aws-logs-integration/#get-list-of-aws-log-ready-services) endpoint.", "items": { "example": "s3", "type": "string" @@ -6873,13 +6882,13 @@ "type": "object" }, "AWSLogsConfig": { - "description": "AWS Logs config", + "description": "AWS Logs Collection config.", "properties": { "lambda_forwarder": { - "description": "AWS Lambda forwarder", + "description": "Log Autosubscription configuration for Datadog Forwarder Lambda functions. Automatically set up triggers for existing\nand new logs for some services, ensuring no logs from new resources are missed and saving time spent on manual configuration.", "properties": { "lambdas": { - "description": "List of Datadog Lambda Log Forwarder ARNs", + "description": "List of Datadog Lambda Log Forwarder ARNs in your AWS account. Defaults to `[]`.", "items": { "example": "arn:aws:lambda:us-east-1:123456789012:function:DatadogLambdaLogForwarder", "type": "string" @@ -6887,7 +6896,7 @@ "type": "array" }, "sources": { - "description": "List of AWS services that will send logs to the Datadog Lambda Log Forwarder", + "description": "List of service IDs set to enable automatic log collection. Discover the list of available services with the\n[Get list of AWS log ready services](https://docs.datadoghq.com/api/latest/aws-logs-integration/#get-list-of-aws-log-ready-services) endpoint.", "items": { "example": "s3", "type": "string" @@ -7038,41 +7047,42 @@ ] }, "AWSMetricsConfig": { - "description": "AWS Metrics config", + "description": "AWS Metrics Collection config.", "properties": { "automute_enabled": { - "description": "Enable EC2 automute for AWS metrics", + "description": "Enable EC2 automute for AWS metrics. Defaults to `true`.", "example": true, "type": "boolean" }, "collect_cloudwatch_alarms": { - "description": "Enable CloudWatch alarms collection", - "example": true, + "description": "Enable CloudWatch alarms collection. Defaults to `false`.", + "example": false, "type": "boolean" }, "collect_custom_metrics": { - "description": "Enable custom metrics collection", - "example": true, + "description": "Enable custom metrics collection. Defaults to `false`.", + "example": false, "type": "boolean" }, "enabled": { - "description": "Enable AWS metrics collection", + "description": "Enable AWS metrics collection. Defaults to `true`.", "example": true, "type": "boolean" }, "namespace_filters": { - "description": "AWS Metrics namespace filters", + "description": "AWS Metrics namespace filters. Defaults to `exclude_only`.", "oneOf": [ { - "description": "Exclude only these namespaces", + "description": "Exclude only these namespaces from metrics collection. Defaults to `[\"AWS/SQS\", \"AWS/ElasticMapReduce\"]`.\n`AWS/SQS` and `AWS/ElasticMapReduce` are excluded by default to reduce your AWS CloudWatch costs from `GetMetricData` API calls.", "properties": { "exclude_only": { - "description": "Exclude only these namespaces", + "description": "Exclude only these namespaces from metrics collection. Defaults to `[\"AWS/SQS\", \"AWS/ElasticMapReduce\"]`.\n`AWS/SQS` and `AWS/ElasticMapReduce` are excluded by default to reduce your AWS CloudWatch costs from `GetMetricData` API calls.", "example": [ - "AWS/EC2" + "AWS/SQS", + "AWS/ElasticMapReduce" ], "items": { - "example": "AWS/EC2", + "example": "AWS/SQS", "type": "string" }, "type": "array" @@ -7083,10 +7093,10 @@ ] }, { - "description": "Include only these namespaces", + "description": "Include only these namespaces.", "properties": { "include_only": { - "description": "Include only these namespaces", + "description": "Include only these namespaces.", "example": [ "AWS/EC2" ], @@ -7104,19 +7114,20 @@ ] }, "tag_filters": { - "description": "AWS Metrics tag filters list", + "description": "AWS Metrics collection tag filters list. Defaults to `[]`.", "items": { - "description": "AWS Metrics tag filters", + "description": "AWS Metrics Collection tag filters list. Defaults to `[]`.\nThe array of custom AWS resource tags (in the form `key:value`) defines a filter that Datadog uses when collecting metrics from a specified service.\nWildcards, such as `?` (match a single character) and `*` (match multiple characters), and exclusion using `!` before the tag are supported.\nFor EC2, only hosts that match one of the defined tags will be imported into Datadog. The rest will be ignored.\nFor example, `env:production,instance-type:c?.*,!region:us-east-1`.", "properties": { "namespace": { - "description": "The AWS Namespace to apply the tag filters against", + "description": "The AWS service for which the tag filters defined in `tags` will be applied.", "example": "AWS/EC2", "type": "string" }, "tags": { - "description": "The tags to filter based on", + "description": "The AWS resource tags to filter on for the service specified by `namespace`.", "items": { - "example": "key:value", + "description": "Tag in the form `key:value`.", + "example": "datadog:true", "type": "string" }, "nullable": true, @@ -7131,18 +7142,19 @@ "type": "object" }, "AWSNamespaceFilters": { - "description": "AWS Metrics namespace filters", + "description": "AWS Metrics namespace filters. Defaults to `exclude_only`.", "oneOf": [ { - "description": "Exclude only these namespaces", + "description": "Exclude only these namespaces from metrics collection. Defaults to `[\"AWS/SQS\", \"AWS/ElasticMapReduce\"]`.\n`AWS/SQS` and `AWS/ElasticMapReduce` are excluded by default to reduce your AWS CloudWatch costs from `GetMetricData` API calls.", "properties": { "exclude_only": { - "description": "Exclude only these namespaces", + "description": "Exclude only these namespaces from metrics collection. Defaults to `[\"AWS/SQS\", \"AWS/ElasticMapReduce\"]`.\n`AWS/SQS` and `AWS/ElasticMapReduce` are excluded by default to reduce your AWS CloudWatch costs from `GetMetricData` API calls.", "example": [ - "AWS/EC2" + "AWS/SQS", + "AWS/ElasticMapReduce" ], "items": { - "example": "AWS/EC2", + "example": "AWS/SQS", "type": "string" }, "type": "array" @@ -7153,10 +7165,10 @@ ] }, { - "description": "Include only these namespaces", + "description": "Include only these namespaces.", "properties": { "include_only": { - "description": "Include only these namespaces", + "description": "Include only these namespaces.", "example": [ "AWS/EC2" ], @@ -7174,15 +7186,16 @@ ] }, "AWSNamespaceFiltersExcludeOnly": { - "description": "Exclude only these namespaces", + "description": "Exclude only these namespaces from metrics collection. Defaults to `[\"AWS/SQS\", \"AWS/ElasticMapReduce\"]`.\n`AWS/SQS` and `AWS/ElasticMapReduce` are excluded by default to reduce your AWS CloudWatch costs from `GetMetricData` API calls.", "properties": { "exclude_only": { - "description": "Exclude only these namespaces", + "description": "Exclude only these namespaces from metrics collection. Defaults to `[\"AWS/SQS\", \"AWS/ElasticMapReduce\"]`.\n`AWS/SQS` and `AWS/ElasticMapReduce` are excluded by default to reduce your AWS CloudWatch costs from `GetMetricData` API calls.", "example": [ - "AWS/EC2" + "AWS/SQS", + "AWS/ElasticMapReduce" ], "items": { - "example": "AWS/EC2", + "example": "AWS/SQS", "type": "string" }, "type": "array" @@ -7193,10 +7206,10 @@ ] }, "AWSNamespaceFiltersIncludeOnly": { - "description": "Include only these namespaces", + "description": "Include only these namespaces.", "properties": { "include_only": { - "description": "Include only these namespaces", + "description": "Include only these namespaces.", "example": [ "AWS/EC2" ], @@ -7212,17 +7225,18 @@ ] }, "AWSNamespaceTagFilter": { - "description": "AWS Metrics tag filters", + "description": "AWS Metrics Collection tag filters list. Defaults to `[]`.\nThe array of custom AWS resource tags (in the form `key:value`) defines a filter that Datadog uses when collecting metrics from a specified service.\nWildcards, such as `?` (match a single character) and `*` (match multiple characters), and exclusion using `!` before the tag are supported.\nFor EC2, only hosts that match one of the defined tags will be imported into Datadog. The rest will be ignored.\nFor example, `env:production,instance-type:c?.*,!region:us-east-1`.", "properties": { "namespace": { - "description": "The AWS Namespace to apply the tag filters against", + "description": "The AWS service for which the tag filters defined in `tags` will be applied.", "example": "AWS/EC2", "type": "string" }, "tags": { - "description": "The tags to filter based on", + "description": "The AWS resource tags to filter on for the service specified by `namespace`.", "items": { - "example": "key:value", + "description": "Tag in the form `key:value`.", + "example": "datadog:true", "type": "string" }, "nullable": true, @@ -7232,16 +7246,16 @@ "type": "object" }, "AWSNamespacesResponse": { - "description": "AWS Namespaces response body", + "description": "AWS Namespaces response body.", "properties": { "data": { - "description": "AWS Namespaces response body", + "description": "AWS Namespaces response data.", "properties": { "attributes": { - "description": "AWS Namespaces response body", + "description": "AWS Namespaces response attributes.", "properties": { "namespaces": { - "description": "AWS CloudWatch namespace", + "description": "AWS CloudWatch namespace.", "example": [ "AWS/ApiGateway" ], @@ -7289,10 +7303,10 @@ "type": "object" }, "AWSNamespacesResponseAttributes": { - "description": "AWS Namespaces response body", + "description": "AWS Namespaces response attributes.", "properties": { "namespaces": { - "description": "AWS CloudWatch namespace", + "description": "AWS CloudWatch namespace.", "example": [ "AWS/ApiGateway" ], @@ -7309,13 +7323,13 @@ "type": "object" }, "AWSNamespacesResponseData": { - "description": "AWS Namespaces response body", + "description": "AWS Namespaces response data.", "properties": { "attributes": { - "description": "AWS Namespaces response body", + "description": "AWS Namespaces response attributes.", "properties": { "namespaces": { - "description": "AWS CloudWatch namespace", + "description": "AWS CloudWatch namespace.", "example": [ "AWS/ApiGateway" ], @@ -7369,16 +7383,16 @@ ] }, "AWSNewExternalIDResponse": { - "description": "AWS External ID response body", + "description": "AWS External ID response body.", "properties": { "data": { - "description": "AWS External ID response body", + "description": "AWS External ID response body.", "properties": { "attributes": { - "description": "AWS External ID response body", + "description": "AWS External ID response body.", "properties": { "external_id": { - "description": "AWS IAM External ID for associated role", + "description": "AWS IAM External ID for associated role.", "example": "acb8f6b8a844443dbb726d07dcb1a870", "type": "string" } @@ -7420,10 +7434,10 @@ "type": "object" }, "AWSNewExternalIDResponseAttributes": { - "description": "AWS External ID response body", + "description": "AWS External ID response body.", "properties": { "external_id": { - "description": "AWS IAM External ID for associated role", + "description": "AWS IAM External ID for associated role.", "example": "acb8f6b8a844443dbb726d07dcb1a870", "type": "string" } @@ -7434,13 +7448,13 @@ "type": "object" }, "AWSNewExternalIDResponseData": { - "description": "AWS External ID response body", + "description": "AWS External ID response body.", "properties": { "attributes": { - "description": "AWS External ID response body", + "description": "AWS External ID response body.", "properties": { "external_id": { - "description": "AWS IAM External ID for associated role", + "description": "AWS IAM External ID for associated role.", "example": "acb8f6b8a844443dbb726d07dcb1a870", "type": "string" } @@ -7488,14 +7502,14 @@ ] }, "AWSRegions": { - "description": "AWS Regions to collect data from", + "description": "AWS Regions to collect data from. Defaults to `include_all`.", "oneOf": [ { - "description": "Include all regions", + "description": "Include all regions. Defaults to `true`.", "properties": { "include_all": { - "description": "Include all regions", - "example": false, + "description": "Include all regions.", + "example": true, "type": "boolean" } }, @@ -7504,10 +7518,10 @@ ] }, { - "description": "Include only these regions", + "description": "Include only these regions.", "properties": { "include_only": { - "description": "Include only these regions", + "description": "Include only these regions.", "example": [ "us-east-1" ], @@ -7525,11 +7539,11 @@ ] }, "AWSRegionsIncludeAll": { - "description": "Include all regions", + "description": "Include all regions. Defaults to `true`.", "properties": { "include_all": { - "description": "Include all regions", - "example": false, + "description": "Include all regions.", + "example": true, "type": "boolean" } }, @@ -7538,10 +7552,10 @@ ] }, "AWSRegionsIncludeOnly": { - "description": "Include only these regions", + "description": "Include only these regions.", "properties": { "include_only": { - "description": "Include only these regions", + "description": "Include only these regions.", "example": [ "us-east-1" ], @@ -7557,32 +7571,32 @@ ] }, "AWSResourcesConfig": { - "description": "AWS Resources config", + "description": "AWS Resources Collection config.", "properties": { "cloud_security_posture_management_collection": { - "description": "Whether Datadog collects cloud security posture management resources from your AWS account.", + "description": "Enable Cloud Security Management to scan AWS resources for vulnerabilities, misconfigurations, identity risks, and compliance violations. Defaults to `false`. Requires `extended_collection` to be set to `true`.", "example": false, "type": "boolean" }, "extended_collection": { - "description": "Whether Datadog collects additional attributes and configuration information about the resources in your AWS account. Required for `cspm_resource_collection`.", - "example": false, + "description": "Whether Datadog collects additional attributes and configuration information about the resources in your AWS account. Defaults to `true`. Required for `cloud_security_posture_management_collection`.", + "example": true, "type": "boolean" } }, "type": "object" }, "AWSTracesConfig": { - "description": "AWS Traces config", + "description": "AWS Traces Collection config.", "properties": { "xray_services": { - "description": "AWS X-Ray services to collect traces from", + "description": "AWS X-Ray services to collect traces from. Defaults to `include_only`.", "oneOf": [ { - "description": "Include all services", + "description": "Include all services.", "properties": { "include_all": { - "description": "Include all services", + "description": "Include all services.", "example": false, "type": "boolean" } @@ -7592,11 +7606,11 @@ ] }, { - "description": "Include only these services", + "description": "Include only these services. Defaults to `[]`.", "nullable": true, "properties": { "include_only": { - "description": "Include only these services", + "description": "Include only these services.", "example": [ "AWS/AppSync" ], @@ -184196,10 +184210,10 @@ "type": "object" }, "XRayServicesIncludeAll": { - "description": "Include all services", + "description": "Include all services.", "properties": { "include_all": { - "description": "Include all services", + "description": "Include all services.", "example": false, "type": "boolean" } @@ -184209,11 +184223,11 @@ ] }, "XRayServicesIncludeOnly": { - "description": "Include only these services", + "description": "Include only these services. Defaults to `[]`.", "nullable": true, "properties": { "include_only": { - "description": "Include only these services", + "description": "Include only these services.", "example": [ "AWS/AppSync" ], @@ -184229,13 +184243,13 @@ ] }, "XRayServicesList": { - "description": "AWS X-Ray services to collect traces from", + "description": "AWS X-Ray services to collect traces from. Defaults to `include_only`.", "oneOf": [ { - "description": "Include all services", + "description": "Include all services.", "properties": { "include_all": { - "description": "Include all services", + "description": "Include all services.", "example": false, "type": "boolean" } @@ -184245,11 +184259,11 @@ ] }, { - "description": "Include only these services", + "description": "Include only these services. Defaults to `[]`.", "nullable": true, "properties": { "include_only": { - "description": "Include only these services", + "description": "Include only these services.", "example": [ "AWS/AppSync" ], @@ -246401,7 +246415,7 @@ "operationId": "ListAWSAccounts", "parameters": [ { - "description": "Optional query filter accounts by AWS Account ID", + "description": "Optional query parameter to filter accounts by AWS Account ID. If not provided, all accounts are returned.", "example": "123456789012", "in": "query", "name": "aws_account_id", @@ -246416,39 +246430,39 @@ "content": { "application/json": { "schema": { - "description": "AWS Accounts response body", + "description": "AWS Accounts response body.", "properties": { "data": { - "description": "List of AWS Account Integration Configs", + "description": "List of AWS Account Integration Configs.", "items": { - "description": "AWS Account Response body", + "description": "AWS Account response data.", "properties": { "attributes": { - "description": "The AWS Account Integration Config", + "description": "AWS Account response attributes.", "properties": { "account_tags": { - "description": "Tags to apply to all metrics in the account", + "description": "Tags to apply to all hosts and metrics reporting for this account. Defaults to `[]`.", "items": { - "description": "Tag to apply to all metrics in the account", - "example": "key:value", + "description": "Tag in the form `key:value`.", + "example": "env:prod", "type": "string" }, "nullable": true, "type": "array" }, "auth_config": { - "description": "AWS Authentication config", + "description": "AWS Authentication config.", "oneOf": [ { - "description": "AWS Authentication config for key-based account", + "description": "AWS Authentication config to integrate your account using an access key pair.", "properties": { "access_key_id": { - "description": "AWS Access Key ID", + "description": "AWS Access Key ID.", "example": "AKIAIOSFODNN7EXAMPLE", "type": "string" }, "secret_access_key": { - "description": "AWS Secret Access Key", + "description": "AWS Secret Access Key.", "example": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY", "minLength": 1, "type": "string", @@ -246461,14 +246475,14 @@ "type": "object" }, { - "description": "AWS Authentication config for role-based account", + "description": "AWS Authentication config to integrate your account using an IAM role.", "properties": { "external_id": { - "description": "AWS IAM External ID for associated role", + "description": "AWS IAM External ID for associated role.", "type": "string" }, "role_name": { - "description": "AWS IAM Role name", + "description": "AWS IAM Role name.", "example": "DatadogIntegrationRole", "maxLength": 576, "minLength": 1, @@ -246483,13 +246497,12 @@ ] }, "aws_account_id": { - "description": "AWS Account ID", + "description": "AWS Account ID.", "example": "123456789012", "type": "string" }, "aws_partition": { - "default": "aws", - "description": "AWS Account partition", + "description": "AWS partition your AWS account is scoped to. Defaults to `aws`.\nSee [Partitions](https://docs.aws.amazon.com/whitepapers/latest/aws-fault-isolation-boundaries/partitions.html) in the AWS documentation for more information.", "enum": [ "aws", "aws-cn", @@ -246504,14 +246517,14 @@ ] }, "aws_regions": { - "description": "AWS Regions to collect data from", + "description": "AWS Regions to collect data from. Defaults to `include_all`.", "oneOf": [ { - "description": "Include all regions", + "description": "Include all regions. Defaults to `true`.", "properties": { "include_all": { - "description": "Include all regions", - "example": false, + "description": "Include all regions.", + "example": true, "type": "boolean" } }, @@ -246520,10 +246533,10 @@ ] }, { - "description": "Include only these regions", + "description": "Include only these regions.", "properties": { "include_only": { - "description": "Include only these regions", + "description": "Include only these regions.", "example": [ "us-east-1" ], @@ -246541,19 +246554,19 @@ ] }, "created_at": { - "description": "Timestamp of when the account integration was created", + "description": "Timestamp of when the account integration was created.", "format": "date-time", "readOnly": true, "type": "string" }, "logs_config": { - "description": "AWS Logs config", + "description": "AWS Logs Collection config.", "properties": { "lambda_forwarder": { - "description": "AWS Lambda forwarder", + "description": "Log Autosubscription configuration for Datadog Forwarder Lambda functions. Automatically set up triggers for existing\nand new logs for some services, ensuring no logs from new resources are missed and saving time spent on manual configuration.", "properties": { "lambdas": { - "description": "List of Datadog Lambda Log Forwarder ARNs", + "description": "List of Datadog Lambda Log Forwarder ARNs in your AWS account. Defaults to `[]`.", "items": { "example": "arn:aws:lambda:us-east-1:123456789012:function:DatadogLambdaLogForwarder", "type": "string" @@ -246561,7 +246574,7 @@ "type": "array" }, "sources": { - "description": "List of AWS services that will send logs to the Datadog Lambda Log Forwarder", + "description": "List of service IDs set to enable automatic log collection. Discover the list of available services with the\n[Get list of AWS log ready services](https://docs.datadoghq.com/api/latest/aws-logs-integration/#get-list-of-aws-log-ready-services) endpoint.", "items": { "example": "s3", "type": "string" @@ -246575,41 +246588,42 @@ "type": "object" }, "metrics_config": { - "description": "AWS Metrics config", + "description": "AWS Metrics Collection config.", "properties": { "automute_enabled": { - "description": "Enable EC2 automute for AWS metrics", + "description": "Enable EC2 automute for AWS metrics. Defaults to `true`.", "example": true, "type": "boolean" }, "collect_cloudwatch_alarms": { - "description": "Enable CloudWatch alarms collection", - "example": true, + "description": "Enable CloudWatch alarms collection. Defaults to `false`.", + "example": false, "type": "boolean" }, "collect_custom_metrics": { - "description": "Enable custom metrics collection", - "example": true, + "description": "Enable custom metrics collection. Defaults to `false`.", + "example": false, "type": "boolean" }, "enabled": { - "description": "Enable AWS metrics collection", + "description": "Enable AWS metrics collection. Defaults to `true`.", "example": true, "type": "boolean" }, "namespace_filters": { - "description": "AWS Metrics namespace filters", + "description": "AWS Metrics namespace filters. Defaults to `exclude_only`.", "oneOf": [ { - "description": "Exclude only these namespaces", + "description": "Exclude only these namespaces from metrics collection. Defaults to `[\"AWS/SQS\", \"AWS/ElasticMapReduce\"]`.\n`AWS/SQS` and `AWS/ElasticMapReduce` are excluded by default to reduce your AWS CloudWatch costs from `GetMetricData` API calls.", "properties": { "exclude_only": { - "description": "Exclude only these namespaces", + "description": "Exclude only these namespaces from metrics collection. Defaults to `[\"AWS/SQS\", \"AWS/ElasticMapReduce\"]`.\n`AWS/SQS` and `AWS/ElasticMapReduce` are excluded by default to reduce your AWS CloudWatch costs from `GetMetricData` API calls.", "example": [ - "AWS/EC2" + "AWS/SQS", + "AWS/ElasticMapReduce" ], "items": { - "example": "AWS/EC2", + "example": "AWS/SQS", "type": "string" }, "type": "array" @@ -246620,10 +246634,10 @@ ] }, { - "description": "Include only these namespaces", + "description": "Include only these namespaces.", "properties": { "include_only": { - "description": "Include only these namespaces", + "description": "Include only these namespaces.", "example": [ "AWS/EC2" ], @@ -246641,19 +246655,20 @@ ] }, "tag_filters": { - "description": "AWS Metrics tag filters list", + "description": "AWS Metrics collection tag filters list. Defaults to `[]`.", "items": { - "description": "AWS Metrics tag filters", + "description": "AWS Metrics Collection tag filters list. Defaults to `[]`.\nThe array of custom AWS resource tags (in the form `key:value`) defines a filter that Datadog uses when collecting metrics from a specified service.\nWildcards, such as `?` (match a single character) and `*` (match multiple characters), and exclusion using `!` before the tag are supported.\nFor EC2, only hosts that match one of the defined tags will be imported into Datadog. The rest will be ignored.\nFor example, `env:production,instance-type:c?.*,!region:us-east-1`.", "properties": { "namespace": { - "description": "The AWS Namespace to apply the tag filters against", + "description": "The AWS service for which the tag filters defined in `tags` will be applied.", "example": "AWS/EC2", "type": "string" }, "tags": { - "description": "The tags to filter based on", + "description": "The AWS resource tags to filter on for the service specified by `namespace`.", "items": { - "example": "key:value", + "description": "Tag in the form `key:value`.", + "example": "datadog:true", "type": "string" }, "nullable": true, @@ -246668,38 +246683,38 @@ "type": "object" }, "modified_at": { - "description": "Timestamp of when the account integration was updated", + "description": "Timestamp of when the account integration was updated.", "format": "date-time", "readOnly": true, "type": "string" }, "resources_config": { - "description": "AWS Resources config", + "description": "AWS Resources Collection config.", "properties": { "cloud_security_posture_management_collection": { - "description": "Whether Datadog collects cloud security posture management resources from your AWS account.", + "description": "Enable Cloud Security Management to scan AWS resources for vulnerabilities, misconfigurations, identity risks, and compliance violations. Defaults to `false`. Requires `extended_collection` to be set to `true`.", "example": false, "type": "boolean" }, "extended_collection": { - "description": "Whether Datadog collects additional attributes and configuration information about the resources in your AWS account. Required for `cspm_resource_collection`.", - "example": false, + "description": "Whether Datadog collects additional attributes and configuration information about the resources in your AWS account. Defaults to `true`. Required for `cloud_security_posture_management_collection`.", + "example": true, "type": "boolean" } }, "type": "object" }, "traces_config": { - "description": "AWS Traces config", + "description": "AWS Traces Collection config.", "properties": { "xray_services": { - "description": "AWS X-Ray services to collect traces from", + "description": "AWS X-Ray services to collect traces from. Defaults to `include_only`.", "oneOf": [ { - "description": "Include all services", + "description": "Include all services.", "properties": { "include_all": { - "description": "Include all services", + "description": "Include all services.", "example": false, "type": "boolean" } @@ -246709,11 +246724,11 @@ ] }, { - "description": "Include only these services", + "description": "Include only these services. Defaults to `[]`.", "nullable": true, "properties": { "include_only": { - "description": "Include only these services", + "description": "Include only these services.", "example": [ "AWS/AppSync" ], @@ -246740,7 +246755,7 @@ "type": "object" }, "id": { - "description": "Unique Datadog ID of the AWS Account Integration Config", + "description": "Unique Datadog ID of the AWS Account Integration Config.\nTo get the config ID for an account, use the [List all AWS integrations](https://docs.datadoghq.com/api/latest/aws-integration/#list-all-aws-integrations)\nendpoint and query by AWS Account ID.", "example": "00000000-abcd-0001-0000-000000000000", "type": "string" }, @@ -246846,7 +246861,7 @@ "x-undo": { "type": "safe" }, - "x-unstable": "**Note: This endpoint is in public beta. If you have any feedback,\ncontact [Datadog support](https://docs.datadoghq.com/help/).**" + "x-unstable": "**Note: This endpoint is in Preview. If you have any feedback,\ncontact [Datadog support](https://docs.datadoghq.com/help/).**" }, "post": { "description": "Create a new AWS Account Integration Config.", @@ -246855,37 +246870,37 @@ "content": { "application/json": { "schema": { - "description": "AWS Account Create Request body", + "description": "AWS Account Create Request body.", "properties": { "data": { - "description": "AWS Account Create Request data", + "description": "AWS Account Create Request data.", "properties": { "attributes": { - "description": "The AWS Account Integration Config to be created", + "description": "The AWS Account Integration Config to be created.", "properties": { "account_tags": { - "description": "Tags to apply to all metrics in the account", + "description": "Tags to apply to all hosts and metrics reporting for this account. Defaults to `[]`.", "items": { - "description": "Tag to apply to all metrics in the account", - "example": "key:value", + "description": "Tag in the form `key:value`.", + "example": "env:prod", "type": "string" }, "nullable": true, "type": "array" }, "auth_config": { - "description": "AWS Authentication config", + "description": "AWS Authentication config.", "oneOf": [ { - "description": "AWS Authentication config for key-based account", + "description": "AWS Authentication config to integrate your account using an access key pair.", "properties": { "access_key_id": { - "description": "AWS Access Key ID", + "description": "AWS Access Key ID.", "example": "AKIAIOSFODNN7EXAMPLE", "type": "string" }, "secret_access_key": { - "description": "AWS Secret Access Key", + "description": "AWS Secret Access Key.", "example": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY", "minLength": 1, "type": "string", @@ -246898,14 +246913,14 @@ "type": "object" }, { - "description": "AWS Authentication config for role-based account", + "description": "AWS Authentication config to integrate your account using an IAM role.", "properties": { "external_id": { - "description": "AWS IAM External ID for associated role", + "description": "AWS IAM External ID for associated role.", "type": "string" }, "role_name": { - "description": "AWS IAM Role name", + "description": "AWS IAM Role name.", "example": "DatadogIntegrationRole", "maxLength": 576, "minLength": 1, @@ -246920,13 +246935,12 @@ ] }, "aws_account_id": { - "description": "AWS Account ID", + "description": "AWS Account ID.", "example": "123456789012", "type": "string" }, "aws_partition": { - "default": "aws", - "description": "AWS Account partition", + "description": "AWS partition your AWS account is scoped to. Defaults to `aws`.\nSee [Partitions](https://docs.aws.amazon.com/whitepapers/latest/aws-fault-isolation-boundaries/partitions.html) in the AWS documentation for more information.", "enum": [ "aws", "aws-cn", @@ -246941,14 +246955,14 @@ ] }, "aws_regions": { - "description": "AWS Regions to collect data from", + "description": "AWS Regions to collect data from. Defaults to `include_all`.", "oneOf": [ { - "description": "Include all regions", + "description": "Include all regions. Defaults to `true`.", "properties": { "include_all": { - "description": "Include all regions", - "example": false, + "description": "Include all regions.", + "example": true, "type": "boolean" } }, @@ -246957,10 +246971,10 @@ ] }, { - "description": "Include only these regions", + "description": "Include only these regions.", "properties": { "include_only": { - "description": "Include only these regions", + "description": "Include only these regions.", "example": [ "us-east-1" ], @@ -246978,13 +246992,13 @@ ] }, "logs_config": { - "description": "AWS Logs config", + "description": "AWS Logs Collection config.", "properties": { "lambda_forwarder": { - "description": "AWS Lambda forwarder", + "description": "Log Autosubscription configuration for Datadog Forwarder Lambda functions. Automatically set up triggers for existing\nand new logs for some services, ensuring no logs from new resources are missed and saving time spent on manual configuration.", "properties": { "lambdas": { - "description": "List of Datadog Lambda Log Forwarder ARNs", + "description": "List of Datadog Lambda Log Forwarder ARNs in your AWS account. Defaults to `[]`.", "items": { "example": "arn:aws:lambda:us-east-1:123456789012:function:DatadogLambdaLogForwarder", "type": "string" @@ -246992,7 +247006,7 @@ "type": "array" }, "sources": { - "description": "List of AWS services that will send logs to the Datadog Lambda Log Forwarder", + "description": "List of service IDs set to enable automatic log collection. Discover the list of available services with the\n[Get list of AWS log ready services](https://docs.datadoghq.com/api/latest/aws-logs-integration/#get-list-of-aws-log-ready-services) endpoint.", "items": { "example": "s3", "type": "string" @@ -247006,41 +247020,42 @@ "type": "object" }, "metrics_config": { - "description": "AWS Metrics config", + "description": "AWS Metrics Collection config.", "properties": { "automute_enabled": { - "description": "Enable EC2 automute for AWS metrics", + "description": "Enable EC2 automute for AWS metrics. Defaults to `true`.", "example": true, "type": "boolean" }, "collect_cloudwatch_alarms": { - "description": "Enable CloudWatch alarms collection", - "example": true, + "description": "Enable CloudWatch alarms collection. Defaults to `false`.", + "example": false, "type": "boolean" }, "collect_custom_metrics": { - "description": "Enable custom metrics collection", - "example": true, + "description": "Enable custom metrics collection. Defaults to `false`.", + "example": false, "type": "boolean" }, "enabled": { - "description": "Enable AWS metrics collection", + "description": "Enable AWS metrics collection. Defaults to `true`.", "example": true, "type": "boolean" }, "namespace_filters": { - "description": "AWS Metrics namespace filters", + "description": "AWS Metrics namespace filters. Defaults to `exclude_only`.", "oneOf": [ { - "description": "Exclude only these namespaces", + "description": "Exclude only these namespaces from metrics collection. Defaults to `[\"AWS/SQS\", \"AWS/ElasticMapReduce\"]`.\n`AWS/SQS` and `AWS/ElasticMapReduce` are excluded by default to reduce your AWS CloudWatch costs from `GetMetricData` API calls.", "properties": { "exclude_only": { - "description": "Exclude only these namespaces", + "description": "Exclude only these namespaces from metrics collection. Defaults to `[\"AWS/SQS\", \"AWS/ElasticMapReduce\"]`.\n`AWS/SQS` and `AWS/ElasticMapReduce` are excluded by default to reduce your AWS CloudWatch costs from `GetMetricData` API calls.", "example": [ - "AWS/EC2" + "AWS/SQS", + "AWS/ElasticMapReduce" ], "items": { - "example": "AWS/EC2", + "example": "AWS/SQS", "type": "string" }, "type": "array" @@ -247051,10 +247066,10 @@ ] }, { - "description": "Include only these namespaces", + "description": "Include only these namespaces.", "properties": { "include_only": { - "description": "Include only these namespaces", + "description": "Include only these namespaces.", "example": [ "AWS/EC2" ], @@ -247072,19 +247087,20 @@ ] }, "tag_filters": { - "description": "AWS Metrics tag filters list", + "description": "AWS Metrics collection tag filters list. Defaults to `[]`.", "items": { - "description": "AWS Metrics tag filters", + "description": "AWS Metrics Collection tag filters list. Defaults to `[]`.\nThe array of custom AWS resource tags (in the form `key:value`) defines a filter that Datadog uses when collecting metrics from a specified service.\nWildcards, such as `?` (match a single character) and `*` (match multiple characters), and exclusion using `!` before the tag are supported.\nFor EC2, only hosts that match one of the defined tags will be imported into Datadog. The rest will be ignored.\nFor example, `env:production,instance-type:c?.*,!region:us-east-1`.", "properties": { "namespace": { - "description": "The AWS Namespace to apply the tag filters against", + "description": "The AWS service for which the tag filters defined in `tags` will be applied.", "example": "AWS/EC2", "type": "string" }, "tags": { - "description": "The tags to filter based on", + "description": "The AWS resource tags to filter on for the service specified by `namespace`.", "items": { - "example": "key:value", + "description": "Tag in the form `key:value`.", + "example": "datadog:true", "type": "string" }, "nullable": true, @@ -247099,32 +247115,32 @@ "type": "object" }, "resources_config": { - "description": "AWS Resources config", + "description": "AWS Resources Collection config.", "properties": { "cloud_security_posture_management_collection": { - "description": "Whether Datadog collects cloud security posture management resources from your AWS account.", + "description": "Enable Cloud Security Management to scan AWS resources for vulnerabilities, misconfigurations, identity risks, and compliance violations. Defaults to `false`. Requires `extended_collection` to be set to `true`.", "example": false, "type": "boolean" }, "extended_collection": { - "description": "Whether Datadog collects additional attributes and configuration information about the resources in your AWS account. Required for `cspm_resource_collection`.", - "example": false, + "description": "Whether Datadog collects additional attributes and configuration information about the resources in your AWS account. Defaults to `true`. Required for `cloud_security_posture_management_collection`.", + "example": true, "type": "boolean" } }, "type": "object" }, "traces_config": { - "description": "AWS Traces config", + "description": "AWS Traces Collection config.", "properties": { "xray_services": { - "description": "AWS X-Ray services to collect traces from", + "description": "AWS X-Ray services to collect traces from. Defaults to `include_only`.", "oneOf": [ { - "description": "Include all services", + "description": "Include all services.", "properties": { "include_all": { - "description": "Include all services", + "description": "Include all services.", "example": false, "type": "boolean" } @@ -247134,11 +247150,11 @@ ] }, { - "description": "Include only these services", + "description": "Include only these services. Defaults to `[]`.", "nullable": true, "properties": { "include_only": { - "description": "Include only these services", + "description": "Include only these services.", "example": [ "AWS/AppSync" ], @@ -247200,37 +247216,37 @@ "content": { "application/json": { "schema": { - "description": "AWS Account response body", + "description": "AWS Account response body.", "properties": { "data": { - "description": "AWS Account Response body", + "description": "AWS Account response data.", "properties": { "attributes": { - "description": "The AWS Account Integration Config", + "description": "AWS Account response attributes.", "properties": { "account_tags": { - "description": "Tags to apply to all metrics in the account", + "description": "Tags to apply to all hosts and metrics reporting for this account. Defaults to `[]`.", "items": { - "description": "Tag to apply to all metrics in the account", - "example": "key:value", + "description": "Tag in the form `key:value`.", + "example": "env:prod", "type": "string" }, "nullable": true, "type": "array" }, "auth_config": { - "description": "AWS Authentication config", + "description": "AWS Authentication config.", "oneOf": [ { - "description": "AWS Authentication config for key-based account", + "description": "AWS Authentication config to integrate your account using an access key pair.", "properties": { "access_key_id": { - "description": "AWS Access Key ID", + "description": "AWS Access Key ID.", "example": "AKIAIOSFODNN7EXAMPLE", "type": "string" }, "secret_access_key": { - "description": "AWS Secret Access Key", + "description": "AWS Secret Access Key.", "example": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY", "minLength": 1, "type": "string", @@ -247243,14 +247259,14 @@ "type": "object" }, { - "description": "AWS Authentication config for role-based account", + "description": "AWS Authentication config to integrate your account using an IAM role.", "properties": { "external_id": { - "description": "AWS IAM External ID for associated role", + "description": "AWS IAM External ID for associated role.", "type": "string" }, "role_name": { - "description": "AWS IAM Role name", + "description": "AWS IAM Role name.", "example": "DatadogIntegrationRole", "maxLength": 576, "minLength": 1, @@ -247265,13 +247281,12 @@ ] }, "aws_account_id": { - "description": "AWS Account ID", + "description": "AWS Account ID.", "example": "123456789012", "type": "string" }, "aws_partition": { - "default": "aws", - "description": "AWS Account partition", + "description": "AWS partition your AWS account is scoped to. Defaults to `aws`.\nSee [Partitions](https://docs.aws.amazon.com/whitepapers/latest/aws-fault-isolation-boundaries/partitions.html) in the AWS documentation for more information.", "enum": [ "aws", "aws-cn", @@ -247286,14 +247301,14 @@ ] }, "aws_regions": { - "description": "AWS Regions to collect data from", + "description": "AWS Regions to collect data from. Defaults to `include_all`.", "oneOf": [ { - "description": "Include all regions", + "description": "Include all regions. Defaults to `true`.", "properties": { "include_all": { - "description": "Include all regions", - "example": false, + "description": "Include all regions.", + "example": true, "type": "boolean" } }, @@ -247302,10 +247317,10 @@ ] }, { - "description": "Include only these regions", + "description": "Include only these regions.", "properties": { "include_only": { - "description": "Include only these regions", + "description": "Include only these regions.", "example": [ "us-east-1" ], @@ -247323,19 +247338,19 @@ ] }, "created_at": { - "description": "Timestamp of when the account integration was created", + "description": "Timestamp of when the account integration was created.", "format": "date-time", "readOnly": true, "type": "string" }, "logs_config": { - "description": "AWS Logs config", + "description": "AWS Logs Collection config.", "properties": { "lambda_forwarder": { - "description": "AWS Lambda forwarder", + "description": "Log Autosubscription configuration for Datadog Forwarder Lambda functions. Automatically set up triggers for existing\nand new logs for some services, ensuring no logs from new resources are missed and saving time spent on manual configuration.", "properties": { "lambdas": { - "description": "List of Datadog Lambda Log Forwarder ARNs", + "description": "List of Datadog Lambda Log Forwarder ARNs in your AWS account. Defaults to `[]`.", "items": { "example": "arn:aws:lambda:us-east-1:123456789012:function:DatadogLambdaLogForwarder", "type": "string" @@ -247343,7 +247358,7 @@ "type": "array" }, "sources": { - "description": "List of AWS services that will send logs to the Datadog Lambda Log Forwarder", + "description": "List of service IDs set to enable automatic log collection. Discover the list of available services with the\n[Get list of AWS log ready services](https://docs.datadoghq.com/api/latest/aws-logs-integration/#get-list-of-aws-log-ready-services) endpoint.", "items": { "example": "s3", "type": "string" @@ -247357,41 +247372,42 @@ "type": "object" }, "metrics_config": { - "description": "AWS Metrics config", + "description": "AWS Metrics Collection config.", "properties": { "automute_enabled": { - "description": "Enable EC2 automute for AWS metrics", + "description": "Enable EC2 automute for AWS metrics. Defaults to `true`.", "example": true, "type": "boolean" }, "collect_cloudwatch_alarms": { - "description": "Enable CloudWatch alarms collection", - "example": true, + "description": "Enable CloudWatch alarms collection. Defaults to `false`.", + "example": false, "type": "boolean" }, "collect_custom_metrics": { - "description": "Enable custom metrics collection", - "example": true, + "description": "Enable custom metrics collection. Defaults to `false`.", + "example": false, "type": "boolean" }, "enabled": { - "description": "Enable AWS metrics collection", + "description": "Enable AWS metrics collection. Defaults to `true`.", "example": true, "type": "boolean" }, "namespace_filters": { - "description": "AWS Metrics namespace filters", + "description": "AWS Metrics namespace filters. Defaults to `exclude_only`.", "oneOf": [ { - "description": "Exclude only these namespaces", + "description": "Exclude only these namespaces from metrics collection. Defaults to `[\"AWS/SQS\", \"AWS/ElasticMapReduce\"]`.\n`AWS/SQS` and `AWS/ElasticMapReduce` are excluded by default to reduce your AWS CloudWatch costs from `GetMetricData` API calls.", "properties": { "exclude_only": { - "description": "Exclude only these namespaces", + "description": "Exclude only these namespaces from metrics collection. Defaults to `[\"AWS/SQS\", \"AWS/ElasticMapReduce\"]`.\n`AWS/SQS` and `AWS/ElasticMapReduce` are excluded by default to reduce your AWS CloudWatch costs from `GetMetricData` API calls.", "example": [ - "AWS/EC2" + "AWS/SQS", + "AWS/ElasticMapReduce" ], "items": { - "example": "AWS/EC2", + "example": "AWS/SQS", "type": "string" }, "type": "array" @@ -247402,10 +247418,10 @@ ] }, { - "description": "Include only these namespaces", + "description": "Include only these namespaces.", "properties": { "include_only": { - "description": "Include only these namespaces", + "description": "Include only these namespaces.", "example": [ "AWS/EC2" ], @@ -247423,19 +247439,20 @@ ] }, "tag_filters": { - "description": "AWS Metrics tag filters list", + "description": "AWS Metrics collection tag filters list. Defaults to `[]`.", "items": { - "description": "AWS Metrics tag filters", + "description": "AWS Metrics Collection tag filters list. Defaults to `[]`.\nThe array of custom AWS resource tags (in the form `key:value`) defines a filter that Datadog uses when collecting metrics from a specified service.\nWildcards, such as `?` (match a single character) and `*` (match multiple characters), and exclusion using `!` before the tag are supported.\nFor EC2, only hosts that match one of the defined tags will be imported into Datadog. The rest will be ignored.\nFor example, `env:production,instance-type:c?.*,!region:us-east-1`.", "properties": { "namespace": { - "description": "The AWS Namespace to apply the tag filters against", + "description": "The AWS service for which the tag filters defined in `tags` will be applied.", "example": "AWS/EC2", "type": "string" }, "tags": { - "description": "The tags to filter based on", + "description": "The AWS resource tags to filter on for the service specified by `namespace`.", "items": { - "example": "key:value", + "description": "Tag in the form `key:value`.", + "example": "datadog:true", "type": "string" }, "nullable": true, @@ -247450,38 +247467,38 @@ "type": "object" }, "modified_at": { - "description": "Timestamp of when the account integration was updated", + "description": "Timestamp of when the account integration was updated.", "format": "date-time", "readOnly": true, "type": "string" }, "resources_config": { - "description": "AWS Resources config", + "description": "AWS Resources Collection config.", "properties": { "cloud_security_posture_management_collection": { - "description": "Whether Datadog collects cloud security posture management resources from your AWS account.", + "description": "Enable Cloud Security Management to scan AWS resources for vulnerabilities, misconfigurations, identity risks, and compliance violations. Defaults to `false`. Requires `extended_collection` to be set to `true`.", "example": false, "type": "boolean" }, "extended_collection": { - "description": "Whether Datadog collects additional attributes and configuration information about the resources in your AWS account. Required for `cspm_resource_collection`.", - "example": false, + "description": "Whether Datadog collects additional attributes and configuration information about the resources in your AWS account. Defaults to `true`. Required for `cloud_security_posture_management_collection`.", + "example": true, "type": "boolean" } }, "type": "object" }, "traces_config": { - "description": "AWS Traces config", + "description": "AWS Traces Collection config.", "properties": { "xray_services": { - "description": "AWS X-Ray services to collect traces from", + "description": "AWS X-Ray services to collect traces from. Defaults to `include_only`.", "oneOf": [ { - "description": "Include all services", + "description": "Include all services.", "properties": { "include_all": { - "description": "Include all services", + "description": "Include all services.", "example": false, "type": "boolean" } @@ -247491,11 +247508,11 @@ ] }, { - "description": "Include only these services", + "description": "Include only these services. Defaults to `[]`.", "nullable": true, "properties": { "include_only": { - "description": "Include only these services", + "description": "Include only these services.", "example": [ "AWS/AppSync" ], @@ -247522,7 +247539,7 @@ "type": "object" }, "id": { - "description": "Unique Datadog ID of the AWS Account Integration Config", + "description": "Unique Datadog ID of the AWS Account Integration Config.\nTo get the config ID for an account, use the [List all AWS integrations](https://docs.datadoghq.com/api/latest/aws-integration/#list-all-aws-integrations)\nendpoint and query by AWS Account ID.", "example": "00000000-abcd-0001-0000-000000000000", "type": "string" }, @@ -247701,16 +247718,16 @@ ], "type": "unsafe" }, - "x-unstable": "**Note: This endpoint is in public beta. If you have any feedback,\ncontact [Datadog support](https://docs.datadoghq.com/help/).**" + "x-unstable": "**Note: This endpoint is in Preview. If you have any feedback,\ncontact [Datadog support](https://docs.datadoghq.com/help/).**" } }, "/api/v2/integration/aws/accounts/{aws_account_config_id}": { "delete": { - "description": "Delete an AWS Account Integration Config", + "description": "Delete an AWS Account Integration Config by config ID.", "operationId": "DeleteAWSAccount", "parameters": [ { - "description": "Unique Datadog ID of the AWS Account Integration Config", + "description": "Unique Datadog ID of the AWS Account Integration Config. To get the config ID for an account, use the\n[List all AWS integrations](https://docs.datadoghq.com/api/latest/aws-integration/#list-all-aws-integrations) endpoint and query by AWS Account ID.", "in": "path", "name": "aws_account_config_id", "required": true, @@ -247850,14 +247867,14 @@ "x-undo": { "type": "idempotent" }, - "x-unstable": "**Note: This endpoint is in public beta. If you have any feedback,\ncontact [Datadog support](https://docs.datadoghq.com/help/).**" + "x-unstable": "**Note: This endpoint is in Preview. If you have any feedback,\ncontact [Datadog support](https://docs.datadoghq.com/help/).**" }, "get": { - "description": "Get an AWS Account Integration Config", + "description": "Get an AWS Account Integration Config by config ID.", "operationId": "GetAWSAccount", "parameters": [ { - "description": "Unique Datadog ID of the AWS Account Integration Config", + "description": "Unique Datadog ID of the AWS Account Integration Config. To get the config ID for an account, use the\n[List all AWS integrations](https://docs.datadoghq.com/api/latest/aws-integration/#list-all-aws-integrations) endpoint and query by AWS Account ID.", "in": "path", "name": "aws_account_config_id", "required": true, @@ -247871,37 +247888,37 @@ "content": { "application/json": { "schema": { - "description": "AWS Account response body", + "description": "AWS Account response body.", "properties": { "data": { - "description": "AWS Account Response body", + "description": "AWS Account response data.", "properties": { "attributes": { - "description": "The AWS Account Integration Config", + "description": "AWS Account response attributes.", "properties": { "account_tags": { - "description": "Tags to apply to all metrics in the account", + "description": "Tags to apply to all hosts and metrics reporting for this account. Defaults to `[]`.", "items": { - "description": "Tag to apply to all metrics in the account", - "example": "key:value", + "description": "Tag in the form `key:value`.", + "example": "env:prod", "type": "string" }, "nullable": true, "type": "array" }, "auth_config": { - "description": "AWS Authentication config", + "description": "AWS Authentication config.", "oneOf": [ { - "description": "AWS Authentication config for key-based account", + "description": "AWS Authentication config to integrate your account using an access key pair.", "properties": { "access_key_id": { - "description": "AWS Access Key ID", + "description": "AWS Access Key ID.", "example": "AKIAIOSFODNN7EXAMPLE", "type": "string" }, "secret_access_key": { - "description": "AWS Secret Access Key", + "description": "AWS Secret Access Key.", "example": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY", "minLength": 1, "type": "string", @@ -247914,14 +247931,14 @@ "type": "object" }, { - "description": "AWS Authentication config for role-based account", + "description": "AWS Authentication config to integrate your account using an IAM role.", "properties": { "external_id": { - "description": "AWS IAM External ID for associated role", + "description": "AWS IAM External ID for associated role.", "type": "string" }, "role_name": { - "description": "AWS IAM Role name", + "description": "AWS IAM Role name.", "example": "DatadogIntegrationRole", "maxLength": 576, "minLength": 1, @@ -247936,13 +247953,12 @@ ] }, "aws_account_id": { - "description": "AWS Account ID", + "description": "AWS Account ID.", "example": "123456789012", "type": "string" }, "aws_partition": { - "default": "aws", - "description": "AWS Account partition", + "description": "AWS partition your AWS account is scoped to. Defaults to `aws`.\nSee [Partitions](https://docs.aws.amazon.com/whitepapers/latest/aws-fault-isolation-boundaries/partitions.html) in the AWS documentation for more information.", "enum": [ "aws", "aws-cn", @@ -247957,14 +247973,14 @@ ] }, "aws_regions": { - "description": "AWS Regions to collect data from", + "description": "AWS Regions to collect data from. Defaults to `include_all`.", "oneOf": [ { - "description": "Include all regions", + "description": "Include all regions. Defaults to `true`.", "properties": { "include_all": { - "description": "Include all regions", - "example": false, + "description": "Include all regions.", + "example": true, "type": "boolean" } }, @@ -247973,10 +247989,10 @@ ] }, { - "description": "Include only these regions", + "description": "Include only these regions.", "properties": { "include_only": { - "description": "Include only these regions", + "description": "Include only these regions.", "example": [ "us-east-1" ], @@ -247994,19 +248010,19 @@ ] }, "created_at": { - "description": "Timestamp of when the account integration was created", + "description": "Timestamp of when the account integration was created.", "format": "date-time", "readOnly": true, "type": "string" }, "logs_config": { - "description": "AWS Logs config", + "description": "AWS Logs Collection config.", "properties": { "lambda_forwarder": { - "description": "AWS Lambda forwarder", + "description": "Log Autosubscription configuration for Datadog Forwarder Lambda functions. Automatically set up triggers for existing\nand new logs for some services, ensuring no logs from new resources are missed and saving time spent on manual configuration.", "properties": { "lambdas": { - "description": "List of Datadog Lambda Log Forwarder ARNs", + "description": "List of Datadog Lambda Log Forwarder ARNs in your AWS account. Defaults to `[]`.", "items": { "example": "arn:aws:lambda:us-east-1:123456789012:function:DatadogLambdaLogForwarder", "type": "string" @@ -248014,7 +248030,7 @@ "type": "array" }, "sources": { - "description": "List of AWS services that will send logs to the Datadog Lambda Log Forwarder", + "description": "List of service IDs set to enable automatic log collection. Discover the list of available services with the\n[Get list of AWS log ready services](https://docs.datadoghq.com/api/latest/aws-logs-integration/#get-list-of-aws-log-ready-services) endpoint.", "items": { "example": "s3", "type": "string" @@ -248028,41 +248044,42 @@ "type": "object" }, "metrics_config": { - "description": "AWS Metrics config", + "description": "AWS Metrics Collection config.", "properties": { "automute_enabled": { - "description": "Enable EC2 automute for AWS metrics", + "description": "Enable EC2 automute for AWS metrics. Defaults to `true`.", "example": true, "type": "boolean" }, "collect_cloudwatch_alarms": { - "description": "Enable CloudWatch alarms collection", - "example": true, + "description": "Enable CloudWatch alarms collection. Defaults to `false`.", + "example": false, "type": "boolean" }, "collect_custom_metrics": { - "description": "Enable custom metrics collection", - "example": true, + "description": "Enable custom metrics collection. Defaults to `false`.", + "example": false, "type": "boolean" }, "enabled": { - "description": "Enable AWS metrics collection", + "description": "Enable AWS metrics collection. Defaults to `true`.", "example": true, "type": "boolean" }, "namespace_filters": { - "description": "AWS Metrics namespace filters", + "description": "AWS Metrics namespace filters. Defaults to `exclude_only`.", "oneOf": [ { - "description": "Exclude only these namespaces", + "description": "Exclude only these namespaces from metrics collection. Defaults to `[\"AWS/SQS\", \"AWS/ElasticMapReduce\"]`.\n`AWS/SQS` and `AWS/ElasticMapReduce` are excluded by default to reduce your AWS CloudWatch costs from `GetMetricData` API calls.", "properties": { "exclude_only": { - "description": "Exclude only these namespaces", + "description": "Exclude only these namespaces from metrics collection. Defaults to `[\"AWS/SQS\", \"AWS/ElasticMapReduce\"]`.\n`AWS/SQS` and `AWS/ElasticMapReduce` are excluded by default to reduce your AWS CloudWatch costs from `GetMetricData` API calls.", "example": [ - "AWS/EC2" + "AWS/SQS", + "AWS/ElasticMapReduce" ], "items": { - "example": "AWS/EC2", + "example": "AWS/SQS", "type": "string" }, "type": "array" @@ -248073,10 +248090,10 @@ ] }, { - "description": "Include only these namespaces", + "description": "Include only these namespaces.", "properties": { "include_only": { - "description": "Include only these namespaces", + "description": "Include only these namespaces.", "example": [ "AWS/EC2" ], @@ -248094,19 +248111,20 @@ ] }, "tag_filters": { - "description": "AWS Metrics tag filters list", + "description": "AWS Metrics collection tag filters list. Defaults to `[]`.", "items": { - "description": "AWS Metrics tag filters", + "description": "AWS Metrics Collection tag filters list. Defaults to `[]`.\nThe array of custom AWS resource tags (in the form `key:value`) defines a filter that Datadog uses when collecting metrics from a specified service.\nWildcards, such as `?` (match a single character) and `*` (match multiple characters), and exclusion using `!` before the tag are supported.\nFor EC2, only hosts that match one of the defined tags will be imported into Datadog. The rest will be ignored.\nFor example, `env:production,instance-type:c?.*,!region:us-east-1`.", "properties": { "namespace": { - "description": "The AWS Namespace to apply the tag filters against", + "description": "The AWS service for which the tag filters defined in `tags` will be applied.", "example": "AWS/EC2", "type": "string" }, "tags": { - "description": "The tags to filter based on", + "description": "The AWS resource tags to filter on for the service specified by `namespace`.", "items": { - "example": "key:value", + "description": "Tag in the form `key:value`.", + "example": "datadog:true", "type": "string" }, "nullable": true, @@ -248121,38 +248139,38 @@ "type": "object" }, "modified_at": { - "description": "Timestamp of when the account integration was updated", + "description": "Timestamp of when the account integration was updated.", "format": "date-time", "readOnly": true, "type": "string" }, "resources_config": { - "description": "AWS Resources config", + "description": "AWS Resources Collection config.", "properties": { "cloud_security_posture_management_collection": { - "description": "Whether Datadog collects cloud security posture management resources from your AWS account.", + "description": "Enable Cloud Security Management to scan AWS resources for vulnerabilities, misconfigurations, identity risks, and compliance violations. Defaults to `false`. Requires `extended_collection` to be set to `true`.", "example": false, "type": "boolean" }, "extended_collection": { - "description": "Whether Datadog collects additional attributes and configuration information about the resources in your AWS account. Required for `cspm_resource_collection`.", - "example": false, + "description": "Whether Datadog collects additional attributes and configuration information about the resources in your AWS account. Defaults to `true`. Required for `cloud_security_posture_management_collection`.", + "example": true, "type": "boolean" } }, "type": "object" }, "traces_config": { - "description": "AWS Traces config", + "description": "AWS Traces Collection config.", "properties": { "xray_services": { - "description": "AWS X-Ray services to collect traces from", + "description": "AWS X-Ray services to collect traces from. Defaults to `include_only`.", "oneOf": [ { - "description": "Include all services", + "description": "Include all services.", "properties": { "include_all": { - "description": "Include all services", + "description": "Include all services.", "example": false, "type": "boolean" } @@ -248162,11 +248180,11 @@ ] }, { - "description": "Include only these services", + "description": "Include only these services. Defaults to `[]`.", "nullable": true, "properties": { "include_only": { - "description": "Include only these services", + "description": "Include only these services.", "example": [ "AWS/AppSync" ], @@ -248193,7 +248211,7 @@ "type": "object" }, "id": { - "description": "Unique Datadog ID of the AWS Account Integration Config", + "description": "Unique Datadog ID of the AWS Account Integration Config.\nTo get the config ID for an account, use the [List all AWS integrations](https://docs.datadoghq.com/api/latest/aws-integration/#list-all-aws-integrations)\nendpoint and query by AWS Account ID.", "example": "00000000-abcd-0001-0000-000000000000", "type": "string" }, @@ -248353,14 +248371,14 @@ "x-undo": { "type": "safe" }, - "x-unstable": "**Note: This endpoint is in public beta. If you have any feedback,\ncontact [Datadog support](https://docs.datadoghq.com/help/).**" + "x-unstable": "**Note: This endpoint is in Preview. If you have any feedback,\ncontact [Datadog support](https://docs.datadoghq.com/help/).**" }, "patch": { - "description": "Update an AWS Account Integration Config", + "description": "Update an AWS Account Integration Config by config ID.", "operationId": "UpdateAWSAccount", "parameters": [ { - "description": "Unique Datadog ID of the AWS Account Integration Config", + "description": "Unique Datadog ID of the AWS Account Integration Config. To get the config ID for an account, use the\n[List all AWS integrations](https://docs.datadoghq.com/api/latest/aws-integration/#list-all-aws-integrations) endpoint and query by AWS Account ID.", "in": "path", "name": "aws_account_config_id", "required": true, @@ -248373,37 +248391,37 @@ "content": { "application/json": { "schema": { - "description": "AWS Account Update Request body", + "description": "AWS Account Update Request body.", "properties": { "data": { - "description": "AWS Account Update Request data", + "description": "AWS Account Update Request data.", "properties": { "attributes": { - "description": "The AWS Account Integration Config to be updated", + "description": "The AWS Account Integration Config to be updated.", "properties": { "account_tags": { - "description": "Tags to apply to all metrics in the account", + "description": "Tags to apply to all hosts and metrics reporting for this account. Defaults to `[]`.", "items": { - "description": "Tag to apply to all metrics in the account", - "example": "key:value", + "description": "Tag in the form `key:value`.", + "example": "env:prod", "type": "string" }, "nullable": true, "type": "array" }, "auth_config": { - "description": "AWS Authentication config", + "description": "AWS Authentication config.", "oneOf": [ { - "description": "AWS Authentication config for key-based account", + "description": "AWS Authentication config to integrate your account using an access key pair.", "properties": { "access_key_id": { - "description": "AWS Access Key ID", + "description": "AWS Access Key ID.", "example": "AKIAIOSFODNN7EXAMPLE", "type": "string" }, "secret_access_key": { - "description": "AWS Secret Access Key", + "description": "AWS Secret Access Key.", "example": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY", "minLength": 1, "type": "string", @@ -248416,14 +248434,14 @@ "type": "object" }, { - "description": "AWS Authentication config for role-based account", + "description": "AWS Authentication config to integrate your account using an IAM role.", "properties": { "external_id": { - "description": "AWS IAM External ID for associated role", + "description": "AWS IAM External ID for associated role.", "type": "string" }, "role_name": { - "description": "AWS IAM Role name", + "description": "AWS IAM Role name.", "example": "DatadogIntegrationRole", "maxLength": 576, "minLength": 1, @@ -248438,13 +248456,12 @@ ] }, "aws_account_id": { - "description": "AWS Account ID", + "description": "AWS Account ID.", "example": "123456789012", "type": "string" }, "aws_partition": { - "default": "aws", - "description": "AWS Account partition", + "description": "AWS partition your AWS account is scoped to. Defaults to `aws`.\nSee [Partitions](https://docs.aws.amazon.com/whitepapers/latest/aws-fault-isolation-boundaries/partitions.html) in the AWS documentation for more information.", "enum": [ "aws", "aws-cn", @@ -248459,14 +248476,14 @@ ] }, "aws_regions": { - "description": "AWS Regions to collect data from", + "description": "AWS Regions to collect data from. Defaults to `include_all`.", "oneOf": [ { - "description": "Include all regions", + "description": "Include all regions. Defaults to `true`.", "properties": { "include_all": { - "description": "Include all regions", - "example": false, + "description": "Include all regions.", + "example": true, "type": "boolean" } }, @@ -248475,10 +248492,10 @@ ] }, { - "description": "Include only these regions", + "description": "Include only these regions.", "properties": { "include_only": { - "description": "Include only these regions", + "description": "Include only these regions.", "example": [ "us-east-1" ], @@ -248496,13 +248513,13 @@ ] }, "logs_config": { - "description": "AWS Logs config", + "description": "AWS Logs Collection config.", "properties": { "lambda_forwarder": { - "description": "AWS Lambda forwarder", + "description": "Log Autosubscription configuration for Datadog Forwarder Lambda functions. Automatically set up triggers for existing\nand new logs for some services, ensuring no logs from new resources are missed and saving time spent on manual configuration.", "properties": { "lambdas": { - "description": "List of Datadog Lambda Log Forwarder ARNs", + "description": "List of Datadog Lambda Log Forwarder ARNs in your AWS account. Defaults to `[]`.", "items": { "example": "arn:aws:lambda:us-east-1:123456789012:function:DatadogLambdaLogForwarder", "type": "string" @@ -248510,7 +248527,7 @@ "type": "array" }, "sources": { - "description": "List of AWS services that will send logs to the Datadog Lambda Log Forwarder", + "description": "List of service IDs set to enable automatic log collection. Discover the list of available services with the\n[Get list of AWS log ready services](https://docs.datadoghq.com/api/latest/aws-logs-integration/#get-list-of-aws-log-ready-services) endpoint.", "items": { "example": "s3", "type": "string" @@ -248524,41 +248541,42 @@ "type": "object" }, "metrics_config": { - "description": "AWS Metrics config", + "description": "AWS Metrics Collection config.", "properties": { "automute_enabled": { - "description": "Enable EC2 automute for AWS metrics", + "description": "Enable EC2 automute for AWS metrics. Defaults to `true`.", "example": true, "type": "boolean" }, "collect_cloudwatch_alarms": { - "description": "Enable CloudWatch alarms collection", - "example": true, + "description": "Enable CloudWatch alarms collection. Defaults to `false`.", + "example": false, "type": "boolean" }, "collect_custom_metrics": { - "description": "Enable custom metrics collection", - "example": true, + "description": "Enable custom metrics collection. Defaults to `false`.", + "example": false, "type": "boolean" }, "enabled": { - "description": "Enable AWS metrics collection", + "description": "Enable AWS metrics collection. Defaults to `true`.", "example": true, "type": "boolean" }, "namespace_filters": { - "description": "AWS Metrics namespace filters", + "description": "AWS Metrics namespace filters. Defaults to `exclude_only`.", "oneOf": [ { - "description": "Exclude only these namespaces", + "description": "Exclude only these namespaces from metrics collection. Defaults to `[\"AWS/SQS\", \"AWS/ElasticMapReduce\"]`.\n`AWS/SQS` and `AWS/ElasticMapReduce` are excluded by default to reduce your AWS CloudWatch costs from `GetMetricData` API calls.", "properties": { "exclude_only": { - "description": "Exclude only these namespaces", + "description": "Exclude only these namespaces from metrics collection. Defaults to `[\"AWS/SQS\", \"AWS/ElasticMapReduce\"]`.\n`AWS/SQS` and `AWS/ElasticMapReduce` are excluded by default to reduce your AWS CloudWatch costs from `GetMetricData` API calls.", "example": [ - "AWS/EC2" + "AWS/SQS", + "AWS/ElasticMapReduce" ], "items": { - "example": "AWS/EC2", + "example": "AWS/SQS", "type": "string" }, "type": "array" @@ -248569,10 +248587,10 @@ ] }, { - "description": "Include only these namespaces", + "description": "Include only these namespaces.", "properties": { "include_only": { - "description": "Include only these namespaces", + "description": "Include only these namespaces.", "example": [ "AWS/EC2" ], @@ -248590,19 +248608,20 @@ ] }, "tag_filters": { - "description": "AWS Metrics tag filters list", + "description": "AWS Metrics collection tag filters list. Defaults to `[]`.", "items": { - "description": "AWS Metrics tag filters", + "description": "AWS Metrics Collection tag filters list. Defaults to `[]`.\nThe array of custom AWS resource tags (in the form `key:value`) defines a filter that Datadog uses when collecting metrics from a specified service.\nWildcards, such as `?` (match a single character) and `*` (match multiple characters), and exclusion using `!` before the tag are supported.\nFor EC2, only hosts that match one of the defined tags will be imported into Datadog. The rest will be ignored.\nFor example, `env:production,instance-type:c?.*,!region:us-east-1`.", "properties": { "namespace": { - "description": "The AWS Namespace to apply the tag filters against", + "description": "The AWS service for which the tag filters defined in `tags` will be applied.", "example": "AWS/EC2", "type": "string" }, "tags": { - "description": "The tags to filter based on", + "description": "The AWS resource tags to filter on for the service specified by `namespace`.", "items": { - "example": "key:value", + "description": "Tag in the form `key:value`.", + "example": "datadog:true", "type": "string" }, "nullable": true, @@ -248617,32 +248636,32 @@ "type": "object" }, "resources_config": { - "description": "AWS Resources config", + "description": "AWS Resources Collection config.", "properties": { "cloud_security_posture_management_collection": { - "description": "Whether Datadog collects cloud security posture management resources from your AWS account.", + "description": "Enable Cloud Security Management to scan AWS resources for vulnerabilities, misconfigurations, identity risks, and compliance violations. Defaults to `false`. Requires `extended_collection` to be set to `true`.", "example": false, "type": "boolean" }, "extended_collection": { - "description": "Whether Datadog collects additional attributes and configuration information about the resources in your AWS account. Required for `cspm_resource_collection`.", - "example": false, + "description": "Whether Datadog collects additional attributes and configuration information about the resources in your AWS account. Defaults to `true`. Required for `cloud_security_posture_management_collection`.", + "example": true, "type": "boolean" } }, "type": "object" }, "traces_config": { - "description": "AWS Traces config", + "description": "AWS Traces Collection config.", "properties": { "xray_services": { - "description": "AWS X-Ray services to collect traces from", + "description": "AWS X-Ray services to collect traces from. Defaults to `include_only`.", "oneOf": [ { - "description": "Include all services", + "description": "Include all services.", "properties": { "include_all": { - "description": "Include all services", + "description": "Include all services.", "example": false, "type": "boolean" } @@ -248652,11 +248671,11 @@ ] }, { - "description": "Include only these services", + "description": "Include only these services. Defaults to `[]`.", "nullable": true, "properties": { "include_only": { - "description": "Include only these services", + "description": "Include only these services.", "example": [ "AWS/AppSync" ], @@ -248683,7 +248702,7 @@ "type": "object" }, "id": { - "description": "Unique Datadog ID of the AWS Account Integration Config", + "description": "Unique Datadog ID of the AWS Account Integration Config.\nTo get the config ID for an account, use the [List all AWS integrations](https://docs.datadoghq.com/api/latest/aws-integration/#list-all-aws-integrations)\nendpoint and query by AWS Account ID.", "example": "00000000-abcd-0001-0000-000000000000", "type": "string" }, @@ -248721,37 +248740,37 @@ "content": { "application/json": { "schema": { - "description": "AWS Account response body", + "description": "AWS Account response body.", "properties": { "data": { - "description": "AWS Account Response body", + "description": "AWS Account response data.", "properties": { "attributes": { - "description": "The AWS Account Integration Config", + "description": "AWS Account response attributes.", "properties": { "account_tags": { - "description": "Tags to apply to all metrics in the account", + "description": "Tags to apply to all hosts and metrics reporting for this account. Defaults to `[]`.", "items": { - "description": "Tag to apply to all metrics in the account", - "example": "key:value", + "description": "Tag in the form `key:value`.", + "example": "env:prod", "type": "string" }, "nullable": true, "type": "array" }, "auth_config": { - "description": "AWS Authentication config", + "description": "AWS Authentication config.", "oneOf": [ { - "description": "AWS Authentication config for key-based account", + "description": "AWS Authentication config to integrate your account using an access key pair.", "properties": { "access_key_id": { - "description": "AWS Access Key ID", + "description": "AWS Access Key ID.", "example": "AKIAIOSFODNN7EXAMPLE", "type": "string" }, "secret_access_key": { - "description": "AWS Secret Access Key", + "description": "AWS Secret Access Key.", "example": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY", "minLength": 1, "type": "string", @@ -248764,14 +248783,14 @@ "type": "object" }, { - "description": "AWS Authentication config for role-based account", + "description": "AWS Authentication config to integrate your account using an IAM role.", "properties": { "external_id": { - "description": "AWS IAM External ID for associated role", + "description": "AWS IAM External ID for associated role.", "type": "string" }, "role_name": { - "description": "AWS IAM Role name", + "description": "AWS IAM Role name.", "example": "DatadogIntegrationRole", "maxLength": 576, "minLength": 1, @@ -248786,13 +248805,12 @@ ] }, "aws_account_id": { - "description": "AWS Account ID", + "description": "AWS Account ID.", "example": "123456789012", "type": "string" }, "aws_partition": { - "default": "aws", - "description": "AWS Account partition", + "description": "AWS partition your AWS account is scoped to. Defaults to `aws`.\nSee [Partitions](https://docs.aws.amazon.com/whitepapers/latest/aws-fault-isolation-boundaries/partitions.html) in the AWS documentation for more information.", "enum": [ "aws", "aws-cn", @@ -248807,14 +248825,14 @@ ] }, "aws_regions": { - "description": "AWS Regions to collect data from", + "description": "AWS Regions to collect data from. Defaults to `include_all`.", "oneOf": [ { - "description": "Include all regions", + "description": "Include all regions. Defaults to `true`.", "properties": { "include_all": { - "description": "Include all regions", - "example": false, + "description": "Include all regions.", + "example": true, "type": "boolean" } }, @@ -248823,10 +248841,10 @@ ] }, { - "description": "Include only these regions", + "description": "Include only these regions.", "properties": { "include_only": { - "description": "Include only these regions", + "description": "Include only these regions.", "example": [ "us-east-1" ], @@ -248844,19 +248862,19 @@ ] }, "created_at": { - "description": "Timestamp of when the account integration was created", + "description": "Timestamp of when the account integration was created.", "format": "date-time", "readOnly": true, "type": "string" }, "logs_config": { - "description": "AWS Logs config", + "description": "AWS Logs Collection config.", "properties": { "lambda_forwarder": { - "description": "AWS Lambda forwarder", + "description": "Log Autosubscription configuration for Datadog Forwarder Lambda functions. Automatically set up triggers for existing\nand new logs for some services, ensuring no logs from new resources are missed and saving time spent on manual configuration.", "properties": { "lambdas": { - "description": "List of Datadog Lambda Log Forwarder ARNs", + "description": "List of Datadog Lambda Log Forwarder ARNs in your AWS account. Defaults to `[]`.", "items": { "example": "arn:aws:lambda:us-east-1:123456789012:function:DatadogLambdaLogForwarder", "type": "string" @@ -248864,7 +248882,7 @@ "type": "array" }, "sources": { - "description": "List of AWS services that will send logs to the Datadog Lambda Log Forwarder", + "description": "List of service IDs set to enable automatic log collection. Discover the list of available services with the\n[Get list of AWS log ready services](https://docs.datadoghq.com/api/latest/aws-logs-integration/#get-list-of-aws-log-ready-services) endpoint.", "items": { "example": "s3", "type": "string" @@ -248878,41 +248896,42 @@ "type": "object" }, "metrics_config": { - "description": "AWS Metrics config", + "description": "AWS Metrics Collection config.", "properties": { "automute_enabled": { - "description": "Enable EC2 automute for AWS metrics", + "description": "Enable EC2 automute for AWS metrics. Defaults to `true`.", "example": true, "type": "boolean" }, "collect_cloudwatch_alarms": { - "description": "Enable CloudWatch alarms collection", - "example": true, + "description": "Enable CloudWatch alarms collection. Defaults to `false`.", + "example": false, "type": "boolean" }, "collect_custom_metrics": { - "description": "Enable custom metrics collection", - "example": true, + "description": "Enable custom metrics collection. Defaults to `false`.", + "example": false, "type": "boolean" }, "enabled": { - "description": "Enable AWS metrics collection", + "description": "Enable AWS metrics collection. Defaults to `true`.", "example": true, "type": "boolean" }, "namespace_filters": { - "description": "AWS Metrics namespace filters", + "description": "AWS Metrics namespace filters. Defaults to `exclude_only`.", "oneOf": [ { - "description": "Exclude only these namespaces", + "description": "Exclude only these namespaces from metrics collection. Defaults to `[\"AWS/SQS\", \"AWS/ElasticMapReduce\"]`.\n`AWS/SQS` and `AWS/ElasticMapReduce` are excluded by default to reduce your AWS CloudWatch costs from `GetMetricData` API calls.", "properties": { "exclude_only": { - "description": "Exclude only these namespaces", + "description": "Exclude only these namespaces from metrics collection. Defaults to `[\"AWS/SQS\", \"AWS/ElasticMapReduce\"]`.\n`AWS/SQS` and `AWS/ElasticMapReduce` are excluded by default to reduce your AWS CloudWatch costs from `GetMetricData` API calls.", "example": [ - "AWS/EC2" + "AWS/SQS", + "AWS/ElasticMapReduce" ], "items": { - "example": "AWS/EC2", + "example": "AWS/SQS", "type": "string" }, "type": "array" @@ -248923,10 +248942,10 @@ ] }, { - "description": "Include only these namespaces", + "description": "Include only these namespaces.", "properties": { "include_only": { - "description": "Include only these namespaces", + "description": "Include only these namespaces.", "example": [ "AWS/EC2" ], @@ -248944,19 +248963,20 @@ ] }, "tag_filters": { - "description": "AWS Metrics tag filters list", + "description": "AWS Metrics collection tag filters list. Defaults to `[]`.", "items": { - "description": "AWS Metrics tag filters", + "description": "AWS Metrics Collection tag filters list. Defaults to `[]`.\nThe array of custom AWS resource tags (in the form `key:value`) defines a filter that Datadog uses when collecting metrics from a specified service.\nWildcards, such as `?` (match a single character) and `*` (match multiple characters), and exclusion using `!` before the tag are supported.\nFor EC2, only hosts that match one of the defined tags will be imported into Datadog. The rest will be ignored.\nFor example, `env:production,instance-type:c?.*,!region:us-east-1`.", "properties": { "namespace": { - "description": "The AWS Namespace to apply the tag filters against", + "description": "The AWS service for which the tag filters defined in `tags` will be applied.", "example": "AWS/EC2", "type": "string" }, "tags": { - "description": "The tags to filter based on", + "description": "The AWS resource tags to filter on for the service specified by `namespace`.", "items": { - "example": "key:value", + "description": "Tag in the form `key:value`.", + "example": "datadog:true", "type": "string" }, "nullable": true, @@ -248971,38 +248991,38 @@ "type": "object" }, "modified_at": { - "description": "Timestamp of when the account integration was updated", + "description": "Timestamp of when the account integration was updated.", "format": "date-time", "readOnly": true, "type": "string" }, "resources_config": { - "description": "AWS Resources config", + "description": "AWS Resources Collection config.", "properties": { "cloud_security_posture_management_collection": { - "description": "Whether Datadog collects cloud security posture management resources from your AWS account.", + "description": "Enable Cloud Security Management to scan AWS resources for vulnerabilities, misconfigurations, identity risks, and compliance violations. Defaults to `false`. Requires `extended_collection` to be set to `true`.", "example": false, "type": "boolean" }, "extended_collection": { - "description": "Whether Datadog collects additional attributes and configuration information about the resources in your AWS account. Required for `cspm_resource_collection`.", - "example": false, + "description": "Whether Datadog collects additional attributes and configuration information about the resources in your AWS account. Defaults to `true`. Required for `cloud_security_posture_management_collection`.", + "example": true, "type": "boolean" } }, "type": "object" }, "traces_config": { - "description": "AWS Traces config", + "description": "AWS Traces Collection config.", "properties": { "xray_services": { - "description": "AWS X-Ray services to collect traces from", + "description": "AWS X-Ray services to collect traces from. Defaults to `include_only`.", "oneOf": [ { - "description": "Include all services", + "description": "Include all services.", "properties": { "include_all": { - "description": "Include all services", + "description": "Include all services.", "example": false, "type": "boolean" } @@ -249012,11 +249032,11 @@ ] }, { - "description": "Include only these services", + "description": "Include only these services. Defaults to `[]`.", "nullable": true, "properties": { "include_only": { - "description": "Include only these services", + "description": "Include only these services.", "example": [ "AWS/AppSync" ], @@ -249043,7 +249063,7 @@ "type": "object" }, "id": { - "description": "Unique Datadog ID of the AWS Account Integration Config", + "description": "Unique Datadog ID of the AWS Account Integration Config.\nTo get the config ID for an account, use the [List all AWS integrations](https://docs.datadoghq.com/api/latest/aws-integration/#list-all-aws-integrations)\nendpoint and query by AWS Account ID.", "example": "00000000-abcd-0001-0000-000000000000", "type": "string" }, @@ -249204,7 +249224,7 @@ "x-undo": { "type": "idempotent" }, - "x-unstable": "**Note: This endpoint is in public beta. If you have any feedback,\ncontact [Datadog support](https://docs.datadoghq.com/help/).**" + "x-unstable": "**Note: This endpoint is in Preview. If you have any feedback,\ncontact [Datadog support](https://docs.datadoghq.com/help/).**" } }, "/api/v2/integration/aws/available_namespaces": { @@ -249216,16 +249236,16 @@ "content": { "application/json": { "schema": { - "description": "AWS Namespaces response body", + "description": "AWS Namespaces response body.", "properties": { "data": { - "description": "AWS Namespaces response body", + "description": "AWS Namespaces response data.", "properties": { "attributes": { - "description": "AWS Namespaces response body", + "description": "AWS Namespaces response attributes.", "properties": { "namespaces": { - "description": "AWS CloudWatch namespace", + "description": "AWS CloudWatch namespace.", "example": [ "AWS/ApiGateway" ], @@ -249347,7 +249367,7 @@ "x-undo": { "type": "safe" }, - "x-unstable": "**Note: This endpoint is in public beta. If you have any feedback,\ncontact [Datadog support](https://docs.datadoghq.com/help/).**" + "x-unstable": "**Note: This endpoint is in Preview. If you have any feedback,\ncontact [Datadog support](https://docs.datadoghq.com/help/).**" } }, "/api/v2/integration/aws/generate_new_external_id": { @@ -249359,16 +249379,16 @@ "content": { "application/json": { "schema": { - "description": "AWS External ID response body", + "description": "AWS External ID response body.", "properties": { "data": { - "description": "AWS External ID response body", + "description": "AWS External ID response body.", "properties": { "attributes": { - "description": "AWS External ID response body", + "description": "AWS External ID response body.", "properties": { "external_id": { - "description": "AWS IAM External ID for associated role", + "description": "AWS IAM External ID for associated role.", "example": "acb8f6b8a844443dbb726d07dcb1a870", "type": "string" } @@ -249484,7 +249504,7 @@ "x-undo": { "type": "safe" }, - "x-unstable": "**Note: This endpoint is in public beta. If you have any feedback,\ncontact [Datadog support](https://docs.datadoghq.com/help/).**" + "x-unstable": "**Note: This endpoint is in Preview. If you have any feedback,\ncontact [Datadog support](https://docs.datadoghq.com/help/).**" } }, "/api/v2/integration/aws/logs/services": {