Product logo
DocsBlogPricing

Policy types for @turbot/aws-securityhub

AWS > Security Hub > API Enabled

Configure whether the AWS Security Hub API is enabled.

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

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

AWS > Security Hub > Approved Regions [Default]

A list of AWS regions in which AWS Security Hub resources are approved for use.

The expected format is an array of regions names. You may use the '*' and
'?' wildcard characters.

This policy is the default value for all AWS Security Hub resources' Approved > Regions policies.

URI
tmod:@turbot/aws-securityhub#/policy/types/securityHubApprovedRegionsDefault
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 > Security Hub > Enabled

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

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

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

AWS > Security Hub > Hub > Approved

Determine the action to take when an AWS Security Hub hub is not approved based on AWS > Security Hub > Hub > Approved > * policies.

The Approved control checks the status of the defined Approved sub-policies for the resource. If the resource is not approved according to any of these policies, this control raises an alarm and takes the defined enforcement action.

For any enforcement actions that specify if new, e.g., Enforce: Delete unapproved if new, this control will only take the enforcement actions for resources created within the last 60 minutes.

See Approved for more information.

URI
tmod:@turbot/aws-securityhub#/policy/types/hubApproved
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 > Security Hub > Hub > Approved > Budget

The policy allows you to set hubs to unapproved based on the current budget state, as reflected in AWS > Account > Budget > State

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

See Approved for more information.

URI
tmod:@turbot/aws-securityhub#/policy/types/hubApprovedBudget
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 > Security Hub > Hub > Approved > Custom

Determine whether the AWS Security Hub hub is allowed to exist.
This policy will be evaluated by the Approved control. If an AWS Security Hub hub is not approved, it will be subject to the action specified in the AWS > Security Hub > Hub > Approved policy.
See Approved for more information.

Note: The policy value must be a string with a value of Approved, Not approved or Skip, or in the form of YAML objects. The object(s) must contain the key result with its value as Approved or Not approved. A custom title and message can also be added using the keys title and message respectively.

URI
tmod:@turbot/aws-securityhub#/policy/types/hubApprovedCustom
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 > Security Hub > Hub > Approved > Regions

A list of AWS regions in which AWS Security Hub hubs are approved for use.

The expected format is an array of regions names. You may use the '*' and '?' wildcard characters.

This policy will be evaluated by the Approved control. If an AWS Security Hub hub is created in a region that is not in the approved list, it will be subject to the action specified in the AWS > Security Hub > Hub > Approved policy.

See Approved for more information.

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

AWS > Security Hub > Hub > Approved > Usage

Determine whether the AWS Security Hub hub is allowed to exist.

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

See Approved for more information.

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

AWS > Security Hub > Hub > CMDB

Configure whether to record and synchronize details for the AWS Security Hub hub into the CMDB.

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

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

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

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

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

URI
tmod:@turbot/aws-securityhub#/policy/types/hubCmdb
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 > Security Hub > Hub > Regions

A list of AWS regions in which AWS Security Hub hubs are supported for use.

Any hubs in a region not listed here will not be recorded in CMDB.

The expected format is an array of regions names. You may use the '*' and
'?' wildcard characters.

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

AWS > Security Hub > Hub > Tags

Determine the action to take when an AWS Security Hub hub tags are not updated based on the AWS > Security Hub > Hub > Tags > * policies.

The control ensure AWS Security Hub hub tags include tags defined in AWS > Security Hub > Hub > Tags > Template.

Tags not defined in Hub Tags Template will not be modified or deleted. Setting a tag value to undefined will result in the tag being deleted.

See Tags for more information.

URI
tmod:@turbot/aws-securityhub#/policy/types/hubTags
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 > Security Hub > Hub > Tags > Template

The template is used to generate the keys and values for AWS Security Hub hub.

Tags not defined in Hub Tags Template will not be modified or deleted. Setting a tag value to undefined will result in the tag being deleted.

See Tags for more information.

URI
tmod:@turbot/aws-securityhub#/policy/types/hubTagsTemplate
Category
Parent
Targets
Default Template Input
[
  "{\n  account {\n    turbot {\n      id\n    }\n  }\n}\n",
  "{\n  defaultTags: policyValue(uri:\"tmod:@turbot/aws-securityhub#/policy/types/securityHubTagsTemplate\" 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 > Security Hub > Permissions

Configure whether permissions policies are in effect for AWS Security Hub.

This setting does not affect account level permissions (AWS/Admin, AWS/Owner, etc)

Note: The behavior of this policy depends on the value of AWS > Permissions.

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

AWS > Security Hub > Permissions > Levels

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

URI
tmod:@turbot/aws-securityhub#/policy/types/securityHubPermissionsLevels
Category
Parent
Targets
Default Template Input
[
  "{\n  item: account {\n    turbot{\n      id\n    }\n  }\n}\n",
  "{\n  availableLevels: policyValues(filter:\"policyTypeLevel:self resourceId:{{ $.item.turbot.id }} policyTypeId:'tmod:@turbot/aws-iam#/policy/types/permissionsLevelsDefault'\") {\n    items {\n      value\n    }\n  }\n}\n"
]
Default Template
"{% if $.availableLevels.items[0].value | length == 0 %} [] {% endif %}{% for item in $.availableLevels.items[0].value %}- {{ item }}\n{% endfor %}"
Schema
{
  "type": "array",
  "items": {
    "type": "string",
    "enum": [
      "Metadata",
      "ReadOnly",
      "Operator",
      "Admin",
      "Owner"
    ]
  }
}

AWS > Security Hub > Permissions > Levels > Modifiers

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

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

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

URI
tmod:@turbot/aws-securityhub#/policy/types/securityHubPermissionsLevelsModifiers
Category
Parent
Targets
Schema

AWS > Security Hub > Permissions > Lockdown

URI
tmod:@turbot/aws-securityhub#/policy/types/securityHubPermissionsLockdown
Category
Parent
Targets

AWS > Security Hub > Permissions > Lockdown > API Boundary

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

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

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

AWS > Security Hub > Regions

A list of AWS regions in which AWS Security Hub resources are supported for use.

The expected format is an array of regions names. You may use the '*' and
'?' wildcard characters.

This policy is the default value for all AWS Security Hub resources' Regions policies.

URI
tmod:@turbot/aws-securityhub#/policy/types/securityHubRegionsDefault
Category
Parent
Targets
Schema
{
  "allOf": [
    {
      "$ref": "aws#/definitions/regionNameMatcherList"
    },
    {
      "default": [
        "af-south-1",
        "ap-east-1",
        "ap-northeast-1",
        "ap-northeast-2",
        "ap-south-1",
        "ap-southeast-1",
        "ap-southeast-2",
        "ca-central-1",
        "eu-central-1",
        "eu-north-1",
        "eu-south-1",
        "eu-west-1",
        "eu-west-2",
        "eu-west-3",
        "me-south-1",
        "sa-east-1",
        "us-east-1",
        "us-east-2",
        "us-gov-east-1",
        "us-gov-west-1",
        "us-west-1",
        "us-west-2"
      ]
    }
  ]
}

AWS > Security Hub > Tags Template [Default]

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

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

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

AWS > Turbot > Event Handlers > Events > Rules > Event Sources > @turbot/aws-securityhub

AWS Security Hub CloudWatch Events event sources for the Guardrails Event Handlers.

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

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

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

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

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

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

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

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

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

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