Policy types for @turbot/aws-athena
- AWS > Athena > API Enabled
- AWS > Athena > Approved Regions [Default]
- AWS > Athena > Enabled
- AWS > Athena > NamedQuery > Active
- AWS > Athena > NamedQuery > Active > Age
- AWS > Athena > NamedQuery > Active > Budget
- AWS > Athena > NamedQuery > Active > Last Modified
- AWS > Athena > NamedQuery > Approved
- AWS > Athena > NamedQuery > Approved > Budget
- AWS > Athena > NamedQuery > Approved > Custom
- AWS > Athena > NamedQuery > Approved > Regions
- AWS > Athena > NamedQuery > Approved > Usage
- AWS > Athena > NamedQuery > CMDB
- AWS > Athena > NamedQuery > Regions
- AWS > Athena > NamedQuery > Tags
- AWS > Athena > NamedQuery > Tags > Template
- AWS > Athena > Permissions
- AWS > Athena > Permissions > Levels
- AWS > Athena > Permissions > Levels > Modifiers
- AWS > Athena > Permissions > Lockdown
- AWS > Athena > Permissions > Lockdown > API Boundary
- AWS > Athena > Regions
- AWS > Athena > Tags Template [Default]
- AWS > Athena > Workgroup > Active
- AWS > Athena > Workgroup > Active > Age
- AWS > Athena > Workgroup > Active > Last Modified
- AWS > Athena > Workgroup > Approved
- AWS > Athena > Workgroup > Approved > Custom
- AWS > Athena > Workgroup > Approved > Regions
- AWS > Athena > Workgroup > Approved > Usage
- AWS > Athena > Workgroup > CMDB
- AWS > Athena > Workgroup > Enforce Workgroup Configuration
- AWS > Athena > Workgroup > Regions
- AWS > Athena > Workgroup > Tags
- AWS > Athena > Workgroup > Tags > Template
- AWS > Athena > Workgroup > Usage
- AWS > Athena > Workgroup > Usage > Limit
- AWS > Turbot > Event Handlers > Events > Rules > Custom Event Patterns > @turbot/aws-athena
- AWS > Turbot > Permissions > Compiled > API Boundary > @turbot/aws-athena
- AWS > Turbot > Permissions > Compiled > Levels > @turbot/aws-athena
- AWS > Turbot > Permissions > Compiled > Service Permissions > @turbot/aws-athena
AWS > Athena > API Enabled
Configure whether the AWS Athena 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-athena#/policy/types/athenaApiEnabled
[ "Enabled", "Disabled", "Enabled if AWS > Athena > Enabled"]
{ "type": "string", "enum": [ "Enabled", "Disabled", "Enabled if AWS > Athena > Enabled" ], "default": "Enabled"}
AWS > Athena > Approved Regions [Default]
A list of AWS regions in which AWS Athena 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 Athena resources' Approved > Regions policies.
tmod:@turbot/aws-athena#/policy/types/athenaApprovedRegionsDefault
"{\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 > Athena > Enabled
Configure whether the AWS Athena service is enabled.
This will only affect Guardrails managed User Roles and will allow the Guardrails managed user to access AWS Athena 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-athena#/policy/types/athenaEnabled
[ "Enabled", "Enabled: Metadata Only", "Disabled"]
{ "type": "string", "enum": [ "Enabled", "Enabled: Metadata Only", "Disabled" ], "example": [ "Enabled" ], "default": "Disabled"}
AWS > Athena > NamedQuery > Active
Determine the action to take when an AWS Athena namedquery, based on the AWS > Athena > NamedQuery > 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 > Athena > NamedQuery > 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-athena#/policy/types/namedQueryActive
[ "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 > Athena > NamedQuery > Active > Age
The age after which the AWS Athena namedquery
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 > Athena > NamedQuery > 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-athena#/policy/types/namedQueryActiveAge
[ "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 > Athena > NamedQuery > Active > Budget
The impact of the budget state on the active control. This policy allows you to force
namedQuerys 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 > Athena > NamedQuery > 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-athena#/policy/types/namedQueryActiveBudget
[ "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 > Athena > NamedQuery > Active > Last Modified
The number of days since the AWS Athena namedquery
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 > Athena > NamedQuery > 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-athena#/policy/types/namedQueryActiveLastModified
[ "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 > Athena > NamedQuery > Approved
Determine the action to take when an AWS Athena namedquery is not approved based on AWS > Athena > NamedQuery > 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-athena#/policy/types/namedQueryApproved
[ "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 > Athena > NamedQuery > Approved > Budget
The policy allows you to set namedquerys 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 Athena namedquery is not matched by the approved list, it will be subject to the action specified in the AWS > Athena > NamedQuery > Approved
policy.
See Approved for more information.
tmod:@turbot/aws-athena#/policy/types/namedQueryApprovedBudget
[ "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 > Athena > NamedQuery > Approved > Custom
Determine whether the AWS Athena namedquery is allowed to exist.
This policy will be evaluated by the Approved control. If an AWS Athena namedquery is not approved, it will be subject to the action specified in the AWS > Athena > NamedQuery > 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-athena#/policy/types/namedQueryApprovedCustom
{ "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 > Athena > NamedQuery > Approved > Regions
A list of AWS regions in which AWS Athena namedquerys 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 Athena namedquery is created in a region that is not in the approved list, it will be subject to the action specified in the AWS > Athena > NamedQuery > Approved
policy.
See Approved for more information.
tmod:@turbot/aws-athena#/policy/types/namedQueryApprovedRegions
"{\n regions: policy(uri: \"tmod:@turbot/aws-athena#/policy/types/athenaApprovedRegionsDefault\")\n}\n"
"{% if $.regions | length == 0 %} [] {% endif %}{% for item in $.regions %}- '{{ item }}'\n{% endfor %}"
AWS > Athena > NamedQuery > Approved > Usage
Determine whether the AWS Athena namedquery is allowed to exist.
This policy will be evaluated by the Approved control. If an AWS Athena namedquery is not approved, it will be subject to the action specified in the AWS > Athena > NamedQuery > Approved
policy.
See Approved for more information.
tmod:@turbot/aws-athena#/policy/types/namedQueryApprovedUsage
[ "Not approved", "Approved", "Approved if AWS > Athena > Enabled"]
{ "type": "string", "enum": [ "Not approved", "Approved", "Approved if AWS > Athena > Enabled" ], "example": [ "Not approved" ], "default": "Approved if AWS > Athena > Enabled"}
AWS > Athena > NamedQuery > CMDB
Configure whether to record and synchronize details for the AWS Athena namedquery 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 > Athena > NamedQuery > 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-athena#/policy/types/namedQueryCmdb
[ "Skip", "Enforce: Enabled", "Enforce: Disabled"]
{ "type": "string", "enum": [ "Skip", "Enforce: Enabled", "Enforce: Disabled" ], "example": [ "Skip" ], "default": "Enforce: Enabled"}
AWS > Athena > NamedQuery > Regions
A list of AWS regions in which AWS Athena namedquerys are supported for use.
Any namedquerys in a region not listed here will not be recorded in CMDB.
The expected format is an array of regions names. You may use the '*' and
'?' wildcard characters.
tmod:@turbot/aws-athena#/policy/types/namedQueryRegions
"{\n regions: policyValue(uri:\"tmod:@turbot/aws-athena#/policy/types/athenaRegionsDefault\") {\n value\n }\n}\n"
"{% if $.regions.value | length == 0 %} [] {% endif %}{% for item in $.regions.value %}- '{{ item }}'\n{% endfor %}"
AWS > Athena > NamedQuery > Tags
Determine the action to take when an AWS Athena namedquery tags are not updated based on the AWS > Athena > NamedQuery > Tags > *
policies.
The control ensure AWS Athena namedquery tags include tags defined in AWS > Athena > NamedQuery > Tags > Template
.
Tags not defined in NamedQuery Tags Template will not be modified or deleted. Setting a tag value to undefined
will result in the tag being deleted.
See Tags for more information.
tmod:@turbot/aws-athena#/policy/types/namedQueryTags
[ "Skip", "Check: Tags are correct", "Enforce: Set tags"]
{ "type": "string", "enum": [ "Skip", "Check: Tags are correct", "Enforce: Set tags" ], "example": [ "Check: Tags are correct" ], "default": "Skip"}
AWS > Athena > NamedQuery > Tags > Template
The template is used to generate the keys and values for AWS Athena namedquery.
Tags not defined in NamedQuery Tags Template will not be modified or deleted. Setting a tag value to undefined
will result in the tag being deleted.
See Tags for more information.
tmod:@turbot/aws-athena#/policy/types/namedQueryTagsTemplate
[ "{\n account {\n turbot {\n id\n }\n }\n}\n", "{\n defaultTags: policyValue(uri:\"tmod:@turbot/aws-athena#/policy/types/athenaTagsTemplate\" resourceId: \"{{ $.account.turbot.id }}\") {\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 %}"
AWS > Athena > Permissions
Configure whether permissions policies are in effect for AWS Athena.
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-athena#/policy/types/athenaPermissions
[ "Enabled", "Disabled", "Enabled if AWS > Athena > Enabled & AWS > Athena > API Enabled"]
{ "type": "string", "enum": [ "Enabled", "Disabled", "Enabled if AWS > Athena > Enabled & AWS > Athena > API Enabled" ], "example": [ "Enabled" ], "default": "Enabled if AWS > Athena > Enabled & AWS > Athena > API Enabled"}
AWS > Athena > 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-athena#/policy/types/athenaPermissionsLevels
[ "{\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 > Athena > 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-athena#/policy/types/athenaPermissionsLevelsModifiers
AWS > Athena > Permissions > Lockdown
tmod:@turbot/aws-athena#/policy/types/athenaPermissionsLockdown
AWS > Athena > Permissions > Lockdown > API Boundary
Configure whether the AWS athena 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-athena#/policy/types/athenaPermissionsLockdownApiBoundary
[ "Enabled if AWS > Athena > API Enabled"]
{ "type": "string", "enum": [ "Enabled if AWS > Athena > API Enabled" ], "example": [ "Enabled if AWS > Athena > API Enabled" ], "default": "Enabled if AWS > Athena > API Enabled"}
AWS > Athena > Regions
A list of AWS regions in which AWS Athena 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 Athena resources' Regions policies.
tmod:@turbot/aws-athena#/policy/types/athenaRegionsDefault
{ "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", "cn-north-1", "cn-northwest-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-east-1", "us-gov-west-1", "us-west-1", "us-west-2" ] } ]}
AWS > Athena > Tags Template [Default]
A template used to generate the keys and values for AWS Athena resources.
By default, all Athena resource Tags > Template policies will use this value.
tmod:@turbot/aws-athena#/policy/types/athenaTagsTemplate
"{\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 %}"
AWS > Athena > Workgroup > Active
Determine the action to take when an AWS Athena workgroup, based on the AWS > Athena > Workgroup > 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 > Athena > Workgroup > 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-athena#/policy/types/workgroupActive
[ "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 > Athena > Workgroup > Active > Age
The age after which the AWS Athena workgroup
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 > Athena > Workgroup > 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-athena#/policy/types/workgroupActiveAge
[ "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 > Athena > Workgroup > Active > Last Modified
The number of days since the AWS Athena workgroup
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 > Athena > Workgroup > 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-athena#/policy/types/workgroupActiveLastModified
[ "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 > Athena > Workgroup > Approved
Determine the action to take when an AWS Athena workgroup is not approved based on AWS > Athena > Workgroup > 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-athena#/policy/types/workgroupApproved
[ "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 > Athena > Workgroup > Approved > Custom
Determine whether the AWS Athena workgroup is allowed to exist.
This policy will be evaluated by the Approved control. If an AWS Athena workgroup is not approved, it will be subject to the action specified in the AWS > Athena > Workgroup > 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-athena#/policy/types/workgroupApprovedCustom
{ "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 > Athena > Workgroup > Approved > Regions
A list of AWS regions in which AWS Athena workgroups 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 Athena workgroup is created in a region that is not in the approved list, it will be subject to the action specified in the AWS > Athena > Workgroup > Approved
policy.
See Approved for more information.
tmod:@turbot/aws-athena#/policy/types/workgroupApprovedRegions
"{\n regions: policy(uri: \"tmod:@turbot/aws-athena#/policy/types/athenaApprovedRegionsDefault\")\n}\n"
"{% if $.regions | length == 0 %} [] {% endif %}{% for item in $.regions %}- '{{ item }}'\n{% endfor %}"
AWS > Athena > Workgroup > Approved > Usage
Determine whether the AWS Athena workgroup is allowed to exist.
This policy will be evaluated by the Approved control. If an AWS Athena workgroup is not approved, it will be subject to the action specified in the AWS > Athena > Workgroup > Approved
policy.
See Approved for more information.
tmod:@turbot/aws-athena#/policy/types/workgroupApprovedUsage
[ "Not approved", "Approved", "Approved if AWS > Athena > Enabled"]
{ "type": "string", "enum": [ "Not approved", "Approved", "Approved if AWS > Athena > Enabled" ], "example": [ "Not approved" ], "default": "Approved if AWS > Athena > Enabled"}
AWS > Athena > Workgroup > CMDB
Configure whether to record and synchronize details for the AWS Athena workgroup 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 > Athena > Workgroup > 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-athena#/policy/types/workgroupCmdb
[ "Skip", "Enforce: Enabled", "Enforce: Disabled"]
{ "type": "string", "enum": [ "Skip", "Enforce: Enabled", "Enforce: Disabled" ], "example": [ "Skip" ], "default": "Enforce: Enabled"}
AWS > Athena > Workgroup > Enforce Workgroup Configuration
Configure the Enforce Workgroup Configuration settings required for AWS > Athena > Workgroup
. This setting determines whether Athena uses the workgroup-wide settings for query results location and encryption.
tmod:@turbot/aws-athena#/policy/types/workgroupEnforceWorkgroupConfiguration
[ "Skip", "Check: Enabled", "Check: Disabled", "Enforce: Enabled", "Enforce: Disabled"]
{ "type": "string", "enum": [ "Skip", "Check: Enabled", "Check: Disabled", "Enforce: Enabled", "Enforce: Disabled" ], "default": "Skip"}
AWS > Athena > Workgroup > Regions
A list of AWS regions in which AWS Athena workgroups are supported for use.
Any workgroups in a region not listed here will not be recorded in CMDB.
The expected format is an array of regions names. You may use the '*' and
'?' wildcard characters.
tmod:@turbot/aws-athena#/policy/types/workgroupRegions
"{\n regions: policyValue(uri:\"tmod:@turbot/aws-athena#/policy/types/athenaRegionsDefault\") {\n value\n }\n}\n"
"{% if $.regions.value | length == 0 %} [] {% endif %}{% for item in $.regions.value %}- '{{ item }}'\n{% endfor %}"
AWS > Athena > Workgroup > Tags
Determine the action to take when an AWS Athena workgroup tags are not updated based on the AWS > Athena > Workgroup > Tags > *
policies.
The control ensure AWS Athena workgroup tags include tags defined in AWS > Athena > Workgroup > Tags > Template
.
Tags not defined in Workgroup Tags Template will not be modified or deleted. Setting a tag value to undefined
will result in the tag being deleted.
See Tags for more information.
tmod:@turbot/aws-athena#/policy/types/workgroupTags
[ "Skip", "Check: Tags are correct", "Enforce: Set tags"]
{ "type": "string", "enum": [ "Skip", "Check: Tags are correct", "Enforce: Set tags" ], "example": [ "Check: Tags are correct" ], "default": "Skip"}
AWS > Athena > Workgroup > Tags > Template
The template is used to generate the keys and values for AWS Athena workgroup.
Tags not defined in Workgroup Tags Template will not be modified or deleted. Setting a tag value to undefined
will result in the tag being deleted.
See Tags for more information.
tmod:@turbot/aws-athena#/policy/types/workgroupTagsTemplate
[ "{\n account {\n turbot {\n id\n }\n }\n}\n", "{\n defaultTags: policyValue(uri:\"tmod:@turbot/aws-athena#/policy/types/athenaTagsTemplate\" resourceId: \"{{ $.account.turbot.id }}\") {\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 %}"
AWS > Athena > Workgroup > Usage
Configure the number of AWS Athena workgroups 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 > Athena > Workgroup > Usage
policy.
tmod:@turbot/aws-athena#/policy/types/workgroupUsage
[ "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 > Athena > Workgroup > Usage > Limit
Maximum number of items that can be created for this region.
tmod:@turbot/aws-athena#/policy/types/workgroupUsageLimit
{ "type": "integer", "minimum": 0, "default": 1000}
AWS > Turbot > Event Handlers > Events > Rules > Custom Event Patterns > @turbot/aws-athena
The CloudWatch Events event pattern used by the AWS Athena module to specify
which events to forward to the Guardrails Event Handlers.
tmod:@turbot/aws-athena#/policy/types/athenaCustomEventPatterns
{ "type": "array", "items": { "type": "object" }}
AWS > Turbot > Permissions > Compiled > API Boundary > @turbot/aws-athena
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 > Athena > Permissions > Lockdown > API Boundary
policy
tmod:@turbot/aws-athena#/policy/types/awsCompiledApiBoundary
{ "type": "array"}
AWS > Turbot > Permissions > Compiled > Levels > @turbot/aws-athena
A calculated policy that Guardrails uses to create a compiled list of ALL permissions for AWS Athena
that is used as input to the stack that manages the Guardrails IAM permissions objects.
tmod:@turbot/aws-athena#/policy/types/awsLevelsCompiled
AWS > Turbot > Permissions > Compiled > Service Permissions > @turbot/aws-athena
A calculated policy that Guardrails uses to create a compiled list of ALL permissions for AWS Athena
that is used as input to the control that manages the IAM stack.
tmod:@turbot/aws-athena#/policy/types/awsCompiledServicePermissions