checkSsmParameter

Check AWS Systems Manager (SSM) and related SSM security settings.

• Parameter existence and type

Parameters

checkSsmParameter: str

Check the AWS SSM parameter

aliases: checkSsmParam CheckAwsSsmParameter, checkAWSSSMParameter

type: str (Optional)

The type of parameter

default: ‘String’

allowed values: ‘String’, ‘StringList’, ‘SecureString’, None

profile: str (Optional)

An alternative profile name to use for AWS authentication

desc: str (Optional)

The description for the check

substitute: bool (Optional)

Whether to substitute environment variables in check values

default: True

aliases: substitute, env_substitute

Example 1 (yaml)

The checkSsmParameter check in YAML format.

AWS:
  SSMParameters:
      ContainerUrl:
        desc: The container image url
        checkSsmParam: "/myproject/dev/containerImageUrl"

Example 2 (toml)

The checkSsmParameter check in TOML format.

[AWS.SSMParameters.ContainerUrl]
desc = "The container image url"
checkSsmParam = "/myproject/dev/containerImageUrl"

Example 3 (toml)

The checkSsmParameter check in abbreviated TOML format.

[AWS.SSMParameters]
ContainerUrl = {desc = "The container image url", checkSsmParam = "/myproject/dev/containerImageUrl"}

New in version 1.2.1.