Skip to main content

CDK Construct for managing EC2 key pairs

Project description

CDK EC2 Key Pair

Source Docs npm version PyPI version NuGet version GitHub

AWS CDK L3 construct for managing EC2 Key Pairs.

CloudFormation doesn't directly support creation of EC2 Key Pairs. This construct provides an easy interface for creating Key Pairs through a custom CloudFormation resource. The private key is stored in AWS Secrets Manager.

Usage

# Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
import aws_cdk.core as cdk
import aws_cdk.aws_ec2 as ec2
from cdk_ec2_key_pair import KeyPair

# Create the Key Pair
key = KeyPair(self, "A-Key-Pair",
    name="a-key-pair",
    description="This is a Key Pair"
)

# Grant read access to the private key to a role or user
key.grant_read(some_role)

# Use Key Pair on an EC2 instance
ec2.Instance(self, "An-Instance", {
    "key_name": key.name
})

The private key will be stored in AWS Secrets Manager. The secret name is prefixed with ec2-private-key/, so in this example it will be saved as ec2-private-key/a-key-pair.

Roadmap

  • Secret prefix should be configurable
  • Name should be optional
  • Automated Tests
  • Tagging support in a more standard way

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cdk-ec2-key-pair-1.0.1.tar.gz (26.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

cdk_ec2_key_pair-1.0.1-py3-none-any.whl (25.7 kB view details)

Uploaded Python 3

File details

Details for the file cdk-ec2-key-pair-1.0.1.tar.gz.

File metadata

  • Download URL: cdk-ec2-key-pair-1.0.1.tar.gz
  • Upload date:
  • Size: 26.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/41.6.0 requests-toolbelt/0.9.1 tqdm/4.43.0 CPython/3.7.5

File hashes

Hashes for cdk-ec2-key-pair-1.0.1.tar.gz
Algorithm Hash digest
SHA256 51b449c33362ff0fb044d44626dba7e025a60b4fe492c889ec4c81a13e021c29
MD5 a566dd2dc029151b49fa7a532fa3eef9
BLAKE2b-256 082b267e719507353eb2c11ffa9da409efabc1297298e5d27dd1af7d026412b7

See more details on using hashes here.

File details

Details for the file cdk_ec2_key_pair-1.0.1-py3-none-any.whl.

File metadata

  • Download URL: cdk_ec2_key_pair-1.0.1-py3-none-any.whl
  • Upload date:
  • Size: 25.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/41.6.0 requests-toolbelt/0.9.1 tqdm/4.43.0 CPython/3.7.5

File hashes

Hashes for cdk_ec2_key_pair-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 d0816efa35279f6ab6693f96f8684d0d7cde40c952c929fc174aba95010ffd75
MD5 97f0ae7df9880ca301a4e4295d6fdcd6
BLAKE2b-256 000aa59f3bcce275feee0ac277669f8c6b9825c22e3a0d86898c5e90c0126ac0

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page