Product logo
DocsBlogPricing

Policy types for @turbot/aws-rds

AWS > RDS > API Enabled

Configure whether the AWS RDS API is enabled.\n\nNote: Disabling the service disables the API for ALL users\nand roles, and Guardrails will have no access to the API.\n

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

AWS > RDS > Approved Regions [Default]

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

URI
tmod:@turbot/aws-rds#/policy/types/rdsApprovedRegionsDefault
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 > RDS > DB Cluster > Active

Determine the action to take when an AWS RDS db cluster, based on the AWS > RDS > DB Cluster > 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 > RDS > DB Cluster > 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

URI
tmod:@turbot/aws-rds#/policy/types/dbClusterActive
Category
Parent
Targets
Valid Value
[
  "Skip",
  "Check: Active",
  "Enforce: Snapshot and delete inactive with 1 day warning",
  "Enforce: Snapshot and delete inactive with 3 days warning",
  "Enforce: Snapshot and delete inactive with 7 days warning",
  "Enforce: Snapshot and delete inactive with 14 days warning",
  "Enforce: Snapshot and delete inactive with 30 days warning",
  "Enforce: Snapshot and delete inactive with 60 days warning",
  "Enforce: Snapshot and delete inactive with 90 days warning",
  "Enforce: Snapshot and delete inactive with 180 days warning",
  "Enforce: Snapshot and delete inactive with 365 days warning"
]
Schema
{
  "type": "string",
  "enum": [
    "Skip",
    "Check: Active",
    "Enforce: Snapshot and delete inactive with 1 day warning",
    "Enforce: Snapshot and delete inactive with 3 days warning",
    "Enforce: Snapshot and delete inactive with 7 days warning",
    "Enforce: Snapshot and delete inactive with 14 days warning",
    "Enforce: Snapshot and delete inactive with 30 days warning",
    "Enforce: Snapshot and delete inactive with 60 days warning",
    "Enforce: Snapshot and delete inactive with 90 days warning",
    "Enforce: Snapshot and delete inactive with 180 days warning",
    "Enforce: Snapshot and delete inactive with 365 days warning"
  ],
  "example": [
    "Check: Active"
  ],
  "default": "Skip"
}

AWS > RDS > DB Cluster > Active > Age

The age after which the AWS RDS db cluster\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 > RDS > DB Cluster > 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

URI
tmod:@turbot/aws-rds#/policy/types/dbClusterActiveAge
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 > RDS > DB Cluster > Active > Budget

The impact of the budget state on the active control. This policy allows you to force\ndbClusters 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 > RDS > DB Cluster > 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

URI
tmod:@turbot/aws-rds#/policy/types/dbClusterActiveBudget
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 > RDS > DB Cluster > Active > Last Modified

The number of days since the AWS RDS db cluster\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 > RDS > DB Cluster > 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

URI
tmod:@turbot/aws-rds#/policy/types/dbClusterActiveLastModified
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 > RDS > DB Cluster > Approved

Determine the action to take when an AWS RDS db cluster is not approved based on AWS > RDS > DB Cluster > 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

URI
tmod:@turbot/aws-rds#/policy/types/dbClusterApproved
Category
Parent
Targets
Valid Value
[
  "Skip",
  "Check: Approved",
  "Enforce: Snapshot and delete unapproved if new"
]
Schema
{
  "type": "string",
  "enum": [
    "Skip",
    "Check: Approved",
    "Enforce: Snapshot and delete unapproved if new"
  ],
  "example": [
    "Check: Approved"
  ],
  "default": "Skip"
}

AWS > RDS > DB Cluster > Approved > Budget

The policy allows you to set db clusters 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 RDS db cluster is not matched by the approved list, it will be subject to the action specified in the AWS > RDS > DB Cluster > Approved policy.\n\nSee Approved for more information.\n

URI
tmod:@turbot/aws-rds#/policy/types/dbClusterApprovedBudget
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 > RDS > DB Cluster > Approved > Custom

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

URI
tmod:@turbot/aws-rds#/policy/types/dbClusterApprovedCustom
Category
Parent
Targets
Schema
{
  "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 > RDS > DB Cluster > Approved > Regions

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

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

AWS > RDS > DB Cluster > Approved > Usage

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

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

AWS > RDS > DB Cluster > Backup Retention Period

Ensure the backup retention period is configured to meet policy. Automatic snapshots are deleted by AWS when the RDS cluster is deleted.\n

URI
tmod:@turbot/aws-rds#/policy/types/dbClusterBackupRetentionPeriod
Category
Parent
Targets
Valid Value
[
  "Skip",
  "Check: Backup retention period",
  "Enforce: Backup retention period"
]
Schema
{
  "type": "string",
  "enum": [
    "Skip",
    "Check: Backup retention period",
    "Enforce: Backup retention period"
  ],
  "default": "Skip"
}

AWS > RDS > DB Cluster > Backup Retention Period > Days

The number of days for which the automated snapshots are retained. Automated snapshots are deleted by AWS at the end of a retention period.\n

URI
tmod:@turbot/aws-rds#/policy/types/dbClusterBackupRetentionPeriodDays
Category
Parent
Targets
Schema
{
  "type": "integer",
  "minimum": 1,
  "maximum": 35,
  "default": 7
}

AWS > RDS > DB Cluster > CMDB

Configure whether to record and synchronize details for the AWS RDS db cluster 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 > RDS > DB Cluster > 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

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

AWS > RDS > DB Cluster > 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

URI
tmod:@turbot/aws-rds#/policy/types/dbClusterConfigured
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 > RDS > DB Cluster > 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

URI
tmod:@turbot/aws-rds#/policy/types/dbClusterConfiguredPrecedence
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 > RDS > DB Cluster > Configured > Source

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

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

AWS > RDS > DB Cluster > Copy Tags to Snapshot

Configure Copy Tags to Snapshot settings on an AWS > RDS > DB Cluster.\n

URI
tmod:@turbot/aws-rds#/policy/types/dbClusterCopyTagsToSnapshot
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"
  ],
  "default": "Skip"
}

AWS > RDS > DB Cluster > Deletion Protection

Configure Deletion Protection settings on an AWS > RDS > DB Cluster.\n

URI
tmod:@turbot/aws-rds#/policy/types/dbClusterDeletionProtection
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"
  ],
  "default": "Skip"
}

AWS > RDS > DB Cluster > Logs Export Configuration

Configure logs export to CloudWatch for an AWS > RDS > DB Cluster as per the AWS > RDS > DB Cluster > Logs Export Configuration > * policies.\n

URI
tmod:@turbot/aws-rds#/policy/types/dbClusterLogsExportConfiguration
Category
Parent
Targets
Valid Value
[
  "Skip",
  "Check: Disabled",
  "Check: Enabled per Logs Export Configuration > Log Types",
  "Enforce: Disabled",
  "Enforce : Enabled per Logs Export Configuration > Log Types"
]
Schema
{
  "type": "string",
  "enum": [
    "Skip",
    "Check: Disabled",
    "Check: Enabled per Logs Export Configuration > Log Types",
    "Enforce: Disabled",
    "Enforce : Enabled per Logs Export Configuration > Log Types"
  ],
  "example": [
    "Check: Enabled per Logs Export Configuration > Log Types"
  ],
  "default": "Skip"
}

AWS > RDS > DB Cluster > Logs Export Configuration > Log Types

List of log types to be enabled for an AWS > RDS > DB Cluster.\n\nSupported log types for various DB engines:\n\n&#92;n&#92;nAmazon Aurora MySQL:&#92;n * Audit Log&#92;n * Error Log&#92;n * General Log&#92;n * Slow Query Log&#92;n&#92;nAmazon Aurora PostgreSQL:&#92;n * PostgreSQL Log&#92;n&#92;n\n\nNote: Unsupported log types selected for a DB engine will be filtered out automatically and only the supported log types will be enabled.\n

URI
tmod:@turbot/aws-rds#/policy/types/dbClusterLogsExportConfigurationLogTypes
Category
Parent
Targets
Schema
{
  "type": "array",
  "items": {
    "type": "string",
    "enum": [
      "Audit log",
      "Error log",
      "General log",
      "PostgreSQL log",
      "Slow query log"
    ]
  },
  "example": [
    "Error log",
    "General log"
  ],
  "default": []
}

AWS > RDS > DB Cluster > Regions

A list of AWS regions in which AWS RDS db clusters are supported for use.\n\nAny db clusters 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

URI
tmod:@turbot/aws-rds#/policy/types/dbClusterRegions
Category
Parent
Targets
Default Template Input
"{\n  regions: policyValue(uri:\"tmod:@turbot/aws-rds#/policy/types/rdsRegionsDefault\") {\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 > RDS > DB Cluster > Schedule

Set a schedule for starting and stopping an AWS RDS db cluster.\n\nNote If both "Schedule" and "Schedule Tag" are set to enforce and the\ndb cluster has a turbot_custom_schedule tag, then the schedule specified by\nthe tag will be in effect.\n

URI
tmod:@turbot/aws-rds#/policy/types/dbClusterSchedule
Category
Parent
Targets
Valid Value
[
  "Skip",
  "Enforce: Business hours (8:00am - 6:00pm on weekdays)",
  "Enforce: Extended business hours (7:00am - 11:00pm on weekdays)",
  "Enforce: Stop for night (stop at 10:00pm every day)",
  "Enforce: Stop for weekend (stop at 10:00pm on Friday)"
]
Schema
{
  "type": "string",
  "enum": [
    "Skip",
    "Enforce: Business hours (8:00am - 6:00pm on weekdays)",
    "Enforce: Extended business hours (7:00am - 11:00pm on weekdays)",
    "Enforce: Stop for night (stop at 10:00pm every day)",
    "Enforce: Stop for weekend (stop at 10:00pm on Friday)"
  ],
  "example": [
    "Enforce: Business hours (8:00am - 6:00pm on weekdays)"
  ],
  "default": "Skip"
}

AWS > RDS > DB Cluster > Schedule Tag

Allow setting a schedule for starting and stopping an RDS db cluster via the\nturbot_custom_schedule tag. If the schedule is invalid, no actions will be\ntaken against the dbCluster.\n\nNote If both "Schedule" and "Schedule Tag" are set to enforce and the\ndb cluster has a turbot_custom_schedule, then the schedule specified by the\ntag will be in effect.\n

URI
tmod:@turbot/aws-rds#/policy/types/dbClusterScheduleTag
Category
Parent
Targets
Valid Value
[
  "Skip",
  "Enforce: Schedule per turbot_custom_schedule tag"
]
Schema
{
  "type": "string",
  "enum": [
    "Skip",
    "Enforce: Schedule per turbot_custom_schedule tag"
  ],
  "example": [
    "Enforce: Schedule per turbot_custom_schedule tag"
  ],
  "default": "Skip"
}

AWS > RDS > DB Cluster > Tags

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

URI
tmod:@turbot/aws-rds#/policy/types/dbClusterTags
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 > RDS > DB Cluster > Tags > Template

The template is used to generate the keys and values for AWS RDS db cluster.\n\nTags not defined in DB Cluster 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

URI
tmod:@turbot/aws-rds#/policy/types/dbClusterTagsTemplate
Category
Parent
Targets
Default Template Input
[
  "{\n  account {\n    turbot {\n      id\n    }\n  }\n}\n",
  "{\n  defaultTags: policyValue(uri:\"tmod:@turbot/aws-rds#/policy/types/rdsTagsTemplate\" 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 > RDS > DB Cluster > Usage

Configure the number of AWS RDS db clusters 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 > RDS > DB Cluster > Usage policy.\n

URI
tmod:@turbot/aws-rds#/policy/types/dbClusterUsage
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 > RDS > DB Cluster > Usage > Limit

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

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

AWS > RDS > DB Cluster Parameter Group > Active

Determine the action to take when an AWS RDS db cluster parameter group, based on the AWS > RDS > DB Cluster Parameter Group > 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 > RDS > DB Cluster Parameter Group > 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

URI
tmod:@turbot/aws-rds#/policy/types/dbClusterParameterGroupActive
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 > RDS > DB Cluster Parameter Group > Active > Age

The age after which the AWS RDS db cluster parameter group\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 > RDS > DB Cluster Parameter Group > 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

URI
tmod:@turbot/aws-rds#/policy/types/dbClusterParameterGroupActiveAge
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 > RDS > DB Cluster Parameter Group > Active > Last Modified

The number of days since the AWS RDS db cluster parameter group\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 > RDS > DB Cluster Parameter Group > 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

URI
tmod:@turbot/aws-rds#/policy/types/dbClusterParameterGroupActiveLastModified
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 > RDS > DB Cluster Parameter Group > Approved

Determine the action to take when an AWS RDS db cluster parameter group is not approved based on AWS > RDS > DB Cluster Parameter Group > 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

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

AWS > RDS > DB Cluster Parameter Group > Approved > Custom

Determine whether the AWS RDS db cluster parameter group is allowed to exist.\nThis policy will be evaluated by the Approved control. If an AWS RDS db cluster parameter group is not approved, it will be subject to the action specified in the AWS > RDS > DB Cluster Parameter Group > 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

URI
tmod:@turbot/aws-rds#/policy/types/dbClusterParameterGroupApprovedCustom
Category
Parent
Targets
Schema
{
  "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 > RDS > DB Cluster Parameter Group > Approved > Regions

A list of AWS regions in which AWS RDS db cluster parameter groups 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 RDS db cluster parameter group is created in a region that is not in the approved list, it will be subject to the action specified in the AWS > RDS > DB Cluster Parameter Group > Approved policy.\n\nSee Approved for more information.\n

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

AWS > RDS > DB Cluster Parameter Group > Approved > Usage

Determine whether the AWS RDS db cluster parameter group is allowed to exist.\n\nThis policy will be evaluated by the Approved control. If an AWS RDS db cluster parameter group is not approved, it will be subject to the action specified in the AWS > RDS > DB Cluster Parameter Group > Approved policy.\n\nSee Approved for more information.\n

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

AWS > RDS > DB Cluster Parameter Group > CMDB

Configure whether to record and synchronize details for the AWS RDS db cluster parameter group 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 > RDS > DB Cluster Parameter Group > 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

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

AWS > RDS > DB Cluster Parameter Group > 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

URI
tmod:@turbot/aws-rds#/policy/types/dbClusterParameterGroupConfigured
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 > RDS > DB Cluster Parameter Group > 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

URI
tmod:@turbot/aws-rds#/policy/types/dbClusterParameterGroupConfiguredPrecedence
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 > RDS > DB Cluster Parameter Group > Configured > Source

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

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

AWS > RDS > DB Cluster Parameter Group > Regions

A list of AWS regions in which AWS RDS db cluster parameter groups are supported for use.\n\nAny db cluster parameter groups 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

URI
tmod:@turbot/aws-rds#/policy/types/dbClusterParameterGroupRegions
Category
Parent
Targets
Default Template Input
"{\n  regions: policyValue(uri:\"tmod:@turbot/aws-rds#/policy/types/rdsRegionsDefault\") {\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 > RDS > DB Cluster Parameter Group > Tags

Determine the action to take when an AWS RDS db cluster parameter group tags are not updated based on the AWS > RDS > DB Cluster Parameter Group > Tags > * policies.\n\nThe control ensure AWS RDS db cluster parameter group tags include tags defined in AWS > RDS > DB Cluster Parameter Group > Tags > Template.\n\nTags not defined in DB Cluster Parameter Group 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

URI
tmod:@turbot/aws-rds#/policy/types/dbClusterParameterGroupTags
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 > RDS > DB Cluster Parameter Group > Tags > Template

The template is used to generate the keys and values for AWS RDS db cluster parameter group.\n\nTags not defined in DB Cluster Parameter Group 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

URI
tmod:@turbot/aws-rds#/policy/types/dbClusterParameterGroupTagsTemplate
Category
Parent
Targets
Default Template Input
[
  "{\n  account {\n    turbot {\n      id\n    }\n  }\n}\n",
  "{\n  defaultTags: policyValue(uri:\"tmod:@turbot/aws-rds#/policy/types/rdsTagsTemplate\" 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 > RDS > DB Cluster Parameter Group > Usage

Configure the number of AWS RDS db cluster parameter groups 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 > RDS > DB Cluster Parameter Group > Usage policy.\n

URI
tmod:@turbot/aws-rds#/policy/types/dbClusterParameterGroupUsage
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 > RDS > DB Cluster Parameter Group > Usage > Limit

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

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

AWS > RDS > DB Cluster Snapshot [Manual] > Active

Determine the action to take when an AWS RDS db cluster snapshot [manual], based on the AWS > RDS > DB Cluster Snapshot [Manual] > 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 > RDS > DB Cluster Snapshot [Manual] > 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

URI
tmod:@turbot/aws-rds#/policy/types/dbClusterSnapshotManualActive
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 > RDS > DB Cluster Snapshot [Manual] > Active > Age

The age after which the AWS RDS db cluster snapshot [manual]\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 > RDS > DB Cluster Snapshot [Manual] > 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

URI
tmod:@turbot/aws-rds#/policy/types/dbClusterSnapshotManualActiveAge
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 > RDS > DB Cluster Snapshot [Manual] > Active > Budget

The impact of the budget state on the active control. This policy allows you to force\ndbClusterSnapshotManuals 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 > RDS > DB Cluster Snapshot [Manual] > 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

URI
tmod:@turbot/aws-rds#/policy/types/dbClusterSnapshotManualActiveBudget
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 > RDS > DB Cluster Snapshot [Manual] > Active > Last Modified

The number of days since the AWS RDS db cluster snapshot [manual]\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 > RDS > DB Cluster Snapshot [Manual] > 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

URI
tmod:@turbot/aws-rds#/policy/types/dbClusterSnapshotManualActiveLastModified
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 > RDS > DB Cluster Snapshot [Manual] > Approved

Determine the action to take when an AWS RDS db cluster snapshot [manual] is not approved based on AWS > RDS > DB Cluster Snapshot [Manual] > 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

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

AWS > RDS > DB Cluster Snapshot [Manual] > Approved > Budget

The policy allows you to set db cluster snapshot [manual]s 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 RDS db cluster snapshot [manual] is not matched by the approved list, it will be subject to the action specified in the AWS > RDS > DB Cluster Snapshot [Manual] > Approved policy.\n\nSee Approved for more information.\n

URI
tmod:@turbot/aws-rds#/policy/types/dbClusterSnapshotManualApprovedBudget
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 > RDS > DB Cluster Snapshot [Manual] > Approved > Custom

Determine whether the AWS RDS db cluster snapshot [manual] is allowed to exist.\nThis policy will be evaluated by the Approved control. If an AWS RDS db cluster snapshot [manual] is not approved, it will be subject to the action specified in the AWS > RDS > DB Cluster Snapshot [Manual] > 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

URI
tmod:@turbot/aws-rds#/policy/types/dbClusterSnapshotManualApprovedCustom
Category
Parent
Targets
Schema
{
  "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 > RDS > DB Cluster Snapshot [Manual] > Approved > Regions

A list of AWS regions in which AWS RDS db cluster snapshot [manual]s 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 RDS db cluster snapshot [manual] is created in a region that is not in the approved list, it will be subject to the action specified in the AWS > RDS > DB Cluster Snapshot [Manual] > Approved policy.\n\nSee Approved for more information.\n

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

AWS > RDS > DB Cluster Snapshot [Manual] > Approved > Usage

Determine whether the AWS RDS db cluster snapshot [manual] is allowed to exist.\n\nThis policy will be evaluated by the Approved control. If an AWS RDS db cluster snapshot [manual] is not approved, it will be subject to the action specified in the AWS > RDS > DB Cluster Snapshot [Manual] > Approved policy.\n\nSee Approved for more information.\n

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

AWS > RDS > DB Cluster Snapshot [Manual] > CMDB

Configure whether to record and synchronize details for the AWS RDS db cluster snapshot [manual] 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 > RDS > DB Cluster Snapshot [Manual] > 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

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

AWS > RDS > DB Cluster Snapshot [Manual] > 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

URI
tmod:@turbot/aws-rds#/policy/types/dbClusterSnapshotManualConfigured
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 > RDS > DB Cluster Snapshot [Manual] > 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

URI
tmod:@turbot/aws-rds#/policy/types/dbClusterSnapshotManualConfiguredPrecedence
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 > RDS > DB Cluster Snapshot [Manual] > Configured > Source

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

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

AWS > RDS > DB Cluster Snapshot [Manual] > Regions

A list of AWS regions in which AWS RDS db cluster snapshot [manual]s are supported for use.\n\nAny db cluster snapshot [manual]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

URI
tmod:@turbot/aws-rds#/policy/types/dbClusterSnapshotManualRegions
Category
Parent
Targets
Default Template Input
"{\n  regions: policyValue(uri:\"tmod:@turbot/aws-rds#/policy/types/rdsRegionsDefault\") {\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 > RDS > DB Cluster Snapshot [Manual] > Tags

Determine the action to take when an AWS RDS db cluster snapshot [manual] tags are not updated based on the AWS > RDS > DB Cluster Snapshot [Manual] > Tags > * policies.\n\nThe control ensure AWS RDS db cluster snapshot [manual] tags include tags defined in AWS > RDS > DB Cluster Snapshot [Manual] > Tags > Template.\n\nTags not defined in DB Cluster Snapshot [Manual] 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

URI
tmod:@turbot/aws-rds#/policy/types/dbClusterSnapshotManualTags
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 > RDS > DB Cluster Snapshot [Manual] > Tags > Template

The template is used to generate the keys and values for AWS RDS db cluster snapshot [manual].\n\nTags not defined in DB Cluster Snapshot [Manual] 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

URI
tmod:@turbot/aws-rds#/policy/types/dbClusterSnapshotManualTagsTemplate
Category
Parent
Targets
Default Template Input
[
  "{\n  account {\n    turbot {\n      id\n    }\n  }\n}\n",
  "{\n  defaultTags: policyValue(uri:\"tmod:@turbot/aws-rds#/policy/types/rdsTagsTemplate\" 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 > RDS > DB Cluster Snapshot [Manual] > Trusted Access

Manage trusted access for AWS RDS DB Cluster Snapshot [Manual]s.\n\nAWS allows RDS DB Cluster Snapshot [Manual]s to be shared with specific AWS accounts.\nThis policy allows you to configure whether such sharing is allowed, and to which accounts.\n\nIf set to Enforce, access to non-trusted accounts will be removed.\n

URI
tmod:@turbot/aws-rds#/policy/types/dbClusterSnapshotManualTrustedAccess
Category
Parent
Targets
Valid Value
[
  "Skip",
  "Check: Trusted Access > Accounts",
  "Enforce: Trusted Access > Accounts"
]
Schema
{
  "type": "string",
  "enum": [
    "Skip",
    "Check: Trusted Access > Accounts",
    "Enforce: Trusted Access > Accounts"
  ],
  "example": [
    "Check: Trusted Access > Accounts"
  ],
  "default": "Skip"
}

AWS > RDS > DB Cluster Snapshot [Manual] > Trusted Access > Accounts

A list of AWS account IDs that are allowed to have access

URI
tmod:@turbot/aws-rds#/policy/types/dbClusterSnapshotManualTrustedAccessAccounts
Category
Parent
Targets
Default Template Input
"{\n  accounts: policy(uri: \"tmod:@turbot/aws-rds#/policy/types/rdsTrustedAccounts\")\n}\n"
Default Template
"{% if $.accounts | length == 0 %}[]{% endif %}{% for item in $.accounts %}- &#39;{{ item }}&#39;&#92;n{% endfor %}"
Schema
{
  "type": "array",
  "items": {
    "type": "string",
    "pattern": "(?:^[0-9]{12}$|^\\*$|^all$)"
  }
}

AWS > RDS > DB Cluster Snapshot [Manual] > Usage

Configure the number of AWS RDS db cluster snapshot [manual]s 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 > RDS > DB Cluster Snapshot [Manual] > Usage policy.\n

URI
tmod:@turbot/aws-rds#/policy/types/dbClusterSnapshotManualUsage
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 > RDS > DB Cluster Snapshot [Manual] > Usage > Limit

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

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

AWS > RDS > DB Instance > Active

Determine the action to take when an AWS RDS db instance, based on the AWS > RDS > DB Instance > 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 > RDS > DB Instance > 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

URI
tmod:@turbot/aws-rds#/policy/types/dbInstanceActive
Category
Parent
Targets
Valid Value
[
  "Skip",
  "Check: Active",
  "Enforce: Snapshot and delete inactive with 1 day warning",
  "Enforce: Snapshot and delete inactive with 3 days warning",
  "Enforce: Snapshot and delete inactive with 7 days warning",
  "Enforce: Snapshot and delete inactive with 14 days warning",
  "Enforce: Snapshot and delete inactive with 30 days warning",
  "Enforce: Snapshot and delete inactive with 60 days warning",
  "Enforce: Snapshot and delete inactive with 90 days warning",
  "Enforce: Snapshot and delete inactive with 180 days warning",
  "Enforce: Snapshot and delete inactive with 365 days warning"
]
Schema
{
  "type": "string",
  "enum": [
    "Skip",
    "Check: Active",
    "Enforce: Snapshot and delete inactive with 1 day warning",
    "Enforce: Snapshot and delete inactive with 3 days warning",
    "Enforce: Snapshot and delete inactive with 7 days warning",
    "Enforce: Snapshot and delete inactive with 14 days warning",
    "Enforce: Snapshot and delete inactive with 30 days warning",
    "Enforce: Snapshot and delete inactive with 60 days warning",
    "Enforce: Snapshot and delete inactive with 90 days warning",
    "Enforce: Snapshot and delete inactive with 180 days warning",
    "Enforce: Snapshot and delete inactive with 365 days warning"
  ],
  "example": [
    "Check: Active"
  ],
  "default": "Skip"
}

AWS > RDS > DB Instance > Active > Age

The age after which the AWS RDS db instance\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 > RDS > DB Instance > 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

URI
tmod:@turbot/aws-rds#/policy/types/dbInstanceActiveAge
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 > RDS > DB Instance > Active > Budget

The impact of the budget state on the active control. This policy allows you to force\ndbInstances 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 > RDS > DB Instance > 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

URI
tmod:@turbot/aws-rds#/policy/types/dbInstanceActiveBudget
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 > RDS > DB Instance > Active > Last Modified

The number of days since the AWS RDS db instance\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 > RDS > DB Instance > 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

URI
tmod:@turbot/aws-rds#/policy/types/dbInstanceActiveLastModified
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 > RDS > DB Instance > Approved

Determine the action to take when an AWS RDS db instance is not approved based on AWS > RDS > DB Instance > 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\nSee Approved for more information.\n

URI
tmod:@turbot/aws-rds#/policy/types/dbInstanceApproved
Category
Parent
Targets
Valid Value
[
  "Skip",
  "Check: Approved",
  "Enforce: Stop unapproved",
  "Enforce: Stop unapproved if new",
  "Enforce: Snapshot and delete unapproved if new"
]
Schema
{
  "type": "string",
  "enum": [
    "Skip",
    "Check: Approved",
    "Enforce: Stop unapproved",
    "Enforce: Stop unapproved if new",
    "Enforce: Snapshot and delete unapproved if new"
  ],
  "example": [
    "Check: Approved"
  ],
  "default": "Skip"
}

AWS > RDS > DB Instance > Approved > Budget

The policy allows you to set db instances 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 RDS db instance is not matched by the approved list, it will be subject to the action specified in the AWS > RDS > DB Instance > Approved policy.\n\nSee Approved for more information.\n

URI
tmod:@turbot/aws-rds#/policy/types/dbInstanceApprovedBudget
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 > RDS > DB Instance > Approved > Custom

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

URI
tmod:@turbot/aws-rds#/policy/types/dbInstanceApprovedCustom
Category
Parent
Targets
Schema
{
  "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 > RDS > DB Instance > Approved > Database Engines

A list of database engines that the AWS RDS db instance is approved to use.\n\nThe expected format is an array of database engines. You may use the * and ? wildcard characters (and more).\n\nThis policy will be evaluated by the Approved control. If an AWS RDS db instance is not matched by the approved list, it will be subject to the action specified in the AWS > RDS > DB Instance > Approved policy.\n\n&#92;nexample:&#92;n postgres&#92;n\n\nSee Approved for more information.\n

URI
tmod:@turbot/aws-rds#/policy/types/dbInstanceApprovedDatabaseEngines
Category
Parent
Targets
Schema
{
  "type": "array",
  "default": [
    "*"
  ],
  "items": {
    "type": "string",
    "pattern": "^[a-z0-9.?*-]+$"
  }
}

AWS > RDS > DB Instance > Approved > Encryption at Rest

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

URI
tmod:@turbot/aws-rds#/policy/types/dbInstanceEncryptionAtRest
Category
Parent
Targets
Valid Value
[
  "None",
  "None or higher",
  "AWS managed key",
  "AWS managed key or higher",
  "Customer managed key",
  "Encryption at Rest > Customer Managed Key"
]
Schema
{
  "type": "string",
  "enum": [
    "None",
    "None 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 > RDS > DB Instance > 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 > RDS > DB Instance > 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&#92;nexample:&#92;n alias/aws/ebs&#92;n ddc06e04-ce5f-4995-c758-c2b6c510e8fd&#92;n arn:aws:kms:us-east-1:123456789012:key/ddc06e04-ce5f-4995-c758-c2b6c510e8fd&#92;n arn:aws:kms:us-east-1:123456789012:alias/aws/ebs&#92;n\n

URI
tmod:@turbot/aws-rds#/policy/types/dbInstanceEncryptionAtRestCustomerManagedKey
Category
Parent
Targets
Default Template Input
"{\n  defaultKey: policy(uri: \"aws-kms#/policy/types/keyDefaultCustomerManagedKey\")\n}\n"
Default Template
"{{ $.defaultKey }}"
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}$"
    }
  ],
  "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 > RDS > DB Instance > Approved > Instance Classes

A list of instance classes that the AWS RDS db instance is approved to use.\n\nThe expected format is an array of instance classes. You may use the * and ? wildcard characters (and more).\n\nThis policy will be evaluated by the Approved control. If an AWS RDS db instance is not matched by the approved list, it will be subject to the action specified in the AWS > RDS > DB Instance > Approved policy.\n\n&#92;nexample:&#92;n db.t2.large&#92;n\n\nSee Approved for more information.\n

URI
tmod:@turbot/aws-rds#/policy/types/dbInstanceApprovedInstanceClasses
Category
Parent
Targets
Schema
{
  "type": "array",
  "default": [
    "*"
  ],
  "items": {
    "type": "string",
    "pattern": "^[a-z0-9.?*]+$"
  }
}

AWS > RDS > DB Instance > Approved > Regions

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

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

AWS > RDS > DB Instance > Approved > Usage

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

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

AWS > RDS > DB Instance > Auto Minor Version Upgrade

Configure Auto Minor Version Upgrade settings on an AWS > RDS > DB Instance.\n

URI
tmod:@turbot/aws-rds#/policy/types/dbInstanceAutoMinorVersionUpgrade
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"
  ],
  "default": "Skip"
}

AWS > RDS > DB Instance > Backup Retention Period

Ensure the backup retention period is configured to meet policy. Automatic snapshots are deleted by AWS when the RDS instance is deleted.\n

URI
tmod:@turbot/aws-rds#/policy/types/dbInstanceBackupRetentionPeriod
Category
Parent
Targets
Valid Value
[
  "Skip",
  "Check: Backup retention period",
  "Enforce: Backup retention period"
]
Schema
{
  "type": "string",
  "enum": [
    "Skip",
    "Check: Backup retention period",
    "Enforce: Backup retention period"
  ],
  "default": "Skip"
}

AWS > RDS > DB Instance > Backup Retention Period > Days

The number of days for which the automated snapshots are retained. Automated snapshots are deleted by AWS at the end of a retention period.\n

URI
tmod:@turbot/aws-rds#/policy/types/dbInstanceBackupRetentionPeriodDays
Category
Parent
Targets
Schema
{
  "type": "integer",
  "minimum": 0,
  "maximum": 35,
  "default": 7
}

AWS > RDS > DB Instance > CMDB

Configure whether to record and synchronize details for the AWS RDS db instance 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 > RDS > DB Instance > 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

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

AWS > RDS > DB Instance > 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

URI
tmod:@turbot/aws-rds#/policy/types/dbInstanceConfigured
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 > RDS > DB Instance > 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

URI
tmod:@turbot/aws-rds#/policy/types/dbInstanceConfiguredPrecedence
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 > RDS > DB Instance > Configured > Source

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

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

AWS > RDS > DB Instance > Copy Tags to Snapshot

Configure Copy Tags to Snapshot settings on an AWS > RDS > DB Instance.\n

URI
tmod:@turbot/aws-rds#/policy/types/dbInstanceCopyTagsToSnapshot
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"
  ],
  "default": "Skip"
}

AWS > RDS > DB Instance > Deletion Protection

Configure Deletion Protection settings on an AWS > RDS > DB Instance.\n

URI
tmod:@turbot/aws-rds#/policy/types/dbInstanceDeletionProtection
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"
  ],
  "default": "Skip"
}

AWS > RDS > DB Instance > Logs Export Configuration

Configure logs export to CloudWatch for an AWS > RDS > DB Instance as per the AWS > RDS > DB Instance > Logs Export Configuration > * policies.\n

URI
tmod:@turbot/aws-rds#/policy/types/dbInstanceLogsExportConfiguration
Category
Parent
Targets
Valid Value
[
  "Skip",
  "Check: Disabled",
  "Check: Enabled per Logs Export Configuration > Log Types",
  "Enforce: Disabled",
  "Enforce : Enabled per Logs Export Configuration > Log Types"
]
Schema
{
  "type": "string",
  "enum": [
    "Skip",
    "Check: Disabled",
    "Check: Enabled per Logs Export Configuration > Log Types",
    "Enforce: Disabled",
    "Enforce : Enabled per Logs Export Configuration > Log Types"
  ],
  "example": [
    "Check: Enabled Logs Export Configuration > Log Types"
  ],
  "default": "Skip"
}

AWS > RDS > DB Instance > Logs Export Configuration > Log Types

List of log types to be enabled for an AWS > RDS > DB Instance.\n\nSupported log types for various DB engines:\n\n&#92;n&#92;nMySQL:&#92;n * Audit Log&#92;n * Error Log&#92;n * General Log&#92;n * Slow Query Log&#92;n&#92;nMariaDB:&#92;n * Audit Log&#92;n * Error Log&#92;n * General Log&#92;n * Slow Query Log&#92;n&#92;nPostgreSQL:&#92;n * PostgreSQL Log&#92;n * Upgrade Log&#92;n&#92;nOracle:&#92;n * Alert Log&#92;n * Audit Log&#92;n * Listener Log&#92;n * Oracle Management Agent Log&#92;n * Trace Log&#92;n&#92;nMicrosoft SQL Server:&#92;n * Error Log&#92;n&#92;n\n\nNote: Unsupported log types selected for a DB engine will be filtered out automatically and only the supported log types will be enabled.\n

URI
tmod:@turbot/aws-rds#/policy/types/dbInstanceLogsExportConfigurationLogTypes
Category
Parent
Targets
Schema
{
  "type": "array",
  "items": {
    "type": "string",
    "enum": [
      "Agent log",
      "Alert log",
      "Audit log",
      "Error log",
      "General log",
      "Listener log",
      "Oracle management agent log",
      "PostgreSQL log",
      "Slow query log",
      "Trace log",
      "Upgrade log"
    ]
  },
  "example": [
    "Alert log",
    "Error log",
    "General log"
  ],
  "default": []
}

AWS > RDS > DB Instance > Multi-AZ

Configure Multi-AZ deployment settings on an AWS > RDS > DB Instance.\n

URI
tmod:@turbot/aws-rds#/policy/types/dbInstanceMultiAz
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"
  ],
  "default": "Skip"
}

AWS > RDS > DB Instance > Parameter Group

Determine whether to check or enforce a specific Parameter Group for this DB Instance.\n\nUse the Parameter Group > Name sub-policy to set which Parameter Group to configure for this instance.\n

URI
tmod:@turbot/aws-rds#/policy/types/dbInstanceParameterGroup
Category
Parent
Targets
Valid Value
[
  "Skip",
  "Check: Set to Parameter Group > Name",
  "Enforce: Set to Parameter Group > Name",
  "Enforce: Set to Parameter Group > Name (Create if missing)"
]
Schema
{
  "type": "string",
  "enum": [
    "Skip",
    "Check: Set to Parameter Group > Name",
    "Enforce: Set to Parameter Group > Name",
    "Enforce: Set to Parameter Group > Name (Create if missing)"
  ],
  "example": [
    "Check: Set to Parameter Group > Name"
  ],
  "default": "Skip"
}

AWS > RDS > DB Instance > Parameter Group > Name

The name of a DB Parameter Group for this DB Instance.\n\nIf the parent Parameter Group policy is set to Enforce: Set to Parameter Group > Name (Create if missing) a new parameter group with this name will be created if it does not already exist.\n

URI
tmod:@turbot/aws-rds#/policy/types/dbInstanceParameterGroupName
Category
Parent
Targets
Default Template Input
"{\n  item: dbInstance { DBInstanceIdentifier }\n}\n"
Default Template
"turbot-{{ $.item.DBInstanceIdentifier }}"
Schema
{
  "type": "string",
  "pattern": "^([a-z])[a-z0-9-.]{0,62}$"
}

AWS > RDS > DB Instance > Performance Insights

Configure performance insights settings for an AWS > RDS > DB Instance as per the AWS > RDS > DB Instance > Performance Insights > * policies.\n

URI
tmod:@turbot/aws-rds#/policy/types/dbInstancePerformanceInsights
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"
  ],
  "default": "Skip"
}

AWS > RDS > DB Instance > Performance Insights > KMS Key

The AWS KMS key to enable performance insights. This key cannot be changed after enabling performance insights.\n\nPlease make sure the key defined in the template has required permissions.\n\n&#92;nexample:&#92;n alias/aws/rds&#92;n ddc06e04-ce5f-4995-c758-c2b6c510e8fd&#92;n arn:aws:kms:us-east-1:123456789012:key/ddc06e04-ce5f-4995-c758-c2b6c510e8fd&#92;n arn:aws:kms:us-east-1:123456789012:alias/aws/rds&#92;n\n

URI
tmod:@turbot/aws-rds#/policy/types/dbInstancePerformanceInsightsKmsKey
Category
Parent
Targets
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}$"
    }
  ],
  "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 > RDS > DB Instance > Performance Insights > Retention Period

The number of days for which the performance insights are retained. Performance insights are deleted by AWS at the end of a retention period.\n

URI
tmod:@turbot/aws-rds#/policy/types/dbInstancePerformanceInsightsRetentionPeriod
Category
Parent
Targets
Valid Value
[
  7,
  731
]
Schema
{
  "type": "integer",
  "enum": [
    7,
    731
  ],
  "default": 7
}

AWS > RDS > DB Instance > Publicly Accessible

Ensure the RDS instance is not publicly accessible.

URI
tmod:@turbot/aws-rds#/policy/types/dbInstancePubliclyAccessible
Category
Parent
Targets
Valid Value
[
  "Skip",
  "Check: DB Instance is not publicly accessible",
  "Enforce: DB Instance is not publicly accessible"
]
Schema
{
  "type": "string",
  "enum": [
    "Skip",
    "Check: DB Instance is not publicly accessible",
    "Enforce: DB Instance is not publicly accessible"
  ],
  "example": [
    "Skip"
  ],
  "default": "Skip"
}

AWS > RDS > DB Instance > Regions

A list of AWS regions in which AWS RDS db instances are supported for use.\n\nAny db instances 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

URI
tmod:@turbot/aws-rds#/policy/types/dbInstanceRegions
Category
Parent
Targets
Default Template Input
"{\n  regions: policyValue(uri:\"tmod:@turbot/aws-rds#/policy/types/rdsRegionsDefault\") {\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 > RDS > DB Instance > Schedule

Set a schedule for starting and stopping an AWS RDS db instance.\n\nNote If both "Schedule" and "Schedule Tag" are set to enforce and the\nthe tag will be in effect.\n

URI
tmod:@turbot/aws-rds#/policy/types/instanceSchedule
Category
Parent
Targets
Valid Value
[
  "Skip",
  "Enforce: Business hours (8:00am - 6:00pm on weekdays)",
  "Enforce: Extended business hours (7:00am - 11:00pm on weekdays)",
  "Enforce: Stop for night (stop at 10:00pm every day)",
  "Enforce: Stop for weekend (stop at 10:00pm on Friday)"
]
Schema
{
  "type": "string",
  "enum": [
    "Skip",
    "Enforce: Business hours (8:00am - 6:00pm on weekdays)",
    "Enforce: Extended business hours (7:00am - 11:00pm on weekdays)",
    "Enforce: Stop for night (stop at 10:00pm every day)",
    "Enforce: Stop for weekend (stop at 10:00pm on Friday)"
  ],
  "example": [
    "Enforce: Business hours (8:00am - 6:00pm on weekdays)"
  ],
  "default": "Skip"
}

AWS > RDS > DB Instance > Schedule Tag

Allow setting a schedule for starting and stopping an RDS db instance via the\nturbot_custom_schedule tag. If the schedule is invalid, no actions will be\ntaken against the dbInstance.\n\nNote If both "Schedule" and "Schedule Tag" are set to enforce and the\ndb instance has a turbot_custom_schedule, then the schedule specified by the\ntag will be in effect.\n

URI
tmod:@turbot/aws-rds#/policy/types/instanceScheduleTag
Category
Parent
Targets
Valid Value
[
  "Skip",
  "Enforce: Schedule per turbot_custom_schedule tag"
]
Schema
{
  "type": "string",
  "enum": [
    "Skip",
    "Enforce: Schedule per turbot_custom_schedule tag"
  ],
  "example": [
    "Enforce: Schedule per turbot_custom_schedule tag"
  ],
  "default": "Skip"
}

AWS > RDS > DB Instance > Tags

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

URI
tmod:@turbot/aws-rds#/policy/types/dbInstanceTags
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 > RDS > DB Instance > Tags > Template

The template is used to generate the keys and values for AWS RDS db instance.\n\nTags not defined in DB Instance 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

URI
tmod:@turbot/aws-rds#/policy/types/dbInstanceTagsTemplate
Category
Parent
Targets
Default Template Input
[
  "{\n  account {\n    turbot {\n      id\n    }\n  }\n}\n",
  "{\n  defaultTags: policyValue(uri:\"tmod:@turbot/aws-rds#/policy/types/rdsTagsTemplate\" 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 > RDS > DB Instance > Usage

Configure the number of AWS RDS db instances 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 > RDS > DB Instance > Usage policy.\n

URI
tmod:@turbot/aws-rds#/policy/types/dbInstanceUsage
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 > RDS > DB Instance > Usage > Limit

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

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

AWS > RDS > DB Parameter Group > Active

Determine the action to take when an AWS RDS db parameter group, based on the AWS > RDS > DB Parameter Group > 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 > RDS > DB Parameter Group > 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

URI
tmod:@turbot/aws-rds#/policy/types/dbParameterGroupActive
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 > RDS > DB Parameter Group > Active > Age

The age after which the AWS RDS db parameter group\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 > RDS > DB Parameter Group > 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

URI
tmod:@turbot/aws-rds#/policy/types/dbParameterGroupActiveAge
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 > RDS > DB Parameter Group > Active > Last Modified

The number of days since the AWS RDS db parameter group\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 > RDS > DB Parameter Group > 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

URI
tmod:@turbot/aws-rds#/policy/types/dbParameterGroupActiveLastModified
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 > RDS > DB Parameter Group > Approved

Determine the action to take when an AWS RDS db parameter group is not approved based on AWS > RDS > DB Parameter Group > 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

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

AWS > RDS > DB Parameter Group > Approved > Custom

Determine whether the AWS RDS db parameter group is allowed to exist.\nThis policy will be evaluated by the Approved control. If an AWS RDS db parameter group is not approved, it will be subject to the action specified in the AWS > RDS > DB Parameter Group > 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 contai