github.com/pulumi/pulumi-aws/sdk/v6@v6.32.0/go/aws/ec2/getKeyPair.go

// Code generated by the Pulumi Terraform Bridge (tfgen) Tool DO NOT EDIT.
// *** WARNING: Do not edit by hand unless you're certain you know what you are doing! ***

package ec2

import (
	"context"
	"reflect"

	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/internal"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

// 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.
//
// <!--Start PulumiCodeChooser -->
// ```go
// package main
//
// import (
//
//	"github.com/pulumi/pulumi-aws/sdk/v6/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{
//				KeyName:          pulumi.StringRef("test"),
//				IncludePublicKey: pulumi.BoolRef(true),
//				Filters: []ec2.GetKeyPairFilter{
//					{
//						Name: "tag:Component",
//						Values: []string{
//							"web",
//						},
//					},
//				},
//			}, nil)
//			if err != nil {
//				return err
//			}
//			ctx.Export("fingerprint", example.Fingerprint)
//			ctx.Export("name", example.KeyName)
//			ctx.Export("id", example.Id)
//			return nil
//		})
//	}
//
// ```
// <!--End PulumiCodeChooser -->
func LookupKeyPair(ctx *pulumi.Context, args *LookupKeyPairArgs, opts ...pulumi.InvokeOption) (*LookupKeyPairResult, error) {
	opts = internal.PkgInvokeDefaultOpts(opts)
	var rv LookupKeyPairResult
	err := ctx.Invoke("aws:ec2/getKeyPair:getKeyPair", args, &rv, opts...)
	if err != nil {
		return nil, err
	}
	return &rv, nil
}

// A collection of arguments for invoking getKeyPair.
type LookupKeyPairArgs struct {
	// Custom filter block as described below.
	Filters []GetKeyPairFilter `pulumi:"filters"`
	// Whether to include the public key material in the response.
	IncludePublicKey *bool `pulumi:"includePublicKey"`
	// Key Pair name.
	KeyName *string `pulumi:"keyName"`
	// Key Pair ID.
	KeyPairId *string `pulumi:"keyPairId"`
	// Any tags assigned to the Key Pair.
	Tags map[string]string `pulumi:"tags"`
}

// A collection of values returned by getKeyPair.
type LookupKeyPairResult struct {
	// ARN of the Key Pair.
	Arn string `pulumi:"arn"`
	// Timestamp for when the key pair was created in ISO 8601 format.
	CreateTime string             `pulumi:"createTime"`
	Filters    []GetKeyPairFilter `pulumi:"filters"`
	// SHA-1 digest of the DER encoded private key.
	Fingerprint string `pulumi:"fingerprint"`
	// The provider-assigned unique ID for this managed resource.
	Id               string  `pulumi:"id"`
	IncludePublicKey *bool   `pulumi:"includePublicKey"`
	KeyName          *string `pulumi:"keyName"`
	KeyPairId        *string `pulumi:"keyPairId"`
	// Type of key pair.
	KeyType string `pulumi:"keyType"`
	// Public key material.
	PublicKey string `pulumi:"publicKey"`
	// Any tags assigned to the Key Pair.
	Tags map[string]string `pulumi:"tags"`
}

func LookupKeyPairOutput(ctx *pulumi.Context, args LookupKeyPairOutputArgs, opts ...pulumi.InvokeOption) LookupKeyPairResultOutput {
	return pulumi.ToOutputWithContext(context.Background(), args).
		ApplyT(func(v interface{}) (LookupKeyPairResult, error) {
			args := v.(LookupKeyPairArgs)
			r, err := LookupKeyPair(ctx, &args, opts...)
			var s LookupKeyPairResult
			if r != nil {
				s = *r
			}
			return s, err
		}).(LookupKeyPairResultOutput)
}

// A collection of arguments for invoking getKeyPair.
type LookupKeyPairOutputArgs struct {
	// Custom filter block as described below.
	Filters GetKeyPairFilterArrayInput `pulumi:"filters"`
	// Whether to include the public key material in the response.
	IncludePublicKey pulumi.BoolPtrInput `pulumi:"includePublicKey"`
	// Key Pair name.
	KeyName pulumi.StringPtrInput `pulumi:"keyName"`
	// Key Pair ID.
	KeyPairId pulumi.StringPtrInput `pulumi:"keyPairId"`
	// Any tags assigned to the Key Pair.
	Tags pulumi.StringMapInput `pulumi:"tags"`
}

func (LookupKeyPairOutputArgs) ElementType() reflect.Type {
	return reflect.TypeOf((*LookupKeyPairArgs)(nil)).Elem()
}

// A collection of values returned by getKeyPair.
type LookupKeyPairResultOutput struct{ *pulumi.OutputState }

func (LookupKeyPairResultOutput) ElementType() reflect.Type {
	return reflect.TypeOf((*LookupKeyPairResult)(nil)).Elem()
}

func (o LookupKeyPairResultOutput) ToLookupKeyPairResultOutput() LookupKeyPairResultOutput {
	return o
}

func (o LookupKeyPairResultOutput) ToLookupKeyPairResultOutputWithContext(ctx context.Context) LookupKeyPairResultOutput {
	return o
}

// ARN of the Key Pair.
func (o LookupKeyPairResultOutput) Arn() pulumi.StringOutput {
	return o.ApplyT(func(v LookupKeyPairResult) string { return v.Arn }).(pulumi.StringOutput)
}

// Timestamp for when the key pair was created in ISO 8601 format.
func (o LookupKeyPairResultOutput) CreateTime() pulumi.StringOutput {
	return o.ApplyT(func(v LookupKeyPairResult) string { return v.CreateTime }).(pulumi.StringOutput)
}

func (o LookupKeyPairResultOutput) Filters() GetKeyPairFilterArrayOutput {
	return o.ApplyT(func(v LookupKeyPairResult) []GetKeyPairFilter { return v.Filters }).(GetKeyPairFilterArrayOutput)
}

// SHA-1 digest of the DER encoded private key.
func (o LookupKeyPairResultOutput) Fingerprint() pulumi.StringOutput {
	return o.ApplyT(func(v LookupKeyPairResult) string { return v.Fingerprint }).(pulumi.StringOutput)
}

// The provider-assigned unique ID for this managed resource.
func (o LookupKeyPairResultOutput) Id() pulumi.StringOutput {
	return o.ApplyT(func(v LookupKeyPairResult) string { return v.Id }).(pulumi.StringOutput)
}

func (o LookupKeyPairResultOutput) IncludePublicKey() pulumi.BoolPtrOutput {
	return o.ApplyT(func(v LookupKeyPairResult) *bool { return v.IncludePublicKey }).(pulumi.BoolPtrOutput)
}

func (o LookupKeyPairResultOutput) KeyName() pulumi.StringPtrOutput {
	return o.ApplyT(func(v LookupKeyPairResult) *string { return v.KeyName }).(pulumi.StringPtrOutput)
}

func (o LookupKeyPairResultOutput) KeyPairId() pulumi.StringPtrOutput {
	return o.ApplyT(func(v LookupKeyPairResult) *string { return v.KeyPairId }).(pulumi.StringPtrOutput)
}

// Type of key pair.
func (o LookupKeyPairResultOutput) KeyType() pulumi.StringOutput {
	return o.ApplyT(func(v LookupKeyPairResult) string { return v.KeyType }).(pulumi.StringOutput)
}

// Public key material.
func (o LookupKeyPairResultOutput) PublicKey() pulumi.StringOutput {
	return o.ApplyT(func(v LookupKeyPairResult) string { return v.PublicKey }).(pulumi.StringOutput)
}

// Any tags assigned to the Key Pair.
func (o LookupKeyPairResultOutput) Tags() pulumi.StringMapOutput {
	return o.ApplyT(func(v LookupKeyPairResult) map[string]string { return v.Tags }).(pulumi.StringMapOutput)
}

func init() {
	pulumi.RegisterOutputType(LookupKeyPairResultOutput{})
}