getKey

suspend fun getKey(argument: GetKeyPlainArgs): GetKeyResult

Use this data source to get the name and value of a pre-existing API Key, for example to supply credentials for a dependency microservice.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const myApiKey = aws.apigateway.getKey({
id: "ru3mpjgse6",
});
import pulumi
import pulumi_aws as aws
my_api_key = aws.apigateway.get_key(id="ru3mpjgse6")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var myApiKey = Aws.ApiGateway.GetKey.Invoke(new()
{
Id = "ru3mpjgse6",
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/apigateway"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := apigateway.GetKey(ctx, &apigateway.GetKeyArgs{
Id: "ru3mpjgse6",
}, nil)
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.apigateway.ApigatewayFunctions;
import com.pulumi.aws.apigateway.inputs.GetKeyArgs;
import java.util.List;
import java.util.ArrayList;
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 myApiKey = ApigatewayFunctions.getKey(GetKeyArgs.builder()
.id("ru3mpjgse6")
.build());
}
}
variables:
myApiKey:
fn::invoke:
function: aws:apigateway:getKey
arguments:
id: ru3mpjgse6

Return

A collection of values returned by getKey.

Parameters

argument

A collection of arguments for invoking getKey.


suspend fun getKey(id: String, tags: Map<String, String>? = null): GetKeyResult

Return

A collection of values returned by getKey.

Parameters

id

ID of the API Key to look up.

tags

Map of tags for the resource.

See also


suspend fun getKey(argument: suspend GetKeyPlainArgsBuilder.() -> Unit): GetKeyResult

Return

A collection of values returned by getKey.

Parameters

argument

Builder for com.pulumi.aws.apigateway.kotlin.inputs.GetKeyPlainArgs.

See also