1. Registry
  2. Packages
  3. Scaleway
  4. API Docs
  5. annotations
  6. getKey
Viewing docs for Scaleway v1.54.0
published on Friday, Jul 31, 2026 by pulumiverse
scaleway logo
Viewing docs for Scaleway v1.54.0
published on Friday, Jul 31, 2026 by pulumiverse

    Retrieves information about an existing annotation key using its ID.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as scaleway from "@pulumiverse/scaleway";
    
    const environment = new scaleway.annotations.Key("environment", {
        name: "environment",
        description: "Deployment environment (production, staging, development)",
    });
    const main = scaleway.annotations.getKeyOutput({
        keyId: environment.id,
    });
    
    import pulumi
    import pulumi_scaleway as scaleway
    import pulumiverse_scaleway as scaleway
    
    environment = scaleway.annotations.Key("environment",
        name="environment",
        description="Deployment environment (production, staging, development)")
    main = scaleway.annotations.get_key_output(key_id=environment.id)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    	"github.com/pulumiverse/pulumi-scaleway/sdk/go/scaleway/annotations"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		environment, err := annotations.NewKey(ctx, "environment", &annotations.KeyArgs{
    			Name:        pulumi.String("environment"),
    			Description: pulumi.String("Deployment environment (production, staging, development)"),
    		})
    		if err != nil {
    			return err
    		}
    		_ = annotations.LookupKeyOutput(ctx, annotations.GetKeyOutputArgs{
    			KeyId: environment.ID(),
    		}, nil)
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Scaleway = Pulumiverse.Scaleway;
    
    return await Deployment.RunAsync(() => 
    {
        var environment = new Scaleway.Annotations.Key("environment", new()
        {
            Name = "environment",
            Description = "Deployment environment (production, staging, development)",
        });
    
        var main = Scaleway.Annotations.GetKey.Invoke(new()
        {
            KeyId = environment.Id,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.scaleway.annotations.Key;
    import com.pulumi.scaleway.annotations.KeyArgs;
    import com.pulumi.scaleway.annotations.AnnotationsFunctions;
    import com.pulumi.scaleway.annotations.inputs.GetKeyArgs;
    import java.util.ArrayList;
    import java.util.Arrays;
    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) {
            var environment = new Key("environment", KeyArgs.builder()
                .name("environment")
                .description("Deployment environment (production, staging, development)")
                .build());
    
            final var main = AnnotationsFunctions.getKey(GetKeyArgs.builder()
                .keyId(environment.id())
                .build());
    
        }
    }
    
    resources:
      environment:
        type: scaleway:annotations:Key
        properties:
          name: environment
          description: Deployment environment (production, staging, development)
    variables:
      main:
        fn::invoke:
          function: scaleway:annotations:getKey
          arguments:
            keyId: ${environment.id}
    
    Example coming soon!
    

    Using getKey

    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 getKey(args: GetKeyArgs, opts?: InvokeOptions): Promise<GetKeyResult>
    function getKeyOutput(args: GetKeyOutputArgs, opts?: InvokeOutputOptions): Output<GetKeyResult>
    def get_key(key_id: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetKeyResult
    def get_key_output(key_id: pulumi.Input[Optional[str]] = None,
                opts: Optional[InvokeOutputOptions] = None) -> Output[GetKeyResult]
    func LookupKey(ctx *Context, args *LookupKeyArgs, opts ...InvokeOption) (*LookupKeyResult, error)
    func LookupKeyOutput(ctx *Context, args *LookupKeyOutputArgs, opts ...InvokeOption) LookupKeyResultOutput

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

    public static class GetKey 
    {
        public static Task<GetKeyResult> InvokeAsync(GetKeyArgs args, InvokeOptions? opts = null)
        public static Output<GetKeyResult> Invoke(GetKeyInvokeArgs args, InvokeOptions? opts = null)
        public static Output<GetKeyResult> Invoke(GetKeyInvokeArgs args, InvokeOutputOptions opts)
    }
    public static CompletableFuture<GetKeyResult> getKey(GetKeyArgs args, InvokeOptions options)
    public static Output<GetKeyResult> getKey(GetKeyArgs args, InvokeOptions options)
    public static Output<GetKeyResult> getKey(GetKeyArgs args, InvokeOutputOptions options)
    
    fn::invoke:
      function: scaleway:annotations/getKey:getKey
      arguments:
        # arguments dictionary
    data "scaleway_annotations_get_key" "name" {
        # arguments
    }

    The following arguments are supported:

    KeyId string
    The ID of the annotation key to retrieve.
    KeyId string
    The ID of the annotation key to retrieve.
    key_id string
    The ID of the annotation key to retrieve.
    keyId String
    The ID of the annotation key to retrieve.
    keyId string
    The ID of the annotation key to retrieve.
    key_id str
    The ID of the annotation key to retrieve.
    keyId String
    The ID of the annotation key to retrieve.

    getKey Result

    The following output properties are available:

    Description string
    Description of the annotation key
    Id string
    The ID of the annotation key
    KeyId string
    Name string
    Name of the annotation key
    Description string
    Description of the annotation key
    Id string
    The ID of the annotation key
    KeyId string
    Name string
    Name of the annotation key
    description string
    Description of the annotation key
    id string
    The ID of the annotation key
    key_id string
    name string
    Name of the annotation key
    description String
    Description of the annotation key
    id String
    The ID of the annotation key
    keyId String
    name String
    Name of the annotation key
    description string
    Description of the annotation key
    id string
    The ID of the annotation key
    keyId string
    name string
    Name of the annotation key
    description str
    Description of the annotation key
    id str
    The ID of the annotation key
    key_id str
    name str
    Name of the annotation key
    description String
    Description of the annotation key
    id String
    The ID of the annotation key
    keyId String
    name String
    Name of the annotation key

    Package Details

    Repository
    scaleway pulumiverse/pulumi-scaleway
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the scaleway Terraform Provider.
    scaleway logo
    Viewing docs for Scaleway v1.54.0
    published on Friday, Jul 31, 2026 by pulumiverse

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial