# tf-aws-keypair
> AWS CDK [L1 construct](https://docs.aws.amazon.com/cdk/latest/guide/constructs.html) and data structures for the [AWS CloudFormation Registry](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry.html) type `TF::AWS::KeyPair` v1.0.0.
## Description
Provides an [EC2 key pair](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html) resource. A key pair is used to control login access to EC2 instances.
Currently this resource requires an existing user-supplied key pair. This key pair's public key will be registered with AWS to allow logging-in to EC2 instances.
When importing an existing key pair the public key material may be in any format supported by AWS. Supported formats (per the [AWS documentation](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html#how-to-generate-your-own-key-and-import-it-to-aws)) are:
* OpenSSH public key format (the format in ~/.ssh/authorized_keys)
* Base64 encoded DER format
* SSH public key file format as specified in RFC4716
## References
* [Documentation](https://github.com/iann0036/cfn-tf-custom-types/blob/docs/resources/aws/TF-AWS-KeyPair/docs/README.md)
* [Source](https://github.com/iann0036/cfn-tf-custom-types.git)
## Usage
In order to use this library, you will need to activate this AWS CloudFormation Registry type in your account. You can do this via the AWS Management Console or using the [AWS CLI](https://aws.amazon.com/cli/) using the following command:
```sh
aws cloudformation activate-type \
--type-name TF::AWS::KeyPair \
--publisher-id e1238fdd31aee1839e14fb3fb2dac9db154dae29 \
--type RESOURCE \
--execution-role-arn ROLE-ARN
```
Alternatively:
```sh
aws cloudformation activate-type \
--public-type-arn arn:aws:cloudformation:us-east-1::type/resource/e1238fdd31aee1839e14fb3fb2dac9db154dae29/TF-AWS-KeyPair \
--execution-role-arn ROLE-ARN
```
You can find more information about activating this type in the [AWS CloudFormation documentation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-public.html).
## Feedback
This library is auto-generated and published to all supported programming languages by the [cdklabs/cdk-cloudformation](https://github.com/cdklabs/cdk-cloudformation) project based on the API schema published for `TF::AWS::KeyPair`.
* Issues related to this generated library should be [reported here](https://github.com/cdklabs/cdk-cloudformation/issues/new?title=Issue+with+%40cdk-cloudformation%2Ftf-aws-keypair+v1.0.0).
* Issues related to `TF::AWS::KeyPair` should be reported to the [publisher](https://github.com/iann0036/cfn-tf-custom-types/blob/docs/resources/aws/TF-AWS-KeyPair/docs/README.md).
## License
Distributed under the Apache-2.0 License.
Raw data
{
"_id": null,
"home_page": "https://github.com/iann0036/cfn-tf-custom-types/blob/docs/resources/aws/TF-AWS-KeyPair/docs/README.md",
"name": "cdk-cloudformation-tf-aws-keypair",
"maintainer": "",
"docs_url": null,
"requires_python": "~=3.7",
"maintainer_email": "",
"keywords": "",
"author": "Amazon Web Services",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/b8/ee/6aa3722c5eaba9a4c674b662ee9128dc83d5150c5a2b2be3cf31fdcf3576/cdk-cloudformation-tf-aws-keypair-1.0.0a7.tar.gz",
"platform": null,
"description": "# tf-aws-keypair\n\n> AWS CDK [L1 construct](https://docs.aws.amazon.com/cdk/latest/guide/constructs.html) and data structures for the [AWS CloudFormation Registry](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry.html) type `TF::AWS::KeyPair` v1.0.0.\n\n## Description\n\nProvides an [EC2 key pair](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html) resource. A key pair is used to control login access to EC2 instances.\n\nCurrently this resource requires an existing user-supplied key pair. This key pair's public key will be registered with AWS to allow logging-in to EC2 instances.\n\nWhen importing an existing key pair the public key material may be in any format supported by AWS. Supported formats (per the [AWS documentation](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html#how-to-generate-your-own-key-and-import-it-to-aws)) are:\n\n* OpenSSH public key format (the format in ~/.ssh/authorized_keys)\n* Base64 encoded DER format\n* SSH public key file format as specified in RFC4716\n\n## References\n\n* [Documentation](https://github.com/iann0036/cfn-tf-custom-types/blob/docs/resources/aws/TF-AWS-KeyPair/docs/README.md)\n* [Source](https://github.com/iann0036/cfn-tf-custom-types.git)\n\n## Usage\n\nIn order to use this library, you will need to activate this AWS CloudFormation Registry type in your account. You can do this via the AWS Management Console or using the [AWS CLI](https://aws.amazon.com/cli/) using the following command:\n\n```sh\naws cloudformation activate-type \\\n --type-name TF::AWS::KeyPair \\\n --publisher-id e1238fdd31aee1839e14fb3fb2dac9db154dae29 \\\n --type RESOURCE \\\n --execution-role-arn ROLE-ARN\n```\n\nAlternatively:\n\n```sh\naws cloudformation activate-type \\\n --public-type-arn arn:aws:cloudformation:us-east-1::type/resource/e1238fdd31aee1839e14fb3fb2dac9db154dae29/TF-AWS-KeyPair \\\n --execution-role-arn ROLE-ARN\n```\n\nYou can find more information about activating this type in the [AWS CloudFormation documentation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-public.html).\n\n## Feedback\n\nThis library is auto-generated and published to all supported programming languages by the [cdklabs/cdk-cloudformation](https://github.com/cdklabs/cdk-cloudformation) project based on the API schema published for `TF::AWS::KeyPair`.\n\n* Issues related to this generated library should be [reported here](https://github.com/cdklabs/cdk-cloudformation/issues/new?title=Issue+with+%40cdk-cloudformation%2Ftf-aws-keypair+v1.0.0).\n* Issues related to `TF::AWS::KeyPair` should be reported to the [publisher](https://github.com/iann0036/cfn-tf-custom-types/blob/docs/resources/aws/TF-AWS-KeyPair/docs/README.md).\n\n## License\n\nDistributed under the Apache-2.0 License.\n\n\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Provides an [EC2 key pair](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html) resource. A key pair is used to control login access to EC2 instances.",
"version": "1.0.0a7",
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0b8ffaeffe009f78000e276f66b5fea96934c1b71c8ffdaaf84cbc8231d36a84",
"md5": "bcb1ffb4b17fa21993ec040d091c7d86",
"sha256": "2517d4113a56ca9412e81b6e4c63d4dd4411a5172cde5d063d51f66ed0e34268"
},
"downloads": -1,
"filename": "cdk_cloudformation_tf_aws_keypair-1.0.0a7-py3-none-any.whl",
"has_sig": false,
"md5_digest": "bcb1ffb4b17fa21993ec040d091c7d86",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "~=3.7",
"size": 32759,
"upload_time": "2023-02-03T16:18:35",
"upload_time_iso_8601": "2023-02-03T16:18:35.103344Z",
"url": "https://files.pythonhosted.org/packages/0b/8f/faeffe009f78000e276f66b5fea96934c1b71c8ffdaaf84cbc8231d36a84/cdk_cloudformation_tf_aws_keypair-1.0.0a7-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b8ee6aa3722c5eaba9a4c674b662ee9128dc83d5150c5a2b2be3cf31fdcf3576",
"md5": "a95e004848d431adadc377112ca8c039",
"sha256": "00364c8578ca783a637c19b7b09fde7e4f640ecbd023fd5b8efe2c4977cf08e1"
},
"downloads": -1,
"filename": "cdk-cloudformation-tf-aws-keypair-1.0.0a7.tar.gz",
"has_sig": false,
"md5_digest": "a95e004848d431adadc377112ca8c039",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "~=3.7",
"size": 33620,
"upload_time": "2023-02-03T16:18:38",
"upload_time_iso_8601": "2023-02-03T16:18:38.941555Z",
"url": "https://files.pythonhosted.org/packages/b8/ee/6aa3722c5eaba9a4c674b662ee9128dc83d5150c5a2b2be3cf31fdcf3576/cdk-cloudformation-tf-aws-keypair-1.0.0a7.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-02-03 16:18:38",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "cdk-cloudformation-tf-aws-keypair"
}
JSON