# FirewallRuleSets Object

> Source: https://truto.one/docs/api-reference/unified-cloud-infrastructure-api/firewallrulesets/

Schema for the `FirewallRuleSets` resource in **Unified Cloud Infrastructure API**.

## Properties

- **`id`** _(string, required)_
  Truto's stable unified identifier for this object. Opaque; use provider_ref to address the object in the provider's own console or API.
- **`provider_ref`** _(string, required)_
  The provider's own unbroken identifier, passed through verbatim -- a full ARN, resource id or self-link. Never truncated, prefixed or normalised. This is the customer-facing key used to find the object in the console.
- **`provider`** _(string, required)_
  Which cloud this object was read from.
  Allowed: `aws`, `azure`, `gcp`
- **`account_ref`** _(string, required)_
  The account, subscription or project the object belongs to. An object with no account cannot be attributed to an environment, so this is always present for objects that live inside an account.
- **`region`** _(string)_
  Where the object is. A compliance answer in its own right, not metadata. The literal string 'global' is emitted for genuinely global resources (for example IAM, or a GCP VPC network) rather than guessing a region. Never invented: where the provider does not return a location and none can be derived, the collector's queried region is used and that substitution is recorded in unreadable_fields.
- **`native_type`** _(string, required)_
  The provider's own type string, unmodified -- for example 'AWS::S3::Bucket', 'aws_iam_role', 'Microsoft.Sql/servers'. Used for display and drill-down.
- **`tags`** _(object)_
  Key-value pairs exactly as the customer set them: no case folding, no key or value normalisation, no merging of separate provider concepts. Present on every object because tags are the primary input for environment classification. An empty object means the object carries no tags; tags that could not be read are recorded in unreadable_fields instead.
- **`collected_at`** _(string, required)_
  When Truto actually read this object from the provider, in UTC ISO 8601 with the offset present. Not when the request was made and not a provider timestamp. Drives consumer staleness rules.
- **`unreadable_fields`** _(array<object>)_
  Per-object list of the fields that could not be read, and why -- the brief section 8.4 answer, chosen over per-field sentinel values. Each entry is an object with 'field' (the property name on this resource), 'reason' (a reason code) and an optional human-readable 'detail'. Reason codes: not_supported_by_provider, not_configured, permission_denied, not_collected, collection_error, partially_collected. An empty array means every property on this object was read successfully. A property absent from this array and null in the payload means the provider genuinely returned no value, which is different from 'we could not look'.
- **`remote_data`** _(object)_
  Raw data returned from the remote API call.
- **`rule_set_ref`** _(string, required)_
  The provider's own identifier for the rule set.
- **`name`** _(string, required)_
  The rule set name.
- **`scope_type`** _(string, required)_
  Which firewall primitive this is. Emitted as a real discriminator rather than papering over the difference, because the primitives have different semantics and different available fields.
  Allowed: `security_group`, `network_acl`, `firewall_policy`, `firewall_rule`, `unknown`
- **`is_stateful`** _(boolean)_
  Whether return traffic is implicitly allowed.
- **`supports_deny`** _(boolean)_
  Whether this primitive can express a deny at all. False for AWS security groups, which are allow-only, so the 'allow' action on their rules is a structural constant and not something the provider told us.
- **`is_ordered`** _(boolean)_
  Whether rule order determines evaluation. False for AWS security groups, whose rules are an unordered set evaluated as a union -- which is why no priority is fabricated from array position.
- **`attached_to`** _(array<object>)_
  What this rule set is attached to, as objects carrying the target reference and its type. For AWS security groups the attachment is not in the provider's model at all: it is observed by listing network interfaces and joining, which makes it 'groups observed in use right now' rather than configuration -- an autoscaling event changes it.
- **`attached_boundary_ref`** _(string)_
  The network boundary this rule set belongs to.
- **`observed_attachment_only`** _(boolean)_
  True when attached_to was observed from live interfaces rather than read from configuration, so the consumer does not treat a point-in-time observation as a stable fact.
- **`rules`** _(array<object>)_
  The rules in this set, as objects. Each rule carries direction, action, protocol, port_range, source_ranges, destination_ranges, target_selector, priority, description, enabled and logging_enabled. Four of those are not real for AWS security groups and are marked in unreadable_fields rather than fabricated: action is a constant because the primitive is allow-only, priority does not exist because rules are unordered, no per-rule enabled state exists, and no per-rule logging exists. target_selector matters where a provider selects targets by tag or service identity rather than by attachment, making 'which rules apply to this machine' a computed answer. Note that a protocol meaning 'all' makes any accompanying port range meaningless, and for ICMP the two port numbers are type and code rather than ports. An empty array means the set genuinely has no rules.
- **`rule_count`** _(integer)_
  How many rules this set contains.
- **`descriptions_supported`** _(boolean)_
  Whether this primitive carries a per-rule description at all. One standard asks whether each rule has a documented business reason, and the answer must distinguish 'the rule has no description' from 'this primitive has no description field' -- AWS security group rules have one, network ACL entries do not.
- **`has_open_ingress_from_anywhere`** _(boolean)_
  Whether any rule permits inbound traffic from the whole internet. Derived.

## Methods

- [GET /unified/cloud-infrastructure/firewall_rule_sets](/docs/api-reference/unified-cloud-infrastructure-api/firewallrulesets/list) — List Firewall rule sets