oci_tenancies

Creates, updates, deletes, gets or lists an oci_tenancies resource.

Overview

Name	oci_tenancies
Type	Resource
Id	datadog.integrations.oci_tenancies

Fields

The following fields are returned by SELECT queries:

get_tenancy_config

Name	Datatype	Description
id	string	The OCID of the OCI tenancy.
attributes	object	Attributes of an OCI tenancy integration configuration, including authentication details, region settings, and collection options.
type	string	OCI tenancy resource type. (oci_tenancy) (default: oci_tenancy, example: oci_tenancy)

get_tenancy_configs

Name	Datatype	Description
id	string	The OCID of the OCI tenancy.
attributes	object	Attributes of an OCI tenancy integration configuration, including authentication details, region settings, and collection options.
type	string	OCI tenancy resource type. (oci_tenancy) (default: oci_tenancy, example: oci_tenancy)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_tenancy_config	select	tenancy_ocid		Get a single tenancy config object by its OCID. Returns detailed configuration including authentication credentials, enabled services, region settings, and collection preferences.
get_tenancy_configs	select			Get a list of all configured OCI tenancy integrations. Returns basic information about each tenancy including authentication credentials, region settings, and collection preferences for metrics, logs, and resources.
create_tenancy_config	insert	data		Create a new tenancy config to establish monitoring and data collection from your OCI environment. Requires OCI authentication credentials and tenancy details. Warning: Datadog recommends interacting with this endpoint only through the Datadog web UI to ensure all necessary OCI resources have been created and configured properly.
update_tenancy_config	update	tenancy_ocid, data		Update an existing tenancy config. You can modify authentication credentials, enable/disable collection types, update service filters, and change region settings. Warning: We recommend using the Datadog web UI to avoid unintended update effects.
delete_tenancy_config	delete	tenancy_ocid		Delete an existing tenancy config. This will stop all data collection from the specified OCI tenancy and remove the stored configuration. This operation cannot be undone.

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
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.
tenancy_ocid	string	The OCID of the tenancy config to delete.

SELECT examples

get_tenancy_config

Get a single tenancy config object by its OCID. Returns detailed configuration including authentication credentials, enabled services, region settings, and collection preferences.

SELECT
id,
attributes,
type
FROM datadog.integrations.oci_tenancies
WHERE tenancy_ocid = '{{ tenancy_ocid }}' -- required
;

get_tenancy_configs

Get a list of all configured OCI tenancy integrations. Returns basic information about each tenancy including authentication credentials, region settings, and collection preferences for metrics, logs, and resources.

SELECT
id,
attributes,
type
FROM datadog.integrations.oci_tenancies
;

INSERT examples

create_tenancy_config

Create a new tenancy config to establish monitoring and data collection from your OCI environment. Requires OCI authentication credentials and tenancy details. Warning: Datadog recommends interacting with this endpoint only through the Datadog web UI to ensure all necessary OCI resources have been created and configured properly.

INSERT INTO datadog.integrations.oci_tenancies (
data
)
SELECT 
'{{ data }}' /* required */
RETURNING
data
;

Manifest

# Description fields are for documentation purposes
- name: oci_tenancies
props:
  - name: data
    description: |
      The data object for creating a new OCI tenancy integration configuration, including the tenancy ID, type, and configuration attributes.
    value:
      attributes:
        auth_credentials:
          fingerprint: "{{ fingerprint }}"
          private_key: "{{ private_key }}"
        config_version: {{ config_version }}
        cost_collection_enabled: {{ cost_collection_enabled }}
        dd_compartment_id: "{{ dd_compartment_id }}"
        dd_stack_id: "{{ dd_stack_id }}"
        home_region: "{{ home_region }}"
        logs_config:
          compartment_tag_filters:
            - "{{ compartment_tag_filters }}"
          enabled: {{ enabled }}
          enabled_services:
            - "{{ enabled_services }}"
        metrics_config:
          compartment_tag_filters:
            - "{{ compartment_tag_filters }}"
          enabled: {{ enabled }}
          excluded_services:
            - "{{ excluded_services }}"
        regions_config:
          available:
            - "{{ available }}"
          disabled:
            - "{{ disabled }}"
          enabled:
            - "{{ enabled }}"
        resource_collection_enabled: {{ resource_collection_enabled }}
        user_ocid: "{{ user_ocid }}"
      id: "{{ id }}"
      type: "{{ type }}"

UPDATE examples

update_tenancy_config

Update an existing tenancy config. You can modify authentication credentials, enable/disable collection types, update service filters, and change region settings. Warning: We recommend using the Datadog web UI to avoid unintended update effects.

UPDATE datadog.integrations.oci_tenancies
SET 
data = '{{ data }}'
WHERE 
tenancy_ocid = '{{ tenancy_ocid }}' --required
AND data = '{{ data }}' --required
RETURNING
data;

DELETE examples

delete_tenancy_config

Delete an existing tenancy config. This will stop all data collection from the specified OCI tenancy and remove the stored configuration. This operation cannot be undone.

DELETE FROM datadog.integrations.oci_tenancies
WHERE tenancy_ocid = '{{ tenancy_ocid }}' --required
;