Policy types for @turbot/aws-iotevents

AWS > IoT Events > API Enabled

Configure whether the AWS IoT Events 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-iotevents#/policy/types/iotEventsApiEnabled
Valid Value
[
"Enabled",
"Disabled",
"Enabled if AWS > IoT Events > Enabled"
]
Schema
{
"type": "string",
"enum": [
"Enabled",
"Disabled",
"Enabled if AWS > IoT Events > Enabled"
],
"default": "Enabled"
}

AWS > IoT Events > Approved Regions [Default]

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

URI
tmod:@turbot/aws-iotevents#/policy/types/iotEventsApprovedRegionsDefault

AWS > IoT Events > Enabled

Enabled IoT Events.

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

AWS > IoT Events > Permissions

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

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-iotevents#/policy/types/iotEventsPermissions
Valid Value
[
"Enabled",
"Disabled",
"Enabled if AWS > IoT Events > Enabled & AWS > IoT Events > API Enabled"
]
Schema
{
"type": "string",
"enum": [
"Enabled",
"Disabled",
"Enabled if AWS > IoT Events > Enabled & AWS > IoT Events > API Enabled"
],
"example": [
"Enabled"
],
"default": "Enabled if AWS > IoT Events > Enabled & AWS > IoT Events > API Enabled"
}

AWS > IoT Events > 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-iotevents#/policy/types/iotEventsPermissionsLevels
Schema
{
"type": "array",
"items": {
"type": "string",
"enum": [
"Metadata",
"ReadOnly",
"Operator",
"Admin",
"Owner"
]
}
}

AWS > IoT Events > 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-iotevents#/policy/types/iotEventsPermissionsLevelsModifiers

AWS > IoT Events > Permissions > Lockdown

URI
tmod:@turbot/aws-iotevents#/policy/types/iotEventsPermissionsLockdown
Targets

AWS > IoT Events > Permissions > Lockdown > API Boundary

Configure whether the AWS iotEvents 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-iotevents#/policy/types/iotEventsPermissionsLockdownApiBoundary
Valid Value
[
"Enabled if AWS > IoT Events > API Enabled"
]
Schema
{
"type": "string",
"enum": [
"Enabled if AWS > IoT Events > API Enabled"
],
"example": [
"Enabled if AWS > IoT Events > API Enabled"
],
"default": "Enabled if AWS > IoT Events > API Enabled"
}

AWS > IoT Events > Regions

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

URI
tmod:@turbot/aws-iotevents#/policy/types/iotEventsRegionsDefault
Schema
{
"allOf": [
{
"$ref": "aws#/definitions/regionNameMatcherList"
},
{
"default": [
"ap-northeast-1",
"ap-northeast-2",
"ap-southeast-1",
"ap-southeast-2",
"eu-central-1",
"eu-west-1",
"eu-west-2",
"us-east-1",
"us-east-2",
"us-west-2"
]
}
]
}

AWS > IoT Events > Tags Template [Default]

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

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

URI
tmod:@turbot/aws-iotevents#/policy/types/iotEventsTagsTemplate

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

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

URI
tmod:@turbot/aws-iotevents#/policy/types/awsCompiledApiBoundary
Schema
{
"type": "array"
}

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

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

URI
tmod:@turbot/aws-iotevents#/policy/types/awsLevelsCompiled

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

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

URI
tmod:@turbot/aws-iotevents#/policy/types/awsCompiledServicePermissions