terraform-aws-kms-key

Terraform module to provision a KMS key with alias.

Can be used with chamber for managing secrets by storing them in Amazon EC2 Systems Manager Parameter Store.

Usage

module "kms_key" {
  source                  = "git::https://github.com/cloudposse/terraform-aws-kms-key.git?ref=master"
  namespace               = "cp"
  stage                   = "prod"
  name                    = "app"
  description             = "KMS key for chamber"
  deletion_window_in_days = 10
  enable_key_rotation     = "true"
  alias                   = "alias/parameter_store_key"
}

Variables

Name	Default	Description	Required
`namespace`	``	Namespace (e.g. `cp` or `cloudposse`)	Yes
`stage`	``	Stage (e.g. `prod`, `dev`, `staging`)	Yes
`name`	``	Application or solution name (e.g. `app`)	Yes
`attributes`	`[]`	Additional attributes (e.g. `policy` or `role`)	No
`tags`	`{}`	Additional tags (e.g. `map("Cluster","xyz")`	No
`delimiter`	`-`	Delimiter to be used between `namespace`, `stage`, `name`, and `attributes`	No
`alias`	``	The display name of the alias. The name must start with the word `alias` followed by a forward slash	No
`deletion_window_in_days`	`10`	Duration in days after which the key is deleted after destruction of the resource	No
`enable_key_rotation`	`true`	Specifies whether key rotation is enabled	No
`description`	`Parameter Store KMS master key`	The description of the key as viewed in AWS console	No

NOTE: To use the KMS key with chamber, the alias must be set to alias/parameter_store_key.

NOTE: If alias is not specified, format("alias/%v", module.label.id) will be used instead.

Outputs

Name	Description
`key_arn`	Key ARN
`key_id`	Key ID
`alias_arn`	Alias ARN
`alias_name`	Alias name

Help

Got a question?

File a GitHub issue, send us an email or reach out to us on Gitter.

Contributing

Bug Reports & Feature Requests

Please use the issue tracker to report any bugs or file feature requests.

Developing

If you are interested in being a contributor and want to get involved in developing terraform-aws-kms-key, we would love to hear from you! Shoot us an email.

In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.

Fork the repo on GitHub
Clone the project to your own machine
Commit changes to your own branch
Push your work back up to your fork
Submit a Pull request so that we can review your changes

NOTE: Be sure to merge the latest from "upstream" before making a pull request!

License

See LICENSE for full details.

Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements.  See the NOTICE file
distributed with this work for additional information
regarding copyright ownership.  The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License.  You may obtain a copy of the License at

  http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied.  See the License for the
specific language governing permissions and limitations
under the License.

About

terraform-aws-kms-key is maintained and funded by Cloud Posse, LLC.

Like it? Please let us know at [email protected]

We love Open Source Software!

See our other projects or hire us to help build your next cloud platform.

Contributors

Erik Osterman	Andriy Knysh

brunogain / terraform-aws-kms-key Goto Github PK