Policy types for @turbot/aws-ssm

Parent

Targets

Valid Value

[
  "Enabled",
  "Disabled",
  "Enabled if AWS > SSM > Enabled"
]

Schema

{
  "type": "string",
  "enum": [
    "Enabled",
    "Disabled",
    "Enabled if AWS > SSM > Enabled"
  ],
  "default": "Enabled"
}

AWS > SSM > Approved Regions [Default]

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

URI

tmod:@turbot/aws-ssm#/policy/types/ssmApprovedRegionsDefault

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 %}- &#39;{{ item }}&#39;\n{% endfor %}"

Schema

AWS > SSM > Association > Active

Determine the action to take when an AWS SSM association, based on the AWS > SSM > Association > 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 > SSM > Association > 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-ssm#/policy/types/associationActive

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 > SSM > Association > Active > Age

The age after which the AWS SSM association 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.

See Active for more information.

URI

tmod:@turbot/aws-ssm#/policy/types/associationActiveAge

Category

AWS > SSM > Association > Active

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 > SSM > Association > Active > Last Modified

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

See Active for more information.

URI

tmod:@turbot/aws-ssm#/policy/types/associationActiveLastModified

Category

AWS > SSM > Association > Active

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 > SSM > Association > Approved

Determine the action to take when an AWS SSM association is not approved based on AWS > SSM > Association > 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-ssm#/policy/types/associationApproved

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 > SSM > Association > Approved > Custom

Determine whether the AWS SSM association is allowed to exist. This policy will be evaluated by the Approved control. If an AWS SSM association is not approved, it will be subject to the action specified in the AWS > SSM > Association > 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-ssm#/policy/types/associationApprovedCustom

Category

AWS > SSM > Association > Approved

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 > SSM > Association > Approved > Regions

A list of AWS regions in which AWS SSM associations 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 SSM association is created in a region that is not in the approved list, it will be subject to the action specified in the AWS > SSM > Association > Approved policy.

See Approved for more information.

URI

tmod:@turbot/aws-ssm#/policy/types/associationApprovedRegions

Category

AWS > SSM > Association > Approved

Parent

Targets

Default Template Input

"{\n  regions: policy(uri: \"tmod:@turbot/aws-ssm#/policy/types/ssmApprovedRegionsDefault\")\n}\n"

Default Template

"{% if $.regions | length == 0 %} [] {% endif %}{% for item in $.regions %}- &#39;{{ item }}&#39;\n{% endfor %}"

Schema

AWS > SSM > Association > Approved > Usage

Determine whether the AWS SSM association is allowed to exist.

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

See Approved for more information.

URI

tmod:@turbot/aws-ssm#/policy/types/associationApprovedUsage

Category

AWS > SSM > Association > Approved

Parent

Targets

Valid Value

[
  "Not approved",
  "Approved",
  "Approved if AWS > SSM > Enabled"
]

Schema

{
  "type": "string",
  "enum": [
    "Not approved",
    "Approved",
    "Approved if AWS > SSM > Enabled"
  ],
  "example": [
    "Not approved"
  ],
  "default": "Approved if AWS > SSM > Enabled"
}

AWS > SSM > Association > CMDB

Configure whether to record and synchronize details for the AWS SSM association 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".

CMDB controls also use the Regions policy associated with the resource. If region is not in AWS > SSM > Association > 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-ssm#/policy/types/associationCmdb

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 > SSM > Association > 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-ssm#/policy/types/associationConfigured

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 > SSM > Association > 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-ssm#/policy/types/associationConfiguredPrecedence

Category

AWS > SSM > Association > Configured

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 > SSM > Association > Configured > Source

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

URI

tmod:@turbot/aws-ssm#/policy/types/associationConfiguredSource

Category

AWS > SSM > Association > Configured

Parent

Targets

Schema

{
  "type": "string",
  "default": "",
  "x-schema-form": {
    "type": "code",
    "language": "hcl"
  }
}

AWS > SSM > Association > Regions

A list of AWS regions in which AWS SSM associations are supported for use.

Any associations 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-ssm#/policy/types/associationRegions

Category

Parent

Targets

Default Template Input

"{\n  regions: policyValue(uri:\"tmod:@turbot/aws-ssm#/policy/types/ssmRegionsDefault\") {\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 > SSM > Association > Usage

Configure the number of AWS SSM associations 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 > SSM > Association > Usage policy.

URI

tmod:@turbot/aws-ssm#/policy/types/associationUsage

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 > SSM > Association > Usage > Limit

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

URI

tmod:@turbot/aws-ssm#/policy/types/associationUsageLimit

Category

AWS > SSM > Association > Usage

Parent

Targets

Schema

{
  "type": "integer",
  "minimum": 0,
  "default": 2000
}

AWS > SSM > CMDB

Configure whether to record and synchronize details for the AWS SSM ssm into the CMDB.

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 > SSM > SSM > 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-ssm#/policy/types/ssmCmdb

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 > SSM > Document > Active

Determine the action to take when an AWS SSM document, based on the AWS > SSM > Document > Active > * policies.

The Active control checks the status of all defined Active policies for the resource (AWS > SSM > Document > 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-ssm#/policy/types/documentActive

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 > SSM > Document > Active > Age

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

See Active for more information.

URI

tmod:@turbot/aws-ssm#/policy/types/documentActiveAge

Category

AWS > SSM > Document > Active

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 > SSM > Document > Active > Last Modified

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

See Active for more information.

URI

tmod:@turbot/aws-ssm#/policy/types/documentActiveLastModified

Category

AWS > SSM > Document > Active

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 > SSM > Document > Approved

Determine the action to take when an AWS SSM document is not approved based on AWS > SSM > Document > Approved > * policies.

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-ssm#/policy/types/documentApproved

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 > SSM > Document > Approved > Custom

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

URI

tmod:@turbot/aws-ssm#/policy/types/documentApprovedCustom

Category

AWS > SSM > Document > Approved

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 > SSM > Document > Approved > Regions

A list of AWS regions in which AWS SSM documents 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 SSM document is created in a region that is not in the approved list, it will be subject to the action specified in the AWS > SSM > Document > Approved policy.

See Approved for more information.

URI

tmod:@turbot/aws-ssm#/policy/types/documentApprovedRegions

Category

AWS > SSM > Document > Approved

Parent

Targets

Default Template Input

"{\n  regions: policy(uri: \"tmod:@turbot/aws-ssm#/policy/types/ssmApprovedRegionsDefault\")\n}\n"

Default Template

"{% if $.regions | length == 0 %} [] {% endif %}{% for item in $.regions %}- &#39;{{ item }}&#39;\n{% endfor %}"

Schema

AWS > SSM > Document > Approved > Usage

Determine whether the AWS SSM document is allowed to exist.

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

See Approved for more information.

URI

tmod:@turbot/aws-ssm#/policy/types/documentApprovedUsage

Category

AWS > SSM > Document > Approved

Parent

Targets

Valid Value

[
  "Not approved",
  "Approved",
  "Approved if AWS > SSM > Enabled"
]

Schema

{
  "type": "string",
  "enum": [
    "Not approved",
    "Approved",
    "Approved if AWS > SSM > Enabled"
  ],
  "example": [
    "Not approved"
  ],
  "default": "Approved if AWS > SSM > Enabled"
}

AWS > SSM > Document > CMDB

Configure whether to record and synchronize details for the AWS SSM document into the CMDB.

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 > SSM > Document > 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-ssm#/policy/types/documentCmdb

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 > SSM > Document > 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-ssm#/policy/types/documentConfigured

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 > SSM > Document > 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-ssm#/policy/types/documentConfiguredPrecedence

Category

AWS > SSM > Document > Configured

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 > SSM > Document > Configured > Source

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

URI

tmod:@turbot/aws-ssm#/policy/types/documentConfiguredSource

Category

AWS > SSM > Document > Configured

Parent

Targets

Schema

{
  "type": "string",
  "default": "",
  "x-schema-form": {
    "type": "code",
    "language": "hcl"
  }
}

AWS > SSM > Document > Regions

A list of AWS regions in which AWS SSM documents are supported for use.

Any documents 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-ssm#/policy/types/documentRegions

Category

Parent

Targets

Default Template Input

"{\n  regions: policyValue(uri:\"tmod:@turbot/aws-ssm#/policy/types/ssmRegionsDefault\") {\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 > SSM > Document > Tags

Determine the action to take when an AWS SSM document tags are not updated based on the AWS > SSM > Document > Tags > * policies.

The control ensure AWS SSM document tags include tags defined in AWS > SSM > Document > Tags > Template.

Tags not defined in Document 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-ssm#/policy/types/documentTags

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 > SSM > Document > Tags > Template

The template is used to generate the keys and values for AWS SSM document.

Tags not defined in Document 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-ssm#/policy/types/documentTagsTemplate

Category

AWS > SSM > Document > Tags

Parent

Targets

Default Template Input

[
  "{\n  account {\n    turbot {\n      id\n    }\n  }\n}\n",
  "{\n  defaultTags: policyValue(uri:\"tmod:@turbot/aws-ssm#/policy/types/ssmTagsTemplate\" 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 > SSM > Document > Usage

Configure the number of AWS SSM documents 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 > SSM > Document > Usage policy.

URI

tmod:@turbot/aws-ssm#/policy/types/documentUsage

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 > SSM > Document > Usage > Limit

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

URI

tmod:@turbot/aws-ssm#/policy/types/documentUsageLimit

Category

AWS > SSM > Document > Usage

Parent

Targets

Schema

{
  "type": "integer",
  "minimum": 0,
  "default": 200
}

AWS > SSM > Enabled

Configure whether the AWS SSM service is enabled. This will only affect Turbot managed User Roles and will allow the Turbot managed user to access AWS SSM 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-ssm#/policy/types/ssmEnabled

Category

Parent

Targets

Valid Value

[
  "Enabled",
  "Enabled: Metadata Only",
  "Disabled"
]

Schema

{
  "type": "string",
  "enum": [
    "Enabled",
    "Enabled: Metadata Only",
    "Disabled"
  ],
  "example": [
    "Enabled"
  ],
  "default": "Disabled"
}

AWS > SSM > Inventory Management

URI

tmod:@turbot/aws-ssm#/policy/types/inventoryManagement

Category

Parent

Targets

AWS > SSM > Inventory Management > Inventory Association

Configure the SSM Inventory Association stack. This stack configures the inventory association required for EC2 instance operating system (OS) configuration and management.

URI

tmod:@turbot/aws-ssm#/policy/types/inventoryAssociation

Category

AWS > SSM > Inventory Management

Parent

Targets

Valid Value

[
  "Skip",
  "Check: Configured",
  "Check: Not configured",
  "Enforce: Configured",
  "Enforce: Not configured"
]

Schema

{
  "type": "string",
  "enum": [
    "Skip",
    "Check: Configured",
    "Check: Not configured",
    "Enforce: Configured",
    "Enforce: Not configured"
  ],
  "default": "Skip"
}

AWS > SSM > Inventory Management > Inventory Association > Name

A value to add as SSM Association name.

URI

tmod:@turbot/aws-ssm#/policy/types/inventoryAssociationName

Category

AWS > SSM > Inventory Management > Inventory Association

Parent

Targets

Default Template Input

"{\n  item: account {\n      turbot{\n        id\n      }\n    }\n  associationNamePrefix: policy(uri: \"#/policy/types/inventoryAssociationNamePrefix\")\n}\n"

Default Template

"&#39;{{ $.associationNamePrefix }}Inventory&#39;"

Schema

{
  "type": "string"
}

AWS > SSM > Inventory Management > Inventory Association > Name Prefix

A value to add as SSM Association name prefix.

URI

tmod:@turbot/aws-ssm#/policy/types/inventoryAssociationNamePrefix

Category

AWS > SSM > Inventory Management > Inventory Association

Parent

Targets

Schema

{
  "type": "string",
  "default": "Turbot-"
}

AWS > SSM > Inventory Management > Inventory Association > Parameters

A value to add as SSM Association parameters.

URI

tmod:@turbot/aws-ssm#/policy/types/inventoryAssociationParameters

Category

AWS > SSM > Inventory Management > Inventory Association

Parent

Targets

Schema

{
  "type": "array",
  "items": {
    "type": "string",
    "enum": [
      "applications",
      "awsComponents",
      "billingInfo",
      "customInventory",
      "instanceDetailedInformation",
      "networkConfig",
      "services",
      "windowsRoles",
      "windowsUpdates"
    ]
  },
  "default": [
    "applications",
    "awsComponents",
    "billingInfo",
    "customInventory",
    "instanceDetailedInformation",
    "networkConfig",
    "services",
    "windowsRoles",
    "windowsUpdates"
  ]
}

AWS > SSM > Inventory Management > Inventory Association > Schedule

A value to add as SSM Association schedule.

URI

tmod:@turbot/aws-ssm#/policy/types/inventoryAssociationSchedule

Category

AWS > SSM > Inventory Management > Inventory Association

Parent

Targets

Valid Value

[
  "1 hour",
  "3 hours",
  "6 hours",
  "12 hours",
  "24 hours"
]

Schema

{
  "type": "string",
  "enum": [
    "1 hour",
    "3 hours",
    "6 hours",
    "12 hours",
    "24 hours"
  ],
  "default": "1 hour"
}

AWS > SSM > Inventory Management > Inventory Association > Source

The Terraform source used to configure the inventory association stack. This policy is read-only and is generated by Turbot based on the Inventory Association > * policies.

URI

tmod:@turbot/aws-ssm#/policy/types/inventoryAssociationSource

Category

AWS > SSM > Inventory Management > Inventory Association

Parent

Targets

Schema

{
  "type": "string",
  "x-schema-form": {
    "type": "code",
    "language": "hcl"
  }
}

AWS > SSM > Inventory Management > Inventory Association > Targets Tag Key

A key to add as SSM Association tag key.

URI

tmod:@turbot/aws-ssm#/policy/types/inventoryAssociationTargetsTagKey

Category

AWS > SSM > Inventory Management > Inventory Association

Parent

Targets

Schema

{
  "type": "string",
  "example": "turbot:InventoryCollection",
  "default": "turbot:InventoryCollection"
}

AWS > SSM > Inventory Management > Inventory Association > Targets Tag Value

A value to add as SSM Association tag value.

URI

tmod:@turbot/aws-ssm#/policy/types/inventoryAssociationTargetsTagValue

Category

AWS > SSM > Inventory Management > Inventory Association

Parent

Targets

Schema

{
  "type": "string",
  "example": "true",
  "default": "true"
}

AWS > SSM > Maintenance Window > Active

Determine the action to take when an AWS SSM maintenance window, based on the AWS > SSM > Maintenance Window > Active > * policies.

The Active control checks the status of all defined Active policies for the resource (AWS > SSM > Maintenance Window > 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-ssm#/policy/types/maintenanceWindowActive

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 > SSM > Maintenance Window > Active > Age

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

See Active for more information.

URI

tmod:@turbot/aws-ssm#/policy/types/maintenanceWindowActiveAge

Category

AWS > SSM > Maintenance Window > Active

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 > SSM > Maintenance Window > Active > Last Modified

The number of days since the AWS SSM maintenance window was last modified before it is considered inactive.

See Active for more information.

URI

tmod:@turbot/aws-ssm#/policy/types/maintenanceWindowActiveLastModified

Category

AWS > SSM > Maintenance Window > Active

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 > SSM > Maintenance Window > Approved

Determine the action to take when an AWS SSM maintenance window is not approved based on AWS > SSM > Maintenance Window > Approved > * policies.

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-ssm#/policy/types/maintenanceWindowApproved

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 > SSM > Maintenance Window > Approved > Custom

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

URI

tmod:@turbot/aws-ssm#/policy/types/maintenanceWindowApprovedCustom

Category

AWS > SSM > Maintenance Window > Approved

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 > SSM > Maintenance Window > Approved > Regions

A list of AWS regions in which AWS SSM maintenance windows 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 SSM maintenance window is created in a region that is not in the approved list, it will be subject to the action specified in the AWS > SSM > Maintenance Window > Approved policy.

See Approved for more information.

URI

tmod:@turbot/aws-ssm#/policy/types/maintenanceWindowApprovedRegions

Category

AWS > SSM > Maintenance Window > Approved

Parent

Targets

Default Template Input

"{\n  regions: policy(uri: \"tmod:@turbot/aws-ssm#/policy/types/ssmApprovedRegionsDefault\")\n}\n"

Default Template

"{% if $.regions | length == 0 %} [] {% endif %}{% for item in $.regions %}- &#39;{{ item }}&#39;\n{% endfor %}"

Schema

AWS > SSM > Maintenance Window > Approved > Usage

Determine whether the AWS SSM maintenance window is allowed to exist.

This policy will be evaluated by the Approved control. If an AWS SSM maintenance window is not approved, it will be subject to the action specified in the AWS > SSM > Maintenance Window > Approved policy.

See Approved for more information.

URI

tmod:@turbot/aws-ssm#/policy/types/maintenanceWindowApprovedUsage

Category

AWS > SSM > Maintenance Window > Approved

Parent

Targets

Valid Value

[
  "Not approved",
  "Approved",
  "Approved if AWS > SSM > Enabled"
]

Schema

{
  "type": "string",
  "enum": [
    "Not approved",
    "Approved",
    "Approved if AWS > SSM > Enabled"
  ],
  "example": [
    "Not approved"
  ],
  "default": "Approved if AWS > SSM > Enabled"
}

AWS > SSM > Maintenance Window > CMDB

Configure whether to record and synchronize details for the AWS SSM maintenance window into the CMDB.

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 > SSM > Maintenance Window > 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-ssm#/policy/types/maintenanceWindowCmdb

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 > SSM > Maintenance Window > 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-ssm#/policy/types/maintenanceWindowConfigured

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 > SSM > Maintenance Window > 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-ssm#/policy/types/maintenanceWindowConfiguredPrecedence

Category

AWS > SSM > Maintenance Window > Configured

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 > SSM > Maintenance Window > Configured > Source

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

URI

tmod:@turbot/aws-ssm#/policy/types/maintenanceWindowConfiguredSource

Category

AWS > SSM > Maintenance Window > Configured

Parent

Targets

Schema

{
  "type": "string",
  "default": "",
  "x-schema-form": {
    "type": "code",
    "language": "hcl"
  }
}

AWS > SSM > Maintenance Window > Regions

A list of AWS regions in which AWS SSM maintenance windows are supported for use.

Any maintenance windows 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-ssm#/policy/types/maintenanceWindowRegions

Category

Parent

Targets

Default Template Input

"{\n  regions: policyValue(uri:\"tmod:@turbot/aws-ssm#/policy/types/ssmRegionsDefault\") {\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 > SSM > Maintenance Window > Tags

Determine the action to take when an AWS SSM maintenance window tags are not updated based on the AWS > SSM > Maintenance Window > Tags > * policies.

The control ensure AWS SSM maintenance window tags include tags defined in AWS > SSM > Maintenance Window > Tags > Template.

Tags not defined in Maintenance Window 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-ssm#/policy/types/maintenanceWindowTags

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 > SSM > Maintenance Window > Tags > Template

The template is used to generate the keys and values for AWS SSM maintenance window.

Tags not defined in Maintenance Window 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-ssm#/policy/types/maintenanceWindowTagsTemplate

Category

AWS > SSM > Maintenance Window > Tags

Parent

Targets

Default Template Input

[
  "{\n  account {\n    turbot {\n      id\n    }\n  }\n}\n",
  "{\n  defaultTags: policyValue(uri:\"tmod:@turbot/aws-ssm#/policy/types/ssmTagsTemplate\" 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 > SSM > Maintenance Window > Usage

Configure the number of AWS SSM maintenance windows that can be used for this account and the current consumption against the limit.

You can configure the behavior of the control with this AWS > SSM > Maintenance Window > Usage policy.

URI

tmod:@turbot/aws-ssm#/policy/types/maintenanceWindowUsage

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 > SSM > Maintenance Window > Usage > Limit

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

URI

tmod:@turbot/aws-ssm#/policy/types/maintenanceWindowUsageLimit

Category

AWS > SSM > Maintenance Window > Usage

Parent

Targets

Schema

{
  "type": "integer",
  "minimum": 0,
  "default": 50
}

AWS > SSM > Managed Instance > CMDB

Configure whether to record and synchronize details for the AWS SSM managed instance into the CMDB.

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 > SSM > Managed Instance > 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-ssm#/policy/types/managedInstanceCmdb

Category

AWS > SSM > Managed Instance

Parent

Targets

Valid Value

[
  "Skip",
  "Enforce: Enabled",
  "Enforce: Disabled"
]

Schema

{
  "type": "string",
  "enum": [
    "Skip",
    "Enforce: Enabled",
    "Enforce: Disabled"
  ],
  "example": [
    "Skip"
  ],
  "default": "Enforce: Enabled"
}

AWS > SSM > Managed Instance > Regions

A list of AWS regions in which AWS SSM managed instances are supported for use.

Any managed instances 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-ssm#/policy/types/managedInstanceRegions

Category

AWS > SSM > Managed Instance

Parent

Targets

Default Template Input

"{\n  regions: policyValue(uri:\"tmod:@turbot/aws-ssm#/policy/types/ssmRegionsDefault\") {\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 > SSM > Parameter > Active

Determine the action to take when an AWS SSM parameter, based on the AWS > SSM > Parameter > Active > * policies.

The Active control checks the status of all defined Active policies for the resource (AWS > SSM > Parameter > 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-ssm#/policy/types/ssmParameterActive

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 > SSM > Parameter > Active > Age

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

See Active for more information.

URI

tmod:@turbot/aws-ssm#/policy/types/ssmParameterActiveAge

Category

AWS > SSM > Parameter > Active

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 > SSM > Parameter > Active > Budget

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

See Active for more information.

URI

tmod:@turbot/aws-ssm#/policy/types/ssmParameterActiveBudget

Category

AWS > SSM > Parameter > Active

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 > SSM > Parameter > Active > Last Modified

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

See Active for more information.

URI

tmod:@turbot/aws-ssm#/policy/types/ssmParameterActiveLastModified

Category

AWS > SSM > Parameter > Active

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 > SSM > Parameter > Approved

Determine the action to take when an AWS SSM parameter is not approved based on AWS > SSM > Parameter > Approved > * policies.

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-ssm#/policy/types/ssmParameterApproved

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 > SSM > Parameter > Approved > Budget

The policy allows you to set parameters 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 SSM parameter is not matched by the approved list, it will be subject to the action specified in the AWS > SSM > Parameter > Approved policy.

See Approved for more information.

URI

tmod:@turbot/aws-ssm#/policy/types/ssmParameterApprovedBudget

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 > SSM > Parameter > Approved > Custom

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

URI

tmod:@turbot/aws-ssm#/policy/types/ssmParameterApprovedCustom

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 > SSM > Parameter > Approved > Parameter Type

A list of parameter type that the AWS SSM parameter is approved to use.

The expected format is an array of parameter type. You may use the * and ? wildcard characters (and more).

example:
  SecureString

See Approved for more information.

URI

tmod:@turbot/aws-ssm#/policy/types/ssmParameterApprovedParameterType

Category

Parent

Targets

Schema

{
  "type": "array",
  "default": [
    "*"
  ],
  "items": {
    "type": "string",
    "pattern": "^[a-zA-Z0-9.?*]+$"
  }
}

AWS > SSM > Parameter > Approved > Regions

A list of AWS regions in which AWS SSM parameters 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 SSM parameter is created in a region that is not in the approved list, it will be subject to the action specified in the AWS > SSM > Parameter > Approved policy.

See Approved for more information.

URI

tmod:@turbot/aws-ssm#/policy/types/ssmParameterApprovedRegions

Category

Parent

Targets

Default Template Input

"{\n  regions: policy(uri: \"tmod:@turbot/aws-ssm#/policy/types/ssmApprovedRegionsDefault\")\n}\n"

Default Template

"{% if $.regions | length == 0 %} [] {% endif %}{% for item in $.regions %}- &#39;{{ item }}&#39;\n{% endfor %}"

Schema

AWS > SSM > Parameter > Approved > Usage

Determine whether the AWS SSM parameter is allowed to exist.

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

See Approved for more information.

URI

tmod:@turbot/aws-ssm#/policy/types/ssmParameterApprovedUsage

Category

Parent

Targets

Valid Value

[
  "Not approved",
  "Approved",
  "Approved if AWS > SSM > Enabled"
]

Schema

{
  "type": "string",
  "enum": [
    "Not approved",
    "Approved",
    "Approved if AWS > SSM > Enabled"
  ],
  "example": [
    "Not approved"
  ],
  "default": "Approved if AWS > SSM > Enabled"
}

AWS > SSM > Parameter > CMDB

Configure whether to record and synchronize details for the AWS SSM parameter into the CMDB.

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 > SSM > Parameter > 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-ssm#/policy/types/ssmParameterCmdb

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 > SSM > Parameter > CMDB > Included Parameter Value Types

Configure whether to diplay the SSM parameter types' values in the CMDB. Values for the parameter types that are not selected will be stored as <sensitive>.

URI

tmod:@turbot/aws-ssm#/policy/types/ssmParameterIncludedParameterValueTypes

Category

AWS > SSM > Parameter > CMDB

Parent

Targets

Resource > Encryption at Rest

Schema

{
  "type": "array",
  "items": {
    "type": "string",
    "enum": [
      "String",
      "StringList",
      "SecureString"
    ]
  },
  "default": [
    "String",
    "StringList",
    "SecureString"
  ]
}

AWS > SSM > Parameter > Encryption at Rest

Define the Encryption at Rest settings required for AWS > SSM > Parameter.

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 > SSM > Parameter > Encryption at Rest > *), raises an alarm, and takes the defined enforcement action

URI

tmod:@turbot/aws-ssm#/policy/types/ssmParameterEncryptionAtRest

Category

Parent

Targets

Resource > Encryption at Rest

Valid Value

[
  "Skip",
  "Check: AWS managed key",
  "Check: AWS managed key or higher",
  "Check: Customer managed key",
  "Check: Encryption at Rest > Customer Managed Key",
  "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: AWS managed key",
    "Check: AWS managed key or higher",
    "Check: Customer managed key",
    "Check: Encryption at Rest > Customer Managed Key",
    "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 > SSM > Parameter > Encryption at Rest > Customer Managed Key

Define the KMS key ID for encryption at rest.

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-ssm#/policy/types/ssmParameterEncryptionAtRestCustomerManagedKey

Category

Parent

AWS > SSM > Parameter > Encryption at Rest

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 > SSM > Parameter > Regions

A list of AWS regions in which AWS SSM parameters are supported for use.

Any parameters 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-ssm#/policy/types/ssmParameterRegions

Category

Parent

Targets

Default Template Input

"{\n  regions: policyValue(uri:\"tmod:@turbot/aws-ssm#/policy/types/ssmRegionsDefault\") {\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 > SSM > Parameter > Tags

Determine the action to take when an AWS SSM parameter tags are not updated based on the AWS > SSM > Parameter > Tags > * policies.

The control ensure AWS SSM parameter tags include tags defined in AWS > SSM > Parameter > Tags > Template.

Tags not defined in Parameter 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-ssm#/policy/types/ssmParameterTags

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 > SSM > Parameter > Tags > Template

The template is used to generate the keys and values for AWS SSM parameter.

Tags not defined in Parameter 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-ssm#/policy/types/ssmParameterTagsTemplate

Category

AWS > SSM > Parameter > Tags

Parent

Targets

Default Template Input

[
  "{\n  account {\n    turbot {\n      id\n    }\n  }\n}\n",
  "{\n  defaultTags: policyValue(uri:\"tmod:@turbot/aws-ssm#/policy/types/ssmTagsTemplate\" 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 > SSM > Parameter > Usage

Configure the number of AWS SSM parameters 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 > SSM > Parameter > Usage policy.

URI

tmod:@turbot/aws-ssm#/policy/types/ssmParameterUsage

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 > SSM > Parameter > Usage > Limit

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

URI

tmod:@turbot/aws-ssm#/policy/types/ssmParameterUsageLimit

Category

AWS > SSM > Parameter > Usage

Parent

Targets

Schema

{
  "type": "integer",
  "minimum": 0,
  "default": 10000
}

AWS > SSM > Permissions

Configure whether permissions policies are in effect for AWS SSM.

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-ssm#/policy/types/ssmPermissions

Category

Parent

Targets

Valid Value

[
  "Enabled",
  "Disabled",
  "Enabled if AWS > SSM > Enabled & AWS > SSM > API Enabled"
]

Schema

{
  "type": "string",
  "enum": [
    "Enabled",
    "Disabled",
    "Enabled if AWS > SSM > Enabled & AWS > SSM > API Enabled"
  ],
  "example": [
    "Enabled"
  ],
  "default": "Enabled if AWS > SSM > Enabled & AWS > SSM > API Enabled"
}

AWS > SSM > 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-ssm#/policy/types/ssmPermissionsLevels

Category

Parent

AWS > SSM > Permissions

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 > SSM > 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:
  - &quot;glacier:createvault&quot;: admin
  - &quot;glacier:ListVaults&quot;: metadata
  - &quot;s3:DeleteBucket&quot;: none

URI

tmod:@turbot/aws-ssm#/policy/types/ssmPermissionsLevelsModifiers

Category

AWS > SSM > Permissions > Levels

Parent

Targets

aws-iam#/definitions/awsModifierList

Schema

AWS > SSM > Permissions > Lockdown

URI

tmod:@turbot/aws-ssm#/policy/types/ssmPermissionsLockdown

Category

Parent

AWS > SSM > Permissions

Targets

AWS > SSM > Permissions > Lockdown > API Boundary

Configure whether the AWS ssm 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-ssm#/policy/types/ssmPermissionsLockdownApiBoundary

Category

AWS > SSM > Permissions > Lockdown

Parent

Targets

Valid Value

[
  "Enabled if AWS > SSM > API Enabled"
]

Schema

{
  "type": "string",
  "enum": [
    "Enabled if AWS > SSM > API Enabled"
  ],
  "example": [
    "Enabled if AWS > SSM > API Enabled"
  ],
  "default": "Enabled if AWS > SSM > API Enabled"
}

AWS > SSM > Regions

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

URI

tmod:@turbot/aws-ssm#/policy/types/ssmRegionsDefault

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 > SSM > 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-ssm#/policy/types/ssmStack

Category

Parent

Targets

Valid Value

[
  "Skip",
  "Check: Configured",
  "Enforce: Configured"
]

Schema

{
  "type": "string",
  "enum": [
    "Skip",
    "Check: Configured",
    "Enforce: Configured"
  ],
  "default": "Skip"
}

AWS > SSM > Stack > Secret Variables

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

URI

tmod:@turbot/aws-ssm#/policy/types/ssmStackSecretVariables

Category

Parent

Targets

Schema

{
  "type": "string",
  "x-schema-form": {
    "type": "code",
    "language": "hcl"
  }
}

AWS > SSM > Stack > Source

The Terraform HCL source used to configure this stack.

URI

tmod:@turbot/aws-ssm#/policy/types/ssmStackSource

Category

Parent

Targets

Schema

{
  "type": "string",
  "default": "",
  "x-schema-form": {
    "type": "code",
    "language": "hcl"
  }
}

AWS > SSM > 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.

URI

tmod:@turbot/aws-ssm#/policy/types/ssmStackTerraformVersion

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 > SSM > Stack > Variables

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

URI

tmod:@turbot/aws-ssm#/policy/types/ssmStackVariables

Category

Parent

Targets

Schema

{
  "type": "string",
  "x-schema-form": {
    "type": "code",
    "language": "hcl"
  }
}

AWS > SSM > Tags Template [Default]

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

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

URI

tmod:@turbot/aws-ssm#/policy/types/ssmTagsTemplate

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 > Turbot > Event Handlers > Events > Rules > Custom Event Patterns > @turbot/aws-ssm

The CloudWatch Events event pattern used by the AWS SSM module to specify which events to forward to the Turbot Event Handlers.

URI

tmod:@turbot/aws-ssm#/policy/types/ssmCustomEventPatterns

Category

AWS > Turbot > Event Handlers > Events > Rules > Custom Event Patterns

Parent

Targets

Schema

{
  "type": "array",
  "items": {
    "type": "object"
  }
}

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

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

URI

tmod:@turbot/aws-ssm#/policy/types/awsCompiledApiBoundary

Category

AWS > Turbot > Permissions > Compiled > API Boundary

Parent

Targets

Schema

{
  "type": "array"
}

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

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

URI

tmod:@turbot/aws-ssm#/policy/types/awsLevelsCompiled

Category

AWS > Turbot > Permissions > Compiled > Levels

Parent

Targets

aws-iam#/definitions/awsLevelDefinitionList

Schema

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

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

URI

tmod:@turbot/aws-ssm#/policy/types/awsCompiledServicePermissions

Category

AWS > Turbot > Permissions > Compiled > Service Permissions

Parent

Targets