Product logo
DocsBlogPricing

Policy types for @turbot/aws-fms

AWS > FMS > API Enabled

Configure whether the AWS FMS API is enabled.

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

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

AWS > FMS > Enabled

Configure whether the AWS FMS service is enabled. This will only affect Turbot managed User Roles and will allow the Turbot managed user to access AWS FMS service.

  • Enabled policy allows Turbot managed users to perform all the actions for the service
  • Enabled: Metadata Only policy allows Turbot 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 Turbot or SuperUsers
  • All the resource data stored in the Turbot CMDB is considered to be metadata
  • For more information related to permissions and grant levels, please check the documentation
URI
tmod:@turbot/aws-fms#/policy/types/fmsEnabled
Category
Parent
Targets
Valid Value
[
  "Enabled",
  "Enabled: Metadata Only",
  "Disabled"
]
Schema
{
  "type": "string",
  "enum": [
    "Enabled",
    "Enabled: Metadata Only",
    "Disabled"
  ],
  "example": [
    "Enabled"
  ],
  "default": "Disabled"
}

AWS > FMS > Permissions

Configure whether permissions policies are in effect for AWS FMS.

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-fms#/policy/types/fmsPermissions
Category
Parent
Targets
Valid Value
[
  "Enabled",
  "Disabled",
  "Enabled if AWS > FMS > Enabled & AWS > FMS > API Enabled"
]
Schema
{
  "type": "string",
  "enum": [
    "Enabled",
    "Disabled",
    "Enabled if AWS > FMS > Enabled & AWS > FMS > API Enabled"
  ],
  "example": [
    "Enabled"
  ],
  "default": "Enabled if AWS > FMS > Enabled & AWS > FMS > API Enabled"
}

AWS > FMS > 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 Turbot 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-fms#/policy/types/fmsPermissionsLevels
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 > FMS > Permissions > Levels > Modifiers

A map of AWS API to Turbot Permission Level used to customize Turbot's standard permissions. You can add, remove or redefine the mapping of AWS API operations to Turbot 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

example:
  - "glacier:createvault": admin
  - "glacier:ListVaults": metadata
  - "s3:DeleteBucket": none
URI
tmod:@turbot/aws-fms#/policy/types/fmsPermissionsLevelsModifiers
Category
Parent
Targets
Schema

AWS > FMS > Permissions > Lockdown

URI
tmod:@turbot/aws-fms#/policy/types/fmsPermissionsLockdown
Category
Parent
Targets

AWS > FMS > Permissions > Lockdown > API Boundary

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

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

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

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

A read-only policy generated by Turbot that lists the APIs that should be added to the turbot-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 > FMS > Permissions > Lockdown > API Boundary policy

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

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

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

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

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

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

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