feature_flag_environments

Creates, updates, deletes, gets or lists a feature_flag_environments resource.

Overview

Name	feature_flag_environments
Type	Resource
Id	datadog.software_delivery.feature_flag_environments

Fields

The following fields are returned by SELECT queries:

get_feature_flags_environment

Name	Datatype	Description
id	string (uuid)	The unique identifier of the environment. (example: 550e8400-e29b-41d4-a716-446655440001)
attributes	object	Attributes of an environment.
type	string	The resource type. (environments) (example: environments)

list_feature_flags_environments

Name	Datatype	Description
id	string (uuid)	The unique identifier of the environment. (example: 550e8400-e29b-41d4-a716-446655440001)
attributes	object	Attributes of an environment.
type	string	The resource type. (environments) (example: environments)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_feature_flags_environment	select	environment_id		Returns the details of a specific environment.
list_feature_flags_environments	select		name, key, dd_env, limit, offset	Returns a list of environments for the organization.<br />Supports filtering by name, key, and DD_ENV.
create_feature_flags_environment	insert	data		Creates a new environment for organizing feature flags.
update_feature_flags_environment	replace	environment_id, data		Updates an existing environment's metadata such as<br /> name and description.
delete_feature_flags_environment	delete	environment_id		Deletes an environment. This operation cannot be undone.
disable_feature_flag_environment	exec	feature_flag_id, environment_id		Disable a feature flag in a specific environment.
enable_feature_flag_environment	exec	feature_flag_id, environment_id		Enable a feature flag in a specific environment.

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
environment_id	string (uuid)	The ID of the environment.
feature_flag_id	string (uuid)	The ID of the feature flag.
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.
dd_env	string	Filter environments by queries that contain the provided DD_ENV value. (example: staging)
key	string	Filter environments by key (partial matching). (example: env-partial)
limit	integer (int64)	Maximum number of results to return. (example: 10)
name	string	Filter environments by name (partial matching). (example: env-search-term)
offset	integer (int64)	Number of results to skip. (example: 0)

SELECT examples

get_feature_flags_environment

Returns the details of a specific environment.

SELECT
id,
attributes,
type
FROM datadog.software_delivery.feature_flag_environments
WHERE environment_id = '{{ environment_id }}' -- required
;

list_feature_flags_environments

Returns a list of environments for the organization.<br />Supports filtering by name, key, and DD_ENV.

SELECT
id,
attributes,
type
FROM datadog.software_delivery.feature_flag_environments
WHERE name = '{{ name }}'
AND key = '{{ key }}'
AND dd_env = '{{ dd_env }}'
AND limit = '{{ limit }}'
AND offset = '{{ offset }}'
;

INSERT examples

create_feature_flags_environment

Creates a new environment for organizing feature flags.

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

Manifest

# Description fields are for documentation purposes
- name: feature_flag_environments
props:
  - name: data
    description: |
      Data for creating a new environment.
    value:
      attributes:
        is_production: {{ is_production }}
        name: "{{ name }}"
        queries:
          - "{{ queries }}"
        require_feature_flag_approval: {{ require_feature_flag_approval }}
      type: "{{ type }}"

REPLACE examples

update_feature_flags_environment

Updates an existing environment's metadata such as<br /> name and description.

REPLACE datadog.software_delivery.feature_flag_environments
SET 
data = '{{ data }}'
WHERE 
environment_id = '{{ environment_id }}' --required
AND data = '{{ data }}' --required
RETURNING
data;

DELETE examples

delete_feature_flags_environment

Deletes an environment. This operation cannot be undone.

DELETE FROM datadog.software_delivery.feature_flag_environments
WHERE environment_id = '{{ environment_id }}' --required
;

Lifecycle Methods

EXEC variables use wire (API) names.

disable_feature_flag_environment

Disable a feature flag in a specific environment.

EXEC datadog.software_delivery.feature_flag_environments.disable_feature_flag_environment 
@feature_flag_id='{{ feature_flag_id }}' --required, 
@environment_id='{{ environment_id }}' --required 
;

enable_feature_flag_environment

Enable a feature flag in a specific environment.

EXEC datadog.software_delivery.feature_flag_environments.enable_feature_flag_environment 
@feature_flag_id='{{ feature_flag_id }}' --required, 
@environment_id='{{ environment_id }}' --required 
;