published on Friday, Jul 31, 2026 by pulumiverse
published on Friday, Jul 31, 2026 by pulumiverse
Create an annotation value to define a specific label instance that can be attached to Scaleway resources. Annotation values are associated with annotation keys and represent concrete tag values (e.g., “production” as a value for an “environment” key).
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 production = new scaleway.annotations.Value("production", {
keyId: environment.id,
name: "production",
description: "Production environment",
});
import pulumi
import pulumiverse_scaleway as scaleway
environment = scaleway.annotations.Key("environment",
name="environment",
description="Deployment environment (production, staging, development)")
production = scaleway.annotations.Value("production",
key_id=environment.id,
name="production",
description="Production environment")
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
}
_, err = annotations.NewValue(ctx, "production", &annotations.ValueArgs{
KeyId: environment.ID(),
Name: pulumi.String("production"),
Description: pulumi.String("Production environment"),
})
if err != nil {
return err
}
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 production = new Scaleway.Annotations.Value("production", new()
{
KeyId = environment.Id,
Name = "production",
Description = "Production environment",
});
});
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.Value;
import com.pulumi.scaleway.annotations.ValueArgs;
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());
var production = new Value("production", ValueArgs.builder()
.keyId(environment.id())
.name("production")
.description("Production environment")
.build());
}
}
resources:
environment:
type: scaleway:annotations:Key
properties:
name: environment
description: Deployment environment (production, staging, development)
production:
type: scaleway:annotations:Value
properties:
keyId: ${environment.id}
name: production
description: Production environment
Example coming soon!
Create Value Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Value(name: string, args: ValueArgs, opts?: CustomResourceOptions);@overload
def Value(resource_name: str,
args: ValueArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Value(resource_name: str,
opts: Optional[ResourceOptions] = None,
key_id: Optional[str] = None,
description: Optional[str] = None,
name: Optional[str] = None)func NewValue(ctx *Context, name string, args ValueArgs, opts ...ResourceOption) (*Value, error)public Value(string name, ValueArgs args, CustomResourceOptions? opts = null)type: scaleway:annotations:Value
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "scaleway_annotations_value" "name" {
# resource properties
}Parameters
- name string
- The unique name of the resource.
- args ValueArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args ValueArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args ValueArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ValueArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ValueArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var valueResource = new Scaleway.Annotations.Value("valueResource", new()
{
KeyId = "string",
Description = "string",
Name = "string",
});
example, err := annotations.NewValue(ctx, "valueResource", &annotations.ValueArgs{
KeyId: pulumi.String("string"),
Description: pulumi.String("string"),
Name: pulumi.String("string"),
})
resource "scaleway_annotations_value" "valueResource" {
lifecycle {
create_before_destroy = true
}
key_id = "string"
description = "string"
name = "string"
}
var valueResource = new Value("valueResource", ValueArgs.builder()
.keyId("string")
.description("string")
.name("string")
.build());
value_resource = scaleway.annotations.Value("valueResource",
key_id="string",
description="string",
name="string")
const valueResource = new scaleway.annotations.Value("valueResource", {
keyId: "string",
description: "string",
name: "string",
});
type: scaleway:annotations:Value
properties:
description: string
keyId: string
name: string
Value Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The Value resource accepts the following input properties:
- Key
Id string - ID of the key the value is associated to.
- Description string
- Description of the annotation value.
- Name string
- Name of the annotation value.
- Key
Id string - ID of the key the value is associated to.
- Description string
- Description of the annotation value.
- Name string
- Name of the annotation value.
- key_
id string - ID of the key the value is associated to.
- description string
- Description of the annotation value.
- name string
- Name of the annotation value.
- key
Id String - ID of the key the value is associated to.
- description String
- Description of the annotation value.
- name String
- Name of the annotation value.
- key
Id string - ID of the key the value is associated to.
- description string
- Description of the annotation value.
- name string
- Name of the annotation value.
- key_
id str - ID of the key the value is associated to.
- description str
- Description of the annotation value.
- name str
- Name of the annotation value.
- key
Id String - ID of the key the value is associated to.
- description String
- Description of the annotation value.
- name String
- Name of the annotation value.
Outputs
All input properties are implicitly available as output properties. Additionally, the Value resource produces the following output properties:
Look up Existing Value Resource
Get an existing Value resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: ValueState, opts?: CustomResourceOptions): Value@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
description: Optional[str] = None,
key_id: Optional[str] = None,
name: Optional[str] = None,
value_id: Optional[str] = None) -> Valuefunc GetValue(ctx *Context, name string, id IDInput, state *ValueState, opts ...ResourceOption) (*Value, error)public static Value Get(string name, Input<string> id, ValueState? state, CustomResourceOptions? opts = null)public static Value get(String name, Output<String> id, ValueState state, CustomResourceOptions options)resources: _: type: scaleway:annotations:Value get: id: ${id}import {
to = scaleway_annotations_value.example
id = "${id}"
}
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Description string
- Description of the annotation value.
- Key
Id string - ID of the key the value is associated to.
- Name string
- Name of the annotation value.
- Value
Id string - The ID of the annotation value.
- Description string
- Description of the annotation value.
- Key
Id string - ID of the key the value is associated to.
- Name string
- Name of the annotation value.
- Value
Id string - The ID of the annotation value.
- description string
- Description of the annotation value.
- key_
id string - ID of the key the value is associated to.
- name string
- Name of the annotation value.
- value_
id string - The ID of the annotation value.
- description String
- Description of the annotation value.
- key
Id String - ID of the key the value is associated to.
- name String
- Name of the annotation value.
- value
Id String - The ID of the annotation value.
- description string
- Description of the annotation value.
- key
Id string - ID of the key the value is associated to.
- name string
- Name of the annotation value.
- value
Id string - The ID of the annotation value.
- description str
- Description of the annotation value.
- key_
id str - ID of the key the value is associated to.
- name str
- Name of the annotation value.
- value_
id str - The ID of the annotation value.
- description String
- Description of the annotation value.
- key
Id String - ID of the key the value is associated to.
- name String
- Name of the annotation value.
- value
Id String - The ID of the annotation value.
Import
Annotation values can be imported using their id:
$ pulumi import scaleway:annotations/value:Value main <value_id>
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- scaleway pulumiverse/pulumi-scaleway
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
scalewayTerraform Provider.
published on Friday, Jul 31, 2026 by pulumiverse