Policy types for @turbot/aws-comprehend

• AWS > Comprehend > API Enabled
• AWS > Comprehend > Approved Regions [Default]
• AWS > Comprehend > Enabled
• AWS > Comprehend > Permissions
• AWS > Comprehend > Permissions > Levels
• AWS > Comprehend > Permissions > Levels > Modifiers
• AWS > Comprehend > Permissions > Lockdown
• AWS > Comprehend > Permissions > Lockdown > API Boundary
• AWS > Comprehend > Regions
• AWS > Comprehend > Regions
• AWS > Comprehend > Tags Template [Default]
• AWS > Turbot > Permissions > Compiled > API Boundary > @turbot/aws-comprehend
• AWS > Turbot > Permissions > Compiled > Levels > @turbot/aws-comprehend
• AWS > Turbot > Permissions > Compiled > Service Permissions > @turbot/aws-comprehend

AWS > Comprehend > API Enabled

Configure whether the AWS Comprehend API is enabled.

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

[
  "Enabled",
  "Disabled",
  "Enabled if AWS > Comprehend > Enabled"
]

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

AWS > Comprehend > Approved Regions [Default]

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

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

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

AWS > Comprehend > Enabled

Configure whether the AWS Comprehend service is enabled. This will only affect Turbot managed User Roles and will allow the Turbot managed user to access AWS Comprehend 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

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

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

AWS > Comprehend > Permissions

Configure whether permissions policies are in effect for AWS Comprehend.

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.

[
  "Enabled",
  "Disabled",
  "Enabled if AWS > Comprehend > Enabled & AWS > Comprehend > API Enabled"
]

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

AWS > Comprehend > 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

[
  "{\n  item: account {\n    turbot{\n      id\n    }\n  }\n}\n",
  "{\n  availableLevels: policyValues(filter:\"policyTypeLevel:self resourceId:{{ $.item.turbot.id }} policyTypeId:'tmod:@turbot/aws-iam#/policy/types/permissionsLevelsDefault'\") {\n    items {\n      value\n    }\n  }\n}\n"
]

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

{
  "type": "array",
  "items": {
    "type": "string",
    "enum": [
      "Metadata",
      "ReadOnly",
      "Operator",
      "Admin",
      "Owner"
    ]
  }
}

AWS > Comprehend > 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

AWS > Comprehend > Permissions > Lockdown

AWS > Comprehend > Permissions > Lockdown > API Boundary

Configure whether the AWS comprehend 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.

[
  "Enabled if AWS > Comprehend > API Enabled"
]

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

AWS > Comprehend > Regions

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

{
  "allOf": [
    {
      "$ref": "aws#/definitions/regionNameMatcherList"
    },
    {
      "default": [
        "ap-northeast-1",
        "ap-northeast-2",
        "ap-south-1",
        "ap-southeast-1",
        "ap-southeast-2",
        "ca-central-1",
        "eu-central-1",
        "eu-west-1",
        "eu-west-2",
        "us-east-1",
        "us-east-2",
        "us-gov-west-1",
        "us-west-2"
      ]
    }
  ]
}

AWS > Comprehend > Regions

Regions where AWS supports Comprehend. Turbot updates this option as AWS expands their regional support. Unless there is an explicit requirement (e.g. accelerated regional support), it should not be set.

AWS > Comprehend > Tags Template [Default]

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

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

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

"{%- if $.defaultTags.value | length == 0 %} [] {%- elif $.defaultTags.value != undefined %}{{ $.defaultTags.value | dump | safe }}{%- else %}{% for item in $.defaultTags.value %}- {{ item }}{% endfor %}{% endif %}"

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

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 > Comprehend > Permissions > Lockdown > API Boundary policy

{
  "type": "array"
}

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

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

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

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