Datadog v4.28.1 published on Monday, Jun 24, 2024 by Pulumi
datadog.getApiKey
Explore with Pulumi AI
Use this data source to retrieve information about an existing api key.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as datadog from "@pulumi/datadog";
const foo = datadog.getApiKey({
    name: "foo-application",
});
import pulumi
import pulumi_datadog as datadog
foo = datadog.get_api_key(name="foo-application")
package main
import (
	"github.com/pulumi/pulumi-datadog/sdk/v4/go/datadog"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := datadog.LookupApiKey(ctx, &datadog.LookupApiKeyArgs{
			Name: pulumi.StringRef("foo-application"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Datadog = Pulumi.Datadog;
return await Deployment.RunAsync(() => 
{
    var foo = Datadog.GetApiKey.Invoke(new()
    {
        Name = "foo-application",
    });
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.datadog.DatadogFunctions;
import com.pulumi.datadog.inputs.GetApiKeyArgs;
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 foo = DatadogFunctions.getApiKey(GetApiKeyArgs.builder()
            .name("foo-application")
            .build());
    }
}
variables:
  foo:
    fn::invoke:
      Function: datadog:getApiKey
      Arguments:
        name: foo-application
Using getApiKey
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 getApiKey(args: GetApiKeyArgs, opts?: InvokeOptions): Promise<GetApiKeyResult>
function getApiKeyOutput(args: GetApiKeyOutputArgs, opts?: InvokeOptions): Output<GetApiKeyResult>def get_api_key(exact_match: Optional[bool] = None,
                id: Optional[str] = None,
                name: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetApiKeyResult
def get_api_key_output(exact_match: Optional[pulumi.Input[bool]] = None,
                id: Optional[pulumi.Input[str]] = None,
                name: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetApiKeyResult]func LookupApiKey(ctx *Context, args *LookupApiKeyArgs, opts ...InvokeOption) (*LookupApiKeyResult, error)
func LookupApiKeyOutput(ctx *Context, args *LookupApiKeyOutputArgs, opts ...InvokeOption) LookupApiKeyResultOutput> Note: This function is named LookupApiKey in the Go SDK.
public static class GetApiKey 
{
    public static Task<GetApiKeyResult> InvokeAsync(GetApiKeyArgs args, InvokeOptions? opts = null)
    public static Output<GetApiKeyResult> Invoke(GetApiKeyInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetApiKeyResult> getApiKey(GetApiKeyArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
  function: datadog:index/getApiKey:getApiKey
  arguments:
    # arguments dictionaryThe following arguments are supported:
- Exact
Match bool - Whether to use exact match when searching by name.
 - Id string
 - The ID of this resource.
 - Name string
 - Name for API Key.
 
- Exact
Match bool - Whether to use exact match when searching by name.
 - Id string
 - The ID of this resource.
 - Name string
 - Name for API Key.
 
- exact
Match Boolean - Whether to use exact match when searching by name.
 - id String
 - The ID of this resource.
 - name String
 - Name for API Key.
 
- exact
Match boolean - Whether to use exact match when searching by name.
 - id string
 - The ID of this resource.
 - name string
 - Name for API Key.
 
- exact_
match bool - Whether to use exact match when searching by name.
 - id str
 - The ID of this resource.
 - name str
 - Name for API Key.
 
- exact
Match Boolean - Whether to use exact match when searching by name.
 - id String
 - The ID of this resource.
 - name String
 - Name for API Key.
 
getApiKey Result
The following output properties are available:
- Key string
 - The value of the API Key.
 - Exact
Match bool - Whether to use exact match when searching by name.
 - Id string
 - The ID of this resource.
 - Name string
 - Name for API Key.
 
- Key string
 - The value of the API Key.
 - Exact
Match bool - Whether to use exact match when searching by name.
 - Id string
 - The ID of this resource.
 - Name string
 - Name for API Key.
 
- key String
 - The value of the API Key.
 - exact
Match Boolean - Whether to use exact match when searching by name.
 - id String
 - The ID of this resource.
 - name String
 - Name for API Key.
 
- key string
 - The value of the API Key.
 - exact
Match boolean - Whether to use exact match when searching by name.
 - id string
 - The ID of this resource.
 - name string
 - Name for API Key.
 
- key str
 - The value of the API Key.
 - exact_
match bool - Whether to use exact match when searching by name.
 - id str
 - The ID of this resource.
 - name str
 - Name for API Key.
 
- key String
 - The value of the API Key.
 - exact
Match Boolean - Whether to use exact match when searching by name.
 - id String
 - The ID of this resource.
 - name String
 - Name for API Key.
 
Package Details
- Repository
 - Datadog pulumi/pulumi-datadog
 - License
 - Apache-2.0
 - Notes
 - This Pulumi package is based on the 
datadogTerraform Provider.