1. Packages
  2. stackit
  3. API Docs
  4. getKeyPair
Viewing docs for stackit v0.0.4
published on Friday, Feb 20, 2026 by stackitcloud
stackit logo
Viewing docs for stackit v0.0.4
published on Friday, Feb 20, 2026 by stackitcloud

    Key pair resource schema. Must have a region specified in the provider configuration.

    Example Usage

    data "stackit_key_pair" "example" {
      name = "example-key-pair-name"
    }
    

    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(name: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetKeyPairResult
    def get_key_pair_output(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)
    public static Output<GetKeyPairResult> getKeyPair(GetKeyPairArgs args, InvokeOptions options)
    
    fn::invoke:
      function: stackit:index/getKeyPair:getKeyPair
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Name string
    The name of the SSH key pair.
    Name string
    The name of the SSH key pair.
    name String
    The name of the SSH key pair.
    name string
    The name of the SSH key pair.
    name str
    The name of the SSH key pair.
    name String
    The name of the SSH key pair.

    getKeyPair Result

    The following output properties are available:

    Fingerprint string
    The fingerprint of the public SSH key.
    Id string
    Labels Dictionary<string, string>
    Labels are key-value string pairs which can be attached to a resource container.
    Name string
    The name of the SSH key pair.
    PublicKey string
    A string representation of the public SSH key. E.g., ssh-rsa <key_data> or ssh-ed25519 <key-data>.
    Fingerprint string
    The fingerprint of the public SSH key.
    Id string
    Labels map[string]string
    Labels are key-value string pairs which can be attached to a resource container.
    Name string
    The name of the SSH key pair.
    PublicKey string
    A string representation of the public SSH key. E.g., ssh-rsa <key_data> or ssh-ed25519 <key-data>.
    fingerprint String
    The fingerprint of the public SSH key.
    id String
    labels Map<String,String>
    Labels are key-value string pairs which can be attached to a resource container.
    name String
    The name of the SSH key pair.
    publicKey String
    A string representation of the public SSH key. E.g., ssh-rsa <key_data> or ssh-ed25519 <key-data>.
    fingerprint string
    The fingerprint of the public SSH key.
    id string
    labels {[key: string]: string}
    Labels are key-value string pairs which can be attached to a resource container.
    name string
    The name of the SSH key pair.
    publicKey string
    A string representation of the public SSH key. E.g., ssh-rsa <key_data> or ssh-ed25519 <key-data>.
    fingerprint str
    The fingerprint of the public SSH key.
    id str
    labels Mapping[str, str]
    Labels are key-value string pairs which can be attached to a resource container.
    name str
    The name of the SSH key pair.
    public_key str
    A string representation of the public SSH key. E.g., ssh-rsa <key_data> or ssh-ed25519 <key-data>.
    fingerprint String
    The fingerprint of the public SSH key.
    id String
    labels Map<String>
    Labels are key-value string pairs which can be attached to a resource container.
    name String
    The name of the SSH key pair.
    publicKey String
    A string representation of the public SSH key. E.g., ssh-rsa <key_data> or ssh-ed25519 <key-data>.

    Package Details

    Repository
    stackit stackitcloud/pulumi-stackit
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the stackit Terraform Provider.
    stackit logo
    Viewing docs for stackit v0.0.4
    published on Friday, Feb 20, 2026 by stackitcloud
      Try Pulumi Cloud free. Your team will thank you.