AWS Native
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:
- Key
Name string The name of the SSH key pair
- Key
Name string The name of the SSH key pair
- key
Name String The name of the SSH key pair
- key
Name string The name of the SSH key pair
- key_
name str The name of the SSH key pair
- key
Name String The name of the SSH key pair
getKeyPair Result
The following output properties are available:
- Key
Fingerprint string A short sequence of bytes used for public key verification
- Key
Pair stringId An AWS generated ID for the key pair
- Public
Key stringMaterial Plain text public key to import
- List<Pulumi.
Aws Native. EC2. Outputs. Key Pair Tag> An array of key-value pairs to apply to this resource.
- Key
Fingerprint string A short sequence of bytes used for public key verification
- Key
Pair stringId An AWS generated ID for the key pair
- Public
Key stringMaterial Plain text public key to import
- []Key
Pair Tag An array of key-value pairs to apply to this resource.
- key
Fingerprint String A short sequence of bytes used for public key verification
- key
Pair StringId An AWS generated ID for the key pair
- public
Key StringMaterial Plain text public key to import
- List<Key
Pair Tag> An array of key-value pairs to apply to this resource.
- key
Fingerprint string A short sequence of bytes used for public key verification
- key
Pair stringId An AWS generated ID for the key pair
- public
Key stringMaterial Plain text public key to import
- Key
Pair Tag[] 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_ strid An AWS generated ID for the key pair
- public_
key_ strmaterial Plain text public key to import
- Sequence[Key
Pair Tag] An array of key-value pairs to apply to this resource.
- key
Fingerprint String A short sequence of bytes used for public key verification
- key
Pair StringId An AWS generated ID for the key pair
- public
Key StringMaterial Plain text public key to import
- 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