Code Monkey home page Code Monkey logo

terraform-aws-ssm-parameter's Introduction

terraform-aws-ssm-parameter

Terraform Actions Status Markdown Actions Status YAML Actions Status JSON Actions Status GitHub tag License

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

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

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 [email protected]: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

License

Apache 2 Licensed. See LICENSE for full details.

terraform-aws-ssm-parameter's People

Contributors

kimxogus avatar tmknom avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.