terraform-aws-ssm-parameter

Terraform module which creates SSM Parameter resources on AWS.

Description

Provision SSM Parameter.

This module provides recommended settings:

• Use SecureString as default
• Avoid overwrite of unmanaged existing resource

Usage

Minimal

module "ssm_parameter" {
  source = "git::https://github.com/tmknom/terraform-aws-ssm-parameter.git?ref=tags/2.0.0"
  name   = "example"
}

Complete

module "ssm_parameter" {
  source = "git::https://github.com/tmknom/terraform-aws-ssm-parameter.git?ref=tags/2.0.0"
  name   = "example"
  value  = "example value"

  type            = "String"
  description     = "This is example."
  key_id          = ""
  overwrite       = true
  allowed_pattern = ""
  enabled         = true

  tags = {
    Environment = "prod"
    Name        = "example"
  }
}

Examples

• Minimal
• Complete

Requirements

Name	Version
terraform	>= 0.12

Providers

Name	Version
aws	n/a

Inputs

Name	Description	Type	Default	Required
name	The name of the parameter.	string	n/a	yes
allowed_pattern	A regular expression used to validate the parameter value.	string	""	no
description	The description of the parameter.	string	"Managed by Terraform"	no
enabled	Set to false to prevent the module from creating anything.	bool	true	no
key_id	The KMS key id or arn for encrypting a SecureString.	string	""	no
overwrite	Overwrite an existing parameter.	string	false	no
tags	A mapping of tags to assign to the object.	map(string)	{}	no
type	The type of the parameter. Valid types are String, StringList and SecureString.	string	"SecureString"	no
value	The value of the parameter.	string	"CHANGE ME"	no

Outputs

Name	Description
ssm_parameter_arn	The ARN of the parameter.
ssm_parameter_description	The description of the parameter.
ssm_parameter_name	The name of the parameter.
ssm_parameter_type	The type of the parameter.
ssm_parameter_value	The value of the parameter.

Development

Development Requirements

• Docker

Configure environment variables

export AWS_ACCESS_KEY_ID=AKIAIOSFODNN7EXAMPLE
export AWS_SECRET_ACCESS_KEY=wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
export AWS_DEFAULT_REGION=ap-northeast-1

Installation

git clone git@github.com:tmknom/terraform-aws-ssm-parameter.git
cd terraform-aws-ssm-parameter
make install

Makefile targets

apply-complete                 Run terraform apply examples/complete
apply-minimal                  Run terraform apply examples/minimal
bump-version                   Bump version (Required argument 'VERSION')
check-format                   Check format code
clean                          Clean .terraform
destroy-complete               Run terraform destroy examples/complete
destroy-minimal                Run terraform destroy examples/minimal
diff                           Word diff
docs                           Generate docs
format                         Format code
help                           Show help
install                        Install requirements
lint                           Lint code
plan-complete                  Run terraform plan examples/complete
plan-minimal                   Run terraform plan examples/minimal
release                        Release GitHub and Terraform Module Registry
upgrade                        Upgrade makefile

Releasing new versions

Bump VERSION file, and run make release.

Terraform Module Registry

• https://registry.terraform.io/modules/tmknom/ssm-parameter/aws

License

Apache 2 Licensed. See LICENSE for full details.