Policy types for @turbot/aws-ecr
- AWS > ECR > API Enabled
- AWS > ECR > Approved Regions [Default]
- AWS > ECR > Enabled
- AWS > ECR > Image > Active
- AWS > ECR > Image > Active > Age
- AWS > ECR > Image > Active > Last Modified
- AWS > ECR > Image > Approved
- AWS > ECR > Image > Approved > Custom
- AWS > ECR > Image > Approved > Regions
- AWS > ECR > Image > Approved > Usage
- AWS > ECR > Image > CMDB
- AWS > ECR > Image > Regions
- AWS > ECR > Image > Usage
- AWS > ECR > Image > Usage > Limit
- AWS > ECR > Permissions
- AWS > ECR > Permissions > Levels
- AWS > ECR > Permissions > Levels > Modifiers
- AWS > ECR > Permissions > Lockdown
- AWS > ECR > Permissions > Lockdown > API Boundary
- AWS > ECR > Private Registry > CMDB
- AWS > ECR > Private Registry > Regions
- AWS > ECR > Private Registry > Scanning Configuration
- AWS > ECR > Private Registry > Scanning Configuration > Continuous Filters
- AWS > ECR > Private Registry > Scanning Configuration > Scan on Push Filters
- AWS > ECR > Public Repository > Active
- AWS > ECR > Public Repository > Active > Age
- AWS > ECR > Public Repository > Active > Budget
- AWS > ECR > Public Repository > Active > Last Modified
- AWS > ECR > Public Repository > Approved
- AWS > ECR > Public Repository > Approved > Budget
- AWS > ECR > Public Repository > Approved > Custom
- AWS > ECR > Public Repository > Approved > Usage
- AWS > ECR > Public Repository > CMDB
- AWS > ECR > Public Repository > Tags
- AWS > ECR > Public Repository > Tags > Template
- AWS > ECR > Public Repository > Usage
- AWS > ECR > Public Repository > Usage > Limit
- AWS > ECR > Regions
- AWS > ECR > Repository > Active
- AWS > ECR > Repository > Active > Age
- AWS > ECR > Repository > Active > Budget
- AWS > ECR > Repository > Active > Last Modified
- AWS > ECR > Repository > Approved
- AWS > ECR > Repository > Approved > Budget
- AWS > ECR > Repository > Approved > Custom
- AWS > ECR > Repository > Approved > Encryption at Rest
- AWS > ECR > Repository > Approved > Encryption at Rest > Customer Managed Key
- AWS > ECR > Repository > Approved > Regions
- AWS > ECR > Repository > Approved > Usage
- AWS > ECR > Repository > CMDB
- AWS > ECR > Repository > Regions
- AWS > ECR > Repository > Scan on Push
- AWS > ECR > Repository > Tags
- AWS > ECR > Repository > Tags > Template
- AWS > ECR > Repository > Usage
- AWS > ECR > Repository > Usage > Limit
- AWS > ECR > Tags Template [Default]
- AWS > Turbot > Event Handlers > Events > Rules > Custom Event Patterns > @turbot/aws-ecr
- AWS > Turbot > Permissions > Compiled > API Boundary > @turbot/aws-ecr
- AWS > Turbot > Permissions > Compiled > Levels > @turbot/aws-ecr
- AWS > Turbot > Permissions > Compiled > Service Permissions > @turbot/aws-ecr
AWS > ECR > API Enabled
Configure whether the AWS ECR API is enabled.\n\nNote: Disabling the service disables the API for ALL users and roles, and Guardrails will have no access to the API.\n
[ "Enabled", "Disabled", "Enabled if AWS > ECR > Enabled"]
{ "type": "string", "enum": [ "Enabled", "Disabled", "Enabled if AWS > ECR > Enabled" ], "default": "Enabled"}
AWS > ECR > Approved Regions [Default]
A list of AWS regions in which AWS ECR resources are approved for use.\n\nThe expected format is an array of regions names. You may use the '*' and\n'?' wildcard characters.\n\nThis policy is the default value for all AWS ECR resources' Approved > Regions policies.\n
"{\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 > ECR > Enabled
Configure whether the AWS ECR service is enabled.\nThis will only affect Guardrails managed User Roles and will allow the Guardrails managed user to access AWS ECR service.\n - Enabled
policy allows Guardrails managed users to perform all the actions for the service\n - Enabled: Metadata Only
policy allows Guardrails managed users to perform only the metadata level actions for the service (like describe*
, list*
)\n\nNote:\n - Disabled
policy disables the service but does NOT disable the API for Guardrails or SuperUsers\n - All the resource data stored in the Guardrails CMDB is considered to be metadata\n - For more information related to permissions and grant levels, please check the documentation\n
[ "Enabled", "Enabled: Metadata Only", "Disabled"]
{ "type": "string", "enum": [ "Enabled", "Enabled: Metadata Only", "Disabled" ], "example": [ "Enabled" ], "default": "Disabled"}
AWS > ECR > Image > Active
Determine the action to take when an AWS ECR image, based on the AWS > ECR > Image > Active > *
policies.\n\nThe control determines whether the resource is in active use, and if not,\nhas the ability to delete / cleanup the resource. When running an automated\ncompliance environment, it's common to end up with a wide range of alarms\nthat are difficult and time consuming to clear. The Active control brings\nautomated, well-defined control to this process.\n\nThe Active control checks the status of all defined Active policies for the\nresource (AWS > ECR > Image > Active > *
), raises an alarm, and takes the defined enforcement\naction. Each Active sub-policy can calculate a status of active, inactive\nor skipped. Generally, if the resource appears to be Active for any reason\nit will be considered Active.\nNote the contrast with Approved, where if the resource appears to be Unapproved for any reason it will be considered\nUnapproved.\n\nSee Active for more information.\n
[ "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 > ECR > Image > Active > Age
The age after which the AWS ECR image\nis no longer considered active. If a create time is unavailable, the time Guardrails discovered the resource is used.\n\nThe Active\ncontrol determines whether the resource is in active use, and if not, has\nthe ability to delete / cleanup the resource. When running an automated\ncompliance environment, it's common to end up with a wide range of alarms\nthat are difficult and time consuming to clear. The Active control brings\nautomated, well-defined control to this process.\n\nThe Active control checks the status of all defined Active policies for the\nresource (AWS > ECR > Image > Active > *
),\nraises an alarm, and takes the defined enforcement action. Each Active\nsub-policy can calculate a status of active, inactive or skipped. Generally,\nif the resource appears to be Active for any reason it will be considered Active.\nNote the contrast with Approved, where if the resource appears to be Unapproved\nfor any reason it will be considered Unapproved.\n\nSee Active for more information.\n
[ "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 > ECR > Image > Active > Last Modified
The number of days since the AWS ECR image\nwas last modified before it is considered inactive.\n\nThe Active\ncontrol determines whether the resource is in active use, and if not, has\nthe ability to delete / cleanup the resource. When running an automated\ncompliance environment, it's common to end up with a wide range of alarms\nthat are difficult and time consuming to clear. The Active control brings\nautomated, well-defined control to this process.\n\nThe Active control checks the status of all defined Active policies for the\nresource (AWS > ECR > Image > Active > *
),\nraises an alarm, and takes the defined enforcement action. Each Active\nsub-policy can calculate a status of active, inactive or skipped. Generally,\nif the resource appears to be Active for any reason it will be considered Active.\nNote the contrast with Approved, where if the resource appears to be Unapproved\nfor any reason it will be considered Unapproved.\n\nSee Active for more information.\n
[ "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 > ECR > Image > Approved
Determine the action to take when an AWS ECR image is not approved based on AWS > ECR > Image > Approved > *
policies.\n\nThe 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.\n\nFor 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.\n\nSee Approved for more information.\n
[ "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 > ECR > Image > Approved > Custom
Determine whether the AWS ECR image is allowed to exist.\nThis policy will be evaluated by the Approved control. If an AWS ECR image is not approved, it will be subject to the action specified in the AWS > ECR > Image > Approved
policy.\nSee Approved for more information.\n\nNote: 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.\n
{ "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 > ECR > Image > Approved > Regions
A list of AWS regions in which AWS ECR images are approved for use.\n\nThe expected format is an array of regions names. You may use the '*' and '?' wildcard characters.\n\nThis policy will be evaluated by the Approved control. If an AWS ECR image is created in a region that is not in the approved list, it will be subject to the action specified in the AWS > ECR > Image > Approved
policy.\n\nSee Approved for more information.\n
"{\n regions: policy(uri: \"tmod:@turbot/aws-ecr#/policy/types/ecrApprovedRegionsDefault\")\n}\n"
"{% if $.regions | length == 0 %} [] {% endif %}{% for item in $.regions %}- '{{ item }}'\n{% endfor %}"
AWS > ECR > Image > Approved > Usage
Determine whether the AWS ECR image is allowed to exist.\n\nThis policy will be evaluated by the Approved control. If an AWS ECR image is not approved, it will be subject to the action specified in the AWS > ECR > Image > Approved
policy.\n\nSee Approved for more information.\n
[ "Not approved", "Approved", "Approved if AWS > ECR > Enabled"]
{ "type": "string", "enum": [ "Not approved", "Approved", "Approved if AWS > ECR > Enabled" ], "example": [ "Not approved" ], "default": "Approved if AWS > ECR > Enabled"}
AWS > ECR > Image > CMDB
Configure whether to record and synchronize details for the AWS ECR image into the CMDB.\n\nThe CMDB control is responsible for populating and updating all the attributes for that resource type in the Guardrails CMDB.\nAll policies and controls in Guardrails are based around the resource, so usually the CMDB policy is set to "Enforce: Enabled".\n\nIf 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.\n\nTo cleanup resources and stop tracking changes, set this policy to "Enforce: Disabled".\n\nCMDB controls also use the Regions policy associated with the resource. If region is not in AWS > ECR > Image > Regions
policy, the CMDB control will delete the resource from the CMDB.\n\n(Note: Setting CMDB to "Skip" will also pause these changes.)\n
[ "Skip", "Enforce: Enabled", "Enforce: Disabled"]
{ "type": "string", "enum": [ "Skip", "Enforce: Enabled", "Enforce: Disabled" ], "example": [ "Skip" ], "default": "Enforce: Enabled"}
AWS > ECR > Image > Regions
A list of AWS regions in which AWS ECR images are supported for use.\n\nAny images in a region not listed here will not be recorded in CMDB.\n\nThe expected format is an array of regions names. You may use the '*' and\n'?' wildcard characters.\n
"{\n regions: policyValue(uri:\"tmod:@turbot/aws-ecr#/policy/types/ecrRegionsDefault\") {\n value\n }\n}\n"
"{% if $.regions.value | length == 0 %} [] {% endif %}{% for item in $.regions.value %}- '{{ item }}'\n{% endfor %}"
AWS > ECR > Image > Usage
Configure the number of AWS ECR images that can be used for this repository and the current consumption against the limit.\n\nYou can configure the behavior of the control with this AWS > ECR > Image > Usage
policy.\n
[ "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 > ECR > Image > Usage > Limit
Maximum number of items that can be created for this repository.
{ "type": "integer", "minimum": 0, "default": 10000}
AWS > ECR > Permissions
Configure whether permissions policies are in effect for AWS ECR.\n\nThis setting does not affect account level permissions (AWS/Admin, AWS/Owner, etc)\n\nNote: The behavior of this policy depends on the value of AWS > Permissions.\n
[ "Enabled", "Disabled", "Enabled if AWS > ECR > Enabled & AWS > ECR > API Enabled"]
{ "type": "string", "enum": [ "Enabled", "Disabled", "Enabled if AWS > ECR > Enabled & AWS > ECR > API Enabled" ], "example": [ "Enabled" ], "default": "Enabled if AWS > ECR > Enabled & AWS > ECR > API Enabled"}
AWS > ECR > Permissions > Levels
Define the permissions levels that can be used to grant access to an AWS account.\nPermissions levels defined will appear in the UI to assign access to Guardrails users.\nThis policy provides a default for Permissions > Levels in each service,\nhowever you can explicitly override the setting for each service if desired\n
[ "{\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 > ECR > Permissions > Levels > Modifiers
A map of AWS API to Guardrails Permission Level used to customize Guardrails' standard permissions.\nYou can add, remove or redefine the mapping of AWS API operations to Guardrails permissions levels here.\n\nNote: Modifiers are cumulative - if you add a permission to the Metadata level, it is also added to ReadOnly, Operator and Admin.\nModifier policies set here apply ONLY to the AWS level\n\n\nexample:\n - "glacier:createvault": admin\n - "glacier:ListVaults": metadata\n - "s3:DeleteBucket": none\n
\n
AWS > ECR > Permissions > Lockdown
AWS > ECR > Permissions > Lockdown > API Boundary
Configure whether the AWS ecr API is enabled for all users and roles in guardrails-managed boundary policies.\n\nNote: Disabling the service disables the API for ALL users and roles, and Guardrails will have no access to the API.\n
[ "Enabled if AWS > ECR > API Enabled"]
{ "type": "string", "enum": [ "Enabled if AWS > ECR > API Enabled" ], "example": [ "Enabled if AWS > ECR > API Enabled" ], "default": "Enabled if AWS > ECR > API Enabled"}
AWS > ECR > Private Registry > CMDB
Configure whether to record and synchronize details for the AWS ECR private registry into the CMDB.\n\nThe CMDB control is responsible for populating and updating all the attributes for that resource type in the Guardrails CMDB.\nAll policies and controls in Guardrails are based around the resource, so usually the CMDB policy is set to "Enforce: Enabled".\n\nIf 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.\n\nTo cleanup resources and stop tracking changes, set this policy to "Enforce: Disabled".\n\nCMDB controls also use the Regions policy associated with the resource. If region is not in AWS > ECR > Private Registry > Regions
policy, the CMDB control will delete the resource from the CMDB.\n\n(Note: Setting CMDB to "Skip" will also pause these changes.)\n
[ "Skip", "Enforce: Enabled", "Enforce: Disabled"]
{ "type": "string", "enum": [ "Skip", "Enforce: Enabled", "Enforce: Disabled" ], "example": [ "Skip" ], "default": "Enforce: Enabled"}
AWS > ECR > Private Registry > Regions
A list of AWS regions in which AWS ECR private registry's are supported for use.\n\nAny private registry's in a region not listed here will not be recorded in CMDB.\n\nThe expected format is an array of regions names. You may use the '*' and\n'?' wildcard characters.\n
"{\n regions: policyValue(uri:\"tmod:@turbot/aws-ecr#/policy/types/ecrRegionsDefault\") {\n value\n }\n}\n"
"{% if $.regions.value | length == 0 %} [] {% endif %}{% for item in $.regions.value %}- '{{ item }}'\n{% endfor %}"
AWS > ECR > Private Registry > Scanning Configuration
Define the Scanning Configuration settings required for AWS > ECR > Private Registry
.\n\nThe Scanning configuration determines the type of scanning performed on the contents of repositories.\n\nNote: Enforcing Basic or Enhanced Scanning on a Private Registry via this control with AWS > ECR > Private Registry > Scanning Configuration > *
policies set to an empty array ([]
) will remove all existing Scanning Configuration filters on the Private Registry.\n
[ "Skip", "Check: Basic Scanning Enabled", "Check: Enhanced Scanning Enabled", "Enforce: Enable Basic Scanning", "Enforce: Enable Enhanced Scanning"]
{ "type": "string", "enum": [ "Skip", "Check: Basic Scanning Enabled", "Check: Enhanced Scanning Enabled", "Enforce: Enable Basic Scanning", "Enforce: Enable Enhanced Scanning" ], "example": [ "Check: Basic Scanning Enabled" ], "default": "Skip"}
AWS > ECR > Private Registry > Scanning Configuration > Continuous Filters
A list of repositories which will have images scanned continuously for vulnerabilities. Filters with wildcards (*)
will match a repository name where the wildcard replaces zero or more characters in the repository name.\n\nNote: This filter is only applicable for Enhanced Scanning configuration.\n
{ "anyOf": [ { "type": "array", "items": { "type": "string" } } ], "default": [], "example": [ "*", "prod-*" ]}
AWS > ECR > Private Registry > Scanning Configuration > Scan on Push Filters
A list of repositories to scan for vulnerabilities on image push. Filters with wildcards (*)
will match a repository name where the wildcard replaces zero or more characters in the repository name.\n
{ "anyOf": [ { "type": "array", "items": { "type": "string" } } ], "default": [], "example": [ "*", "prod-*" ]}
AWS > ECR > Public Repository > Active
Determine the action to take when an AWS ECR public repository, based on the AWS > ECR > Public Repository > Active > *
policies.\n\nThe control determines whether the resource is in active use, and if not,\nhas the ability to delete / cleanup the resource. When running an automated\ncompliance environment, it's common to end up with a wide range of alarms\nthat are difficult and time consuming to clear. The Active control brings\nautomated, well-defined control to this process.\n\nThe Active control checks the status of all defined Active policies for the\nresource (AWS > ECR > Public Repository > Active > *
), raises an alarm, and takes the defined enforcement\naction. Each Active sub-policy can calculate a status of active, inactive\nor skipped. Generally, if the resource appears to be Active for any reason\nit will be considered Active.\nNote the contrast with Approved, where if the resource appears to be Unapproved for any reason it will be considered\nUnapproved.\n\nSee Active for more information.\n
[ "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 > ECR > Public Repository > Active > Age
The age after which the AWS ECR public repository\nis no longer considered active. If a create time is unavailable, the time Guardrails discovered the resource is used.\n\nThe Active\ncontrol determines whether the resource is in active use, and if not, has\nthe ability to delete / cleanup the resource. When running an automated\ncompliance environment, it's common to end up with a wide range of alarms\nthat are difficult and time consuming to clear. The Active control brings\nautomated, well-defined control to this process.\n\nThe Active control checks the status of all defined Active policies for the\nresource (AWS > ECR > Public Repository > Active > *
),\nraises an alarm, and takes the defined enforcement action. Each Active\nsub-policy can calculate a status of active, inactive or skipped. Generally,\nif the resource appears to be Active for any reason it will be considered Active.\nNote the contrast with Approved, where if the resource appears to be Unapproved\nfor any reason it will be considered Unapproved.\n\nSee Active for more information.\n
[ "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 > ECR > Public Repository > Active > Budget
The impact of the budget state on the active control. This policy allows you to force\npublicRepositorys to inactive based on the current budget state, as reflected in\nAWS > Account > Budget > State
\n\nThe Active control determines whether the resource is in active use, and if not, has\nthe ability to delete / cleanup the resource. When running an automated compliance\nenvironment, it's common to end up with a wide range of alarms that are difficult\nand time consuming to clear. The Active control brings automated, well-defined\ncontrol to this process.\n\nThe Active control checks the status of all defined Active policies for the\nresource (AWS > ECR > Public Repository > Active > *
),\nraises an alarm, and takes the defined enforcement action. Each Active\nsub-policy can calculate a status of active, inactive or skipped. Generally,\nif the resource appears to be Active for any reason it will be considered Active.\nNote the contrast with Approved, where if the resource appears to be Unapproved\nfor any reason it will be considered Unapproved.\n\nSee Active for more information.\n
[ "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 > ECR > Public Repository > Active > Last Modified
The number of days since the AWS ECR public repository\nwas last modified before it is considered inactive.\n\nThe Active\ncontrol determines whether the resource is in active use, and if not, has\nthe ability to delete / cleanup the resource. When running an automated\ncompliance environment, it's common to end up with a wide range of alarms\nthat are difficult and time consuming to clear. The Active control brings\nautomated, well-defined control to this process.\n\nThe Active control checks the status of all defined Active policies for the\nresource (AWS > ECR > Public Repository > Active > *
),\nraises an alarm, and takes the defined enforcement action. Each Active\nsub-policy can calculate a status of active, inactive or skipped. Generally,\nif the resource appears to be Active for any reason it will be considered Active.\nNote the contrast with Approved, where if the resource appears to be Unapproved\nfor any reason it will be considered Unapproved.\n\nSee Active for more information.\n
[ "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 > ECR > Public Repository > Approved
Determine the action to take when an AWS ECR public repository is not approved based on AWS > ECR > Public Repository > Approved > *
policies.\n\nThe 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.\n\nFor 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.\n\nSee Approved for more information.\n
[ "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 > ECR > Public Repository > Approved > Budget
The policy allows you to set public repositorys to unapproved based on the current budget state, as reflected in AWS > Account > Budget > State
\n\nThis policy will be evaluated by the Approved control. If an AWS ECR public repository is not matched by the approved list, it will be subject to the action specified in the AWS > ECR > Public Repository > Approved
policy.\n\nSee Approved for more information.\n
[ "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 > ECR > Public Repository > Approved > Custom
Determine whether the AWS ECR public repository is allowed to exist.\nThis policy will be evaluated by the Approved control. If an AWS ECR public repository is not approved, it will be subject to the action specified in the AWS > ECR > Public Repository > Approved
policy.\nSee Approved for more information.\n\nNote: 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.\n
{ "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 > ECR > Public Repository > Approved > Usage
Determine whether the AWS ECR public repository is allowed to exist.\n\nThis policy will be evaluated by the Approved control. If an AWS ECR public repository is not approved, it will be subject to the action specified in the AWS > ECR > Public Repository > Approved
policy.\n\nSee Approved for more information.\n
[ "Not approved", "Approved", "Approved if AWS > ECR > Enabled"]
{ "type": "string", "enum": [ "Not approved", "Approved", "Approved if AWS > ECR > Enabled" ], "example": [ "Not approved" ], "default": "Approved if AWS > ECR > Enabled"}
AWS > ECR > Public Repository > CMDB
Configure whether to record and synchronize details for the AWS ECR public repository into the CMDB.\n\nThe CMDB control is responsible for populating and updating all the attributes for that resource type in the Guardrails CMDB.\nAll policies and controls in Guardrails are based around the resource, so usually the CMDB policy is set to "Enforce: Enabled".\n\nIf 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.\n\nTo cleanup resources and stop tracking changes, set this policy to "Enforce: Disabled".\n\nCMDB controls also use the Regions policy associated with the resource. If region is not in AWS > ECR > Public Repository > Regions
policy, the CMDB control will delete the resource from the CMDB.\n\n(Note: Setting CMDB to "Skip" will also pause these changes.)\n
[ "Skip", "Enforce: Enabled", "Enforce: Disabled"]
{ "type": "string", "enum": [ "Skip", "Enforce: Enabled", "Enforce: Disabled" ], "example": [ "Skip" ], "default": "Enforce: Enabled"}
AWS > ECR > Public Repository > Tags
Determine the action to take when an AWS ECR public repository tags are not updated based on the AWS > ECR > Public Repository > Tags > *
policies.\n\nThe control ensure AWS ECR public repository tags include tags defined in AWS > ECR > Public Repository > Tags > Template
.\n\nTags not defined in Public Repository Tags Template will not be modified or deleted. Setting a tag value to undefined
will result in the tag being deleted.\n\nSee Tags for more information.\n
[ "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 > ECR > Public Repository > Tags > Template
The template is used to generate the keys and values for AWS ECR public repository.\n\nTags not defined in Public Repository Tags Template will not be modified or deleted. Setting a tag value to undefined
will result in the tag being deleted.\n\nSee Tags for more information.\n
[ "{\n account {\n turbot {\n id\n }\n }\n}\n", "{\n defaultTags: policyValue(uri:\"tmod:@turbot/aws-ecr#/policy/types/ecrTagsTemplate\" 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 > ECR > Public Repository > Usage
Configure the number of AWS ECR public repositorys that can be used for this account and the current consumption against the limit.\n\nYou can configure the behavior of the control with this AWS > ECR > Public Repository > Usage
policy.\n
[ "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 > ECR > Public Repository > Usage > Limit
Maximum number of items that can be created for this account.
{ "type": "integer", "minimum": 0, "default": 10000}
AWS > ECR > Regions
A list of AWS regions in which AWS ECR resources are supported for use.\n\nThe expected format is an array of regions names. You may use the '*' and\n'?' wildcard characters.\n\nThis policy is the default value for all AWS ECR resources' Regions policies.\n
{ "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 > ECR > Repository > Active
Determine the action to take when an AWS ECR repository, based on the AWS > ECR > Repository > Active > *
policies.\n\nThe control determines whether the resource is in active use, and if not,\nhas the ability to delete / cleanup the resource. When running an automated\ncompliance environment, it's common to end up with a wide range of alarms\nthat are difficult and time consuming to clear. The Active control brings\nautomated, well-defined control to this process.\n\nThe Active control checks the status of all defined Active policies for the\nresource (AWS > ECR > Repository > Active > *
), raises an alarm, and takes the defined enforcement\naction. Each Active sub-policy can calculate a status of active, inactive\nor skipped. Generally, if the resource appears to be Active for any reason\nit will be considered Active.\nNote the contrast with Approved, where if the resource appears to be Unapproved for any reason it will be considered\nUnapproved.\n\nSee Active for more information.\n
[ "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 > ECR > Repository > Active > Age
The age after which the AWS ECR repository\nis no longer considered active. If a create time is unavailable, the time Guardrails discovered the resource is used.\n\nThe Active\ncontrol determines whether the resource is in active use, and if not, has\nthe ability to delete / cleanup the resource. When running an automated\ncompliance environment, it's common to end up with a wide range of alarms\nthat are difficult and time consuming to clear. The Active control brings\nautomated, well-defined control to this process.\n\nThe Active control checks the status of all defined Active policies for the\nresource (AWS > ECR > Repository > Active > *
),\nraises an alarm, and takes the defined enforcement action. Each Active\nsub-policy can calculate a status of active, inactive or skipped. Generally,\nif the resource appears to be Active for any reason it will be considered Active.\nNote the contrast with Approved, where if the resource appears to be Unapproved\nfor any reason it will be considered Unapproved.\n\nSee Active for more information.\n
[ "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 > ECR > Repository > Active > Budget
The impact of the budget state on the active control. This policy allows you to force\nrepositorys to inactive based on the current budget state, as reflected in\nAWS > Account > Budget > State
\n\nThe Active control determines whether the resource is in active use, and if not, has\nthe ability to delete / cleanup the resource. When running an automated compliance\nenvironment, it's common to end up with a wide range of alarms that are difficult\nand time consuming to clear. The Active control brings automated, well-defined\ncontrol to this process.\n\nThe Active control checks the status of all defined Active policies for the\nresource (AWS > ECR > Repository > Active > *
),\nraises an alarm, and takes the defined enforcement action. Each Active\nsub-policy can calculate a status of active, inactive or skipped. Generally,\nif the resource appears to be Active for any reason it will be considered Active.\nNote the contrast with Approved, where if the resource appears to be Unapproved\nfor any reason it will be considered Unapproved.\n\nSee Active for more information.\n
[ "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 > ECR > Repository > Active > Last Modified
The number of days since the AWS ECR repository\nwas last modified before it is considered inactive.\n\nThe Active\ncontrol determines whether the resource is in active use, and if not, has\nthe ability to delete / cleanup the resource. When running an automated\ncompliance environment, it's common to end up with a wide range of alarms\nthat are difficult and time consuming to clear. The Active control brings\nautomated, well-defined control to this process.\n\nThe Active control checks the status of all defined Active policies for the\nresource (AWS > ECR > Repository > Active > *
),\nraises an alarm, and takes the defined enforcement action. Each Active\nsub-policy can calculate a status of active, inactive or skipped. Generally,\nif the resource appears to be Active for any reason it will be considered Active.\nNote the contrast with Approved, where if the resource appears to be Unapproved\nfor any reason it will be considered Unapproved.\n\nSee Active for more information.\n
[ "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 > ECR > Repository > Approved
Determine the action to take when an AWS ECR repository is not approved based on AWS > ECR > Repository > Approved > *
policies.\n\nThe 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.\n\nFor 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.\n\nSee Approved for more information.\n
[ "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 > ECR > Repository > Approved > Budget
The policy allows you to set repositorys to unapproved based on the current budget state, as reflected in AWS > Account > Budget > State
\n\nThis policy will be evaluated by the Approved control. If an AWS ECR repository is not matched by the approved list, it will be subject to the action specified in the AWS > ECR > Repository > Approved
policy.\n\nSee Approved for more information.\n
[ "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 > ECR > Repository > Approved > Custom
Determine whether the AWS ECR repository is allowed to exist.\nThis policy will be evaluated by the Approved control. If an AWS ECR repository is not approved, it will be subject to the action specified in the AWS > ECR > Repository > Approved
policy.\nSee Approved for more information.\n\nNote: 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.\n
{ "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 > ECR > Repository > Approved > Encryption at Rest
Define the Encryption at Rest settings required for AWS > ECR > Repository
.\n\nEncryption at Rest refers specifically to the encryption of data when written\nto an underlying storage system. This control determines whether the resource\nis encrypted at rest, and sets encryption to your desired level.\n\nThe Encryption at Rest\ncontrol compares the encryption settings against the encryption policies for the resource\n(AWS > ECR > Repository > Encryption at Rest > *
),\nraises an alarm, and takes the defined enforcement action\n
[ "None", "None or higher", "AWS SSE", "AWS SSE or higher", "AWS managed key", "AWS managed key or higher", "Customer managed key", "Encryption at Rest > Customer Managed Key"]
{ "type": "string", "enum": [ "None", "None or higher", "AWS SSE", "AWS SSE or higher", "AWS managed key", "AWS managed key or higher", "Customer managed key", "Encryption at Rest > Customer Managed Key" ], "example": [ "None or higher" ], "default": "None or higher"}
AWS > ECR > Repository > Approved > Encryption at Rest > Customer Managed Key
Define the KMS key ID for encryption at rest.\n\nEncryption at Rest refers specifically to the encryption of data when written\nto an underlying storage system. This control determines whether the resource\nis encrypted at rest, and sets encryption to your desired level.\n\nThe Encryption at Rest\ncontrol compares the encryption settings against the encryption policies for the resource\n(AWS > ECR > Repository > Encryption at Rest > *
),\nraises an alarm, and takes the defined enforcement action\n\nPlease make sure the key defined in the template has required permissions.\n\n\nexample:\n alias/aws/ebs\n ddc06e04-ce5f-4995-c758-c2b6c510e8fd\n arn:aws:kms:us-east-1:123456789012:key/ddc06e04-ce5f-4995-c758-c2b6c510e8fd\n arn:aws:kms:us-east-1:123456789012:alias/aws/ebs\n
\n
"{\n defaultKey: policy(uri: \"aws-kms#/policy/types/keyDefaultCustomerManagedKey\")\n}\n"
"{{ $.defaultKey }}"
{ "anyOf": [ { "type": "string", "pattern": "^alias/[a-zA-Z0-9:/_-]{1,249}$" }, { "type": "string", "pattern": "^[-a-z0-9-]{1,255}$" }, { "type": "string", "pattern": "^arn:aws(-us-gov|-cn)?:kms:[a-z]{2}(-gov)?-[a-z]+-[0-9]:[0-9]{12}:key/[-a-z0-9-]{1,255}$" }, { "type": "string", "pattern": "^arn:aws(-us-gov|-cn)?:kms:[a-z]{2}(-gov)?-[a-z]+-[0-9]:[0-9]{12}:alias/[a-zA-Z0-9:/_-]{1,249}$" } ], "tests": [ { "description": "valid - if keyArn", "input": "arn:aws:kms:us-east-1:039305405804:key/ddc06e04-ce5f-4995-b758-c2b6c510e8fd" }, { "description": "valid - if aliasName", "input": "alias/aws/ebs" }, { "description": "valid - if keyId", "input": "ddc06e04-ce5f-4995-b758-c2b6c510e8fd" }, { "description": "valid - if aliasArn", "input": "arn:aws:kms:us-east-1:039305405804:alias/aws/ebs" } ]}
AWS > ECR > Repository > Approved > Regions
A list of AWS regions in which AWS ECR repositorys are approved for use.\n\nThe expected format is an array of regions names. You may use the '*' and '?' wildcard characters.\n\nThis policy will be evaluated by the Approved control. If an AWS ECR repository is created in a region that is not in the approved list, it will be subject to the action specified in the AWS > ECR > Repository > Approved
policy.\n\nSee Approved for more information.\n
"{\n regions: policy(uri: \"tmod:@turbot/aws-ecr#/policy/types/ecrApprovedRegionsDefault\")\n}\n"
"{% if $.regions | length == 0 %} [] {% endif %}{% for item in $.regions %}- '{{ item }}'\n{% endfor %}"
AWS > ECR > Repository > Approved > Usage
Determine whether the AWS ECR repository is allowed to exist.\n\nThis policy will be evaluated by the Approved control. If an AWS ECR repository is not approved, it will be subject to the action specified in the AWS > ECR > Repository > Approved
policy.\n\nSee Approved for more information.\n
[ "Not approved", "Approved", "Approved if AWS > ECR > Enabled"]
{ "type": "string", "enum": [ "Not approved", "Approved", "Approved if AWS > ECR > Enabled" ], "example": [ "Not approved" ], "default": "Approved if AWS > ECR > Enabled"}
AWS > ECR > Repository > CMDB
Configure whether to record and synchronize details for the AWS ECR repository into the CMDB.\n\nThe CMDB control is responsible for populating and updating all the attributes for that resource type in the Guardrails CMDB.\nAll policies and controls in Guardrails are based around the resource, so usually the CMDB policy is set to "Enforce: Enabled".\n\nIf 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.\n\nTo cleanup resources and stop tracking changes, set this policy to "Enforce: Disabled".\n\nCMDB controls also use the Regions policy associated with the resource. If region is not in AWS > ECR > Repository > Regions
policy, the CMDB control will delete the resource from the CMDB.\n\n(Note: Setting CMDB to "Skip" will also pause these changes.)\n
[ "Skip", "Enforce: Enabled", "Enforce: Disabled"]
{ "type": "string", "enum": [ "Skip", "Enforce: Enabled", "Enforce: Disabled" ], "example": [ "Skip" ], "default": "Enforce: Enabled"}
AWS > ECR > Repository > Regions
A list of AWS regions in which AWS ECR repositorys are supported for use.\n\nAny repositorys in a region not listed here will not be recorded in CMDB.\n\nThe expected format is an array of regions names. You may use the '*' and\n'?' wildcard characters.\n
"{\n regions: policyValue(uri:\"tmod:@turbot/aws-ecr#/policy/types/ecrRegionsDefault\") {\n value\n }\n}\n"
"{% if $.regions.value | length == 0 %} [] {% endif %}{% for item in $.regions.value %}- '{{ item }}'\n{% endfor %}"
AWS > ECR > Repository > Scan on Push
Configure the Scan on Push setting required for AWS > ECR > Repository
.\nThis setting determines whether images are scanned after being pushed to the repository.\n
[ "Check: Enabled", "Check: Disabled", "Enforce: Enabled", "Enforce: Disabled"]
{ "type": "string", "enum": [ "Check: Enabled", "Check: Disabled", "Enforce: Enabled", "Enforce: Disabled" ], "default": "Skip"}
AWS > ECR > Repository > Tags
Determine the action to take when an AWS ECR repository tags are not updated based on the AWS > ECR > Repository > Tags > *
policies.\n\nThe control ensure AWS ECR repository tags include tags defined in AWS > ECR > Repository > Tags > Template
.\n\nTags not defined in Repository Tags Template will not be modified or deleted. Setting a tag value to undefined
will result in the tag being deleted.\n\nSee Tags for more information.\n
[ "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 > ECR > Repository > Tags > Template
The template is used to generate the keys and values for AWS ECR repository.\n\nTags not defined in Repository Tags Template will not be modified or deleted. Setting a tag value to undefined
will result in the tag being deleted.\n\nSee Tags for more information.\n
[ "{\n account {\n turbot {\n id\n }\n }\n}\n", "{\n defaultTags: policyValue(uri:\"tmod:@turbot/aws-ecr#/policy/types/ecrTagsTemplate\" 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 > ECR > Repository > Usage
Configure the number of AWS ECR repositorys that can be used for this account and the current consumption against the limit.\n\nYou can configure the behavior of the control with this AWS > ECR > Repository > Usage
policy.\n
[ "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 > ECR > Repository > Usage > Limit
Maximum number of items that can be created for this account.
{ "type": "integer", "minimum": 0, "default": 1000}
AWS > ECR > Tags Template [Default]
A template used to generate the keys and values for AWS ECR resources.\n\nBy default, all ECR resource Tags > Template policies will use this value.\n
"{\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-ecr
The CloudWatch Events event pattern used by the AWS ECR module to specify\nwhich events to forward to the Guardrails Event Handlers.\n
{ "type": "array", "items": { "type": "object" }}
AWS > Turbot > Permissions > Compiled > API Boundary > @turbot/aws-ecr
A read-only policy generated by Guardrails that lists the APIs that\nshould be added to the guardrails-managed (hard) boundary policy,\nthereby enabling them to be assigned to users and roles.\nThis value will change depending on the value of the value of the\nAWS > ECR > Permissions > Lockdown > API Boundary
policy\n
{ "type": "array"}
AWS > Turbot > Permissions > Compiled > Levels > @turbot/aws-ecr
A calculated policy that Guardrails uses to create a compiled list of ALL permissions for AWS ECR\nthat is used as input to the stack that manages the Guardrails IAM permissions objects.\n
AWS > Turbot > Permissions > Compiled > Service Permissions > @turbot/aws-ecr
A calculated policy that Guardrails uses to create a compiled list of ALL permissions for AWS ECR\nthat is used as input to the control that manages the IAM stack.\n