DAdatadog
AWS Integration

Generate a new external ID

This endpoint is deprecated - use the V2 endpoints instead. Generate a new AWS external ID for a given AWS account ID and role name pair.

put/api/v1/integration/aws/generate_new_external_id

Request

  • Base URL
    https://api.datadoghq.com
  • URL
    https://api.datadoghq.com/api/v1/integration/aws/generate_new_external_id
  • Auth
    API key in header DD-API-KEY and API key in header DD-APPLICATION-KEY

Request body

access_key_idstring

Your AWS access key ID. Only required if your AWS account is a GovCloud or China account.

account_idstring

Your AWS Account ID without dashes.

account_specific_namespace_rulesobject

An object (in the form {"namespace1":true/false, "namespace2":true/false}) containing user-supplied overrides for AWS namespace metric collection. Important: This field only contains namespaces explicitly configured through API calls, not the comprehensive enabled or disabled status of all namespaces. If a namespace is absent from this field, it uses Datadog's internal defaults (all namespaces enabled by default, except AWS/SQS, AWS/ElasticMapReduce, and AWS/Usage). For a complete view of all namespace statuses, use the V2 AWS Integration API instead.

cspm_resource_collection_enabledboolean

Whether Datadog collects cloud security posture management resources from your AWS account. This includes additional resources not covered under the general resource_collection.

excluded_regionsstring[]

An array of AWS regions to exclude from metrics collection.

extended_resource_collection_enabledboolean

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

filter_tagsstring[]

The array of EC2 tags (in the form key:value) defines a filter that Datadog uses when collecting metrics from EC2. Wildcards, such as ? (for single characters) and * (for multiple characters) can also be used. Only hosts that match one of the defined tags will be imported into Datadog. The rest will be ignored. Host matching a given tag can also be excluded by adding ! before the tag. For example, env:production,instance-type:c1.*,!region:us-east-1

host_tagsstring[]

Array of tags (in the form key:value) to add to all hosts and metrics reporting through this integration.

metrics_collection_enabledboolean

Whether Datadog collects metrics for this AWS account.

resource_collection_enabledboolean

Deprecated in favor of 'extended_resource_collection_enabled'. Whether Datadog collects a standard set of resources from your AWS account.

role_namestring

Your Datadog role delegation name.

secret_access_keystring

Your AWS secret access key. Only required if your AWS account is a GovCloud or China account.

Example request

{
  "account_id": "123456789012",
  "account_specific_namespace_rules": {
    "auto_scaling": false,
    "opswork": false
  },
  "cspm_resource_collection_enabled": true,
  "excluded_regions": [
    "us-east-1",
    "us-west-2"
  ],
  "extended_resource_collection_enabled": true,
  "filter_tags": [
    "$KEY:$VALUE"
  ],
  "host_tags": [
    "$KEY:$VALUE"
  ],
  "resource_collection_enabled": true,
  "role_name": "DatadogAWSIntegrationRole"
}

Response

OK

external_idstring

AWS external_id.

Changes

No recorded changes to this operation across all 1 revision of this API.