You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/data-sources/cloud_compliance_framework_controls.md
+15-15Lines changed: 15 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,15 +2,15 @@
2
2
page_title: "crowdstrike_cloud_compliance_framework_controls Data Source - crowdstrike"
3
3
subcategory: "Cloud Compliance"
4
4
description: |-
5
-
This data source retrieves all or a subset of controls within compliance benchmarks. You can search within a single benchmark using the 'benchmark', 'name', and 'requirement' fields, or across multiple benchmarks using an FQL filter. When using 'name', 'benchmark', and 'requirement', the 'benchmark' field is required.
5
+
This data source retrieves all or a subset of controls within compliance benchmarks. All non-FQL fields can accept wildcards * and query Falcon using logical AND. If FQL is defined, all other fields will be ignored. For advanced queries to further narrow your search, please use a Falcon Query Language (FQL) filter. For additional information on FQL filtering and usage, refer to the official CrowdStrike documentation: Falcon Query Language (FQL) https://falcon.crowdstrike.com/documentation/page/d3c84a1b/falcon-query-language-fql
This data source retrieves all or a subset of controls within compliance benchmarks. You can search within a single benchmark using the 'benchmark', 'name', and 'requirement' fields, or across multiple benchmarks using an FQL filter. When using 'name', 'benchmark', and 'requirement', the 'benchmark' field is required.
13
+
This data source retrieves all or a subset of controls within compliance benchmarks. All non-FQL fields can accept wildcards `*` and query Falcon using logical AND. If FQL is defined, all other fields will be ignored. For advanced queries to further narrow your search, please use a Falcon Query Language (FQL) filter. For additional information on FQL filtering and usage, refer to the official CrowdStrike documentation: [Falcon Query Language (FQL)](https://falcon.crowdstrike.com/documentation/page/d3c84a1b/falcon-query-language-fql)
14
14
15
15
## API Scopes
16
16
@@ -36,8 +36,7 @@ provider "crowdstrike" {
36
36
37
37
# retrieve all controls under a named benchmark
38
38
data "crowdstrike_cloud_compliance_framework_controls" "all" {
39
-
cloud_provider = "AWS"
40
-
rule_name = "NLB/ALB configured publicly with TLS/SSL disabled"
39
+
benchmark = "CIS 1.0.0 AWS Web Architecture"
41
40
}
42
41
43
42
# retrieve a single control within a benchmark by name
@@ -63,24 +62,25 @@ data "crowdstrike_cloud_compliance_framework_controls" "fql" {
63
62
64
63
### Optional
65
64
66
-
-`benchmark` (String) Name of the compliance benchmark in the framework.
65
+
-`benchmark` (String) Name of the compliance benchmark in the framework. Examples: `AWS Foundational Security Best Practices v1.*`, `CIS 1.2.0 GCP`, `CIS 1.8.0 GKE`
66
+
-`control_name` (String) Name of the control. Examples: `Ensure security contact phone is set`, `Ensure that Azure Defender*`
67
+
-`fql` (String) Falcon Query Language (FQL) filter for advanced control searches. FQL filter, allowed props: `compliance_control_name`, `compliance_control_authority`, `compliance_control_type`, `compliance_control_section`, `compliance_control_requirement`, `compliance_control_benchmark_name`, `compliance_control_benchmark_version`
68
+
-`requirement` (String) Requirement of the control(s) within the framework. Examples: `2.*`, `1.1`
69
+
-`section` (String) Section of the benchmark where the control(s) reside. Examples: `Data Protection`, `Data*`
70
+
71
+
### Read-Only
72
+
67
73
-`controls` (Attributes Set) Security framework and compliance rule information. (see [below for nested schema](#nestedatt--controls))
68
-
-`fql` (String) Falcon Query Language (FQL) filter for advanced control searches. FQL filter, allowed props: *compliance_control_name**compliance_control_authority**compliance_control_type**compliance_control_section**compliance_control_requirement**compliance_control_benchmark_name**compliance_control_benchmark_version*
69
-
-`name` (String) Name of the control.
70
-
-`requirement` (String) Version of the control.
71
74
72
75
<aid="nestedatt--controls"></a>
73
76
### Nested Schema for `controls`
74
77
75
-
Required:
78
+
Read-Only:
76
79
80
+
-`authority` (String) The compliance authority for the framework
81
+
-`benchmark` (String) The compliance benchmark within the framework.
77
82
-`code` (String) The unique compliance framework rule code.
83
+
-`id` (String) The id of the compliance control.
78
84
-`name` (String) The name of the control.
79
-
-`uuid` (String) The uuid of the compliance control.
80
-
81
-
Optional:
82
-
83
-
-`authority` (String) This compliance authority for the framework
84
-
-`benchmark` (String) The compliance benchmark within the framework.
85
85
-`requirement` (String) The compliance framework requirement.
86
86
-`section` (String) The section within the compliance benchmark.
Copy file name to clipboardExpand all lines: docs/data-sources/cloud_posture_rules.md
+39-25Lines changed: 39 additions & 25 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,15 +2,15 @@
2
2
page_title: "crowdstrike_cloud_posture_rules Data Source - crowdstrike"
3
3
subcategory: "Cloud Posture"
4
4
description: |-
5
-
This data source retrieves detailed information about a specific cloud posture rule, including its unique identifier (UUID) and associated attributes.
5
+
This data source retrieves detailed information about a specific cloud posture rule, including its unique identifier (ID) and associated attributes.All non-FQL fields can accept wildcards * and query Falcon using logical AND. If FQL is defined, all other fields will be ignored. For advanced queries to further narrow your search, please use a Falcon Query Language (FQL) filter. For additional information on FQL filtering and usage, refer to the official CrowdStrike documentation: Falcon Query Language (FQL) https://falcon.crowdstrike.com/documentation/page/d3c84a1b/falcon-query-language-fql
6
6
API Scopes
7
7
The following API scopes are required:
8
8
Cloud Security Policies | Read & Write
9
9
---
10
10
11
11
# crowdstrike_cloud_posture_rules (Data Source)
12
12
13
-
This data source retrieves detailed information about a specific cloud posture rule, including its unique identifier (UUID) and associated attributes.
13
+
This data source retrieves detailed information about a specific cloud posture rule, including its unique identifier (ID) and associated attributes.All non-FQL fields can accept wildcards `*` and query Falcon using logical AND. If FQL is defined, all other fields will be ignored. For advanced queries to further narrow your search, please use a Falcon Query Language (FQL) filter. For additional information on FQL filtering and usage, refer to the official CrowdStrike documentation: [Falcon Query Language (FQL)](https://falcon.crowdstrike.com/documentation/page/d3c84a1b/falcon-query-language-fql)
14
14
15
15
## API Scopes
16
16
@@ -34,59 +34,73 @@ provider "crowdstrike" {
34
34
cloud = "us-2"
35
35
}
36
36
37
-
# return all rules for a single cloud provider
38
-
data "crowdstrike_cloud_posture_rules" "all" {
39
-
cloud_provider = "AWS"
40
-
}
41
-
42
37
# return a single rule within a cloud provider
43
38
data "crowdstrike_cloud_posture_rules" "specific" {
44
39
cloud_provider = "AWS"
45
40
rule_name = "NLB/ALB configured publicly with TLS/SSL disabled"
46
41
}
42
+
43
+
# query by FQL filter
44
+
data "crowdstrike_cloud_posture_rules" "original" {
45
+
fql = "rule_name:'NLB/ALB configured publicly with TLS/SSL disabled'"
46
+
}
47
+
48
+
# return all rules for a specific resource type within a benchmark
49
+
data "crowdstrike_cloud_posture_rules" "original" {
50
+
resource_type = "AWS::ElasticLoadBalancingV2::*"
51
+
benchmark = "CIS 1.0.0 AWS Web Architecture"
52
+
}
53
+
54
+
# return all rules for a specific resource type within an entire framework
55
+
data "crowdstrike_cloud_posture_rules" "original" {
56
+
resource_type = "AWS::ElasticLoadBalancingV2::*"
57
+
framework = "CIS"
58
+
}
47
59
```
48
60
49
61
<!-- schema generated by tfplugindocs -->
50
62
## Schema
51
63
52
-
### Required
64
+
### Optional
53
65
66
+
-`benchmark` (String) Name of the benchmark that this rule is attached to. Note that rules can be associated with multiple benchmarks. Example: `CIS 1.0.0 AWS*`
54
67
-`cloud_provider` (String) Cloud provider for where the rule resides.
-`framework` (String) Name of the framework that this rule is attached to. Note that rules can be associated with multiple benchmarks. Examples: CIS, NIST
70
+
-`resource_type` (String) Name of the resource type to search for. Examples: `AWS::IAM::CredentialReport`, `Microsoft.Compute/virtualMachines`, `container.googleapis.com/Cluster`.
71
+
-`rule_name` (String) Name of the rule to search for. If no name is defined all rules in a cloud provider will be returned.
72
+
-`service` (String) Name of the service within the cloud provider that rule is for. Examples: IAM, S3, Microsoft.Compute
55
73
56
-
### Optional
74
+
### Read-Only
57
75
58
-
-`rule_name` (String) Name of the rule to search for. If no name is defined all rules in cloud provider will be returned.
59
-
-`rules` (Attributes List) List of cloud posture rules (see [below for nested schema](#nestedatt--rules))
76
+
-`rules` (Attributes Set) List of cloud posture rules (see [below for nested schema](#nestedatt--rules))
60
77
61
78
<aid="nestedatt--rules"></a>
62
79
### Nested Schema for `rules`
63
80
64
-
Optional:
81
+
Read-Only:
65
82
66
-
-`alert_info` (List of String) A list of the alert logic and detection criteria for rule violations. Parent value will be used when parent_rule_id is defined.
83
+
-`alert_info` (List of String) A list of the alert logic and detection criteria for rule violations.
67
84
-`attack_types` (Set of String) Specific attack types associated with the rule.
68
-
-`auto_remediable` (Boolean) Autoremediation enabled for rule
85
+
-`auto_remediable` (Boolean) Autoremediation enabled for the policy rule
69
86
-`cloud_platform` (String) Cloud platform for the policy rule.
70
87
-`cloud_provider` (String) Cloud provider for the policy rule.
71
88
-`controls` (Attributes Set) Security framework and compliance rule information. (see [below for nested schema](#nestedatt--rules--controls))
72
89
-`description` (String) Description of the policy rule.
73
-
-`domain` (String) Timestamp of the last Terraform update of the resource.
74
-
-`logic` (String) Rego logic for the rule. If this is not defined, then parent_rule_id must be defined.
90
+
-`domain` (String) Domain for the policy rule.
91
+
-`id` (String) Unique identifier of the policy rule.
92
+
-`logic` (String) Rego logic for the policy rule.
75
93
-`name` (String) Name of the policy rule.
76
-
-`parent_rule_id` (String) UUID of the parent rule to inherit properties from. Required if logic is not specified.
77
-
-`remediation_info` (String) Information about how to remediate issues detected by this rule.
78
-
-`resource_type` (String) The full resource type. Format examples: AWS: AWS::IAM::CredentialReport, Azure: Microsoft.Compute/virtualMachines, GCP: container.googleapis.com/Cluster
79
-
-`severity` (Number) Severity of the rule. Valid values are 0 (critical), 1 (high), 2 (medium), 3 (informational).
94
+
-`parent_rule_id` (String) Id of the parent rule to inherit properties from.
95
+
-`remediation_info` (List of String) Information about how to remediate issues detected by this rule.
96
+
-`resource_type` (String) The full resource type. Format examples: `AWS::IAM::CredentialReport`, `Microsoft.Compute/virtualMachines`, `container.googleapis.com/Cluster`
97
+
-`severity` (String) Severity of the rule. Valid values are `critical`, `high`, `medium`, `informational`.
80
98
-`subdomain` (String) Subdomain for the policy rule. Valid values are 'IOM' (Indicators of Misconfiguration) or 'IAC' (Infrastructure as Code). IOM is only supported at this time.
81
99
82
-
Read-Only:
83
-
84
-
-`uuid` (String) Unique identifier of the policy rule.
85
-
86
100
<aid="nestedatt--rules--controls"></a>
87
101
### Nested Schema for `rules.controls`
88
102
89
103
Required:
90
104
91
-
-`authority` (String) This compliance framework
105
+
-`authority` (String) The compliance framework
92
106
-`code` (String) The compliance framework rule code
This resource manages custom cloud posture rules. These rules can be created either by inheriting properties from a parent rule with minimal customization, or by fully customizing all attributes for maximum flexibility.
5
+
This resource manages custom cloud posture rules. These rules can be created either by inheriting properties from a parent rule with minimal customization, or by fully customizing all attributes for maximum flexibility. To create a rule based on a parent rule, utilize the crowdstrike_cloud_posture_rules data source to gather parent rule information to use in the new custom rule. The crowdstrike_cloud_compliance_framework_controls data source can be used to query Falcon for compliance benchmark controls to associate with custom rules created with this resource.
This resource manages custom cloud posture rules. These rules can be created either by inheriting properties from a parent rule with minimal customization, or by fully customizing all attributes for maximum flexibility.
13
+
This resource manages custom cloud posture rules. These rules can be created either by inheriting properties from a parent rule with minimal customization, or by fully customizing all attributes for maximum flexibility. To create a rule based on a parent rule, utilize the `crowdstrike_cloud_posture_rules` data source to gather parent rule information to use in the new custom rule. The `crowdstrike_cloud_compliance_framework_controls` data source can be used to query Falcon for compliance benchmark controls to associate with custom rules created with this resource.
14
14
15
15
## API Scopes
16
16
@@ -37,12 +37,10 @@ provider "crowdstrike" {
37
37
# Custom rule derived from a parent rule with specific modifications
-`cloud_platform` (String) Cloud platform for the policy rule.
115
110
-`cloud_provider` (String) Cloud provider for the policy rule.
116
111
-`description` (String) Description of the policy rule.
117
112
-`name` (String) Name of the policy rule.
118
-
-`resource_type` (String) The full resource type. Format examples: AWS: AWS::IAM::CredentialReport, Azure: Microsoft.Compute/virtualMachines, GCP: container.googleapis.com/Cluster.
119
-
-`subdomain` (String) Subdomain for the policy rule. Valid values are 'IOM' (Indicators of Misconfiguration) or 'IaC' (Infrastructure as Code). IOM is only supported at this time.
113
+
-`resource_type` (String) The full resource type. Examples: `AWS::IAM::CredentialReport`, `Microsoft.Compute/virtualMachines`, `container.googleapis.com/Cluster`
120
114
121
115
### Optional
122
116
123
-
-`alert_info` (List of String) A list of the alert logic and detection criteria for rule violations. Parent value will be used when parent_rule_id is defined.
124
-
-`attack_types` (Set of String) Specific attack types associated with the rule. Note: If 'parent_rule_id' is specified, these attack types will be inherited from the parent rule, and any values provided here will be ignored.
125
-
-`controls` (Attributes Set) Security framework and compliance rule information. (see [below for nested schema](#nestedatt--controls))
126
-
-`logic` (String) Rego logic for the rule. If this is not defined, then parent_rule_id must be defined.
127
-
-`parent_rule_id` (String) UUID of the parent rule to inherit properties from. Required if logic is not specified.
128
-
-`remediation_info` (List of String) Information about how to remediate issues detected by this rule.
129
-
-`severity` (Number) Severity of the rule. Valid values are 0 (critical), 1 (high), 2 (medium), 3 (informational).
117
+
-`alert_info` (List of String) A list of the alert logic and detection criteria for rule violations. When `alert_info` is not defined and `parent_rule_id` is defined, this field will inherit the parent rule's `alert_info`. Do not include numbering within this list. The Falcon console will automatically add numbering.
118
+
-`attack_types` (Set of String) Specific attack types associated with the rule. Note: If `parent_rule_id` is defined, attack types will be inherited from the parent rule and cannot be specified using this field.
119
+
-`controls` (Attributes Set) Security framework and compliance rule information. Utilize the `crowdstrike_cloud_compliance_framework_controls` data source to obtain this information. When `controls` is not defined and `parent_rule_id` is defined, this field will inherit the parent rule's `controls`. (see [below for nested schema](#nestedatt--controls))
120
+
-`logic` (String) Rego logic for the rule. If this is not defined, then parent_rule_id must be defined. When `parent_rule_id` is defined, `logic` from the parent rule is not visible, but it is used for triggering this rule.
121
+
-`parent_rule_id` (String) Id of the parent rule to inherit properties from. The `crowdstrike_cloud_posture_rules` data source can be used to query Falcon for parent rule information to use in this field. Required if `logic` is not specified.
122
+
-`remediation_info` (List of String) Information about how to remediate issues detected by this rule. Do not include numbering within this list. The Falcon console will automatically add numbering.
123
+
-`severity` (String) Severity of the rule. Valid values are `critical`, `high`, `medium`, `informational`.
130
124
131
125
### Read-Only
132
126
127
+
-`cloud_platform` (String) Cloud platform for the policy rule.
133
128
-`domain` (String) CrowdStrike domain for the custom rule. Default is CSPM
134
-
-`uuid` (String) Unique identifier of the policy rule.
129
+
-`id` (String) Unique identifier of the policy rule.
130
+
-`subdomain` (String) Subdomain for the policy rule. Valid values are 'IOM' (Indicators of Misconfiguration) or 'IAC' (Infrastructure as Code). IOM is only supported at this time.
135
131
136
132
<aid="nestedatt--controls"></a>
137
133
### Nested Schema for `controls`
138
134
139
135
Required:
140
136
141
-
-`authority` (String) This compliance framework
137
+
-`authority` (String) The compliance framework
142
138
-`code` (String) The compliance framework rule code
0 commit comments