Terrablox
GitHubStart
Module library

SSM Parameter Store

Terraform module to create AWS SSM Parameter resources

Version
v2.1.2
Repository
terrablox-aws-ssm-parameter

Inputs

16
allowed_patternoptionalstring

Regular expression used to validate the parameter value

Defaultnull
createoptionalbool

Whether to create SSM Parameter

Defaulttrue
data_typeoptionalstring

Data type of the parameter. Valid values: `text`, `aws:ssm:integration` and `aws:ec2:image` for AMI format, see the [Native parameter support for Amazon Machine Image IDs](https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-ec2-aliases.html)

Defaultnull
descriptionoptionalstring

Description of the parameter

Defaultnull
ignore_value_changesoptionalbool

Whether to create SSM Parameter and ignore changes in value

Defaultfalse
key_idoptionalstring

KMS key ID or ARN for encrypting a `SecureString`

Defaultnull
nameoptionalstring

Name of the parameter. If the name contains a path (e.g., any forward slashes (`/`)), it must be fully qualified with a leading forward slash (`/`)

Defaultnull
overwriteoptionalbool

Overwrite an existing parameter. If not specified, defaults to `false` during create operations to avoid overwriting existing resources and then `true` for all subsequent operations once the resource is managed by Terraform

Defaultnull
regionoptionalstring

Region where the resource(s) will be managed. Defaults to the Region set in the provider configuration

Defaultnull
secure_typeoptionalbool

Whether the type of the value should be considered as secure or not

Defaultfalse
tagsoptionalmap(string)

A map of tags to add to all resources

Default{}
tieroptionalstring

Parameter tier to assign to the parameter. If not specified, will use the default parameter tier for the region. Valid tiers are Standard, Advanced, and Intelligent-Tiering. Downgrading an Advanced tier parameter to Standard will recreate the resource

Defaultnull
typeoptionalstring

Type of the parameter. Valid types are `String`, `StringList` and `SecureString`

Defaultnull
valueoptionalstring

Value of the parameter

Defaultnull
value_wo_versionoptionalnumber

Value of the parameter. This value is always marked as sensitive in the Terraform plan output, regardless of type. Additionally, write-only values are never stored to state. `value_wo_version` can be used to trigger an update and is required with this argument

Defaultnull
valuesoptionallist(string)

List of values of the parameter (will be jsonencoded to store as string natively in SSM)

Default[]

All 16 are optional — the module deploys with none of them set.

Outputs

9
insecure_value

Insecure value of the parameter

raw_value

Raw value of the parameter (as it is stored in SSM). Use 'value' output to get jsondecode'd value

secure_type

Whether SSM parameter is a SecureString or not?

secure_value

Secure value of the parameter

ssm_parameter_arn

The ARN of the parameter

ssm_parameter_name

Name of the parameter

ssm_parameter_type

Type of the parameter

ssm_parameter_version

Version of the parameter

value

Parameter value after jsondecode(). Probably this is what you are looking for

What the agent wires into the next module. An edge on the architecture diagram is one of these consumed by something else.