[ aws . iam ]
Description¶
I'm using the following: Windows 10 Visual Studio Code v1.17.0 Terraform v0.10.3 AWS I'm very new to Terraform. I've been reading a series of posts here which have been very helpful I'm strug. Feb 17, 2020 Terraform module for generating or importing an SSH public key file into AWS. This project is part of our comprehensive 'SweetOps' approach towards DevOps. It's 100% Open Source and licensed under the APACHE2. We literally have hundreds of terraform modules that are Open Source and well-maintained. Tutorial and source code explaining how to manage AWS EC2 Instances and Security with Terraform. EC2 Instances and Resource Security. This is the continuation of a AWS Terraform demo to create a VPC in AWS with an EC2 instance connected to MariaDB database running in RDS using a single Terraform plan. Continue the demo, see: Terraform Setup and VPC Subnet Creation. This will create an SSH key pair that lives in the Terraform state (it is not written to disk in files other than what might be done for the Terraform state itself when not using remote state), creates an AWS key pair based on the public key and then creates an Ubuntu 14.04 instance where the ubuntu user is accessible with the private key that was generated.
Uploads an SSH public key and associates it with the specified IAM user.
The SSH public key uploaded by this operation can be used only for authenticating the associated IAM user to an AWS CodeCommit repository. For more information about using SSH keys to authenticate to an AWS CodeCommit repository, see Set up AWS CodeCommit for SSH Connections in the AWS CodeCommit User Guide .
See also: AWS API Documentation
See 'aws help' for descriptions of global parameters.
Synopsis¶
Options¶
--user-name (string)
The name of the IAM user to associate the SSH public key with.
This parameter allows (through its regex pattern ) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
--ssh-public-key-body (string)
The SSH public key. The public key must be encoded in ssh-rsa format or PEM format. The minimum bit-length of the public key is 2048 bits. For example, you can generate a 2048-bit key, and the resulting PEM file is 1679 bytes long.
The regex pattern used to validate this parameter is a string of characters consisting of the following:
- Any printable ASCII character ranging from the space character (u0020 ) through the end of the ASCII character range
- The printable characters in the Basic Latin and Latin-1 Supplement character set (through u00FF )
- The special characters tab (u0009 ), line feed (u000A ), and carriage return (u000D )
--cli-input-json (string)Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.
--generate-cli-skeleton (string)Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.
See 'aws help' for descriptions of global parameters.
Examples¶
To upload an SSH public key and associate it with a user
The following upload-ssh-public-key command uploads the public key found in the file 'sshkey.pub' and attaches it to the user 'sofia'.
Windows 10 key generator 32 bit. Output:
For more information about how to generate keys in a format suitable for this command, see `SSH and Linux, macOS, or Unix: Set Up the Public and Private Keys for Git and CodeCommit`_ or SSH and Windows: Set Up the Public and Private Keys for Git and CodeCommit`_in the *AWS CodeCommit User Guide*. _`SSH and Linux, macOS, or Unix: Set Up the Public and Private Keys for Git and CodeCommit: https://docs.aws.amazon.com/codecommit/latest/userguide/setting-up-ssh-unixes.html#setting-up-ssh-unixes-keys. SSH and Windows: Set Up the Public and Private Keys for Git and CodeCommit: https://docs.aws.amazon.com/codecommit/latest/userguide/setting-up-ssh-windows.html#setting-up-ssh-windows-keys-windows
Output¶
SSHPublicKey -> (structure)
Contains information about the SSH public key.
UserName -> (string)
SSHPublicKeyId -> (string)
Generate key pem cert pem. Fingerprint -> (string)
SSHPublicKeyBody -> (string)
Terraform Aws Example
Status -> (string)
UploadDate -> (timestamp)
[ aws . iam ]
Description¶
Retrieves the specified SSH public key, including metadata about the key.
The SSH public key retrieved by this operation is used only for authenticating the associated IAM user to an AWS CodeCommit repository. For more information about using SSH keys to authenticate to an AWS CodeCommit repository, see Set up AWS CodeCommit for SSH Connections in the AWS CodeCommit User Guide .
See also: AWS API Documentation
See 'aws help' for descriptions of global parameters.
Synopsis¶
Options¶
--user-name (string)
The name of the IAM user associated with the SSH public key.
This parameter allows (through its regex pattern ) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
--ssh-public-key-id (string)
The unique identifier for the SSH public key.
This parameter allows (through its regex pattern ) a string of characters that can consist of any upper or lowercased letter or digit.
--encoding (string)
Specifies the public key encoding format to use in the response. To retrieve the public key in ssh-rsa format, use SSH . To retrieve the public key in PEM format, use PEM .
Possible values:
- SSH
- PEM
--cli-input-json (string)Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.
--generate-cli-skeleton (string)Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.
See 'aws help' for descriptions of global parameters.
Examples¶
Example 1: To retrieve an SSH public key attached to an IAM user in SSH encoded form
Terraform Documentation Aws
The following get-ssh-public-key command retrieves the specified SSH public key from the IAM user sofia. The output is in SSH encoding.
Generate Public Key For Terraform Aws Server
Output:
Example 2: To retrieve an SSH public key attached to an IAM user in PEM encoded form
The following get-ssh-public-key command retrieves the specified SSH public key from the IAM user 'sofia'. The output is in PEM encoding.
Output:
For more information about SSH keys in IAM, see Use SSH Keys and SSH with CodeCommit in the AWS IAM User Guide.
Output¶
SSHPublicKey -> (structure)
A structure containing details about the SSH public key.
UserName -> (string)
SSHPublicKeyId -> (string)
Fingerprint -> (string)
SSHPublicKeyBody -> (string)
Status -> (string)
UploadDate -> (timestamp)