terraform-aws-key-pair

Terraform module for generating or importing an SSH public key file into AWS.

Usage

IMPORTANT: The master branch is used in source just as an example. In your code, do not pin to master because there may be breaking changes between releases. Instead pin to the release tag (e.g. ?ref=tags/x.y.z) of one of our latest releases.

module "ssh_key_pair" {
  source                = "git::https://github.com/ceibo-it/terraform-aws-key-pair.git?ref=master"
  namespace             = "eg"
  stage                 = "prod"
  name                  = "app"
  ssh_public_key_path   = "/secrets"
  generate_ssh_key      = "true"
  private_key_extension = ".pem"
  public_key_extension  = ".pub"
}

Inputs

Name	Description	Type	Default	Required
attributes	Additional attributes (e.g. 1)	list(string)	<list>	no
delimiter	Delimiter to be used between namespace, environment, stage, name and attributes	string	-	no
environment	Environment, e.g. 'prod', 'staging', 'dev', 'pre-prod', 'UAT'	string	``	no
generate_ssh_key	If set to true, new SSH key pair will be created	bool	false	no
name	Solution name, e.g. 'app' or 'jenkins'	string	``	no
namespace	Namespace, which could be your organization name or abbreviation, e.g. 'eg' or 'cp'	string	``	no
private_key_extension	Private key extension	string	``	no
public_key_extension	Public key extension	string	.pub	no
ssh_key_algorithm	SSH key algorithm	string	RSA	no
ssh_public_key_path	Path to SSH public key directory (e.g. /secrets)	string	-	yes
stage	Stage, e.g. 'prod', 'staging', 'dev', OR 'source', 'build', 'test', 'deploy', 'release'	string	``	no
tags	Additional tags (e.g. map('BusinessUnit','XYZ')	map(string)	<map>	no

Outputs

Name	Description
key_name	Name of SSH key
private_key	Content of the generated private key
private_key_filename	Private Key Filename
public_key	Content of the generated public key
public_key_filename	Public Key Filename

Copyright

Copyright © 2020 Ceibo IT

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

  https://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.

Trademarks

All other trademarks referenced herein are the property of their respective owners.

NOTICE

terraform-aws-key-pair Copyright 2020 Ceibo

This product includes software developed by Cloud Posse, LLC (c) (https://cloudposse.com/) Licensed under Apache License, Version 2.0 Copyright © 2017-2019 Cloud Posse, LLC