Product logo
DocsBlogPricing

Policy types for @turbot/aws-iotsitewise

AWS > IoT SiteWise > API Enabled

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

AWS > IoT SiteWise > Approved Regions [Default]

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

URI
tmod:@turbot/aws-iotsitewise#/policy/types/iotSiteWiseApprovedRegionsDefault
Category
Parent
Targets
Schema

AWS > IoT SiteWise > Enabled

Enabled IoT SiteWise.

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

AWS > IoT SiteWise > Permissions

Configure whether permissions policies are in effect for AWS IoT SiteWise.

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

AWS > IoT SiteWise > 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-iotsitewise#/policy/types/iotSiteWisePermissionsLevels
Category
Parent
Targets
Schema
{
  "type": "array",
  "items": {
    "type": "string",
    "enum": [
      "Metadata",
      "ReadOnly",
      "Operator",
      "Admin",
      "Owner"
    ]
  }
}

AWS > IoT SiteWise > 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-iotsitewise#/policy/types/iotSiteWisePermissionsLevelsModifiers
Category
Parent
Targets
Schema

AWS > IoT SiteWise > Permissions > Lockdown

URI
tmod:@turbot/aws-iotsitewise#/policy/types/iotSiteWisePermissionsLockdown
Category
Parent
Targets

AWS > IoT SiteWise > Permissions > Lockdown > API Boundary

Configure whether the AWS iotSiteWise 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-iotsitewise#/policy/types/iotSiteWisePermissionsLockdownApiBoundary
Category
Parent
Targets
Valid Value
[
  "Enabled if AWS > IoT SiteWise > API Enabled"
]
Schema
{
  "type": "string",
  "enum": [
    "Enabled if AWS > IoT SiteWise > API Enabled"
  ],
  "example": [
    "Enabled if AWS > IoT SiteWise > API Enabled"
  ],
  "default": "Enabled if AWS > IoT SiteWise > API Enabled"
}

AWS > IoT SiteWise > Regions

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

URI
tmod:@turbot/aws-iotsitewise#/policy/types/iotSiteWiseRegionsDefault
Category
Parent
Targets
Schema
{
  "allOf": [
    {
      "$ref": "aws#/definitions/regionNameMatcherList"
    },
    {
      "default": [
        "eu-central-1",
        "eu-west-1",
        "us-east-1",
        "us-west-2"
      ]
    }
  ]
}

AWS > IoT SiteWise > Tags Template [Default]

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

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

URI
tmod:@turbot/aws-iotsitewise#/policy/types/iotSiteWiseTagsTemplate
Category
Parent
Targets
Schema

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

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

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

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

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

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

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

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

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