pulumi-digitalocean-kotlin/com.pulumi.digitalocean.kotlin/DigitaloceanFunctions/getSshKeys

getSshKeys

suspend fun getSshKeys(argument: GetSshKeysPlainArgs): GetSshKeysResult

Get information on SSH Keys for use in other resources. This data source is useful if the SSH Keys in question are not managed by the provider or you need to utilize any of the SSH Keys' data. Note: You can use the digitalocean.SshKey data source to obtain metadata about a single SSH Key if you already know the unique name to retrieve.

Example Usage

For example, to find all SSH keys:

import * as pulumi from "@pulumi/pulumi";
import * as digitalocean from "@pulumi/digitalocean";
const keys = digitalocean.getSshKeys({
    sorts: [{
        key: "name",
        direction: "asc",
    }],
});

import pulumi
import pulumi_digitalocean as digitalocean
keys = digitalocean.get_ssh_keys(sorts=[{
    "key": "name",
    "direction": "asc",
}])

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using DigitalOcean = Pulumi.DigitalOcean;
return await Deployment.RunAsync(() =>
{
    var keys = DigitalOcean.GetSshKeys.Invoke(new()
    {
        Sorts = new[]
        {
            new DigitalOcean.Inputs.GetSshKeysSortInputArgs
            {
                Key = "name",
                Direction = "asc",
            },
        },
    });
});

package main
import (
	"github.com/pulumi/pulumi-digitalocean/sdk/v4/go/digitalocean"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := digitalocean.GetSshKeys(ctx, &digitalocean.GetSshKeysArgs{
			Sorts: []digitalocean.GetSshKeysSort{
				{
					Key:       "name",
					Direction: pulumi.StringRef("asc"),
				},
			},
		}, 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.digitalocean.DigitaloceanFunctions;
import com.pulumi.digitalocean.inputs.GetSshKeysArgs;
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 keys = DigitaloceanFunctions.getSshKeys(GetSshKeysArgs.builder()
            .sorts(GetSshKeysSortArgs.builder()
                .key("name")
                .direction("asc")
                .build())
            .build());
    }
}

variables:
  keys:
    fn::invoke:
      function: digitalocean:getSshKeys
      arguments:
        sorts:
          - key: name
            direction: asc

Or to find ones matching specific values:

import * as pulumi from "@pulumi/pulumi";
import * as digitalocean from "@pulumi/digitalocean";
const keys = digitalocean.getSshKeys({
    filters: [{
        key: "name",
        values: [
            "laptop",
            "desktop",
        ],
    }],
});

import pulumi
import pulumi_digitalocean as digitalocean
keys = digitalocean.get_ssh_keys(filters=[{
    "key": "name",
    "values": [
        "laptop",
        "desktop",
    ],
}])

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using DigitalOcean = Pulumi.DigitalOcean;
return await Deployment.RunAsync(() =>
{
    var keys = DigitalOcean.GetSshKeys.Invoke(new()
    {
        Filters = new[]
        {
            new DigitalOcean.Inputs.GetSshKeysFilterInputArgs
            {
                Key = "name",
                Values = new[]
                {
                    "laptop",
                    "desktop",
                },
            },
        },
    });
});

package main
import (
	"github.com/pulumi/pulumi-digitalocean/sdk/v4/go/digitalocean"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := digitalocean.GetSshKeys(ctx, &digitalocean.GetSshKeysArgs{
			Filters: []digitalocean.GetSshKeysFilter{
				{
					Key: "name",
					Values: []string{
						"laptop",
						"desktop",
					},
				},
			},
		}, 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.digitalocean.DigitaloceanFunctions;
import com.pulumi.digitalocean.inputs.GetSshKeysArgs;
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 keys = DigitaloceanFunctions.getSshKeys(GetSshKeysArgs.builder()
            .filters(GetSshKeysFilterArgs.builder()
                .key("name")
                .values(
                    "laptop",
                    "desktop")
                .build())
            .build());
    }
}

variables:
  keys:
    fn::invoke:
      function: digitalocean:getSshKeys
      arguments:
        filters:
          - key: name
            values:
              - laptop
              - desktop

Return

A collection of values returned by getSshKeys.

Parameters

argument

A collection of arguments for invoking getSshKeys.

suspend fun getSshKeys(filters: List<GetSshKeysFilter>? = null, sorts: List<GetSshKeysSort>? = null): GetSshKeysResult

Return

A collection of values returned by getSshKeys.

Parameters

filters

Filter the results. The filter block is documented below.

sorts

Sort the results. The sort block is documented below.

Return

A collection of values returned by getSshKeys.

Parameters

argument

Builder for com.pulumi.digitalocean.kotlin.inputs.GetSshKeysPlainArgs.

getSshKeys

Example Usage

Return

Parameters

Return

Parameters

See also

Return

Parameters

See also