tcp_flow_protection_rules

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

Overview

Name	tcp_flow_protection_rules
Type	Resource
Id	cloudflare.ddos_protection.tcp_flow_protection_rules

Fields

The following fields are returned by SELECT queries:

get

Get TCP Flow Protection rule response.

Name	Datatype	Description
id	string	The unique ID of the TCP Flow Protection rule.
name	string	The name of the TCP Flow Protection rule. Value is relative to the 'scope' setting. For 'global' scope, name should be 'global'. For either the 'region' or 'datacenter' scope, name should be the actual name of the region or datacenter, e.g., 'wnam' or 'lax'.
burst_sensitivity	string	The burst sensitivity. Must be one of 'low', 'medium', 'high'.
created_on	string (date-time)	The creation timestamp of the TCP Flow Protection rule.
mode	string	The mode for TCP Flow Protection. Must be one of 'enabled', 'disabled', 'monitoring'.
modified_on	string (date-time)	The last modification timestamp of the TCP Flow Protection rule.
rate_sensitivity	string	The rate sensitivity. Must be one of 'low', 'medium', 'high'.
scope	string	The scope for the TCP Flow Protection rule. Must be one of 'global', 'region', or 'datacenter'.

list

List all TCP Flow Protection rules response.

Name	Datatype	Description
id	string	The unique ID of the TCP Flow Protection rule.
name	string	The name of the TCP Flow Protection rule. Value is relative to the 'scope' setting. For 'global' scope, name should be 'global'. For either the 'region' or 'datacenter' scope, name should be the actual name of the region or datacenter, e.g., 'wnam' or 'lax'.
burst_sensitivity	string	The burst sensitivity. Must be one of 'low', 'medium', 'high'.
created_on	string (date-time)	The creation timestamp of the TCP Flow Protection rule.
mode	string	The mode for TCP Flow Protection. Must be one of 'enabled', 'disabled', 'monitoring'.
modified_on	string (date-time)	The last modification timestamp of the TCP Flow Protection rule.
rate_sensitivity	string	The rate sensitivity. Must be one of 'low', 'medium', 'high'.
scope	string	The scope for the TCP Flow Protection rule. Must be one of 'global', 'region', or 'datacenter'.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	account_id, rule_id		Get a TCP Flow Protection rule specified by the given UUID.
list	select	account_id	page, per_page, order, direction	List all TCP Flow Protection rules for an account.
create	insert	account_id, scope, name, mode, rate_sensitivity, burst_sensitivity		Create a TCP Flow Protection rule for an account.
edit	update	account_id, rule_id		Update a TCP Flow Protection rule specified by the given UUID.
delete	delete	account_id, rule_id		Delete a TCP Flow Protection rule specified by the given UUID.
bulk_delete	delete	account_id		Delete all TCP Flow Protection rules for an account.

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
account_id	string	The Cloudflare account ID.
rule_id	string	The rule ID.
direction	string	The direction of ordering (ASC or DESC). Defaults to 'ASC'.
order	string	The field to order by. Defaults to 'prefix'.
page	integer (int64)	The page number for pagination. Defaults to 1.
per_page	integer (int64)	The number of items per page. Must be between 10 and 1000. Defaults to 25.

SELECT examples

get

Get a TCP Flow Protection rule specified by the given UUID.

SELECT
id,
name,
burst_sensitivity,
created_on,
mode,
modified_on,
rate_sensitivity,
scope
FROM cloudflare.ddos_protection.tcp_flow_protection_rules
WHERE account_id = '{{ account_id }}' -- required
AND rule_id = '{{ rule_id }}' -- required
;

list

List all TCP Flow Protection rules for an account.

SELECT
id,
name,
burst_sensitivity,
created_on,
mode,
modified_on,
rate_sensitivity,
scope
FROM cloudflare.ddos_protection.tcp_flow_protection_rules
WHERE account_id = '{{ account_id }}' -- required
AND page = '{{ page }}'
AND per_page = '{{ per_page }}'
AND order = '{{ order }}'
AND direction = '{{ direction }}'
;

INSERT examples

create

Create a TCP Flow Protection rule for an account.

INSERT INTO cloudflare.ddos_protection.tcp_flow_protection_rules (
burst_sensitivity,
mode,
name,
rate_sensitivity,
scope,
account_id
)
SELECT 
'{{ burst_sensitivity }}' /* required */,
'{{ mode }}' /* required */,
'{{ name }}' /* required */,
'{{ rate_sensitivity }}' /* required */,
'{{ scope }}' /* required */,
'{{ account_id }}'
RETURNING
errors,
messages,
result,
success
;

Manifest

# Description fields are for documentation purposes
- name: tcp_flow_protection_rules
props:
  - name: account_id
    value: "{{ account_id }}"
    description: Required parameter for the tcp_flow_protection_rules resource.
  - name: burst_sensitivity
    value: "{{ burst_sensitivity }}"
    description: |
      The burst sensitivity. Must be one of 'low', 'medium', 'high'.
  - name: mode
    value: "{{ mode }}"
    description: |
      The mode for the TCP Flow Protection. Must be one of 'enabled', 'disabled', 'monitoring'.
  - name: name
    value: "{{ name }}"
    description: |
      The name of the TCP Flow Protection rule. Value is relative to the 'scope' setting. For 'global' scope, name should be 'global'. For either the 'region' or 'datacenter' scope, name should be the actual name of the region or datacenter, e.g., 'wnam' or 'lax'.
  - name: rate_sensitivity
    value: "{{ rate_sensitivity }}"
    description: |
      The rate sensitivity. Must be one of 'low', 'medium', 'high'.
  - name: scope
    value: "{{ scope }}"
    description: |
      The scope for the TCP Flow Protection rule.

UPDATE examples

edit

Update a TCP Flow Protection rule specified by the given UUID.

UPDATE cloudflare.ddos_protection.tcp_flow_protection_rules
SET 
burst_sensitivity = '{{ burst_sensitivity }}',
mode = '{{ mode }}',
rate_sensitivity = '{{ rate_sensitivity }}'
WHERE 
account_id = '{{ account_id }}' --required
AND rule_id = '{{ rule_id }}' --required
RETURNING
errors,
messages,
result,
success;

DELETE examples

delete

Delete a TCP Flow Protection rule specified by the given UUID.

DELETE FROM cloudflare.ddos_protection.tcp_flow_protection_rules
WHERE account_id = '{{ account_id }}' --required
AND rule_id = '{{ rule_id }}' --required
;

bulk_delete

Delete all TCP Flow Protection rules for an account.

DELETE FROM cloudflare.ddos_protection.tcp_flow_protection_rules
WHERE account_id = '{{ account_id }}' --required
;