Terraform module for generating or importing an SSH public key file into AWS.
Usage
module "ssh_key_pair" {
source = "git::https://github.com/cloudposse/terraform-aws-key-pair.git?ref=master"
namespace = "cp"
stage = "prod"
name = "app"
ssh_public_key_path = "/secrets"
generate_ssh_key = "true"
private_key_extension = ".pem"
public_key_extension = ".pub"
chmod_command = "chmod 600 %v"
}
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 |
ssh_public_key_path |
`` | Path to SSH public key directory (e.g. /secrets ) |
Yes |
generate_ssh_key |
false |
If set to true , new SSH key pair will be created |
No |
private_key_extension |
`` | Private key file extension (e.g. .pem ) |
No |
public_key_extension |
.pub |
Public key file extension (e.g. .pub ) |
No |
chmod_command |
chmod 600 %v |
Template of the command executed on the private key file | Yes(Linux), No(Windows) |
Outputs
Name | Description |
---|---|
key_name |
Name of SSH key |
public_key |
Contents of the generated public key |
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-key-pair
, 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
APACHE 2.0 © 2017-2018 Cloud Posse, LLC
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-key-pair
is maintained and funded by Cloud Posse, LLC.
Like it? Please let us know at hello@cloudposse.com
We love Open Source Software!
See our other projects or hire us to help build your next cloud platform.
Contributors
Erik Osterman |
Andriy Knysh |
---|