Policy types for @turbot/aws-cloudtrail

• AWS > CloudTrail > API Enabled
• AWS > CloudTrail > Approved Regions [Default]
• AWS > CloudTrail > Enabled
• AWS > CloudTrail > Permissions
• AWS > CloudTrail > Permissions > Levels
• AWS > CloudTrail > Permissions > Levels > Modifiers
• AWS > CloudTrail > Permissions > Lockdown
• AWS > CloudTrail > Permissions > Lockdown > API Boundary
• AWS > CloudTrail > Regions
• AWS > CloudTrail > Shadow Trail > CMDB
• AWS > CloudTrail > Shadow Trail > Regions
• AWS > CloudTrail > Tags Template [Default]
• AWS > CloudTrail > Trail > Active
• AWS > CloudTrail > Trail > Active > Age
• AWS > CloudTrail > Trail > Active > Budget
• AWS > CloudTrail > Trail > Active > Last Modified
• AWS > CloudTrail > Trail > Approved
• AWS > CloudTrail > Trail > Approved > Budget
• AWS > CloudTrail > Trail > Approved > Custom
• AWS > CloudTrail > Trail > Approved > Regions
• AWS > CloudTrail > Trail > Approved > Usage
• AWS > CloudTrail > Trail > CMDB
• AWS > CloudTrail > Trail > Configured
• AWS > CloudTrail > Trail > Configured > Claim Precedence
• AWS > CloudTrail > Trail > Configured > Source
• AWS > CloudTrail > Trail > Encryption at Rest
• AWS > CloudTrail > Trail > Encryption at Rest > Customer Managed Key
• AWS > CloudTrail > Trail > Log File Validation
• AWS > CloudTrail > Trail > Regions
• AWS > CloudTrail > Trail > Tags
• AWS > CloudTrail > Trail > Tags > Template
• AWS > CloudTrail > Trail > Trail Status
• AWS > CloudTrail > Trail > Usage
• AWS > CloudTrail > Trail > Usage > Limit
• AWS > Turbot > Event Handlers > Events > Rules > Custom Event Patterns > CloudTrail
• AWS > Turbot > Permissions > Compiled > API Boundary > @turbot/aws-cloudtrail
• AWS > Turbot > Permissions > Compiled > Levels > @turbot/aws-cloudtrail
• AWS > Turbot > Permissions > Compiled > Service Permissions > @turbot/aws-cloudtrail

AWS > CloudTrail > API Enabled

Configure whether the AWS CloudTrail API is enabled.\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 > CloudTrail > Enabled"
]

{
  "type": "string",
  "enum": [
    "Enabled",
    "Disabled",
    "Enabled if AWS > CloudTrail > Enabled"
  ],
  "default": "Enabled"
}

AWS > CloudTrail > Approved Regions [Default]

A list of AWS regions in which AWS CloudTrail 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 CloudTrail 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 > CloudTrail > Enabled

Enabled CloudTrail.

[
  "Enabled",
  "Enabled: Metadata Only",
  "Disabled"
]

{
  "type": "string",
  "enum": [
    "Enabled",
    "Enabled: Metadata Only",
    "Disabled"
  ],
  "example": [
    "Enabled"
  ],
  "default": "Disabled"
}

AWS > CloudTrail > Permissions

Configure whether permissions policies are in effect for AWS CloudTrail.\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 > CloudTrail > Enabled & AWS > CloudTrail > API Enabled"
]

{
  "type": "string",
  "enum": [
    "Enabled",
    "Disabled",
    "Enabled if AWS > CloudTrail > Enabled & AWS > CloudTrail > API Enabled"
  ],
  "example": [
    "Enabled"
  ],
  "default": "Enabled if AWS > CloudTrail > Enabled & AWS > CloudTrail > API Enabled"
}

AWS > CloudTrail > 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 > CloudTrail > 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 > CloudTrail > Permissions > Lockdown

AWS > CloudTrail > Permissions > Lockdown > API Boundary

Configure whether the AWS cloudTrail 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 > CloudTrail > API Enabled"
]

{
  "type": "string",
  "enum": [
    "Enabled if AWS > CloudTrail > API Enabled"
  ],
  "example": [
    "Enabled if AWS > CloudTrail > API Enabled"
  ],
  "default": "Enabled if AWS > CloudTrail > API Enabled"
}

AWS > CloudTrail > Regions

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

"{\n  regions: policyValue(uri:\"tmod:@turbot/aws#/policy/types/regionsDefault\") {\n    value\n  }\n}\n"

"{% if $.regions.value | length == 0 %} [] {% endif %}{% for item in $.regions.value %}- '{{ item }}'\n{% endfor %}"

AWS > CloudTrail > Shadow Trail > CMDB

Configure whether to record and synchronize details for the AWS CloudTrail shadow trail into the CMDB.\n\nA shadow trail is the replication in a region of a trail that was created in a different region, or in the case of an organization trail, the replication of an organization trail in member accounts.\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 > CloudTrail > Shadow Trail > 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 > CloudTrail > Shadow Trail > Regions

A list of AWS regions in which AWS CloudTrail shadow trails are supported for use.\n\nAny shadow trails 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-cloudtrail#/policy/types/cloudTrailRegionsDefault\") {\n    value\n  }\n}\n"

"{% if $.regions.value | length == 0 %} [] {% endif %}{% for item in $.regions.value %}- '{{ item }}'\n{% endfor %}"

AWS > CloudTrail > Tags Template [Default]

A template used to generate the keys and values for AWS CloudTrail resources.\n\nBy default, all CloudTrail 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 > CloudTrail > Trail > Active

Determine the action to take when an AWS CloudTrail trail, based on the AWS > CloudTrail > Trail > 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 > CloudTrail > Trail > 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 > CloudTrail > Trail > Active > Age

The age after which the AWS CloudTrail trail\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 > CloudTrail > Trail > 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 > CloudTrail > Trail > Active > Budget

The impact of the budget state on the active control. This policy allows you to force\ntrails 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 > CloudTrail > Trail > 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 > CloudTrail > Trail > Active > Last Modified

The number of days since the AWS CloudTrail trail\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 > CloudTrail > Trail > 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 > CloudTrail > Trail > Approved

Determine the action to take when an AWS CloudTrail trail is not approved based on AWS > CloudTrail > Trail > 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: Stop unapproved",
  "Enforce: Stop unapproved if new",
  "Enforce: Delete unapproved if new"
]

{
  "type": "string",
  "enum": [
    "Skip",
    "Check: Approved",
    "Enforce: Stop unapproved",
    "Enforce: Stop unapproved if new",
    "Enforce: Delete unapproved if new"
  ],
  "example": [
    "Check: Approved"
  ],
  "default": "Skip"
}

AWS > CloudTrail > Trail > Approved > Budget

The policy allows you to set trails 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 CloudTrail trail is not matched by the approved list, it will be subject to the action specified in the AWS > CloudTrail > Trail > 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 > CloudTrail > Trail > Approved > Custom

Determine whether the AWS CloudTrail trail is allowed to exist.\nThis policy will be evaluated by the Approved control. If an AWS CloudTrail trail is not approved, it will be subject to the action specified in the AWS > CloudTrail > Trail > 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 > CloudTrail > Trail > Approved > Regions

A list of AWS regions in which AWS CloudTrail trails 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 CloudTrail trail is created in a region that is not in the approved list, it will be subject to the action specified in the AWS > CloudTrail > Trail > Approved policy.\n\nSee Approved for more information.\n

"{\n  regions: policy(uri: \"tmod:@turbot/aws-cloudtrail#/policy/types/cloudTrailApprovedRegionsDefault\")\n}\n"

"{% if $.regions | length == 0 %} [] {% endif %}{% for item in $.regions %}- '{{ item }}'\n{% endfor %}"

AWS > CloudTrail > Trail > Approved > Usage

Determine whether the AWS CloudTrail trail is allowed to exist.\n\nThis policy will be evaluated by the Approved control. If an AWS CloudTrail trail is not approved, it will be subject to the action specified in the AWS > CloudTrail > Trail > Approved policy.\n\nSee Approved for more information.\n

[
  "Not approved",
  "Approved",
  "Approved if AWS > CloudTrail > Enabled"
]

{
  "type": "string",
  "enum": [
    "Not approved",
    "Approved",
    "Approved if AWS > CloudTrail > Enabled"
  ],
  "example": [
    "Not approved"
  ],
  "default": "Approved if AWS > CloudTrail > Enabled"
}

AWS > CloudTrail > Trail > CMDB

Configure whether to record and synchronize details for the AWS CloudTrail trail 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 > CloudTrail > Trail > 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 > CloudTrail > Trail > Configured

Determine how to configure this resource.\n\nNote: If the resource is managed by another stack, then the Skip/Check/Enforce values here are ignored\nand inherit from the stack that owns it\n

[
  "Skip (unless claimed by a stack)",
  "Check: Per Configured > Source (unless claimed by a stack)",
  "Enforce: Per Configured > Source (unless claimed by a stack)"
]

{
  "enum": [
    "Skip (unless claimed by a stack)",
    "Check: Per Configured > Source (unless claimed by a stack)",
    "Enforce: Per Configured > Source (unless claimed by a stack)"
  ],
  "default": "Skip (unless claimed by a stack)"
}

AWS > CloudTrail > Trail > Configured > Claim Precedence

An ordered list of who is allowed to claim a resource.\nA stack cannot claim a resource if it is already claimed by another\nstack at a higher level of precedence.\n

"{\n  defaultPrecedence: policy(uri:\"tmod:@turbot/turbot#/policy/types/claimPrecedenceDefault\")\n}\n"

"{%- if $.defaultPrecedence | length == 0 %}[]{%- else %}{% for item in $.defaultPrecedence %}- '{{ item }}'{% endfor %}{% endif %}"

{
  "type": "array",
  "items": {
    "type": "string"
  }
}

AWS > CloudTrail > Trail > Configured > Source

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

{
  "type": "string",
  "default": "",
  "x-schema-form": {
    "type": "code",
    "language": "hcl"
  }
}

AWS > CloudTrail > Trail > Encryption at Rest

Define the Encryption at Rest settings required for AWS > CloudTrail > Trail.\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 > CloudTrail > Trail > Encryption at Rest > *),\nraises an alarm, and takes the defined enforcement action\n

[
  "Skip",
  "Check: None",
  "Check: None or higher",
  "Check: Customer managed key",
  "Check: Encryption at Rest > Customer Managed Key",
  "Enforce: None",
  "Enforce: Customer managed key",
  "Enforce: Encryption at Rest > Customer Managed Key"
]

{
  "type": "string",
  "enum": [
    "Skip",
    "Check: None",
    "Check: None or higher",
    "Check: Customer managed key",
    "Check: Encryption at Rest > Customer Managed Key",
    "Enforce: None",
    "Enforce: Customer managed key",
    "Enforce: Encryption at Rest > Customer Managed Key"
  ],
  "example": [
    "Check: None or higher"
  ],
  "default": "Skip"
}

AWS > CloudTrail > Trail > 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 > CloudTrail > Trail > 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 > CloudTrail > Trail > Log File Validation

Configure whether Log File Validation is enabled for the CloudTrail trail.

[
  "Skip",
  "Check: Disabled",
  "Check: Enabled",
  "Enforce: Disabled",
  "Enforce: Enabled"
]

{
  "type": "string",
  "enum": [
    "Skip",
    "Check: Disabled",
    "Check: Enabled",
    "Enforce: Disabled",
    "Enforce: Enabled"
  ],
  "example": [
    "Skip"
  ],
  "default": "Skip"
}

AWS > CloudTrail > Trail > Regions

A list of AWS regions in which AWS CloudTrail trails are supported for use.\n\nAny trails 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-cloudtrail#/policy/types/cloudTrailRegionsDefault\") {\n    value\n  }\n}\n"

"{% if $.regions.value | length == 0 %} [] {% endif %}{% for item in $.regions.value %}- '{{ item }}'\n{% endfor %}"

AWS > CloudTrail > Trail > Tags

Determine the action to take when an AWS CloudTrail trail tags are not updated based on the AWS > CloudTrail > Trail > Tags > * policies.\n\nThe control ensure AWS CloudTrail trail tags include tags defined in AWS > CloudTrail > Trail > Tags > Template.\n\nTags not defined in Trail 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 > CloudTrail > Trail > Tags > Template

The template is used to generate the keys and values for AWS CloudTrail trail.\n\nTags not defined in Trail 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-cloudtrail#/policy/types/cloudTrailTagsTemplate\" 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 > CloudTrail > Trail > Trail Status

Check if a CloudTrail trail has any delivery errors.

[
  "Skip",
  "Check: No delivery errors"
]

{
  "type": "string",
  "enum": [
    "Skip",
    "Check: No delivery errors"
  ],
  "example": [
    "Skip"
  ],
  "default": "Skip"
}

AWS > CloudTrail > Trail > Usage

Configure the number of AWS CloudTrail trails that can be used for this region and the current consumption against the limit.\n\nYou can configure the behavior of the control with this AWS > CloudTrail > Trail > 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 > CloudTrail > Trail > Usage > Limit

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

{
  "type": "integer",
  "minimum": 0,
  "default": 5
}

AWS > Turbot > Event Handlers > Events > Rules > Custom Event Patterns > CloudTrail

The CloudWatch Events event pattern used by the AWS CloudTrail module to specify\nwhich events to forward to the Guardrails Event Handlers.\n

{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "type": {
        "type": "object",
        "properties": {
          "title": {
            "type": "string"
          }
        }
      },
      "value": {
        "type": "object",
        "properties": {
          "source": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "detail-type": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "detail": {
            "type": "object",
            "property": {
              "eventName": {
                "type": "array"
              }
            },
            "required": [
              "eventName"
            ]
          }
        },
        "required": [
          "source"
        ]
      }
    },
    "required": [
      "type"
    ]
  },
  "default": [
    {
      "type": {
        "title": "CloudTrail",
        "name": "cloudtrail"
      },
      "value": {
        "source": [
          "aws.cloudtrail"
        ],
        "detail-type": [
          "AWS API Call via CloudTrail"
        ],
        "detail": {
          "eventName": [
            "AddTags",
            "CreateTrail",
            "DeleteTrail",
            "PutEventSelectors",
            "RemoveTags",
            "StartLogging",
            "StopLogging",
            "UpdateTrail"
          ]
        }
      }
    }
  ]
}

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

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 > CloudTrail > Permissions > Lockdown > API Boundary policy\n

{
  "type": "array"
}

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

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

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

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