Product logo
DocsBlogPricing

Policy types for @turbot/aws-sqs

AWS > SQS > API Enabled

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

AWS > SQS > Approved Regions [Default]

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

URI
tmod:@turbot/aws-sqs#/policy/types/sqsApprovedRegionsDefault
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 > SQS > Enabled

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

AWS > SQS > Permissions

Configure whether permissions policies are in effect for AWS SQS.

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

AWS > SQS > 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-sqs#/policy/types/sqsPermissionsLevels
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 > SQS > 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-sqs#/policy/types/sqsPermissionsLevelsModifiers
Category
Parent
Targets
Schema

AWS > SQS > Permissions > Lockdown

URI
tmod:@turbot/aws-sqs#/policy/types/sqsPermissionsLockdown
Category
Parent
Targets

AWS > SQS > Permissions > Lockdown > API Boundary

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

AWS > SQS > Queue > Active

Determine the action to take when an AWS SQS queue, based on the AWS > SQS > Queue > Active > * policies.

The control determines whether the resource is in active use, and if not, has the ability to delete / cleanup the resource. When running an automated compliance environment, it's common to end up with a wide range of alarms that are difficult and time consuming to clear. The Active control brings automated, well-defined control to this process.

The Active control checks the status of all defined Active policies for the resource (AWS > SQS > Queue > Active > *), raises an alarm, and takes the defined enforcement action. Each Active sub-policy can calculate a status of active, inactive or skipped. Generally, if the resource appears to be Active for any reason it will be considered Active. Note the contrast with Approved, where if the resource appears to be Unapproved for any reason it will be considered Unapproved.

See Active for more information.

URI
tmod:@turbot/aws-sqs#/policy/types/queueActive
Category
Parent
Targets
Valid Value
[
  "Skip",
  "Check: Active",
  "Enforce: Delete inactive with 1 day warning",
  "Enforce: Delete inactive with 3 days warning",
  "Enforce: Delete inactive with 7 days warning",
  "Enforce: Delete inactive with 14 days warning",
  "Enforce: Delete inactive with 30 days warning",
  "Enforce: Delete inactive with 60 days warning",
  "Enforce: Delete inactive with 90 days warning",
  "Enforce: Delete inactive with 180 days warning",
  "Enforce: Delete inactive with 365 days warning"
]
Schema
{
  "type": "string",
  "enum": [
    "Skip",
    "Check: Active",
    "Enforce: Delete inactive with 1 day warning",
    "Enforce: Delete inactive with 3 days warning",
    "Enforce: Delete inactive with 7 days warning",
    "Enforce: Delete inactive with 14 days warning",
    "Enforce: Delete inactive with 30 days warning",
    "Enforce: Delete inactive with 60 days warning",
    "Enforce: Delete inactive with 90 days warning",
    "Enforce: Delete inactive with 180 days warning",
    "Enforce: Delete inactive with 365 days warning"
  ],
  "example": [
    "Check: Active"
  ],
  "default": "Skip"
}

AWS > SQS > Queue > Active > Age

The age after which the AWS SQS queue is no longer considered active. If a create time is unavailable, the time Turbot discovered the resource is used.

The Active control determines whether the resource is in active use, and if not, has the ability to delete / cleanup the resource. When running an automated compliance environment, it's common to end up with a wide range of alarms that are difficult and time consuming to clear. The Active control brings automated, well-defined control to this process.

The Active control checks the status of all defined Active policies for the resource (AWS > SQS > Queue > Active > *), raises an alarm, and takes the defined enforcement action. Each Active sub-policy can calculate a status of active, inactive or skipped. Generally, if the resource appears to be Active for any reason it will be considered Active. Note the contrast with Approved, where if the resource appears to be Unapproved for any reason it will be considered Unapproved.

See Active for more information.

URI
tmod:@turbot/aws-sqs#/policy/types/queueActiveAge
Category
Parent
Targets
Valid Value
[
  "Skip",
  "Force inactive if age > 1 day",
  "Force inactive if age > 3 days",
  "Force inactive if age > 7 days",
  "Force inactive if age > 14 days",
  "Force inactive if age > 30 days",
  "Force inactive if age > 60 days",
  "Force inactive if age > 90 days",
  "Force inactive if age > 180 days",
  "Force inactive if age > 365 days"
]
Schema
{
  "type": "string",
  "enum": [
    "Skip",
    "Force inactive if age > 1 day",
    "Force inactive if age > 3 days",
    "Force inactive if age > 7 days",
    "Force inactive if age > 14 days",
    "Force inactive if age > 30 days",
    "Force inactive if age > 60 days",
    "Force inactive if age > 90 days",
    "Force inactive if age > 180 days",
    "Force inactive if age > 365 days"
  ],
  "example": [
    "Force inactive if age > 90 days"
  ],
  "default": "Skip"
}

AWS > SQS > Queue > Active > Budget

The impact of the budget state on the active control. This policy allows you to force queues to inactive based on the current budget state, as reflected in AWS > Account > Budget > State

The Active control determines whether the resource is in active use, and if not, has the ability to delete / cleanup the resource. When running an automated compliance environment, it's common to end up with a wide range of alarms that are difficult and time consuming to clear. The Active control brings automated, well-defined control to this process.

The Active control checks the status of all defined Active policies for the resource (AWS > SQS > Queue > Active > *), raises an alarm, and takes the defined enforcement action. Each Active sub-policy can calculate a status of active, inactive or skipped. Generally, if the resource appears to be Active for any reason it will be considered Active. Note the contrast with Approved, where if the resource appears to be Unapproved for any reason it will be considered Unapproved.

See Active for more information.

URI
tmod:@turbot/aws-sqs#/policy/types/queueActiveBudget
Category
Parent
Targets
Valid Value
[
  "Skip",
  "Force inactive if Budget > State is Over or higher",
  "Force inactive if Budget > State is Critical or higher",
  "Force inactive if Budget > State is Shutdown"
]
Schema
{
  "type": "string",
  "enum": [
    "Skip",
    "Force inactive if Budget > State is Over or higher",
    "Force inactive if Budget > State is Critical or higher",
    "Force inactive if Budget > State is Shutdown"
  ],
  "example": [
    "Skip"
  ],
  "default": "Skip"
}

AWS > SQS > Queue > Active > Last Modified

The number of days since the AWS SQS queue was last modified before it is considered inactive.

The Active control determines whether the resource is in active use, and if not, has the ability to delete / cleanup the resource. When running an automated compliance environment, it's common to end up with a wide range of alarms that are difficult and time consuming to clear. The Active control brings automated, well-defined control to this process.

The Active control checks the status of all defined Active policies for the resource (AWS > SQS > Queue > Active > *), raises an alarm, and takes the defined enforcement action. Each Active sub-policy can calculate a status of active, inactive or skipped. Generally, if the resource appears to be Active for any reason it will be considered Active. Note the contrast with Approved, where if the resource appears to be Unapproved for any reason it will be considered Unapproved.

See Active for more information.

URI
tmod:@turbot/aws-sqs#/policy/types/queueActiveLastModified
Category
Parent
Targets
Valid Value
[
  "Skip",
  "Active if last modified <= 1 day",
  "Active if last modified <= 3 days",
  "Active if last modified <= 7 days",
  "Active if last modified <= 14 days",
  "Active if last modified <= 30 days",
  "Active if last modified <= 60 days",
  "Active if last modified <= 90 days",
  "Active if last modified <= 180 days",
  "Active if last modified <= 365 days",
  "Force active if last modified <= 1 day",
  "Force active if last modified <= 3 days",
  "Force active if last modified <= 7 days",
  "Force active if last modified <= 14 days",
  "Force active if last modified <= 30 days",
  "Force active if last modified <= 60 days",
  "Force active if last modified <= 90 days",
  "Force active if last modified <= 180 days",
  "Force active if last modified <= 365 days"
]
Schema
{
  "type": "string",
  "enum": [
    "Skip",
    "Active if last modified <= 1 day",
    "Active if last modified <= 3 days",
    "Active if last modified <= 7 days",
    "Active if last modified <= 14 days",
    "Active if last modified <= 30 days",
    "Active if last modified <= 60 days",
    "Active if last modified <= 90 days",
    "Active if last modified <= 180 days",
    "Active if last modified <= 365 days",
    "Force active if last modified <= 1 day",
    "Force active if last modified <= 3 days",
    "Force active if last modified <= 7 days",
    "Force active if last modified <= 14 days",
    "Force active if last modified <= 30 days",
    "Force active if last modified <= 60 days",
    "Force active if last modified <= 90 days",
    "Force active if last modified <= 180 days",
    "Force active if last modified <= 365 days"
  ],
  "example": [
    "Active if last modified <= 90 days"
  ],
  "default": "Skip"
}

AWS > SQS > Queue > Approved

Determine the action to take when an AWS SQS queue is not approved based on AWS > SQS > Queue > Approved > * policies.

The Approved control checks the status of the defined Approved sub-policies for the resource. If the resource is not approved according to any of these policies, this control raises an alarm and takes the defined enforcement action.

For any enforcement actions that specify if new, e.g., Enforce: Delete unapproved if new, this control will only take the enforcement actions for resources created within the last 60 minutes.

See Approved for more information.

URI
tmod:@turbot/aws-sqs#/policy/types/queueApproved
Category
Parent
Targets
Valid Value
[
  "Skip",
  "Check: Approved",
  "Enforce: Delete unapproved if new"
]
Schema
{
  "type": "string",
  "enum": [
    "Skip",
    "Check: Approved",
    "Enforce: Delete unapproved if new"
  ],
  "example": [
    "Check: Approved"
  ],
  "default": "Skip"
}

AWS > SQS > Queue > Approved > Budget

The policy allows you to set queues to unapproved based on the current budget state, as reflected in AWS > Account > Budget > State

This policy will be evaluated by the Approved control. If an AWS SQS queue is not matched by the approved list, it will be subject to the action specified in the AWS > SQS > Queue > Approved policy.

See Approved for more information.

URI
tmod:@turbot/aws-sqs#/policy/types/queueApprovedBudget
Category
Parent
Targets
Valid Value
[
  "Skip",
  "Unapproved if Budget > State is Over or higher",
  "Unapproved if Budget > State is Critical or higher",
  "Unapproved if Budget > State is Shutdown"
]
Schema
{
  "type": "string",
  "enum": [
    "Skip",
    "Unapproved if Budget > State is Over or higher",
    "Unapproved if Budget > State is Critical or higher",
    "Unapproved if Budget > State is Shutdown"
  ],
  "example": [
    "Unapproved if Budget > State is Shutdown"
  ],
  "default": "Skip"
}

AWS > SQS > Queue > Approved > Custom

Determine whether the AWS SQS queue is allowed to exist. This policy will be evaluated by the Approved control. If an AWS SQS queue is not approved, it will be subject to the action specified in the AWS > SQS > Queue > Approved policy. See Approved for more information.

Note: The policy value must be a string with a value of Approved, Not approved or Skip, or in the form of YAML objects. The object(s) must contain the key result with its value as Approved or Not approved. A custom title and message can also be added using the keys title and message respectively.

URI
tmod:@turbot/aws-sqs#/policy/types/queueApprovedCustom
Category
Parent
Targets
Schema
{
  "example": [
    "Approved",
    "Not approved",
    "Skip",
    {
      "result": "Approved"
    },
    {
      "title": "string",
      "result": "Not approved"
    },
    {
      "title": "string",
      "result": "Approved",
      "message": "string"
    },
    [
      {
        "title": "string",
        "result": "Approved",
        "message": "string"
      },
      {
        "title": "string",
        "result": "Not approved",
        "message": "string"
      }
    ]
  ],
  "anyOf": [
    {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "title": {
            "type": "string",
            "pattern": "^[\\W\\w]{1,32}$"
          },
          "message": {
            "type": "string",
            "pattern": "^[\\W\\w]{1,128}$"
          },
          "result": {
            "type": "string",
            "pattern": "^(Approved|Not approved|Skip)$"
          }
        },
        "required": [
          "result"
        ],
        "additionalProperties": false
      }
    },
    {
      "type": "object",
      "properties": {
        "title": {
          "type": "string",
          "pattern": "^[\\W\\w]{1,32}$"
        },
        "message": {
          "type": "string",
          "pattern": "^[\\W\\w]{1,128}$"
        },
        "result": {
          "type": "string",
          "pattern": "^(Approved|Not approved|Skip)$"
        }
      },
      "required": [
        "result"
      ],
      "additionalProperties": false
    },
    {
      "type": "string",
      "pattern": "^(Approved|Not approved|Skip)$"
    }
  ],
  "default": "Skip"
}

AWS > SQS > Queue > Approved > Regions

A list of AWS regions in which AWS SQS queues are approved for use.

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

This policy will be evaluated by the Approved control. If an AWS SQS queue is created in a region that is not in the approved list, it will be subject to the action specified in the AWS > SQS > Queue > Approved policy.

See Approved for more information.

URI
tmod:@turbot/aws-sqs#/policy/types/queueApprovedRegions
Category
Parent
Targets
Default Template Input
"{\n  regions: policy(uri: \"tmod:@turbot/aws-sqs#/policy/types/sqsApprovedRegionsDefault\")\n}\n"
Default Template
"{% if $.regions | length == 0 %} [] {% endif %}{% for item in $.regions %}- &#39;{{ item }}&#39;\n{% endfor %}"
Schema

AWS > SQS > Queue > Approved > Usage

Determine whether the AWS SQS queue is allowed to exist.

This policy will be evaluated by the Approved control. If an AWS SQS queue is not approved, it will be subject to the action specified in the AWS > SQS > Queue > Approved policy.

See Approved for more information.

URI
tmod:@turbot/aws-sqs#/policy/types/queueApprovedUsage
Category
Parent
Targets
Valid Value
[
  "Not approved",
  "Approved",
  "Approved if AWS > SQS > Enabled"
]
Schema
{
  "type": "string",
  "enum": [
    "Not approved",
    "Approved",
    "Approved if AWS > SQS > Enabled"
  ],
  "example": [
    "Not approved"
  ],
  "default": "Approved if AWS > SQS > Enabled"
}

AWS > SQS > Queue > CMDB

Configure whether to record and synchronize details for the AWS SQS queue into the CMDB.

The CMDB control is responsible for populating and updating all the attributes for that resource type in the Turbot CMDB. All policies and controls in Turbot 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".

URI
tmod:@turbot/aws-sqs#/policy/types/queueCmdb
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 > SQS > Queue > Configured

Determine how to configure this resource.

Note: If the resource is managed by another stack, then the Skip/Check/Enforce values here are ignored and inherit from the stack that owns it.

URI
tmod:@turbot/aws-sqs#/policy/types/queueConfigured
Category
Parent
Targets
Valid Value
[
  "Skip (unless claimed by a stack)",
  "Check: Per Configured > Source (unless claimed by a stack)",
  "Enforce: Per Configured > Source (unless claimed by a stack)"
]
Schema
{
  "enum": [
    "Skip (unless claimed by a stack)",
    "Check: Per Configured > Source (unless claimed by a stack)",
    "Enforce: Per Configured > Source (unless claimed by a stack)"
  ],
  "default": "Skip (unless claimed by a stack)"
}

AWS > SQS > Queue > Configured > Claim Precedence

An ordered list of who is allowed to claim a resource. A stack cannot claim a resource if it is already claimed by another stack at a higher level of precedence.

URI
tmod:@turbot/aws-sqs#/policy/types/queueConfiguredPrecedence
Category
Parent
Targets
Default Template Input
"{\n  defaultPrecedence: policy(uri:\"tmod:@turbot/turbot#/policy/types/claimPrecedenceDefault\")\n}\n"
Default Template
"{%- if $.defaultPrecedence | length == 0 %}[]{%- else %}{% for item in $.defaultPrecedence %}- &#39;{{ item }}&#39;{% endfor %}{% endif %}"
Schema
{
  "type": "array",
  "items": {
    "type": "string"
  }
}

AWS > SQS > Queue > Configured > Source

A HCL or JSON format Terraform configuration source used to configure this resource.

URI
tmod:@turbot/aws-sqs#/policy/types/queueConfiguredSource
Category
Parent
Targets
Schema
{
  "type": "string",
  "default": "",
  "x-schema-form": {
    "type": "code",
    "language": "hcl"
  }
}

AWS > SQS > Queue > Encryption at Rest

Define the Encryption at Rest settings required for AWS > SQS > Queue.

Encryption at Rest refers specifically to the encryption of data when written to an underlying storage system. This control determines whether the resource is encrypted at rest, and sets encryption to your desired level.

The Encryption at Rest control compares the encryption settings against the encryption policies for the resource (AWS > SQS > Queue > Encryption at Rest > *), raises an alarm, and takes the defined enforcement action

URI
tmod:@turbot/aws-sqs#/policy/types/queueEncryptionAtRest
Category
Parent
Targets
Valid Value
[
  "Skip",
  "Check: None",
  "Check: None or higher",
  "Check: AWS managed key",
  "Check: AWS managed key or higher",
  "Check: Customer managed key",
  "Check: Encryption at Rest > Customer Managed Key",
  "Enforce: None",
  "Enforce: AWS managed key",
  "Enforce: AWS managed key or higher",
  "Enforce: Customer managed key",
  "Enforce: Encryption at Rest > Customer Managed Key"
]
Schema
{
  "type": "string",
  "enum": [
    "Skip",
    "Check: None",
    "Check: None or higher",
    "Check: AWS managed key",
    "Check: AWS managed key or higher",
    "Check: Customer managed key",
    "Check: Encryption at Rest > Customer Managed Key",
    "Enforce: None",
    "Enforce: AWS managed key",
    "Enforce: AWS managed key or higher",
    "Enforce: Customer managed key",
    "Enforce: Encryption at Rest > Customer Managed Key"
  ],
  "example": [
    "Check: None or higher"
  ],
  "default": "Skip"
}

AWS > SQS > Queue > Encryption at Rest > Customer Managed Key

Define the KMS key ID for encryption at rest.

Encryption at Rest refers specifically to the encryption of data when written to an underlying storage system. This control determines whether the resource is encrypted at rest, and sets encryption to your desired level.

The Encryption at Rest control compares the encryption settings against the encryption policies for the resource (AWS > SQS > Queue > Encryption at Rest > *), raises an alarm, and takes the defined enforcement action

Please make sure the key defined in the template has required permissions.

example:
  alias/aws/ebs
  ddc06e04-ce5f-4995-c758-c2b6c510e8fd
  arn:aws:kms:us-east-1:123456789012:key/ddc06e04-ce5f-4995-c758-c2b6c510e8fd
  arn:aws:kms:us-east-1:123456789012:alias/aws/ebs
URI
tmod:@turbot/aws-sqs#/policy/types/queueEncryptionAtRestCustomerManagedKey
Category
Parent
Targets
Default Template Input
"{\n  defaultKey: policy(uri: \"aws-kms#/policy/types/keyDefaultCustomerManagedKey\")\n}\n"
Default Template
"{{ $.defaultKey }}"
Schema
{
  "anyOf": [
    {
      "type": "string",
      "pattern": "^alias/[a-zA-Z0-9:/_-]{1,249}$"
    },
    {
      "type": "string",
      "pattern": "^[-a-z0-9-]{1,255}$"
    },
    {
      "type": "string",
      "pattern": "^arn:aws(-us-gov|-cn)?:kms:[a-z]{2}(-gov)?-[a-z]+-[0-9]:[0-9]{12}:key/[-a-z0-9-]{1,255}$"
    },
    {
      "type": "string",
      "pattern": "^arn:aws(-us-gov|-cn)?:kms:[a-z]{2}(-gov)?-[a-z]+-[0-9]:[0-9]{12}:alias/[a-zA-Z0-9:/_-]{1,249}$"
    }
  ],
  "tests": [
    {
      "description": "valid - if keyArn",
      "input": "arn:aws:kms:us-east-1:039305405804:key/ddc06e04-ce5f-4995-b758-c2b6c510e8fd"
    },
    {
      "description": "valid - if aliasName",
      "input": "alias/aws/ebs"
    },
    {
      "description": "valid - if keyId",
      "input": "ddc06e04-ce5f-4995-b758-c2b6c510e8fd"
    },
    {
      "description": "valid - if aliasArn",
      "input": "arn:aws:kms:us-east-1:039305405804:alias/aws/ebs"
    }
  ]
}

AWS > SQS > Queue > Policy

URI
tmod:@turbot/aws-sqs#/policy/types/queuePolicy
Category
Parent
Targets

AWS > SQS > Queue > Policy > Trusted Access

Take an action when AWS SQS queue policy is not trusted based on the AWS > SQS > Queue > Policy > Trusted Access > * policies.

The Trusted Access control evaluates the queue policy against the list of allowed members in each of the Trusted Access sub-policies (Trusted Access > Accounts, Trusted Access > Services etc.), this control raises an alarm and takes the defined enforcement action.

The account that owns the queue will always be trusted, even if its account ID is not included in the Trusted Accounts policy.

If set to Enforce: Revoke untrusted access, access to non-trusted members will be removed.

URI
tmod:@turbot/aws-sqs#/policy/types/queuePolicyTrustedAccess
Category
Parent
Targets
Valid Value
[
  "Skip",
  "Check: Trusted Access",
  "Enforce: Revoke untrusted access"
]
Schema
{
  "type": "string",
  "enum": [
    "Skip",
    "Check: Trusted Access",
    "Enforce: Revoke untrusted access"
  ],
  "default": "Skip"
}

AWS > SQS > Queue > Policy > Trusted Access > Accounts

List of AWS Account IDs that are trusted for cross-account access in the AWS SQS queue policy.

Note that Trusted Access > Accounts and Trusted Access &gt; Organizations are evaluated independently. To have access, an AWS principal must be allowed in Trusted Access > Accounts AND be a member of an Organization that is allowed in Trusted Access &gt; Organizations.

example:
  - &quot;123456789012&quot;

Note: Setting the policy to an Empty array will remove all accounts.

URI
tmod:@turbot/aws-sqs#/policy/types/queuePolicyTrustedAccounts
Category
Parent
Targets
Default Template Input
"{\n  accounts: policy(uri: \"tmod:@turbot/aws-sqs#/policy/types/sqsPolicyTrustedAccounts\")\n}\n"
Default Template
"{% if $.accounts | length == 0 %}[]{% endif %}{% for item in $.accounts %}- &#39;{{ item }}&#39;\n{% endfor %}"
Schema
{
  "type": "array",
  "items": {
    "type": "string",
    "pattern": "(?:^\\d{12}$|^\\*$)"
  }
}

AWS > SQS > Queue > Policy > Trusted Access > Organization Restrictions

List of AWS Organization IDs that are trusted for cross-account access in the AWS SQS queue policy, or '*' to skip the Organization Restriction.

Note that Trusted Access > Accounts and Trusted Access &gt; Organizations are evaluated independently. To have access, an AWS principal must be allowed in Trusted Access > Accounts AND be a member of an Organization that is allowed in Trusted Access &gt; Organizations.

Note: Trusted Access > Organization Restrictions are ONLY applied to AWS principals. Services and Federated principals do NOT contain the aws:PrincipalOrgId condition key, and thus cannot be validated against the Organization.

example:
  - &quot;o-333333333&quot;
  - &quot;o-c3a5y4wd52&quot;
URI
tmod:@turbot/aws-sqs#/policy/types/queuePolicyTrustedOrganizations
Category
Parent
Targets
Default Template Input
"{\n  organizations: policy(uri: \"tmod:@turbot/aws-sqs#/policy/types/sqsPolicyTrustedOrganizations\")\n}\n"
Default Template
"{% if $.organizations | length == 0 %}[]{% endif %}{% for item in $.organizations %}- &#39;{{ item }}&#39;\n{% endfor %}"
Schema
{
  "type": "array",
  "items": {
    "type": "string",
    "pattern": "(?:^o-[a-z0-9]{10,32}$|^\\*$)"
  }
}

AWS > SQS > Queue > Policy > Trusted Access > Services

List of AWS Services that are trusted for access in the AWS SQS queue policy.

example:
  - sns.amazonaws.com
  - ec2.amazonaws.com

Note: Setting the policy to an Empty array will remove all services.

URI
tmod:@turbot/aws-sqs#/policy/types/queuePolicyTrustedServices
Category
Parent
Targets
Default Template Input
"{\n  services: policy(uri: \"tmod:@turbot/aws-sqs#/policy/types/sqsPolicyTrustedServices\")\n}\n"
Default Template
"{% if $.services | length == 0 %}[]{% endif %}{% for item in $.services %}- &#39;{{ item }}&#39;\n{% endfor %}"
Schema
{
  "type": "array",
  "items": {
    "type": "string",
    "pattern": "(?:^\\S*\\.amazonaws\\.com$|^\\*$)"
  }
}

AWS > SQS > Queue > Regions

A list of AWS regions in which AWS SQS queues are supported for use.

Any queues 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-sqs#/policy/types/queueRegions
Category
Parent
Targets
Default Template Input
"{\n  regions: policyValue(uri:\"tmod:@turbot/aws-sqs#/policy/types/sqsRegionsDefault\") {\n    value\n  }\n}\n"
Default Template
"{% if $.regions.value | length == 0 %} [] {% endif %}{% for item in $.regions.value %}- &#39;{{ item }}&#39;\n{% endfor %}"
Schema

AWS > SQS > Queue > Tags

Determine the action to take when an AWS SQS queue tags are not updated based on the AWS > SQS > Queue > Tags > * policies.

The control ensure AWS SQS queue tags include tags defined in AWS > SQS > Queue > Tags > Template.

Tags not defined in Queue Tags Template will not be modified or deleted. Setting a tag value to undefined will result in the tag being deleted.

See Tags for more information.

URI
tmod:@turbot/aws-sqs#/policy/types/queueTags
Category
Parent
Targets
Valid Value
[
  "Skip",
  "Check: Tags are correct",
  "Enforce: Set tags"
]
Schema
{
  "type": "string",
  "enum": [
    "Skip",
    "Check: Tags are correct",
    "Enforce: Set tags"
  ],
  "example": [
    "Check: Tags are correct"
  ],
  "default": "Skip"
}

AWS > SQS > Queue > Tags > Template

The template is used to generate the keys and values for AWS SQS queue.

Tags not defined in Queue Tags Template will not be modified or deleted. Setting a tag value to undefined will result in the tag being deleted.

See Tags for more information.

URI
tmod:@turbot/aws-sqs#/policy/types/queueTagsTemplate
Category
Parent
Targets
Default Template Input
[
  "{\n  account {\n    turbot {\n      id\n    }\n  }\n}\n",
  "{\n  defaultTags: policyValue(uri:\"tmod:@turbot/aws-sqs#/policy/types/sqsTagsTemplate\" resourceId: \"{{ $.account.turbot.id }}\") {\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

AWS > SQS > Queue > Usage

Configure the number of AWS SQS queues that can be used for this region and the current consumption against the limit.

You can configure the behavior of the control with this AWS > SQS > Queue > Usage policy.

URI
tmod:@turbot/aws-sqs#/policy/types/queueUsage
Category
Parent
Targets
Valid Value
[
  "Skip",
  "Check: Usage <= 85% of Limit",
  "Check: Usage <= 100% of Limit"
]
Schema
{
  "type": "string",
  "enum": [
    "Skip",
    "Check: Usage <= 85% of Limit",
    "Check: Usage <= 100% of Limit"
  ],
  "example": [
    "Check: Usage <= 85% of Limit"
  ],
  "default": "Skip"
}

AWS > SQS > Queue > Usage > Limit

Maximum number of items that can be created for this region.

URI
tmod:@turbot/aws-sqs#/policy/types/queueUsageLimit
Category
Parent
Targets
Schema
{
  "type": "integer",
  "minimum": 0,
  "default": 100
}

AWS > SQS > Regions

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

URI
tmod:@turbot/aws-sqs#/policy/types/sqsRegionsDefault
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-east-1",
        "us-gov-west-1",
        "us-west-1",
        "us-west-2"
      ]
    }
  ]
}

AWS > SQS > Stack

Configure a custom stack on AWS, per the custom Stack > Source.

A Turbot Stack is a set of resources configured by Turbot, as specified via Terraform source. Stacks are responsible for the creation and deletion of multiple resources. Once created, stack resources are responsible for configuring themselves from the stack source via their Configured control.

URI
tmod:@turbot/aws-sqs#/policy/types/sqsStack
Category
Parent
Targets
Valid Value
[
  "Skip",
  "Check: Configured",
  "Enforce: Configured"
]
Schema
{
  "type": "string",
  "enum": [
    "Skip",
    "Check: Configured",
    "Enforce: Configured"
  ],
  "default": "Skip"
}

AWS > SQS > Stack > Secret Variables

Terraform secret variables in Terraform HCL that will be used as inputs to the stack as a .tfvars file.

A Turbot Stack is a set of resources configured by Turbot, as specified via Terraform source. Stacks are responsible for the creation and deletion of multiple resources. Once created, stack resources are responsible for configuring themselves from the stack source via their Configured control.

URI
tmod:@turbot/aws-sqs#/policy/types/sqsStackSecretVariables
Category
Parent
Targets
Schema
{
  "type": "string",
  "x-schema-form": {
    "type": "code",
    "language": "hcl"
  }
}

AWS > SQS > Stack > Source

The Terraform HCL source used to configure this stack.

A Turbot Stack is a set of resources configured by Turbot, as specified via Terraform source. Stacks are responsible for the creation and deletion of multiple resources. Once created, stack resources are responsible for configuring themselves from the stack source via their Configured control.

URI
tmod:@turbot/aws-sqs#/policy/types/sqsStackSource
Category
Parent
Targets
Schema
{
  "type": "string",
  "default": "",
  "x-schema-form": {
    "type": "code",
    "language": "hcl"
  }
}

AWS > SQS > Stack > Terraform Version

The Version of Terraform to use for this stack. Specify an npm-style semver string to determine which version of the Terraform container Turbot will use to run this stack.

A Turbot Stack is a set of resources configured by Turbot, as specified via Terraform source. Stacks are responsible for the creation and deletion of multiple resources. Once created, stack resources are responsible for configuring themselves from the stack source via their Configured control.

URI
tmod:@turbot/aws-sqs#/policy/types/sqsStackTerraformVersion
Category
Parent
Targets
Default Template Input
"{\n  terraformVersion: policy(uri:\"tmod:@turbot/turbot#/policy/types/stackTerraformVersion\")\n}\n"
Default Template
"{% if $.terraformVersion %}&quot;{{$.terraformVersion}}&quot;{% else %}&quot;&quot;{% endif %}"
Schema
{
  "type": "string"
}

AWS > SQS > Stack > Variables

Terraform variables in Terraform HCL that will be used as inputs to the stack as a .tfvars file.

A Turbot Stack is a set of resources configured by Turbot, as specified via Terraform source. Stacks are responsible for the creation and deletion of multiple resources. Once created, stack resources are responsible for configuring themselves from the stack source via their Configured control.

URI
tmod:@turbot/aws-sqs#/policy/types/sqsStackVariables
Category
Parent
Targets
Schema
{
  "type": "string",
  "x-schema-form": {
    "type": "code",
    "language": "hcl"
  }
}

AWS > SQS > Tags Template [Default]

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

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

URI
tmod:@turbot/aws-sqs#/policy/types/sqsTagsTemplate
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

AWS > SQS > Trusted Accounts [Default]

List of AWS Account IDs that are trusted for cross-account access.

Note that Trusted Access > Accounts and Trusted Access &gt; Organizations are evaluated independently. To have access, an AWS principal must be allowed in Trusted Access > Accounts AND be a member of an Organization that is allowed in Trusted Access &gt; Organizations.

example:
  - &quot;013122550996&quot;
  - &quot;560741234067&quot;

Note: Setting the policy to an Empty array will remove all accounts.

URI
tmod:@turbot/aws-sqs#/policy/types/sqsPolicyTrustedAccounts
Category
Parent
Targets
Default Template Input
"{\n  trustedAccounts: policyValue(uri:\"tmod:@turbot/aws#/policy/types/trustedAccounts\") {\n    value\n  }\n}\n"
Default Template
"{% if $.trustedAccounts.value | length == 0 %}[]{% else %}{% for item in $.trustedAccounts.value %}- &#39;{{ item }}&#39;\n{% endfor %}{% endif %}"
Schema
{
  "type": "array",
  "items": {
    "type": "string",
    "pattern": "(?:^\\d{12}$|^\\*$)"
  }
}

AWS > SQS > Trusted Organizations [Default]

List of AWS Organization IDs that users may share resources with.

Note that Trusted Access > Accounts and Trusted Access &gt; Organizations are evaluated independently. To have access, an AWS principal must be allowed in Trusted Access > Accounts AND be a member of an Organization that is allowed in Trusted Access &gt; Organizations.

Note: Trusted Access > Organization Restrictions are ONLY applied to AWS principals. Services and Federated principals do NOT contain the aws:PrincipalOrgId condition key, and thus cannot be validated against the Organization.

example:
  - &quot;o-333333333&quot;
  - &quot;o-c3a5y4wd52&quot;
URI
tmod:@turbot/aws-sqs#/policy/types/sqsPolicyTrustedOrganizations
Category
Parent
Targets
Default Template Input
"{\n  trustedOrganizations: policyValue(uri:\"tmod:@turbot/aws#/policy/types/trustedOrganizations\") {\n    value\n  }\n}\n"
Default Template
"{% if $.trustedOrganizations.value | length == 0 %}[]{% else %}{% for item in $.trustedOrganizations.value %}- &#39;{{ item }}&#39;\n{% endfor %}{% endif %}"
Schema
{
  "type": "array",
  "items": {
    "type": "string",
    "pattern": "(?:^o-[a-z0-9]{10,32}$|^\\*$)"
  }
}

AWS > SQS > Trusted Services [Default]

List of AWS service principals that users may share resources with.

example:
  - sns.amazonaws.com
  - ec2.amazonaws.com

Note: Setting the policy to an Empty array will remove all services.

URI
tmod:@turbot/aws-sqs#/policy/types/sqsPolicyTrustedServices
Category
Parent
Targets
Default Template Input
"{\n  trustedServices: policyValue(uri:\"tmod:@turbot/aws#/policy/types/trustedServices\") {\n    value\n  }\n}\n"
Default Template
"{% if $.trustedServices.value | length == 0 %}[]{% else %}{% for item in $.trustedServices.value %}- &#39;{{ item }}&#39;\n{% endfor %}{% endif %}"
Schema
{
  "type": "array",
  "items": {
    "type": "string",
    "pattern": "(?:^\\S*\\.amazonaws\\.com$|^\\*$)"
  }
}

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

AWS SQS CloudWatch Events event sources for the Turbot Event Handlers.

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

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

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

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

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

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

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

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

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

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