Product logo
DocsBlogPricing

Policy types for @turbot/aws-xray

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

AWS X-Ray CloudWatch Events event sources for the Guardrails Event Handlers.

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

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

A read-only policy generated by Guardrails that lists the APIs that
should be added to the guardrails-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 > X-Ray > Permissions > Lockdown > API Boundary policy

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

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

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

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

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

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

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

AWS > X-Ray > API Enabled

Configure whether the AWS X-Ray API is enabled.

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

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

AWS > X-Ray > Approved Regions [Default]

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

URI
tmod:@turbot/aws-xray#/policy/types/xrayApprovedRegionsDefault
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 > X-Ray > Enabled

Configure whether the AWS X-Ray service is enabled.
This will only affect Guardrails managed User Roles and will allow the Guardrails managed user to access AWS X-Ray service.
- Enabled policy allows Guardrails managed users to perform all the actions for the service
- Enabled: Metadata Only policy allows Guardrails 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 Guardrails or SuperUsers
- All the resource data stored in the Guardrails CMDB is considered to be metadata
- For more information related to permissions and grant levels, please check the documentation

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

AWS > X-Ray > Encryption Config > CMDB

Configure whether to record and synchronize details for the AWS X-Ray encryption config into the CMDB.

The CMDB control is responsible for populating and updating all the attributes for that resource type in the Guardrails CMDB.
All policies and controls in Guardrails are based around the resource, so usually the CMDB policy is set to "Enforce: Enabled".

If set to Skip then all changes to the CMDB are paused - no new resources will be discovered, no updates will be made and deleted resources will not be removed.

To cleanup resources and stop tracking changes, set this policy to "Enforce: Disabled".

CMDB controls also use the Regions policy associated with the resource. If region is not in AWS > X-Ray > Encryption Config > Regions policy, the CMDB control will delete the resource from the CMDB.

(Note: Setting CMDB to "Skip" will also pause these changes.)

URI
tmod:@turbot/aws-xray#/policy/types/encryptionConfigCmdb
Category
Parent
Targets
Valid Value
[
  "Skip",
  "Enforce: Enabled",
  "Enforce: Disabled"
]
Schema
{
  "type": "string",
  "enum": [
    "Skip",
    "Enforce: Enabled",
    "Enforce: Disabled"
  ],
  "example": [
    "Skip"
  ],
  "default": "Enforce: Enabled"
}

AWS > X-Ray > Encryption Config > Regions

A list of AWS regions in which AWS X-Ray encryption configs are supported for use.

Any encryption configs in a region not listed here will not be recorded in CMDB.

The expected format is an array of regions names. You may use the '*' and
'?' wildcard characters.

URI
tmod:@turbot/aws-xray#/policy/types/encryptionConfigRegions
Category
Parent
Targets
Default Template Input
"{\n  regions: policyValue(uri:\"tmod:@turbot/aws-xray#/policy/types/xrayRegionsDefault\") {\n    value\n  }\n}\n"
Default Template
"{% if $.regions.value | length == 0 %} [] {% endif %}{% for item in $.regions.value %}- '{{ item }}'\n{% endfor %}"
Schema

AWS > X-Ray > Permissions

Configure whether permissions policies are in effect for AWS X-Ray.

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

AWS > X-Ray > 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 Guardrails 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-xray#/policy/types/xrayPermissionsLevels
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 }} policyType:'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 > X-Ray > Permissions > Levels > Modifiers

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

<br />example:<br /> - &quot;glacier:createvault&quot;: admin<br /> - &quot;glacier:ListVaults&quot;: metadata<br /> - &quot;s3:DeleteBucket&quot;: none<br />

URI
tmod:@turbot/aws-xray#/policy/types/xrayPermissionsLevelsModifiers
Category
Parent
Targets
Schema

AWS > X-Ray > Permissions > Lockdown

URI
tmod:@turbot/aws-xray#/policy/types/xrayPermissionsLockdown
Category
Parent
Targets

AWS > X-Ray > Permissions > Lockdown > API Boundary

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

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

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

AWS > X-Ray > Regions

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

URI
tmod:@turbot/aws-xray#/policy/types/xrayRegionsDefault
Category
Parent
Targets
Schema
{
  "allOf": [
    {
      "$ref": "aws#/definitions/regionNameMatcherList"
    },
    {
      "default": [
        "af-south-1",
        "ap-east-1",
        "ap-northeast-1",
        "ap-northeast-2",
        "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-east-1",
        "us-gov-west-1",
        "us-west-1",
        "us-west-2"
      ]
    }
  ]
}

AWS > X-Ray > Tags Template [Default]

A template used to generate the keys and values for AWS X-Ray resources.

By default, all X-Ray resource Tags > Template policies will use this value.

URI
tmod:@turbot/aws-xray#/policy/types/xrayTagsTemplate
Category
Parent
Targets
Default Template Input
"{\n  defaultTags: policyValue(uri:\"tmod:@turbot/aws#/policy/types/defaultTagsTemplate\") {\n    value\n  }\n}\n"
Default Template
"{%- if $.defaultTags.value | length == 0 %} [] {%- elif $.defaultTags.value != undefined %}{{ $.defaultTags.value | dump | safe }}{%- else %}{% for item in $.defaultTags.value %}- {{ item }}{% endfor %}{% endif %}"
Schema