Product logo
DocsBlogPricing

Policy types for @turbot/aws-billing

AWS > Billing > API Enabled

Configure whether the AWS Billing API is enabled.\n\nNote: Disabling the service disables the API for ALL users and roles, and Guardrails will have no access to the API.\n\nSetting the AWS > Billing > Enabled policy to Enabled is necessary but insufficient to enabled Billing access for non-root users. More information and setup instructions can can be found in the AWS Billing docs.\n

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

AWS > Billing > Enabled

Configure whether the AWS Billing service is enabled.\nThis will only affect Guardrails managed User Roles and will allow the Guardrails managed user to access AWS Billing service.\n - Enabled policy allows Guardrails managed users to perform all the actions for the service\n - Enabled: Metadata Only policy allows Guardrails managed users to perform only the metadata level actions for the service (like describe*, list*)\n\nNote:\n - Disabled policy disables the service but does NOT disable the API for Guardrails or SuperUsers\n - All the resource data stored in the Guardrails CMDB is considered to be metadata\n - For more information related to permissions and grant levels, please check the documentation\n

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

AWS > Billing > Permissions

Configure whether permissions policies are in effect for AWS Billing.\n\nThis setting does not affect account level permissions (AWS/Admin, AWS/Owner, etc)\n\nNote: The behavior of this policy depends on the value of AWS > Permissions.\n

URI
tmod:@turbot/aws-billing#/policy/types/billingPermissions
Category
Parent
Targets
Valid Value
[
  "Enabled",
  "Disabled",
  "Enabled if AWS > Billing > Enabled & AWS > Billing > API Enabled"
]
Schema
{
  "type": "string",
  "enum": [
    "Enabled",
    "Disabled",
    "Enabled if AWS > Billing > Enabled & AWS > Billing > API Enabled"
  ],
  "example": [
    "Enabled"
  ],
  "default": "Enabled if AWS > Billing > Enabled & AWS > Billing > API Enabled"
}

AWS > Billing > Permissions > Levels

Define the permissions levels that can be used to grant access to an AWS account.\nPermissions levels defined will appear in the UI to assign access to Guardrails users.\nThis policy provides a default for Permissions > Levels in each service,\nhowever you can explicitly override the setting for each service if desired\n

URI
tmod:@turbot/aws-billing#/policy/types/billingPermissionsLevels
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 > Billing > Permissions > Levels > Modifiers

A map of AWS API to Guardrails Permission Level used to customize Guardrails' standard permissions.\nYou can add, remove or redefine the mapping of AWS API operations to Guardrails permissions levels here.\n\nNote: Modifiers are cumulative - if you add a permission to the Metadata level, it is also added to ReadOnly, Operator and Admin.\nModifier policies set here apply ONLY to the AWS level\n\n\nexample:\n - "glacier:createvault": admin\n - "glacier:ListVaults": metadata\n - "s3:DeleteBucket": none\n\n

URI
tmod:@turbot/aws-billing#/policy/types/billingPermissionsLevelsModifiers
Category
Parent
Targets
Schema

AWS > Billing > Permissions > Lockdown

URI
tmod:@turbot/aws-billing#/policy/types/billingPermissionsLockdown
Category
Parent
Targets

AWS > Billing > Permissions > Lockdown > API Boundary

Configure whether the AWS billing API is enabled for all users and roles in guardrails-managed boundary policies.\n\nNote: Disabling the service disables the API for ALL users and roles, and Guardrails will have no access to the API.\n

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

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

A read-only policy generated by Guardrails that lists the APIs that\nshould be added to the guardrails-managed (hard) boundary policy,\nthereby enabling them to be assigned to users and roles.\nThis value will change depending on the value of the value of the\nAWS > Billing > Permissions > Lockdown > API Boundary policy\n

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

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

A calculated policy that Guardrails uses to create a compiled list of ALL permissions for AWS Billing\nthat is used as input to the stack that manages the Guardrails IAM permissions objects.\n

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

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

A calculated policy that Guardrails uses to create a compiled list of ALL permissions for AWS Billing\nthat is used as input to the control that manages the IAM stack.\n

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