Product logo
DocsBlogPricing

Policy types for @turbot/aws-kms

AWS > KMS > API Enabled

Configure whether the AWS KMS API is enabled.

Note: Disabling the service disables the API for ALL users and roles, and Guardrails will have no access to the API.

URI
tmod:@turbot/aws-kms#/policy/types/kmsApiEnabled
Category
Parent
Targets
Valid Value
[
  "Enabled",
  "Disabled",
  "Enabled if AWS > KMS > Enabled"
]
Schema
{
  "type": "string",
  "enum": [
    "Enabled",
    "Disabled",
    "Enabled if AWS > KMS > Enabled"
  ],
  "default": "Enabled"
}

AWS > KMS > Alias > Configured

Determine how to configure this resource. Note that 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

URI
tmod:@turbot/aws-kms#/policy/types/aliasConfigured
Category
Parent
Targets
Valid Value
[
  "Skip if using Configured > Source",
  "Check: Configured if using Configured > Source",
  "Enforce: Configured if using Configured > Source"
]
Schema
{
  "enum": [
    "Skip if using Configured > Source",
    "Check: Configured if using Configured > Source",
    "Enforce: Configured if using Configured > Source"
  ],
  "default": "Enforce: Configured if using Configured > Source"
}

AWS > KMS > Alias > Configured > 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.

By default, all resources are configured to use the precedence defined
here, though they can override their Claim Precedence

URI
tmod:@turbot/aws-kms#/policy/types/aliasConfiguredPrecedence
Category
Parent
Targets
Schema
{
  "type": "array",
  "items": {
    "type": "string"
  },
  "default": [
    "**"
  ]
}

AWS > KMS > Alias > Configured > Source

A HCL or JSON format Terraform configuration source used to configure this resource

URI
tmod:@turbot/aws-kms#/policy/types/aliasConfiguredSource
Category
Parent
Targets
Schema
{
  "type": "string",
  "default": "{\"resource\": {}}\n",
  "x-schema-form": {
    "type": "code",
    "language": "hcl"
  }
}

AWS > KMS > Approved Regions [Default]

A list of AWS regions in which AWS KMS 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 KMS resources' Approved > Regions policies.

URI
tmod:@turbot/aws-kms#/policy/types/kmsApprovedRegionsDefault
Category
Parent
Targets
Default Template Input
"{\n  regions: policyValue(uri:\"tmod:@turbot/aws#/policy/types/approvedRegionsDefault\") {\n    value\n  }\n}\n"
Default Template
"{% if $.regions.value | length == 0 %} [] {% endif %}{% for item in $.regions.value %}- '{{ item }}'\n{% endfor %}"
Schema

AWS > KMS > Enabled

Configure whether the AWS KMS service is enabled.
This will only affect Guardrails managed User Roles and will allow the Guardrails managed user to access AWS KMS service.
- Enabled policy allows Guardrails managed users to perform all the actions for the service
- Enabled: Metadata Only policy allows Guardrails managed users to perform only the metadata level actions for the service (like describe*, list*)

Note:
- Disabled policy disables the service but does NOT disable the API for Guardrails or SuperUsers
- All the resource data stored in the Guardrails CMDB is considered to be metadata
- For more information related to permissions and grant levels, please check the documentation

URI
tmod:@turbot/aws-kms#/policy/types/kmsEnabled
Category
Parent
Targets
Valid Value
[
  "Enabled",
  "Enabled: Metadata Only",
  "Disabled"
]
Schema
{
  "type": "string",
  "enum": [
    "Enabled",
    "Enabled: Metadata Only",
    "Disabled"
  ],
  "example": [
    "Enabled"
  ],
  "default": "Disabled"
}

AWS > KMS > Key > Active

Determine the action to take when an AWS KMS key, based on the AWS > KMS > Key > 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 > KMS > Key > 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.

URI
tmod:@turbot/aws-kms#/policy/types/keyActive
Category
Parent
Targets
Valid Value
[
  "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"
]
Schema
{
  "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 > KMS > Key > Active > Age

The age after which the AWS KMS key
is no longer considered active. If a create time is unavailable, the time Guardrails discovered the resource is used.

The Active
control determines whether the resource is in active use, and if not, has
the ability to delete / cleanup the resource. When running an automated
compliance environment, it's common to end up with a wide range of alarms
that are difficult and time consuming to clear. The Active control brings
automated, well-defined control to this process.

The Active control checks the status of all defined Active policies for the
resource (AWS > KMS > Key > 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.

URI
tmod:@turbot/aws-kms#/policy/types/keyActiveAge
Category
Parent
Targets
Valid Value
[
  "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"
]
Schema
{
  "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 > KMS > Key > Active > Budget

The impact of the budget state on the active control. This policy allows you to force
keys 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 > KMS > Key > 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.

URI
tmod:@turbot/aws-kms#/policy/types/keyActiveBudget
Category
Parent
Targets
Valid Value
[
  "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"
]
Schema
{
  "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 > KMS > Key > Active > Last Modified

The number of days since the AWS KMS key
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 > KMS > Key > 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.

URI
tmod:@turbot/aws-kms#/policy/types/keyActiveLastModified
Category
Parent
Targets
Valid Value
[
  "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"
]
Schema
{
  "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 > KMS > Key > Active > Status

The policy allows you to
check which status determines if the AWS KMS key is active.

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 > KMS > Key > 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.

The policy values for AWS KMS key are deprecated and replaced by new values.
The deprecated values will be removed in next major version.

| Deprecated Values | Current Values |
|-------------------------------------|----------------------------------------|
| Active if status is enabled | Active if $.KeyState is enabled |
| Force active if status is enabled | Force active if $.KeyState is enabled |

URI
tmod:@turbot/aws-kms#/policy/types/keyActiveStatus
Category
Parent
Targets
Valid Value
[
  "Skip",
  "Active if status is enabled",
  "Force active if status is enabled",
  "Active if $.KeyState is enabled",
  "Force active if $.KeyState is enabled"
]
Schema
{
  "type": "string",
  "enum": [
    "Skip",
    "Active if status is enabled",
    "Force active if status is enabled",
    "Active if $.KeyState is enabled",
    "Force active if $.KeyState is enabled"
  ],
  "example": [
    "Skip"
  ],
  "default": "Skip"
}

AWS > KMS > Key > Approved

Determine the action to take when an AWS KMS key is not approved based on AWS > KMS > Key > 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.

URI
tmod:@turbot/aws-kms#/policy/types/keyApproved
Category
Parent
Targets
Valid Value
[
  "Skip",
  "Check: Approved",
  "Enforce: Delete unapproved if new",
  "Enforce: Disable unapproved"
]
Schema
{
  "type": "string",
  "enum": [
    "Skip",
    "Check: Approved",
    "Enforce: Delete unapproved if new",
    "Enforce: Disable unapproved"
  ],
  "example": [
    "Check: Approved"
  ],
  "default": "Skip"
}

AWS > KMS > Key > Approved > Budget

The policy allows you to set keys 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 KMS key is not matched by the approved list, it will be subject to the action specified in the AWS > KMS > Key > Approved policy.

See Approved for more information.

URI
tmod:@turbot/aws-kms#/policy/types/keyApprovedBudget
Category
Parent
Targets
Valid Value
[
  "Skip",
  "Unapproved if Budget > State is Over or higher",
  "Unapproved if Budget > State is Critical or higher",
  "Unapproved if Budget > State is Shutdown"
]
Schema
{
  "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 > KMS > Key > Approved > Custom

Determine whether the AWS KMS key is allowed to exist.
This policy will be evaluated by the Approved control. If an AWS KMS key is not approved, it will be subject to the action specified in the AWS > KMS > Key > 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.

URI
tmod:@turbot/aws-kms#/policy/types/keyApprovedCustom
Category
Parent
Targets
Schema
{
  "example": [
    "Approved",
    {
      "result": "Approved"
    },
    {
      "title": "KeyState",
      "result": "Approved"
    },
    {
      "title": "KeyState",
      "message": "KeyState is Enabled",
      "result": "Approved"
    },
    {
      "title": "KeyRotationStatus",
      "message": "KeyRotationStatus is not true",
      "result": "Not approved"
    },
    [
      {
        "title": "KeyState",
        "message": "KeyState is Enabled",
        "result": "Approved"
      },
      {
        "title": "KeyRotationStatus",
        "message": "KeyRotationStatus is not true",
        "result": "Not approved"
      }
    ]
  ],
  "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 > KMS > Key > Approved > Customer Master Key Spec

A list of customer master key spec that the AWS KMS key is approved to use.

The expected format is an array of customer master key spec. You may use the * and ? wildcard characters (and more).

This policy will be evaluated by the Approved control. If an AWS KMS key is not matched by the approved list, it will be subject to the action specified in the AWS > KMS > Key > Approved policy.

See Approved for more information.

URI
tmod:@turbot/aws-kms#/policy/types/keyApprovedCustomerMasterKeySpec
Category
Parent
Targets
Schema
{
  "type": "array",
  "default": [
    "*"
  ],
  "items": {
    "type": "string",
    "pattern": "^(RSA_2048|RSA_3072|RSA_4096|ECC_NIST_P256|ECC_NIST_P384|ECC_NIST_P521|ECC_SECG_P256K1|SYMMETRIC_DEFAULT)$"
  }
}

AWS > KMS > Key > Approved > Regions

A list of AWS regions in which AWS KMS keys 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 KMS key is created in a region that is not in the approved list, it will be subject to the action specified in the AWS > KMS > Key > Approved policy.

See Approved for more information.

URI
tmod:@turbot/aws-kms#/policy/types/keyApprovedRegions
Category
Parent
Targets
Default Template Input
"{\n  regions: policy(uri: \"tmod:@turbot/aws-kms#/policy/types/kmsApprovedRegionsDefault\")\n}\n"
Default Template
"{% if $.regions | length == 0 %} [] {% endif %}{% for item in $.regions %}- &#39;{{ item }}&#39;&#92;n{% endfor %}"
Schema

AWS > KMS > Key > Approved > Usage

Determine whether the AWS KMS key is allowed to exist.

This policy will be evaluated by the Approved control. If an AWS KMS key is not approved, it will be subject to the action specified in the AWS > KMS > Key > Approved policy.

See Approved for more information.

URI
tmod:@turbot/aws-kms#/policy/types/keyApprovedUsage
Category
Parent
Targets
Valid Value
[
  "Not approved",
  "Approved",
  "Approved if AWS > KMS > Enabled"
]
Schema
{
  "type": "string",
  "enum": [
    "Not approved",
    "Approved",
    "Approved if AWS > KMS > Enabled"
  ],
  "example": [
    "Not approved"
  ],
  "default": "Approved if AWS > KMS > Enabled"
}

AWS > KMS > Key > CMDB

Configure whether to record and synchronize details for the AWS KMS key into the CMDB.

The CMDB control is responsible for populating and updating all the attributes for that resource type in the Guardrails CMDB.
All policies and controls in Guardrails are based around the resource, so usually the CMDB policy is set to "Enforce: Enabled".

If set to Skip then all changes to the CMDB are paused - no new resources will be discovered, no updates will be made and deleted resources will not be removed.

To cleanup resources and stop tracking changes, set this policy to "Enforce: Disabled".

CMDB controls also use the Regions policy associated with the resource. If region is not in AWS > KMS > Key > Regions policy, the CMDB control will delete the resource from the CMDB.

(Note: Setting CMDB to "Skip" will also pause these changes.)

URI
tmod:@turbot/aws-kms#/policy/types/keyCmdb
Category
Parent
Targets
Valid Value
[
  "Skip",
  "Enforce: Enabled",
  "Enforce: Enabled but ignore permission errors",
  "Enforce: Disabled"
]
Schema
{
  "type": "string",
  "enum": [
    "Skip",
    "Enforce: Enabled",
    "Enforce: Enabled but ignore permission errors",
    "Enforce: Disabled"
  ],
  "example": [
    "Skip"
  ],
  "default": "Enforce: Enabled"
}

AWS > KMS > Key > 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.

URI
tmod:@turbot/aws-kms#/policy/types/keyConfigured
Category
Parent
Targets
Valid Value
[
  "Skip (unless claimed by a stack)",
  "Check: Per Configured > Source (unless claimed by a stack)",
  "Enforce: Per Configured > Source (unless claimed by a stack)"
]
Schema
{
  "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 > KMS > Key > 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.

URI
tmod:@turbot/aws-kms#/policy/types/keyConfiguredPrecedence
Category
Parent
Targets
Default Template Input
"{\n  defaultPrecedence: policy(uri:\"tmod:@turbot/turbot#/policy/types/claimPrecedenceDefault\")\n}\n"
Default Template
"{%- if $.defaultPrecedence | length == 0 %}[]{%- else %}{% for item in $.defaultPrecedence %}- &#39;{{ item }}&#39;{% endfor %}{% endif %}"
Schema
{
  "type": "array",
  "items": {
    "type": "string"
  }
}

AWS > KMS > Key > Configured > Source

A HCL or JSON format Terraform configuration source used to configure this resource.

URI
tmod:@turbot/aws-kms#/policy/types/keyConfiguredSource
Category
Parent
Targets
Schema
{
  "type": "string",
  "default": "",
  "x-schema-form": {
    "type": "code",
    "language": "hcl"
  }
}

AWS > KMS > Key > Policy Statements

URI
tmod:@turbot/aws-kms#/policy/types/keyPolicyStatements
Category
Parent
Targets

AWS > KMS > Key > Policy Statements > Approved

Configure policy statements for KMS keys. This control defines whether to verify if the key policy statements are approved, as well as the subsequent action to take on unapproved statements.

If set to Enforce: Delete unapproved, any unapproved statements will be revoked from the key's policy.

Please note that if the policy is set to Enforce: Delete unapproved and the new key policy does not contain statements that allow the Guardrails role to continue to manage the key's policy, this control will fail to apply the new policy due to a best practice from AWS that prevents key administrators from removing their own access.

URI
tmod:@turbot/aws-kms#/policy/types/keyPolicyStatementsApproved
Category
Parent
Targets
Valid Value
[
  "Skip",
  "Check: Approved",
  "Enforce: Delete unapproved"
]
Schema
{
  "type": "string",
  "enum": [
    "Skip",
    "Check: Approved",
    "Enforce: Delete unapproved"
  ],
  "example": [
    "Skip"
  ],
  "default": "Skip"
}

AWS > KMS > Key > Policy Statements > Approved > Rules

An Object Control List (OCL) with a list of filter rules to approve or reject key policy statements.

URI
tmod:@turbot/aws-kms#/policy/types/keyPolicyStatementsApprovedRules
Category
Parent
Targets
Schema
{
  "type": "string",
  "default": "# Approve unmatched rules\nAPPROVE *",
  "x-schema-form": {
    "type": "textarea"
  }
}

AWS > KMS > Key > Regions

A list of AWS regions in which AWS KMS keys are supported for use.

Any keys 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.

URI
tmod:@turbot/aws-kms#/policy/types/keyRegions
Category
Parent
Targets
Default Template Input
"{\n  regions: policyValue(uri:\"tmod:@turbot/aws-kms#/policy/types/kmsRegionsDefault\") {\n    value\n  }\n}\n"
Default Template
"{% if $.regions.value | length == 0 %} [] {% endif %}{% for item in $.regions.value %}- &#39;{{ item }}&#39;&#92;n{% endfor %}"
Schema

AWS > KMS > Key > Rotation

Set customer master key policies for automatic key rotation by AWS. Guardrails recommends setting this option to Enforce: Enabled, ensuring that KMS keys are rotated annually.

URI
tmod:@turbot/aws-kms#/policy/types/keyRotation
Category
Parent
Targets
Valid Value
[
  "Skip",
  "Check: Enabled",
  "Check: Disabled",
  "Enforce: Enabled",
  "Enforce: Disabled"
]
Schema
{
  "type": "string",
  "enum": [
    "Skip",
    "Check: Enabled",
    "Check: Disabled",
    "Enforce: Enabled",
    "Enforce: Disabled"
  ],
  "example": [
    "Check: Enabled"
  ],
  "default": "Skip"
}

AWS > KMS > Key > Tags

Determine the action to take when an AWS KMS key tags are not updated based on the AWS > KMS > Key > Tags > * policies.

The control ensure AWS KMS key tags include tags defined in AWS > KMS > Key > Tags > Template.

Tags not defined in Key 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.

URI
tmod:@turbot/aws-kms#/policy/types/keyTags
Category
Parent
Targets
Valid Value
[
  "Skip",
  "Check: Tags are correct",
  "Enforce: Set tags"
]
Schema
{
  "type": "string",
  "enum": [
    "Skip",
    "Check: Tags are correct",
    "Enforce: Set tags"
  ],
  "example": [
    "Check: Tags are correct"
  ],
  "default": "Skip"
}

AWS > KMS > Key > Tags > Template

The template is used to generate the keys and values for AWS KMS key.

Tags not defined in Key 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.

URI
tmod:@turbot/aws-kms#/policy/types/keyTagsTemplate
Category
Parent
Targets
Default Template Input
[
  "{\n  account {\n    turbot {\n      id\n    }\n  }\n}\n",
  "{\n  defaultTags: policyValue(uri:\"tmod:@turbot/aws-kms#/policy/types/kmsTagsTemplate\" resourceId: \"{{ $.account.turbot.id }}\") {\n    value\n  }\n}\n"
]
Default Template
"{%- if $.defaultTags.value | length == 0 %} [] {%- elif $.defaultTags.value != undefined %}{{ $.defaultTags.value | dump | safe }}{%- else %}{% for item in $.defaultTags.value %}- {{ item }}{% endfor %}{% endif %}"
Schema

AWS > KMS > Key > Usage

Configure the number of AWS KMS keys 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 > KMS > Key > Usage policy.

URI
tmod:@turbot/aws-kms#/policy/types/keyUsage
Category
Parent
Targets
Valid Value
[
  "Skip",
  "Check: Usage <= 85% of Limit",
  "Check: Usage <= 100% of Limit"
]
Schema
{
  "type": "string",
  "enum": [
    "Skip",
    "Check: Usage <= 85% of Limit",
    "Check: Usage <= 100% of Limit"
  ],
  "example": [
    "Check: Usage <= 85% of Limit"
  ],
  "default": "Skip"
}

AWS > KMS > Key > Usage > Limit

Maximum number of items that can be created for this region.

URI
tmod:@turbot/aws-kms#/policy/types/keyUsageLimit
Category
Parent
Targets
Schema
{
  "type": "integer",
  "minimum": 0,
  "default": 1000
}

AWS > KMS > Permissions

Configure whether permissions policies are in effect for AWS KMS.

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.

URI
tmod:@turbot/aws-kms#/policy/types/kmsPermissions
Category
Parent
Targets
Valid Value
[
  "Enabled",
  "Disabled",
  "Enabled if AWS > KMS > Enabled & AWS > KMS > API Enabled"
]
Schema
{
  "type": "string",
  "enum": [
    "Enabled",
    "Disabled",
    "Enabled if AWS > KMS > Enabled & AWS > KMS > API Enabled"
  ],
  "example": [
    "Enabled"
  ],
  "default": "Enabled if AWS > KMS > Enabled & AWS > KMS > API Enabled"
}

AWS > KMS > Permissions > Levels

Define the permissions levels that can be used to grant access to an AWS account.
Permissions levels defined will appear in the UI to assign access to Guardrails users.
This policy provides a default for Permissions > Levels in each service,
however you can explicitly override the setting for each service if desired

URI
tmod:@turbot/aws-kms#/policy/types/kmsPermissionsLevels
Category
Parent
Targets
Default Template Input
[
  "{\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"
]
Default Template
"{% if $.availableLevels.items[0].value | length == 0 %} [] {% endif %}{% for item in $.availableLevels.items[0].value %}- {{ item }}&#92;n{% endfor %}"
Schema
{
  "type": "array",
  "items": {
    "type": "string",
    "enum": [
      "Metadata",
      "ReadOnly",
      "Operator",
      "Admin",
      "Owner"
    ]
  }
}

AWS > KMS > Permissions > Levels > Modifiers

A map of AWS API to Guardrails Permission Level used to customize Guardrails' standard permissions.
You can add, remove or redefine the mapping of AWS API operations to Guardrails permissions levels here.

Note: Modifiers are cumulative - if you add a permission to the Metadata level, it is also added to ReadOnly, Operator and Admin.
Modifier policies set here apply ONLY to the AWS level

<br />example:<br /> - &quot;glacier:createvault&quot;: admin<br /> - &quot;glacier:ListVaults&quot;: metadata<br /> - &quot;s3:DeleteBucket&quot;: none<br />

URI
tmod:@turbot/aws-kms#/policy/types/kmsPermissionsLevelsModifiers
Category
Parent
Targets
Schema

AWS > KMS > Permissions > Lockdown

URI
tmod:@turbot/aws-kms#/policy/types/kmsPermissionsLockdown
Category
Parent
Targets

AWS > KMS > Permissions > Lockdown > API Boundary

Configure whether the AWS kms API is enabled for all users and roles in guardrails-managed boundary policies.

Note: Disabling the service disables the API for ALL users and roles, and Guardrails will have no access to the API.

URI
tmod:@turbot/aws-kms#/policy/types/kmsPermissionsLockdownApiBoundary
Category
Parent
Targets
Valid Value
[
  "Enabled if AWS > KMS > API Enabled"
]
Schema
{
  "type": "string",
  "enum": [
    "Enabled if AWS > KMS > API Enabled"
  ],
  "example": [
    "Enabled if AWS > KMS > API Enabled"
  ],
  "default": "Enabled if AWS > KMS > API Enabled"
}

AWS > KMS > Regions

A list of AWS regions in which AWS KMS 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 KMS resources' Regions policies.

URI
tmod:@turbot/aws-kms#/policy/types/kmsRegionsDefault
Category
Parent
Targets
Default Template Input
"{\n  regions: policyValue(uri:\"tmod:@turbot/aws#/policy/types/regionsDefault\") {\n    value\n  }\n}\n"
Default Template
"{% if $.regions.value | length == 0 %} [] {% endif %}{% for item in $.regions.value %}- &#39;{{ item }}&#39;&#92;n{% endfor %}"
Schema

AWS > KMS > Tags Template [Default]

A template used to generate the keys and values for AWS KMS resources.

By default, all KMS resource Tags > Template policies will use this value.

URI
tmod:@turbot/aws-kms#/policy/types/kmsTagsTemplate
Category
Parent
Targets
Default Template Input
"{\n  defaultTags: policyValue(uri:\"tmod:@turbot/aws#/policy/types/defaultTagsTemplate\") {\n    value\n  }\n}\n"
Default Template
"{%- if $.defaultTags.value | length == 0 %} [] {%- elif $.defaultTags.value != undefined %}{{ $.defaultTags.value | dump | safe }}{%- else %}{% for item in $.defaultTags.value %}- {{ item }}{% endfor %}{% endif %}"
Schema

AWS > Region > KMS Key [Default]

Define the KMS key to be used by the encryption at rest control.

Note: Please make sure the key defined in the template has required permissions.

URI
tmod:@turbot/aws-kms#/policy/types/keyDefaultCustomerManagedKey
Category
Parent
Targets
Default Template Input
"{\n  prefix: policy(uri: \"#/policy/types/encryptionKmsKeyAliasNamePrefix\")\n}\n"
Default Template
"{%- if $.prefix %}alias/{{ $.prefix }}/default{%- else -%}alias/{{ $.prefix }}/default{%- endif -%}"
Schema
{
  "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}$"
    }
  ]
}

AWS > Turbot > Encryption

Configure the Guardrails Encryption Key stack. This stack configures
the default customer managed key.

URI
tmod:@turbot/aws-kms#/policy/types/encryption
Category
Parent
Targets
Valid Value
[
  "Skip",
  "Check: Configured",
  "Check: Not configured",
  "Enforce: Configured",
  "Enforce: Not configured"
]
Schema
{
  "type": "string",
  "enum": [
    "Skip",
    "Check: Configured",
    "Check: Not configured",
    "Enforce: Configured",
    "Enforce: Not configured"
  ],
  "default": "Skip"
}

AWS > Turbot > Encryption > KMS

URI
tmod:@turbot/aws-kms#/policy/types/encryptionKms
Category
Parent
Targets

AWS > Turbot > Encryption > KMS > Key

URI
tmod:@turbot/aws-kms#/policy/types/encryptionKmsKey
Category
Parent
Targets

AWS > Turbot > Encryption > KMS > Key > Alias Name Prefix

A string to be used as a prefix to the guardrails generated name on the
Guardrails Managed Encryption Key. The name will be pre-pended with this value.

URI
tmod:@turbot/aws-kms#/policy/types/encryptionKmsKeyAliasNamePrefix
Category
Parent
Targets
Schema
{
  "type": "string",
  "pattern": "^[a-zA-Z0-9:/_-]+$",
  "maxLength": 249,
  "default": "turbot",
  "example": "turbot"
}

AWS > Turbot > Encryption > Source

The terraform source for creating and managing the customer managed key. This is a read-only policy controlled by guardrails.

URI
tmod:@turbot/aws-kms#/policy/types/keyEncryptionSource
Category
Parent
Targets
Schema
{
  "type": "string",
  "x-schema-form": {
    "type": "code",
    "language": "hcl"
  }
}

AWS > Turbot > Encryption > Terraform Version

The version of Terraform to use for this stack.
Specify an npm-style semver string to
determine which version of the Terraform container
Guardrails will use to run this stack.

A Guardrails Stack is a set of resources configured by Guardrails,
as specified via Terraform source. Stacks are responsible
for the creation and deletion of multiple resources. Once created,
stack resources are responsible for configuring themselves from
the stack source via their Configured control.

URI
tmod:@turbot/aws-kms#/policy/types/encryptionTerraformVersion
Category
Parent
Targets
Schema
{
  "type": "string"
}

AWS > Turbot > Event Handlers > Events > Rules > Custom Event Patterns > @turbot/aws-kms

The CloudWatch Events event pattern used by the AWS KMS module to specify
which events to forward to the Guardrails Event Handlers.

URI
tmod:@turbot/aws-kms#/policy/types/kmsCustomEventPatterns
Category
Parent
Targets
Schema
{
  "type": "array",
  "items": {
    "type": "object"
  }
}

AWS > Turbot > Permissions > Compiled > API Boundary > @turbot/aws-kms

A read-only policy generated by Guardrails that lists the APIs that
should be added to the guardrails-managed (hard) boundary policy,
thereby enabling them to be assigned to users and roles.
This value will change depending on the value of the value of the
AWS > KMS > Permissions > Lockdown > API Boundary policy

URI
tmod:@turbot/aws-kms#/policy/types/awsCompiledApiBoundary
Category
Parent
Targets
Schema
{
  "type": "array"
}

AWS > Turbot > Permissions > Compiled > Levels > @turbot/aws-kms

A calculated policy that Guardrails uses to create a compiled list of ALL permissions for AWS KMS
that is used as input to the stack that manages the Guardrails IAM permissions objects.

URI
tmod:@turbot/aws-kms#/policy/types/awsLevelsCompiled
Category
Parent
Targets
Schema

AWS > Turbot > Permissions > Compiled > Service Permissions > @turbot/aws-kms

A calculated policy that Guardrails uses to create a compiled list of ALL permissions for AWS KMS
that is used as input to the control that manages the IAM stack.

URI
tmod:@turbot/aws-kms#/policy/types/awsCompiledServicePermissions
Category
Parent
Targets
Schema