AWS Native

v0.42.0 published on Wednesday, Nov 23, 2022 by Pulumi

getKeyPair

The AWS::EC2::KeyPair creates an SSH key pair

Using getKeyPair

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getKeyPair(args: GetKeyPairArgs, opts?: InvokeOptions): Promise<GetKeyPairResult>
function getKeyPairOutput(args: GetKeyPairOutputArgs, opts?: InvokeOptions): Output<GetKeyPairResult>
def get_key_pair(key_name: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetKeyPairResult
def get_key_pair_output(key_name: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetKeyPairResult]
func LookupKeyPair(ctx *Context, args *LookupKeyPairArgs, opts ...InvokeOption) (*LookupKeyPairResult, error)
func LookupKeyPairOutput(ctx *Context, args *LookupKeyPairOutputArgs, opts ...InvokeOption) LookupKeyPairResultOutput

> Note: This function is named LookupKeyPair in the Go SDK.

public static class GetKeyPair 
{
    public static Task<GetKeyPairResult> InvokeAsync(GetKeyPairArgs args, InvokeOptions? opts = null)
    public static Output<GetKeyPairResult> Invoke(GetKeyPairInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetKeyPairResult> getKeyPair(GetKeyPairArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
  function: aws-native:ec2:getKeyPair
  arguments:
    # arguments dictionary

The following arguments are supported:

KeyName string

The name of the SSH key pair

KeyName string

The name of the SSH key pair

keyName String

The name of the SSH key pair

keyName string

The name of the SSH key pair

key_name str

The name of the SSH key pair

keyName String

The name of the SSH key pair

getKeyPair Result

The following output properties are available:

KeyFingerprint string

A short sequence of bytes used for public key verification

KeyPairId string

An AWS generated ID for the key pair

PublicKeyMaterial string

Plain text public key to import

Tags List<Pulumi.AwsNative.EC2.Outputs.KeyPairTag>

An array of key-value pairs to apply to this resource.

KeyFingerprint string

A short sequence of bytes used for public key verification

KeyPairId string

An AWS generated ID for the key pair

PublicKeyMaterial string

Plain text public key to import

Tags []KeyPairTag

An array of key-value pairs to apply to this resource.

keyFingerprint String

A short sequence of bytes used for public key verification

keyPairId String

An AWS generated ID for the key pair

publicKeyMaterial String

Plain text public key to import

tags List<KeyPairTag>

An array of key-value pairs to apply to this resource.

keyFingerprint string

A short sequence of bytes used for public key verification

keyPairId string

An AWS generated ID for the key pair

publicKeyMaterial string

Plain text public key to import

tags KeyPairTag[]

An array of key-value pairs to apply to this resource.

key_fingerprint str

A short sequence of bytes used for public key verification

key_pair_id str

An AWS generated ID for the key pair

public_key_material str

Plain text public key to import

tags Sequence[KeyPairTag]

An array of key-value pairs to apply to this resource.

keyFingerprint String

A short sequence of bytes used for public key verification

keyPairId String

An AWS generated ID for the key pair

publicKeyMaterial String

Plain text public key to import

tags List<Property Map>

An array of key-value pairs to apply to this resource.

Supporting Types

KeyPairTag

Key string

The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

Value string

The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

Key string

The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

Value string

The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

key String

The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

value String

The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

key string

The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

value string

The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

key str

The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

value str

The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

key String

The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

value String

The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

Package Details

Repository
https://github.com/pulumi/pulumi-aws-native
License
Apache-2.0