getKeyPair function

Future<GetKeyPairResult> getKeyPair(
  1. GetKeyPairArgs args, {
  2. InvokeOptions? options,
})

Use this data source to get information about a specific EC2 Key Pair.

Example Usage

The following example shows how to get a EC2 Key Pair including the public key material from its name.

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = aws.ec2.getKeyPair({
    filters: [{
        name: "tag:Component",
        values: ["web"],
    }],
    keyName: "test",
    includePublicKey: true,
});
export const fingerprint = example.then(example => example.fingerprint);
export const name = example.then(example => example.keyName);
export const id = example.then(example => example.id);
import pulumi
import pulumi_aws as aws

example = aws.ec2.get_key_pair(filters=[{
        "name": "tag:Component",
        "values": ["web"],
    }],
    key_name="test",
    include_public_key=True)
pulumi.export("fingerprint", example.fingerprint)
pulumi.export("name", example.key_name)
pulumi.export("id", example.id)
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = Aws.Ec2.GetKeyPair.Invoke(new()
    {
        Filters = new[]
        {
            new Aws.Ec2.Inputs.GetKeyPairFilterInputArgs
            {
                Name = "tag:Component",
                Values = new[]
                {
                    "web",
                },
            },
        },
        KeyName = "test",
        IncludePublicKey = true,
    });

    return new Dictionary<string, object?>
    {
        ["fingerprint"] = example.Apply(getKeyPairResult => getKeyPairResult.Fingerprint),
        ["name"] = example.Apply(getKeyPairResult => getKeyPairResult.KeyName),
        ["id"] = example.Apply(getKeyPairResult => getKeyPairResult.Id),
    };
});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/ec2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := ec2.LookupKeyPair(ctx, &ec2.LookupKeyPairArgs{
			Filters: []ec2.GetKeyPairFilter{
				{
					Name: "tag:Component",
					Values: []string{
						"web",
					},
				},
			},
			KeyName:          pulumi.StringRef("test"),
			IncludePublicKey: pulumi.BoolRef(true),
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("fingerprint", example.Fingerprint)
		ctx.Export("name", example.KeyName)
		ctx.Export("id", example.Id)
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

data "aws_ec2_getkeypair" "example" {
  filters {
    name   = "tag:Component"
    values = ["web"]
  }
  key_name           = "test"
  include_public_key = true
}

output "fingerprint" {
  value = data.aws_ec2_getkeypair.example.fingerprint
}
output "name" {
  value = data.aws_ec2_getkeypair.example.key_name
}
output "id" {
  value = data.aws_ec2_getkeypair.example.id
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.ec2.Ec2Functions;
import com.pulumi.aws.ec2.inputs.GetKeyPairArgs;
import com.pulumi.aws.ec2.inputs.GetKeyPairFilterArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var example = Ec2Functions.getKeyPair(GetKeyPairArgs.builder()
            .filters(GetKeyPairFilterArgs.builder()
                .name("tag:Component")
                .values("web")
                .build())
            .keyName("test")
            .includePublicKey(true)
            .build());

        ctx.export("fingerprint", example.fingerprint());
        ctx.export("name", example.keyName());
        ctx.export("id", example.id());
    }
}
variables:
  example:
    fn::invoke:
      function: aws:ec2:getKeyPair
      arguments:
        filters:
          - name: tag:Component
            values:
              - web
        keyName: test
        includePublicKey: true
outputs:
  fingerprint: ${example.fingerprint}
  name: ${example.keyName}
  id: ${example.id}

args Arguments passed to this invoke. Arguments for getKeyPair. options Invoke options controlling this call.

Implementation

Future<GetKeyPairResult> getKeyPair(
  GetKeyPairArgs args, {
  pulumi.InvokeOptions? options,
}) async {
  final deployment = pulumi.Deployment.instance;
  final result = await deployment.invoke<Map<String, dynamic>>(
    'aws:ec2/getKeyPair:getKeyPair',
    args.toMap(),
    options: pulumi.toDeploymentInvokeOptions(options),
  );
  return GetKeyPairResult.fromMap(result);
}