aws_persona_mappings
Creates, updates, deletes, gets or lists an aws_persona_mappings resource.
Overview
| Name | aws_persona_mappings |
| Type | Resource |
| Id | datadog.integrations.aws_persona_mappings |
Fields
The following fields are returned by SELECT queries:
- get_awscloud_auth_persona_mapping
- list_awscloud_auth_persona_mappings
| Name | Datatype | Description |
|---|---|---|
id | string | Unique identifier for the persona mapping (example: c5c758c6-18c2-4484-ae3f-46b84128404a) |
attributes | object | Attributes for AWS cloud authentication persona mapping response |
type | string | Type identifier for AWS cloud authentication persona mapping (aws_cloud_auth_config) (example: aws_cloud_auth_config) |
| Name | Datatype | Description |
|---|---|---|
id | string | Unique identifier for the persona mapping (example: c5c758c6-18c2-4484-ae3f-46b84128404a) |
attributes | object | Attributes for AWS cloud authentication persona mapping response |
type | string | Type identifier for AWS cloud authentication persona mapping (aws_cloud_auth_config) (example: aws_cloud_auth_config) |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_awscloud_auth_persona_mapping | select | persona_mapping_id | Get a specific AWS cloud authentication persona mapping by ID. This endpoint retrieves a single configured persona mapping that associates an AWS IAM principal with a Datadog user. | |
list_awscloud_auth_persona_mappings | select | List all AWS cloud authentication persona mappings. This endpoint retrieves all configured persona mappings that associate AWS IAM principals with Datadog users. | ||
create_awscloud_auth_persona_mapping | insert | data | Create an AWS cloud authentication persona mapping. This endpoint associates an AWS IAM principal with a Datadog user. | |
delete_awscloud_auth_persona_mapping | delete | persona_mapping_id | Delete an AWS cloud authentication persona mapping by ID. This removes the association between an AWS IAM principal and a Datadog user. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
persona_mapping_id | string | The ID of the persona mapping (example: c5c758c6-18c2-4484-ae3f-46b84128404a) |
site | string | The Datadog site (region) for your organization, for example datadoghq.com, us3.datadoghq.com, us5.datadoghq.com, ap1.datadoghq.com, ap2.datadoghq.com, datadoghq.eu, ddog-gov.com. Resolved from the DD_SITE environment variable when set. Optional: defaults to datadoghq.com, or the value of the DD_SITE environment variable when set; a WHERE value overrides both. |
SELECT examples
- get_awscloud_auth_persona_mapping
- list_awscloud_auth_persona_mappings
Get a specific AWS cloud authentication persona mapping by ID. This endpoint retrieves a single configured persona mapping that associates an AWS IAM principal with a Datadog user.
SELECT
id,
attributes,
type
FROM datadog.integrations.aws_persona_mappings
WHERE persona_mapping_id = '{{ persona_mapping_id }}' -- required
;
List all AWS cloud authentication persona mappings. This endpoint retrieves all configured persona mappings that associate AWS IAM principals with Datadog users.
SELECT
id,
attributes,
type
FROM datadog.integrations.aws_persona_mappings
;
INSERT examples
- create_awscloud_auth_persona_mapping
- Manifest
Create an AWS cloud authentication persona mapping. This endpoint associates an AWS IAM principal with a Datadog user.
INSERT INTO datadog.integrations.aws_persona_mappings (
data
)
SELECT
'{{ data }}' /* required */
RETURNING
data
;
# Description fields are for documentation purposes
- name: aws_persona_mappings
props:
- name: data
description: |
Data for creating an AWS cloud authentication persona mapping
value:
attributes:
account_identifier: "{{ account_identifier }}"
arn_pattern: "{{ arn_pattern }}"
type: "{{ type }}"
DELETE examples
- delete_awscloud_auth_persona_mapping
Delete an AWS cloud authentication persona mapping by ID. This removes the association between an AWS IAM principal and a Datadog user.
DELETE FROM datadog.integrations.aws_persona_mappings
WHERE persona_mapping_id = '{{ persona_mapping_id }}' --required
;