Policy types for @turbot/aws-eks
- AWS > EKS > API Enabled
- AWS > EKS > Approved Regions [Default]
- AWS > EKS > Cluster > Active
- AWS > EKS > Cluster > Active > Age
- AWS > EKS > Cluster > Active > Budget
- AWS > EKS > Cluster > Active > Last Modified
- AWS > EKS > Cluster > Approved
- AWS > EKS > Cluster > Approved > Budget
- AWS > EKS > Cluster > Approved > Custom
- AWS > EKS > Cluster > Approved > Regions
- AWS > EKS > Cluster > Approved > Usage
- AWS > EKS > Cluster > CMDB
- AWS > EKS > Cluster > Regions
- AWS > EKS > Cluster > Tags
- AWS > EKS > Cluster > Tags > Template
- AWS > EKS > Cluster > Usage
- AWS > EKS > Cluster > Usage > Limit
- AWS > EKS > Enabled
- AWS > EKS > Node Group > Active
- AWS > EKS > Node Group > Active > Age
- AWS > EKS > Node Group > Active > Last Modified
- AWS > EKS > Node Group > Approved
- AWS > EKS > Node Group > Approved > AMI Type
- AWS > EKS > Node Group > Approved > Custom
- AWS > EKS > Node Group > Approved > Instance Type
- AWS > EKS > Node Group > Approved > Regions
- AWS > EKS > Node Group > Approved > Usage
- AWS > EKS > Node Group > CMDB
- AWS > EKS > Node Group > Configured
- AWS > EKS > Node Group > Configured > Claim Precedence
- AWS > EKS > Node Group > Configured > Source
- AWS > EKS > Node Group > Regions
- AWS > EKS > Node Group > Tags
- AWS > EKS > Node Group > Tags > Template
- AWS > EKS > Node Group > Usage
- AWS > EKS > Node Group > Usage > Limit
- AWS > EKS > Permissions
- AWS > EKS > Permissions > Levels
- AWS > EKS > Permissions > Levels > Modifiers
- AWS > EKS > Permissions > Lockdown
- AWS > EKS > Permissions > Lockdown > API Boundary
- AWS > EKS > Regions
- AWS > EKS > Tags Template [Default]
- AWS > Turbot > Event Handlers > Events > Rules > Custom Event Patterns > @turbot/aws-eks
- AWS > Turbot > Permissions > Compiled > API Boundary > @turbot/aws-eks
- AWS > Turbot > Permissions > Compiled > Levels > @turbot/aws-eks
- AWS > Turbot > Permissions > Compiled > Service Permissions > @turbot/aws-eks
AWS > EKS > API Enabled
Configure whether the AWS EKS API is enabled.
Note: Disabling the service disables the API for ALL users and roles, and Turbot will have no access to the API.
[ "Enabled", "Disabled", "Enabled if AWS > EKS > Enabled"]
{ "type": "string", "enum": [ "Enabled", "Disabled", "Enabled if AWS > EKS > Enabled" ], "default": "Enabled"}
AWS > EKS > Approved Regions [Default]
A list of AWS regions in which AWS EKS 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 EKS resources' Approved > Regions policies.
"{\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 > EKS > Cluster > Active
Determine the action to take when an AWS EKS cluster, based on the AWS > EKS > Cluster > 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 > EKS > Cluster > 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.
[ "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 > EKS > Cluster > Active > Age
The age after which the AWS EKS cluster is no longer considered active. If a create time is unavailable, the time Turbot 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 > EKS > Cluster > 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.
[ "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 > EKS > Cluster > Active > Budget
The impact of the budget state on the active control. This policy allows you to force
clusters to inactive based on the current budget state, as reflected in
AWS > 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 > EKS > Cluster > 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.
[ "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 > EKS > Cluster > Active > Last Modified
The number of days since the AWS EKS cluster 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 > EKS > Cluster > 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.
[ "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 > EKS > Cluster > Approved
Determine the action to take when an AWS EKS cluster is not approved based on AWS > EKS > Cluster > 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.
[ "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 > EKS > Cluster > Approved > Budget
The policy allows you to set clusters 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 EKS cluster is not matched by the approved list, it will be subject to the action specified in the AWS > EKS > Cluster > Approved
policy.
See Approved for more information.
[ "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 > EKS > Cluster > Approved > Custom
Determine whether the AWS EKS cluster is allowed to exist.
This policy will be evaluated by the Approved control. If an AWS EKS cluster is not approved, it will be subject to the action specified in the AWS > EKS > Cluster > 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.
{ "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 > EKS > Cluster > Approved > Regions
A list of AWS regions in which AWS EKS clusters 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 EKS cluster is created in a region that is not in the approved list, it will be subject to the action specified in the AWS > EKS > Cluster > Approved
policy.
See Approved for more information.
"{\n regions: policy(uri: \"tmod:@turbot/aws-eks#/policy/types/eksApprovedRegionsDefault\")\n}\n"
"{% if $.regions | length == 0 %} [] {% endif %}{% for item in $.regions %}- '{{ item }}'\n{% endfor %}"
AWS > EKS > Cluster > Approved > Usage
Determine whether the AWS EKS cluster is allowed to exist.
This policy will be evaluated by the Approved control. If an AWS EKS cluster is not approved, it will be subject to the action specified in the AWS > EKS > Cluster > Approved
policy.
See Approved for more information.
[ "Not approved", "Approved", "Approved if AWS > EKS > Enabled"]
{ "type": "string", "enum": [ "Not approved", "Approved", "Approved if AWS > EKS > Enabled" ], "example": [ "Not approved" ], "default": "Approved if AWS > EKS > Enabled"}
AWS > EKS > Cluster > CMDB
Configure whether to record and synchronize details for the AWS EKS cluster into the CMDB.
The CMDB control is responsible for populating and updating all the attributes for that resource type in the Turbot CMDB. All policies and controls in Turbot 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 > EKS > Cluster > Regions
policy, the CMDB control will delete the resource from the CMDB.
(Note: Setting CMDB to "Skip" will also pause these changes.)
[ "Skip", "Enforce: Enabled", "Enforce: Disabled"]
{ "type": "string", "enum": [ "Skip", "Enforce: Enabled", "Enforce: Disabled" ], "example": [ "Skip" ], "default": "Enforce: Enabled"}
AWS > EKS > Cluster > Regions
A list of AWS regions in which AWS EKS clusters are supported for use.
Any clusters 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.
"{\n regions: policyValue(uri:\"tmod:@turbot/aws-eks#/policy/types/eksRegionsDefault\") {\n value\n }\n}\n"
"{% if $.regions.value | length == 0 %} [] {% endif %}{% for item in $.regions.value %}- '{{ item }}'\n{% endfor %}"
AWS > EKS > Cluster > Tags
Determine the action to take when an AWS EKS cluster tags are not updated based on the AWS > EKS > Cluster > Tags > *
policies.
The control ensure AWS EKS cluster tags include tags defined in AWS > EKS > Cluster > Tags > Template
.
Tags not defined in Cluster 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.
[ "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 > EKS > Cluster > Tags > Template
The template is used to generate the keys and values for AWS EKS cluster.
Tags not defined in Cluster 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.
[ "{\n account {\n turbot {\n id\n }\n }\n}\n", "{\n defaultTags: policyValue(uri:\"tmod:@turbot/aws-eks#/policy/types/eksTagsTemplate\" 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 > EKS > Cluster > Usage
Configure the number of AWS EKS clusters 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 > EKS > Cluster > Usage
policy.
[ "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 > EKS > Cluster > Usage > Limit
Maximum number of items that can be created for this region.
{ "type": "integer", "minimum": 0, "default": 50}
AWS > EKS > Enabled
Configure whether the AWS EKS service is enabled. This will only affect Turbot managed User Roles and will allow the Turbot managed user to access AWS EKS service.
Enabled
policy allows Turbot managed users to perform all the actions for the serviceEnabled: Metadata Only
policy allows Turbot managed users to perform only the metadata level actions for the service (likedescribe*
,list*
)
Note:
Disabled
policy disables the service but does NOT disable the API for Turbot or SuperUsers- All the resource data stored in the Turbot CMDB is considered to be metadata
- For more information related to permissions and grant levels, please check the documentation
[ "Enabled", "Enabled: Metadata Only", "Disabled"]
{ "type": "string", "enum": [ "Enabled", "Enabled: Metadata Only", "Disabled" ], "example": [ "Enabled" ], "default": "Disabled"}
AWS > EKS > Node Group > Active
Determine the action to take when an AWS EKS node group, based on the AWS > EKS > Node Group > 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 > EKS > Node Group > 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.
[ "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 > EKS > Node Group > Active > Age
The age after which the AWS EKS node group is no longer considered active. If a create time is unavailable, the time Turbot 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 > EKS > Node Group > 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.
[ "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 > EKS > Node Group > Active > Last Modified
The number of days since the AWS EKS node group 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 > EKS > Node Group > 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.
[ "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 > EKS > Node Group > Approved
Determine the action to take when an AWS EKS node group is not approved based on AWS > EKS > Node Group > 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.
[ "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 > EKS > Node Group > Approved > AMI Type
A list of ami type that the AWS EKS node group is approved to use.
The expected format is an array of ami type. You may use the *
and ?
wildcard characters (and more).
This policy will be evaluated by the Approved control. If an AWS EKS node group is not matched by the approved list, it will be subject to the action specified in the AWS > EKS > Node Group > Approved
policy.
See Approved for more information.
{ "type": "array", "default": [ "*" ], "items": { "type": "string", "pattern": "^(AL2_x86_64_GPU|AL2_x86_64)$" }}
AWS > EKS > Node Group > Approved > Custom
Determine whether the AWS EKS node group is allowed to exist.
This policy will be evaluated by the Approved control. If an AWS EKS node group is not approved, it will be subject to the action specified in the AWS > EKS > Node Group > 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.
{ "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 > EKS > Node Group > Approved > Instance Type
A list of instance type that the AWS EKS node group is approved to use.
The expected format is an array of instance type. You may use the *
and ?
wildcard characters (and more).
This policy will be evaluated by the Approved control. If an AWS EKS node group is not matched by the approved list, it will be subject to the action specified in the AWS > EKS > Node Group > Approved
policy.
See Approved for more information.
{ "type": "array", "default": [ "*" ], "items": { "type": "string", "pattern": "^[a-z0-9.?*]+$" }}
AWS > EKS > Node Group > Approved > Regions
A list of AWS regions in which AWS EKS node groups 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 EKS node group is created in a region that is not in the approved list, it will be subject to the action specified in the AWS > EKS > Node Group > Approved
policy.
See Approved for more information.
"{\n regions: policy(uri: \"tmod:@turbot/aws-eks#/policy/types/eksApprovedRegionsDefault\")\n}\n"
"{% if $.regions | length == 0 %} [] {% endif %}{% for item in $.regions %}- '{{ item }}'\n{% endfor %}"
AWS > EKS > Node Group > Approved > Usage
Determine whether the AWS EKS node group is allowed to exist.
This policy will be evaluated by the Approved control. If an AWS EKS node group is not approved, it will be subject to the action specified in the AWS > EKS > Node Group > Approved
policy.
See Approved for more information.
[ "Not approved", "Approved", "Approved if AWS > EKS > Enabled"]
{ "type": "string", "enum": [ "Not approved", "Approved", "Approved if AWS > EKS > Enabled" ], "example": [ "Not approved" ], "default": "Approved if AWS > EKS > Enabled"}
AWS > EKS > Node Group > CMDB
Configure whether to record and synchronize details for the AWS EKS node group into the CMDB.
The CMDB control is responsible for populating and updating all the attributes for that resource type in the Turbot CMDB. All policies and controls in Turbot 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 > EKS > Node Group > Regions
policy, the CMDB control will delete the resource from the CMDB.
(Note: Setting CMDB to "Skip" will also pause these changes.)
[ "Skip", "Enforce: Enabled", "Enforce: Disabled"]
{ "type": "string", "enum": [ "Skip", "Enforce: Enabled", "Enforce: Disabled" ], "example": [ "Skip" ], "default": "Enforce: Enabled"}
AWS > EKS > Node Group > Configured
Determine how to configure this resource.
Note: If the resource is managed by another stack, then the Skip/Check/Enforce values here are ignored and inherit from the stack that owns it.
[ "Skip (unless claimed by a stack)", "Check: Per Configured > Source (unless claimed by a stack)", "Enforce: Per Configured > Source (unless claimed by a stack)"]
{ "enum": [ "Skip (unless claimed by a stack)", "Check: Per Configured > Source (unless claimed by a stack)", "Enforce: Per Configured > Source (unless claimed by a stack)" ], "default": "Skip (unless claimed by a stack)"}
AWS > EKS > Node Group > Configured > Claim Precedence
An ordered list of who is allowed to claim a resource. A stack cannot claim a resource if it is already claimed by another stack at a higher level of precedence.
"{\n defaultPrecedence: policy(uri:\"tmod:@turbot/turbot#/policy/types/claimPrecedenceDefault\")\n}\n"
"{%- if $.defaultPrecedence | length == 0 %}[]{%- else %}{% for item in $.defaultPrecedence %}- '{{ item }}'{% endfor %}{% endif %}"
{ "type": "array", "items": { "type": "string" }}
AWS > EKS > Node Group > Configured > Source
A HCL or JSON format Terraform configuration source used to configure this resource.
{ "type": "string", "default": "", "x-schema-form": { "type": "code", "language": "hcl" }}
AWS > EKS > Node Group > Regions
A list of AWS regions in which AWS EKS node groups are supported for use.
Any node groups 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.
"{\n regions: policyValue(uri:\"tmod:@turbot/aws-eks#/policy/types/eksRegionsDefault\") {\n value\n }\n}\n"
"{% if $.regions.value | length == 0 %} [] {% endif %}{% for item in $.regions.value %}- '{{ item }}'\n{% endfor %}"
AWS > EKS > Node Group > Tags
Determine the action to take when an AWS EKS node group tags are not updated based on the AWS > EKS > Node Group > Tags > *
policies.
The control ensure AWS EKS node group tags include tags defined in AWS > EKS > Node Group > Tags > Template
.
Tags not defined in Node Group 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.
[ "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 > EKS > Node Group > Tags > Template
The template is used to generate the keys and values for AWS EKS node group.
Tags not defined in Node Group 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.
[ "{\n account {\n turbot {\n id\n }\n }\n}\n", "{\n defaultTags: policyValue(uri:\"tmod:@turbot/aws-eks#/policy/types/eksTagsTemplate\" 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 > EKS > Node Group > Usage
Configure the number of AWS EKS node groups that can be used for this cluster and the current consumption against the limit.
You can configure the behavior of the control with this AWS > EKS > Node Group > Usage
policy.
[ "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 > EKS > Node Group > Usage > Limit
Maximum number of items that can be created for this cluster.
{ "type": "integer", "minimum": 0, "default": 30}
AWS > EKS > Permissions
Configure whether permissions policies are in effect for AWS EKS.
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.
[ "Enabled", "Disabled", "Enabled if AWS > EKS > Enabled & AWS > EKS > API Enabled"]
{ "type": "string", "enum": [ "Enabled", "Disabled", "Enabled if AWS > EKS > Enabled & AWS > EKS > API Enabled" ], "example": [ "Enabled" ], "default": "Enabled if AWS > EKS > Enabled & AWS > EKS > API Enabled"}
AWS > EKS > 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 Turbot users. This policy provides a default for Permissions > Levels in each service, however you can explicitly override the setting for each service if desired
[ "{\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 > EKS > Permissions > Levels > Modifiers
A map of AWS API to Turbot Permission Level used to customize Turbot's standard permissions. You can add, remove or redefine the mapping of AWS API operations to Turbot 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
example: - "glacier:createvault": admin - "glacier:ListVaults": metadata - "s3:DeleteBucket": none
AWS > EKS > Permissions > Lockdown
AWS > EKS > Permissions > Lockdown > API Boundary
Configure whether the AWS eks API is enabled for all users and roles in turbot-managed boundary policies.
Note: Disabling the service disables the API for ALL users and roles, and Turbot will have no access to the API.
[ "Enabled if AWS > EKS > API Enabled"]
{ "type": "string", "enum": [ "Enabled if AWS > EKS > API Enabled" ], "example": [ "Enabled if AWS > EKS > API Enabled" ], "default": "Enabled if AWS > EKS > API Enabled"}
AWS > EKS > Regions
A list of AWS regions in which AWS EKS 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 EKS resources' Regions policies.
{ "allOf": [ { "$ref": "aws#/definitions/regionNameMatcherList" }, { "default": [ "af-south-1", "ap-east-1", "ap-northeast-1", "ap-northeast-2", "ap-northeast-3", "ap-south-1", "ap-south-2", "ap-southeast-1", "ap-southeast-2", "ap-southeast-3", "ca-central-1", "cn-north-1", "cn-northwest-1", "eu-central-1", "eu-central-2", "eu-north-1", "eu-south-1", "eu-south-2", "eu-west-1", "eu-west-2", "eu-west-3", "me-central-1", "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 > EKS > Tags Template [Default]
A template used to generate the keys and values for AWS EKS resources.
By default, all EKS resource Tags > Template policies will use this value.
"{\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 > Turbot > Event Handlers > Events > Rules > Custom Event Patterns > @turbot/aws-eks
The CloudWatch Events event pattern used by the AWS EKS module to specify which events to forward to the Turbot Event Handlers.
{ "type": "array", "items": { "type": "object" }}
AWS > Turbot > Permissions > Compiled > API Boundary > @turbot/aws-eks
A read-only policy generated by Turbot that lists the APIs that
should be added to the turbot-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 the
AWS > EKS > Permissions > Lockdown > API Boundary
policy
{ "type": "array"}
AWS > Turbot > Permissions > Compiled > Levels > @turbot/aws-eks
A calculated policy that Turbot uses to create a compiled list of ALL permissions for AWS EKS that is used as input to the stack that manages the Turbot IAM permissions objects.
AWS > Turbot > Permissions > Compiled > Service Permissions > @turbot/aws-eks
A calculated policy that Turbot uses to create a compiled list of ALL permissions for AWS EKS that is used as input to the control that manages the IAM stack.