getKeyManagerKey

Scaleway v1.44.1, Mar 9 26

Viewing docs for Scaleway v1.44.1
published on Monday, Mar 9, 2026 by pulumiverse

Schema (JSON)

pulumiverse/pulumi-scaleway

Viewing docs for Scaleway v1.44.1
published on Monday, Mar 9, 2026 by pulumiverse

Schema (JSON)

pulumiverse/pulumi-scaleway

Example Usage

Create a key and get its information

The following commands allow you to:

create a key named my-kms-key
retrieve the key’s information using the key’s ID

import * as pulumi from "@pulumi/pulumi";
import * as scaleway from "@pulumiverse/scaleway";

// Create a key
const symmetric = new scaleway.keymanager.Key("symmetric", {
    name: "my-kms-key",
    region: "fr-par",
    projectId: "your-project-id",
    usage: "symmetric_encryption",
    algorithm: "aes_256_gcm",
    description: "Key for encrypting secrets",
    tags: [
        "env:prod",
        "kms",
    ],
    unprotected: true,
    rotationPolicy: {
        rotationPeriod: "720h",
    },
});
// Get the key information by its ID
const byID = scaleway.keymanager.getKey({
    keyId: "11111111-1111-1111-1111-111111111111",
});

import pulumi
import pulumi_scaleway as scaleway
import pulumiverse_scaleway as scaleway

# Create a key
symmetric = scaleway.keymanager.Key("symmetric",
    name="my-kms-key",
    region="fr-par",
    project_id="your-project-id",
    usage="symmetric_encryption",
    algorithm="aes_256_gcm",
    description="Key for encrypting secrets",
    tags=[
        "env:prod",
        "kms",
    ],
    unprotected=True,
    rotation_policy={
        "rotation_period": "720h",
    })
# Get the key information by its ID
by_id = scaleway.keymanager.get_key(key_id="11111111-1111-1111-1111-111111111111")

package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumiverse/pulumi-scaleway/sdk/go/scaleway/keymanager"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		// Create a key
		_, err := keymanager.NewKey(ctx, "symmetric", &keymanager.KeyArgs{
			Name:        pulumi.String("my-kms-key"),
			Region:      pulumi.String("fr-par"),
			ProjectId:   pulumi.String("your-project-id"),
			Usage:       pulumi.String("symmetric_encryption"),
			Algorithm:   pulumi.String("aes_256_gcm"),
			Description: pulumi.String("Key for encrypting secrets"),
			Tags: pulumi.StringArray{
				pulumi.String("env:prod"),
				pulumi.String("kms"),
			},
			Unprotected: pulumi.Bool(true),
			RotationPolicy: &keymanager.KeyRotationPolicyArgs{
				RotationPeriod: pulumi.String("720h"),
			},
		})
		if err != nil {
			return err
		}
		// Get the key information by its ID
		_, err = keymanager.LookupKey(ctx, &keymanager.LookupKeyArgs{
			KeyId: "11111111-1111-1111-1111-111111111111",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Scaleway = Pulumi.Scaleway;
using Scaleway = Pulumiverse.Scaleway;

return await Deployment.RunAsync(() => 
{
    // Create a key
    var symmetric = new Scaleway.Keymanager.Key("symmetric", new()
    {
        Name = "my-kms-key",
        Region = "fr-par",
        ProjectId = "your-project-id",
        Usage = "symmetric_encryption",
        Algorithm = "aes_256_gcm",
        Description = "Key for encrypting secrets",
        Tags = new[]
        {
            "env:prod",
            "kms",
        },
        Unprotected = true,
        RotationPolicy = new Scaleway.Keymanager.Inputs.KeyRotationPolicyArgs
        {
            RotationPeriod = "720h",
        },
    });

    // Get the key information by its ID
    var byID = Scaleway.Keymanager.GetKey.Invoke(new()
    {
        KeyId = "11111111-1111-1111-1111-111111111111",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.scaleway.keymanager.Key;
import com.pulumi.scaleway.keymanager.KeyArgs;
import com.pulumi.scaleway.keymanager.inputs.KeyRotationPolicyArgs;
import com.pulumi.scaleway.keymanager.KeymanagerFunctions;
import com.pulumi.scaleway.keymanager.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) {
        // Create a key
        var symmetric = new Key("symmetric", KeyArgs.builder()
            .name("my-kms-key")
            .region("fr-par")
            .projectId("your-project-id")
            .usage("symmetric_encryption")
            .algorithm("aes_256_gcm")
            .description("Key for encrypting secrets")
            .tags(            
                "env:prod",
                "kms")
            .unprotected(true)
            .rotationPolicy(KeyRotationPolicyArgs.builder()
                .rotationPeriod("720h")
                .build())
            .build());

        // Get the key information by its ID
        final var byID = KeymanagerFunctions.getKey(GetKeyArgs.builder()
            .keyId("11111111-1111-1111-1111-111111111111")
            .build());

    }
}

resources:
  # Create a key
  symmetric:
    type: scaleway:keymanager:Key
    properties:
      name: my-kms-key
      region: fr-par
      projectId: your-project-id
      usage: symmetric_encryption
      algorithm: aes_256_gcm
      description: Key for encrypting secrets
      tags:
        - env:prod
        - kms
      unprotected: true
      rotationPolicy:
        rotationPeriod: 720h
variables:
  # Get the key information by its ID
  byID:
    fn::invoke:
      function: scaleway:keymanager:getKey
      arguments:
        keyId: 11111111-1111-1111-1111-111111111111

Using getKeyManagerKey

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 getKeyManagerKey(args: GetKeyManagerKeyArgs, opts?: InvokeOptions): Promise<GetKeyManagerKeyResult>
function getKeyManagerKeyOutput(args: GetKeyManagerKeyOutputArgs, opts?: InvokeOptions): Output<GetKeyManagerKeyResult>

def get_key_manager_key(key_id: Optional[str] = None,
                        region: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetKeyManagerKeyResult
def get_key_manager_key_output(key_id: Optional[pulumi.Input[str]] = None,
                        region: Optional[pulumi.Input[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetKeyManagerKeyResult]

func LookupKeyManagerKey(ctx *Context, args *LookupKeyManagerKeyArgs, opts ...InvokeOption) (*LookupKeyManagerKeyResult, error)
func LookupKeyManagerKeyOutput(ctx *Context, args *LookupKeyManagerKeyOutputArgs, opts ...InvokeOption) LookupKeyManagerKeyResultOutput

> Note: This function is named LookupKeyManagerKey in the Go SDK.

public static class GetKeyManagerKey 
{
    public static Task<GetKeyManagerKeyResult> InvokeAsync(GetKeyManagerKeyArgs args, InvokeOptions? opts = null)
    public static Output<GetKeyManagerKeyResult> Invoke(GetKeyManagerKeyInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetKeyManagerKeyResult> getKeyManagerKey(GetKeyManagerKeyArgs args, InvokeOptions options)
public static Output<GetKeyManagerKeyResult> getKeyManagerKey(GetKeyManagerKeyArgs args, InvokeOptions options)

fn::invoke:
  function: scaleway:index/getKeyManagerKey:getKeyManagerKey
  arguments:
    # arguments dictionary

The following arguments are supported:

KeyId string: ID of the key to target. Can be a plain UUID or a regional ID.
Region string: region) The region in which the key was created.

KeyId string: ID of the key to target. Can be a plain UUID or a regional ID.
Region string: region) The region in which the key was created.

keyId String: ID of the key to target. Can be a plain UUID or a regional ID.
region String: region) The region in which the key was created.

keyId string: ID of the key to target. Can be a plain UUID or a regional ID.
region string: region) The region in which the key was created.

key_id str: ID of the key to target. Can be a plain UUID or a regional ID.
region str: region) The region in which the key was created.

keyId String: ID of the key to target. Can be a plain UUID or a regional ID.
region String: region) The region in which the key was created.