Policy types for @turbot/aws-wafregional
- AWS > Turbot > Event Handlers > Events > Rules > Event Sources > @turbot/aws-wafregional
- AWS > Turbot > Permissions > Compiled > API Boundary > @turbot/aws-wafregional
- AWS > Turbot > Permissions > Compiled > Levels > @turbot/aws-wafregional
- AWS > Turbot > Permissions > Compiled > Service Permissions > @turbot/aws-wafregional
- AWS > WAF Regional > API Enabled
- AWS > WAF Regional > Approved Regions [Default]
- AWS > WAF Regional > Enabled
- AWS > WAF Regional > Permissions
- AWS > WAF Regional > Permissions > Levels
- AWS > WAF Regional > Permissions > Levels > Modifiers
- AWS > WAF Regional > Permissions > Lockdown
- AWS > WAF Regional > Permissions > Lockdown > API Boundary
- AWS > WAF Regional > Regions
- AWS > WAF Regional > Rule > Active
- AWS > WAF Regional > Rule > Active > Age
- AWS > WAF Regional > Rule > Active > Budget
- AWS > WAF Regional > Rule > Active > Last Modified
- AWS > WAF Regional > Rule > Approved
- AWS > WAF Regional > Rule > Approved > Budget
- AWS > WAF Regional > Rule > Approved > Custom
- AWS > WAF Regional > Rule > Approved > Regions
- AWS > WAF Regional > Rule > Approved > Usage
- AWS > WAF Regional > Rule > CMDB
- AWS > WAF Regional > Rule > Regions
- AWS > WAF Regional > Rule > Usage
- AWS > WAF Regional > Rule > Usage > Limit
- AWS > WAF Regional > Tags Template [Default]
AWS > Turbot > Event Handlers > Events > Rules > Event Sources > @turbot/aws-wafregional
AWS WAF Regional CloudWatch Events event sources for the Guardrails Event Handlers.
tmod:@turbot/aws-wafregional#/policy/types/wafRegionalEventSources
{ "type": "array", "items": { "type": "string" }, "default": [ "aws.waf-regional" ]}
AWS > Turbot > Permissions > Compiled > API Boundary > @turbot/aws-wafregional
A read-only policy generated by Guardrails that lists the APIs that
should be added to the guardrails-managed (hard) boundary policy,
thereby enabling them to be assigned to users and roles.
This value will change depending on the value of the value of theAWS > WAF Regional > Permissions > Lockdown > API Boundary
policy
tmod:@turbot/aws-wafregional#/policy/types/awsCompiledApiBoundary
{ "type": "array"}
AWS > Turbot > Permissions > Compiled > Levels > @turbot/aws-wafregional
A calculated policy that Guardrails uses to create a compiled list of ALL permissions for AWS WAF Regional
that is used as input to the stack that manages the Guardrails IAM permissions objects.
tmod:@turbot/aws-wafregional#/policy/types/awsLevelsCompiled
AWS > Turbot > Permissions > Compiled > Service Permissions > @turbot/aws-wafregional
A calculated policy that Guardrails uses to create a compiled list of ALL permissions for AWS WAF Regional
that is used as input to the control that manages the IAM stack.
tmod:@turbot/aws-wafregional#/policy/types/awsCompiledServicePermissions
AWS > WAF Regional > API Enabled
Configure whether the AWS WAF Regional API is enabled.
Note: Disabling the service disables the API for ALL users and roles, and Guardrails will have no access to the API.
tmod:@turbot/aws-wafregional#/policy/types/wafRegionalApiEnabled
[ "Enabled", "Disabled", "Enabled if AWS > WAF Regional > Enabled"]
{ "type": "string", "enum": [ "Enabled", "Disabled", "Enabled if AWS > WAF Regional > Enabled" ], "default": "Enabled"}
AWS > WAF Regional > Approved Regions [Default]
A list of AWS regions in which AWS WAF Regional resources are approved for use.
The expected format is an array of regions names. You may use the '*' and
'?' wildcard characters.
This policy is the default value for all AWS WAF Regional resources' Approved > Regions policies.
tmod:@turbot/aws-wafregional#/policy/types/wafRegionalApprovedRegionsDefault
"{\n regions: policyValue(uri:\"tmod:@turbot/aws#/policy/types/approvedRegionsDefault\") {\n value\n }\n}\n"
"{% if $.regions.value | length == 0 %} [] {% endif %}{% for item in $.regions.value %}- '{{ item }}'\n{% endfor %}"
AWS > WAF Regional > Enabled
Configure whether the AWS WAF Regional service is enabled.
This will only affect Guardrails managed User Roles and will allow the Guardrails managed user to access AWS WAF Regional service.
- Enabled
policy allows Guardrails managed users to perform all the actions for the service
- Enabled: Metadata Only
policy allows Guardrails managed users to perform only the metadata level actions for the service (like describe*
, list*
)
Note:
- Disabled
policy disables the service but does NOT disable the API for Guardrails or SuperUsers
- All the resource data stored in the Guardrails CMDB is considered to be metadata
- For more information related to permissions and grant levels, please check the documentation
tmod:@turbot/aws-wafregional#/policy/types/wafRegionalEnabled
[ "Enabled", "Enabled: Metadata Only", "Disabled"]
{ "type": "string", "enum": [ "Enabled", "Enabled: Metadata Only", "Disabled" ], "example": [ "Enabled" ], "default": "Disabled"}
AWS > WAF Regional > Permissions
Configure whether permissions policies are in effect for AWS WAF Regional.
This setting does not affect account level permissions (AWS/Admin, AWS/Owner, etc)
Note: The behavior of this policy depends on the value of AWS > Permissions.
tmod:@turbot/aws-wafregional#/policy/types/wafRegionalPermissions
[ "Enabled", "Disabled", "Enabled if AWS > WAF Regional > Enabled & AWS > WAF Regional > API Enabled"]
{ "type": "string", "enum": [ "Enabled", "Disabled", "Enabled if AWS > WAF Regional > Enabled & AWS > WAF Regional > API Enabled" ], "example": [ "Enabled" ], "default": "Enabled if AWS > WAF Regional > Enabled & AWS > WAF Regional > API Enabled"}
AWS > WAF Regional > Permissions > Levels
Define the permissions levels that can be used to grant access to an AWS account.
Permissions levels defined will appear in the UI to assign access to Guardrails users.
This policy provides a default for Permissions > Levels in each service,
however you can explicitly override the setting for each service if desired
tmod:@turbot/aws-wafregional#/policy/types/wafRegionalPermissionsLevels
[ "{\n item: account {\n turbot{\n id\n }\n }\n}\n", "{\n availableLevels: policyValues(filter:\"policyTypeLevel:self resourceId:{{ $.item.turbot.id }} policyTypeId:'tmod:@turbot/aws-iam#/policy/types/permissionsLevelsDefault'\") {\n items {\n value\n }\n }\n}\n"]
"{% if $.availableLevels.items[0].value | length == 0 %} [] {% endif %}{% for item in $.availableLevels.items[0].value %}- {{ item }}\n{% endfor %}"
{ "type": "array", "items": { "type": "string", "enum": [ "Metadata", "ReadOnly", "Operator", "Admin", "Owner" ] }}
AWS > WAF Regional > Permissions > Levels > Modifiers
A map of AWS API to Guardrails Permission Level used to customize Guardrails' standard permissions.
You can add, remove or redefine the mapping of AWS API operations to Guardrails permissions levels here.
Note: Modifiers are cumulative - if you add a permission to the Metadata level, it is also added to ReadOnly, Operator and Admin.
Modifier policies set here apply ONLY to the AWS level<br />example:<br /> - "glacier:createvault": admin<br /> - "glacier:ListVaults": metadata<br /> - "s3:DeleteBucket": none<br />
tmod:@turbot/aws-wafregional#/policy/types/wafRegionalPermissionsLevelsModifiers
AWS > WAF Regional > Permissions > Lockdown
tmod:@turbot/aws-wafregional#/policy/types/wafRegionalPermissionsLockdown
AWS > WAF Regional > Permissions > Lockdown > API Boundary
Configure whether the AWS wafRegional API is enabled for all users and roles in guardrails-managed boundary policies.
Note: Disabling the service disables the API for ALL users and roles, and Guardrails will have no access to the API.
tmod:@turbot/aws-wafregional#/policy/types/wafRegionalPermissionsLockdownApiBoundary
[ "Enabled if AWS > WAF Regional > API Enabled"]
{ "type": "string", "enum": [ "Enabled if AWS > WAF Regional > API Enabled" ], "example": [ "Enabled if AWS > WAF Regional > API Enabled" ], "default": "Enabled if AWS > WAF Regional > API Enabled"}
AWS > WAF Regional > Regions
A list of AWS regions in which AWS WAF Regional resources are supported for use.
The expected format is an array of regions names. You may use the '*' and
'?' wildcard characters.
This policy is the default value for all AWS WAF Regional resources' Regions policies.
tmod:@turbot/aws-wafregional#/policy/types/wafRegionalRegionsDefault
{ "allOf": [ { "$ref": "aws#/definitions/regionNameMatcherList" }, { "default": [ "ap-east-1", "ap-northeast-1", "ap-northeast-2", "ap-south-1", "ap-southeast-1", "ap-southeast-2", "ca-central-1", "eu-central-1", "eu-north-1", "eu-west-1", "eu-west-2", "eu-west-3", "me-south-1", "sa-east-1", "us-east-1", "us-east-2", "us-gov-west-1", "us-west-1", "us-west-2" ] } ]}
AWS > WAF Regional > Rule > Active
Determine the action to take when an AWS WAF Regional rule, based on the AWS > WAF Regional > Rule > Active > *
policies.
The control determines whether the resource is in active use, and if not,
has the ability to delete / cleanup the resource. When running an automated
compliance environment, it's common to end up with a wide range of alarms
that are difficult and time consuming to clear. The Active control brings
automated, well-defined control to this process.
The Active control checks the status of all defined Active policies for the
resource (AWS > WAF Regional > Rule > Active > *
), raises an alarm, and takes the defined enforcement
action. Each Active sub-policy can calculate a status of active, inactive
or skipped. Generally, if the resource appears to be Active for any reason
it will be considered Active.
Note the contrast with Approved, where if the resource appears to be Unapproved for any reason it will be considered
Unapproved.
See Active for more information.
tmod:@turbot/aws-wafregional#/policy/types/ruleActive
[ "Skip", "Check: Active", "Enforce: Delete inactive with 1 day warning", "Enforce: Delete inactive with 3 days warning", "Enforce: Delete inactive with 7 days warning", "Enforce: Delete inactive with 14 days warning", "Enforce: Delete inactive with 30 days warning", "Enforce: Delete inactive with 60 days warning", "Enforce: Delete inactive with 90 days warning", "Enforce: Delete inactive with 180 days warning", "Enforce: Delete inactive with 365 days warning"]
{ "type": "string", "enum": [ "Skip", "Check: Active", "Enforce: Delete inactive with 1 day warning", "Enforce: Delete inactive with 3 days warning", "Enforce: Delete inactive with 7 days warning", "Enforce: Delete inactive with 14 days warning", "Enforce: Delete inactive with 30 days warning", "Enforce: Delete inactive with 60 days warning", "Enforce: Delete inactive with 90 days warning", "Enforce: Delete inactive with 180 days warning", "Enforce: Delete inactive with 365 days warning" ], "example": [ "Check: Active" ], "default": "Skip"}
AWS > WAF Regional > Rule > Active > Age
The age after which the AWS WAF Regional rule
is no longer considered active. If a create time is unavailable, the time Guardrails discovered the resource is used.
The Active
control determines whether the resource is in active use, and if not, has
the ability to delete / cleanup the resource. When running an automated
compliance environment, it's common to end up with a wide range of alarms
that are difficult and time consuming to clear. The Active control brings
automated, well-defined control to this process.
The Active control checks the status of all defined Active policies for the
resource (AWS > WAF Regional > Rule > Active > *
),
raises an alarm, and takes the defined enforcement action. Each Active
sub-policy can calculate a status of active, inactive or skipped. Generally,
if the resource appears to be Active for any reason it will be considered Active.
Note the contrast with Approved, where if the resource appears to be Unapproved
for any reason it will be considered Unapproved.
See Active for more information.
tmod:@turbot/aws-wafregional#/policy/types/ruleActiveAge
[ "Skip", "Force inactive if age > 1 day", "Force inactive if age > 3 days", "Force inactive if age > 7 days", "Force inactive if age > 14 days", "Force inactive if age > 30 days", "Force inactive if age > 60 days", "Force inactive if age > 90 days", "Force inactive if age > 180 days", "Force inactive if age > 365 days"]
{ "type": "string", "enum": [ "Skip", "Force inactive if age > 1 day", "Force inactive if age > 3 days", "Force inactive if age > 7 days", "Force inactive if age > 14 days", "Force inactive if age > 30 days", "Force inactive if age > 60 days", "Force inactive if age > 90 days", "Force inactive if age > 180 days", "Force inactive if age > 365 days" ], "example": [ "Force inactive if age > 90 days" ], "default": "Skip"}
AWS > WAF Regional > Rule > Active > Budget
The impact of the budget state on the active control. This policy allows you to force
rules to inactive based on the current budget state, as reflected inAWS > Account > Budget > State
The Active control determines whether the resource is in active use, and if not, has
the ability to delete / cleanup the resource. When running an automated compliance
environment, it's common to end up with a wide range of alarms that are difficult
and time consuming to clear. The Active control brings automated, well-defined
control to this process.
The Active control checks the status of all defined Active policies for the
resource (AWS > WAF Regional > Rule > Active > *
),
raises an alarm, and takes the defined enforcement action. Each Active
sub-policy can calculate a status of active, inactive or skipped. Generally,
if the resource appears to be Active for any reason it will be considered Active.
Note the contrast with Approved, where if the resource appears to be Unapproved
for any reason it will be considered Unapproved.
See Active for more information.
tmod:@turbot/aws-wafregional#/policy/types/ruleActiveBudget
[ "Skip", "Force inactive if Budget > State is Over or higher", "Force inactive if Budget > State is Critical or higher", "Force inactive if Budget > State is Shutdown"]
{ "type": "string", "enum": [ "Skip", "Force inactive if Budget > State is Over or higher", "Force inactive if Budget > State is Critical or higher", "Force inactive if Budget > State is Shutdown" ], "example": [ "Skip" ], "default": "Skip"}
AWS > WAF Regional > Rule > Active > Last Modified
The number of days since the AWS WAF Regional rule
was last modified before it is considered inactive.
The Active
control determines whether the resource is in active use, and if not, has
the ability to delete / cleanup the resource. When running an automated
compliance environment, it's common to end up with a wide range of alarms
that are difficult and time consuming to clear. The Active control brings
automated, well-defined control to this process.
The Active control checks the status of all defined Active policies for the
resource (AWS > WAF Regional > Rule > Active > *
),
raises an alarm, and takes the defined enforcement action. Each Active
sub-policy can calculate a status of active, inactive or skipped. Generally,
if the resource appears to be Active for any reason it will be considered Active.
Note the contrast with Approved, where if the resource appears to be Unapproved
for any reason it will be considered Unapproved.
See Active for more information.
tmod:@turbot/aws-wafregional#/policy/types/ruleActiveLastModified
[ "Skip", "Active if last modified <= 1 day", "Active if last modified <= 3 days", "Active if last modified <= 7 days", "Active if last modified <= 14 days", "Active if last modified <= 30 days", "Active if last modified <= 60 days", "Active if last modified <= 90 days", "Active if last modified <= 180 days", "Active if last modified <= 365 days", "Force active if last modified <= 1 day", "Force active if last modified <= 3 days", "Force active if last modified <= 7 days", "Force active if last modified <= 14 days", "Force active if last modified <= 30 days", "Force active if last modified <= 60 days", "Force active if last modified <= 90 days", "Force active if last modified <= 180 days", "Force active if last modified <= 365 days"]
{ "type": "string", "enum": [ "Skip", "Active if last modified <= 1 day", "Active if last modified <= 3 days", "Active if last modified <= 7 days", "Active if last modified <= 14 days", "Active if last modified <= 30 days", "Active if last modified <= 60 days", "Active if last modified <= 90 days", "Active if last modified <= 180 days", "Active if last modified <= 365 days", "Force active if last modified <= 1 day", "Force active if last modified <= 3 days", "Force active if last modified <= 7 days", "Force active if last modified <= 14 days", "Force active if last modified <= 30 days", "Force active if last modified <= 60 days", "Force active if last modified <= 90 days", "Force active if last modified <= 180 days", "Force active if last modified <= 365 days" ], "example": [ "Active if last modified <= 90 days" ], "default": "Skip"}
AWS > WAF Regional > Rule > Approved
Determine the action to take when an AWS WAF Regional rule is not approved based on AWS > WAF Regional > Rule > Approved > *
policies.
The Approved control checks the status of the defined Approved sub-policies for the resource. If the resource is not approved according to any of these policies, this control raises an alarm and takes the defined enforcement action.
For any enforcement actions that specify if new
, e.g., Enforce: Delete unapproved if new
, this control will only take the enforcement actions for resources created within the last 60 minutes.
See Approved for more information.
tmod:@turbot/aws-wafregional#/policy/types/ruleApproved
[ "Skip", "Check: Approved", "Enforce: Delete unapproved if new"]
{ "type": "string", "enum": [ "Skip", "Check: Approved", "Enforce: Delete unapproved if new" ], "example": [ "Check: Approved" ], "default": "Skip"}
AWS > WAF Regional > Rule > Approved > Budget
The policy allows you to set rules to unapproved based on the current budget state, as reflected in AWS > Account > Budget > State
This policy will be evaluated by the Approved control. If an AWS WAF Regional rule is not matched by the approved list, it will be subject to the action specified in the AWS > WAF Regional > Rule > Approved
policy.
See Approved for more information.
tmod:@turbot/aws-wafregional#/policy/types/ruleApprovedBudget
[ "Skip", "Unapproved if Budget > State is Over or higher", "Unapproved if Budget > State is Critical or higher", "Unapproved if Budget > State is Shutdown"]
{ "type": "string", "enum": [ "Skip", "Unapproved if Budget > State is Over or higher", "Unapproved if Budget > State is Critical or higher", "Unapproved if Budget > State is Shutdown" ], "example": [ "Unapproved if Budget > State is Shutdown" ], "default": "Skip"}
AWS > WAF Regional > Rule > Approved > Custom
Determine whether the AWS WAF Regional rule is allowed to exist.
This policy will be evaluated by the Approved control. If an AWS WAF Regional rule is not approved, it will be subject to the action specified in the AWS > WAF Regional > Rule > Approved
policy.
See Approved for more information.
Note: The policy value must be a string with a value of Approved
, Not approved
or Skip
, or in the form of YAML objects. The object(s) must contain the key result
with its value as Approved
or Not approved
. A custom title and message can also be added using the keys title
and message
respectively.
tmod:@turbot/aws-wafregional#/policy/types/ruleApprovedCustom
{ "example": [ "Approved", "Not approved", "Skip", { "result": "Approved" }, { "title": "string", "result": "Not approved" }, { "title": "string", "result": "Approved", "message": "string" }, [ { "title": "string", "result": "Approved", "message": "string" }, { "title": "string", "result": "Not approved", "message": "string" } ] ], "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "title": { "type": "string", "pattern": "^[\\W\\w]{1,32}$" }, "message": { "type": "string", "pattern": "^[\\W\\w]{1,128}$" }, "result": { "type": "string", "pattern": "^(Approved|Not approved|Skip)$" } }, "required": [ "result" ], "additionalProperties": false } }, { "type": "object", "properties": { "title": { "type": "string", "pattern": "^[\\W\\w]{1,32}$" }, "message": { "type": "string", "pattern": "^[\\W\\w]{1,128}$" }, "result": { "type": "string", "pattern": "^(Approved|Not approved|Skip)$" } }, "required": [ "result" ], "additionalProperties": false }, { "type": "string", "pattern": "^(Approved|Not approved|Skip)$" } ], "default": "Skip"}
AWS > WAF Regional > Rule > Approved > Regions
A list of AWS regions in which AWS WAF Regional rules are approved for use.
The expected format is an array of regions names. You may use the '*' and '?' wildcard characters.
This policy will be evaluated by the Approved control. If an AWS WAF Regional rule is created in a region that is not in the approved list, it will be subject to the action specified in the AWS > WAF Regional > Rule > Approved
policy.
See Approved for more information.
tmod:@turbot/aws-wafregional#/policy/types/ruleApprovedRegions
"{\n regions: policy(uri: \"tmod:@turbot/aws-wafregional#/policy/types/wafRegionalApprovedRegionsDefault\")\n}\n"
"{% if $.regions | length == 0 %} [] {% endif %}{% for item in $.regions %}- '{{ item }}'\n{% endfor %}"
AWS > WAF Regional > Rule > Approved > Usage
Determine whether the AWS WAF Regional rule is allowed to exist.
This policy will be evaluated by the Approved control. If an AWS WAF Regional rule is not approved, it will be subject to the action specified in the AWS > WAF Regional > Rule > Approved
policy.
See Approved for more information.
tmod:@turbot/aws-wafregional#/policy/types/ruleApprovedUsage
[ "Not approved", "Approved", "Approved if AWS > WAF Regional > Enabled"]
{ "type": "string", "enum": [ "Not approved", "Approved", "Approved if AWS > WAF Regional > Enabled" ], "example": [ "Not approved" ], "default": "Approved if AWS > WAF Regional > Enabled"}
AWS > WAF Regional > Rule > CMDB
Configure whether to record and synchronize details for the AWS WAF Regional rule into the CMDB.
The CMDB control is responsible for populating and updating all the attributes for that resource type in the Guardrails CMDB.
All policies and controls in Guardrails are based around the resource, so usually the CMDB policy is set to "Enforce: Enabled".
If set to Skip then all changes to the CMDB are paused - no new resources will be discovered, no updates will be made and deleted resources will not be removed.
To cleanup resources and stop tracking changes, set this policy to "Enforce: Disabled".
CMDB controls also use the Regions policy associated with the resource. If region is not in AWS > WAF Regional > Rule > Regions
policy, the CMDB control will delete the resource from the CMDB.
(Note: Setting CMDB to "Skip" will also pause these changes.)
tmod:@turbot/aws-wafregional#/policy/types/ruleCmdb
[ "Skip", "Enforce: Enabled", "Enforce: Disabled"]
{ "type": "string", "enum": [ "Skip", "Enforce: Enabled", "Enforce: Disabled" ], "example": [ "Skip" ], "default": "Enforce: Enabled"}
AWS > WAF Regional > Rule > Regions
Regions where AWS supports WAF Regional Rule. Guardrails updates this option as AWS expands their regional support. Unless there is an explicit requirement (e.g. accelerated regional support), it should not be set.
tmod:@turbot/aws-wafregional#/policy/types/ruleRegions
"{\n regions: policyValue(uri:\"tmod:@turbot/aws-wafregional#/policy/types/wafRegionalRegionsDefault\") {\n value\n }\n}\n"
"{% if $.regions.value | length == 0 %} [] {% endif %}{% for item in $.regions.value %}- '{{ item }}'\n{% endfor %}"
AWS > WAF Regional > Rule > Usage
Configure the number of AWS WAF Regional rules that can be used for this region and the current consumption against the limit.
You can configure the behavior of the control with this AWS > WAF Regional > Rule > Usage
policy.
tmod:@turbot/aws-wafregional#/policy/types/ruleUsage
[ "Skip", "Check: Usage <= 85% of Limit", "Check: Usage <= 100% of Limit"]
{ "type": "string", "enum": [ "Skip", "Check: Usage <= 85% of Limit", "Check: Usage <= 100% of Limit" ], "example": [ "Check: Usage <= 85% of Limit" ], "default": "Skip"}
AWS > WAF Regional > Rule > Usage > Limit
Maximum number of items that can be created for this region.
tmod:@turbot/aws-wafregional#/policy/types/ruleUsageLimit
{ "type": "integer", "minimum": 0, "default": 100}
AWS > WAF Regional > Tags Template [Default]
A template used to generate the keys and values for AWS WAF Regional resources.
By default, all WAF Regional resource Tags > Template policies will use this value.
tmod:@turbot/aws-wafregional#/policy/types/wafRegionalTagsTemplate
"{\n defaultTags: policyValue(uri:\"tmod:@turbot/aws#/policy/types/defaultTagsTemplate\") {\n value\n }\n}\n"
"{%- if $.defaultTags.value | length == 0 %} [] {%- elif $.defaultTags.value != undefined %}{{ $.defaultTags.value | dump | safe }}{%- else %}{% for item in $.defaultTags.value %}- {{ item }}{% endfor %}{% endif %}"