@pulumi/aws
Version:
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
94 lines (93 loc) • 2.89 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Use this data source to get information about a SSH public key associated with the specified IAM user.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const example = aws.iam.getUserSshKey({
* encoding: "SSH",
* sshPublicKeyId: "APKARUZ32GUTKIGARLXE",
* username: "test-user",
* });
* ```
*/
export declare function getUserSshKey(args: GetUserSshKeyArgs, opts?: pulumi.InvokeOptions): Promise<GetUserSshKeyResult>;
/**
* A collection of arguments for invoking getUserSshKey.
*/
export interface GetUserSshKeyArgs {
/**
* 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`.
*/
encoding: string;
/**
* Unique identifier for the SSH public key.
*/
sshPublicKeyId: string;
/**
* Name of the IAM user associated with the SSH public key.
*/
username: string;
}
/**
* A collection of values returned by getUserSshKey.
*/
export interface GetUserSshKeyResult {
readonly encoding: string;
/**
* MD5 message digest of the SSH public key.
*/
readonly fingerprint: string;
/**
* The provider-assigned unique ID for this managed resource.
*/
readonly id: string;
/**
* SSH public key.
*/
readonly publicKey: string;
readonly sshPublicKeyId: string;
/**
* Status of the SSH public key. Active means that the key can be used for authentication with an CodeCommit repository. Inactive means that the key cannot be used.
*/
readonly status: string;
readonly username: string;
}
/**
* Use this data source to get information about a SSH public key associated with the specified IAM user.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const example = aws.iam.getUserSshKey({
* encoding: "SSH",
* sshPublicKeyId: "APKARUZ32GUTKIGARLXE",
* username: "test-user",
* });
* ```
*/
export declare function getUserSshKeyOutput(args: GetUserSshKeyOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetUserSshKeyResult>;
/**
* A collection of arguments for invoking getUserSshKey.
*/
export interface GetUserSshKeyOutputArgs {
/**
* 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`.
*/
encoding: pulumi.Input<string>;
/**
* Unique identifier for the SSH public key.
*/
sshPublicKeyId: pulumi.Input<string>;
/**
* Name of the IAM user associated with the SSH public key.
*/
username: pulumi.Input<string>;
}