Product logo
DocsBlogPricing

Policy types for @turbot/aws-lakeformation

AWS > Lake Formation > API Enabled

Configure whether the AWS Lake Formation 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-lakeformation#/policy/types/lakeFormationApiEnabled
Category
Parent
Targets
Valid Value
[
  "Enabled",
  "Disabled",
  "Enabled if AWS > Lake Formation > Enabled"
]
Schema
{
  "type": "string",
  "enum": [
    "Enabled",
    "Disabled",
    "Enabled if AWS > Lake Formation > Enabled"
  ],
  "default": "Enabled"
}

AWS > Lake Formation > Approved Regions [Default]

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

URI
tmod:@turbot/aws-lakeformation#/policy/types/lakeFormationApprovedRegionsDefault
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 > Lake Formation > Enabled

Configure whether the AWS Lake Formation service is enabled. This will only affect Turbot managed User Roles and will allow the Turbot managed user to access AWS Lake Formation 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-lakeformation#/policy/types/lakeFormationEnabled
Category
Parent
Targets
Valid Value
[
  "Enabled",
  "Enabled: Metadata Only",
  "Disabled"
]
Schema
{
  "type": "string",
  "enum": [
    "Enabled",
    "Enabled: Metadata Only",
    "Disabled"
  ],
  "example": [
    "Enabled"
  ],
  "default": "Disabled"
}

AWS > Lake Formation > Permissions

Configure whether permissions policies are in effect for AWS Lake Formation.

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

AWS > Lake Formation > 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-lakeformation#/policy/types/lakeFormationPermissionsLevels
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 > Lake Formation > 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-lakeformation#/policy/types/lakeFormationPermissionsLevelsModifiers
Category
Parent
Targets
Schema

AWS > Lake Formation > Permissions > Lockdown

URI
tmod:@turbot/aws-lakeformation#/policy/types/lakeFormationPermissionsLockdown
Category
Parent
Targets

AWS > Lake Formation > Permissions > Lockdown > API Boundary

Configure whether the AWS lakeFormation 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-lakeformation#/policy/types/lakeFormationPermissionsLockdownApiBoundary
Category
Parent
Targets
Valid Value
[
  "Enabled if AWS > Lake Formation > API Enabled"
]
Schema
{
  "type": "string",
  "enum": [
    "Enabled if AWS > Lake Formation > API Enabled"
  ],
  "example": [
    "Enabled if AWS > Lake Formation > API Enabled"
  ],
  "default": "Enabled if AWS > Lake Formation > API Enabled"
}

AWS > Lake Formation > Regions

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

URI
tmod:@turbot/aws-lakeformation#/policy/types/lakeFormationRegionsDefault
Category
Parent
Targets
Schema
{
  "allOf": [
    {
      "$ref": "aws#/definitions/regionNameMatcherList"
    },
    {
      "default": [
        "af-south-1",
        "ap-east-1",
        "ap-northeast-1",
        "ap-northeast-2",
        "ap-northeast-3",
        "ap-south-1",
        "ap-southeast-1",
        "ap-southeast-2",
        "ca-central-1",
        "cn-north-1",
        "cn-northwest-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-west-1",
        "us-west-1",
        "us-west-2"
      ]
    }
  ]
}

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

AWS Lake Formation CloudWatch Events event sources for the Turbot Event Handlers.

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

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

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

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

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

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

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

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

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

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