deployment_gate_rules

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

Overview

Name	deployment_gate_rules
Type	Resource
Id	datadog.software_delivery.deployment_gate_rules

Fields

The following fields are returned by SELECT queries:

get_deployment_rule

Name	Datatype	Description
id	string	Unique identifier of the deployment rule. (example: 1111-2222-3333-4444-555566667777)
attributes	object	Basic information about a deployment rule.
type	string	Deployment rule resource type. (deployment_rule) (example: deployment_rule)

get_deployment_gate_rules

Name	Datatype	Description
id	string	Unique identifier of the deployment rule. (example: 1111-2222-3333-4444-555566667777)
attributes	object	Attributes of the response for listing deployment rules.
type	string	List deployment rule resource type. (list_deployment_rules) (example: list_deployment_rules)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_deployment_rule	select	gate_id, id		Endpoint to get a deployment rule.
get_deployment_gate_rules	select	gate_id		Endpoint to get rules for a deployment gate.
create_deployment_rule	insert	gate_id		Endpoint to create a deployment rule. A gate for the rule must already exist.
update_deployment_rule	replace	gate_id, id, data		Endpoint to update a deployment rule.
delete_deployment_rule	delete	gate_id, id		Endpoint to delete a deployment rule.

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
gate_id	string	The ID of the deployment gate.
id	string	The ID of the deployment rule.
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_deployment_rule

Endpoint to get a deployment rule.

SELECT
id,
attributes,
type
FROM datadog.software_delivery.deployment_gate_rules
WHERE gate_id = '{{ gate_id }}' -- required
AND id = '{{ id }}' -- required
;

get_deployment_gate_rules

Endpoint to get rules for a deployment gate.

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

INSERT examples

create_deployment_rule

Endpoint to create a deployment rule. A gate for the rule must already exist.

INSERT INTO datadog.software_delivery.deployment_gate_rules (
data,
gate_id
)
SELECT 
'{{ data }}',
'{{ gate_id }}'
RETURNING
data
;

Manifest

# Description fields are for documentation purposes
- name: deployment_gate_rules
props:
  - name: gate_id
    value: "{{ gate_id }}"
    description: Required parameter for the deployment_gate_rules resource.
  - name: data
    description: |
      Parameters for creating a deployment rule.
    value:
      attributes:
        dry_run: {{ dry_run }}
        name: "{{ name }}"
        options:
          allowed_resources:
            - "{{ allowed_resources }}"
          duration: {{ duration }}
          excluded_resources:
            - "{{ excluded_resources }}"
          query: "{{ query }}"
        type: "{{ type }}"
      type: "{{ type }}"

REPLACE examples

update_deployment_rule

Endpoint to update a deployment rule.

REPLACE datadog.software_delivery.deployment_gate_rules
SET 
data = '{{ data }}'
WHERE 
gate_id = '{{ gate_id }}' --required
AND id = '{{ id }}' --required
AND data = '{{ data }}' --required
RETURNING
data;

DELETE examples

delete_deployment_rule

Endpoint to delete a deployment rule.

DELETE FROM datadog.software_delivery.deployment_gate_rules
WHERE gate_id = '{{ gate_id }}' --required
AND id = '{{ id }}' --required
;