Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. Scaleway
  4. API Docs
  5. mailbox
  6. Alias
Viewing docs for Scaleway v1.60.0
published on Saturday, Oct 24, 2026 by pulumiverse
Schema (JSON)
pulumiverse/pulumi-scaleway

scaleway.mailbox.Alias

scaleway logo
Viewing docs for Scaleway v1.60.0
published on Saturday, Oct 24, 2026 by pulumiverse
Schema (JSON)
pulumiverse/pulumi-scaleway

    Creates and manages a Scaleway Mailbox alias.

    An alias is an alternative address (local_part@domain) that delivers into an existing scaleway.mailbox.Mailbox. It is not a separate mailbox account.

    Note This resource is in alpha and the API is subject to change.

    Example Usage

    Basic alias

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

const main = new scaleway.mailbox.Domain("main", {name: "mail.example.com"});
const john = new scaleway.mailbox.Mailbox("john", {
    domainId: main.id,
    localPart: "john.doe",
    passwordWo: mailboxPassword,
    passwordWoVersion: 1,
    subscriptionPeriod: "monthly",
});
const contact = new scaleway.mailbox.Alias("contact", {
    mailboxId: john.id,
    localPart: "contact",
    description: "Public contact address",
});

    import pulumi
import pulumiverse_scaleway as scaleway

main = scaleway.mailbox.Domain("main", name="mail.example.com")
john = scaleway.mailbox.Mailbox("john",
    domain_id=main.id,
    local_part="john.doe",
    password_wo=mailbox_password,
    password_wo_version=1,
    subscription_period="monthly")
contact = scaleway.mailbox.Alias("contact",
    mailbox_id=john.id,
    local_part="contact",
    description="Public contact address")

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		main, err := mailbox.NewDomain(ctx, "main", &mailbox.DomainArgs{
			Name: pulumi.String("mail.example.com"),
		})
		if err != nil {
			return err
		}
		john, err := mailbox.NewMailbox(ctx, "john", &mailbox.MailboxArgs{
			DomainId:           main.ID().ToIDOutput().ToStringOutput(),
			LocalPart:          pulumi.String("john.doe"),
			PasswordWo:         pulumi.Any(mailboxPassword),
			PasswordWoVersion:  pulumi.Int(1),
			SubscriptionPeriod: pulumi.String("monthly"),
		})
		if err != nil {
			return err
		}
		_, err = mailbox.NewAlias(ctx, "contact", &mailbox.AliasArgs{
			MailboxId:   john.ID().ToIDOutput().ToStringOutput(),
			LocalPart:   pulumi.String("contact"),
			Description: pulumi.String("Public contact address"),
		})
		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 main = new Scaleway.Mailbox.Domain("main", new()
    {
        Name = "mail.example.com",
    });

    var john = new Scaleway.Mailbox.Mailbox("john", new()
    {
        DomainId = main.Id,
        LocalPart = "john.doe",
        PasswordWo = mailboxPassword,
        PasswordWoVersion = 1,
        SubscriptionPeriod = "monthly",
    });

    var contact = new Scaleway.Mailbox.Alias("contact", new()
    {
        MailboxId = john.Id,
        LocalPart = "contact",
        Description = "Public contact address",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.scaleway.mailbox.Domain;
import com.pulumi.scaleway.mailbox.DomainArgs;
import com.pulumi.scaleway.mailbox.Mailbox;
import com.pulumi.scaleway.mailbox.MailboxArgs;
import com.pulumi.scaleway.mailbox.Alias;
import com.pulumi.scaleway.mailbox.AliasArgs;
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 main = new Domain("main", DomainArgs.builder()
            .name("mail.example.com")
            .build());

        var john = new Mailbox("john", MailboxArgs.builder()
            .domainId(main.id())
            .localPart("john.doe")
            .passwordWo(mailboxPassword)
            .passwordWoVersion(1)
            .subscriptionPeriod("monthly")
            .build());

        var contact = new Alias("contact", AliasArgs.builder()
            .mailboxId(john.id())
            .localPart("contact")
            .description("Public contact address")
            .build());

    }
}

    resources:
  main:
    type: scaleway:mailbox:Domain
    properties:
      name: mail.example.com
  john:
    type: scaleway:mailbox:Mailbox
    properties:
      domainId: ${main.id}
      localPart: john.doe
      passwordWo: ${mailboxPassword}
      passwordWoVersion: 1
      subscriptionPeriod: monthly
  contact:
    type: scaleway:mailbox:Alias
    properties:
      mailboxId: ${john.id}
      localPart: contact
      description: Public contact address

    pulumi {
  required_providers {
    scaleway = {
      source = "pulumi/scaleway"
    }
  }
}

resource "scaleway_mailbox_domain" "main" {
  name = "mail.example.com"
}
resource "scaleway_mailbox_mailbox" "john" {
  domain_id           = scaleway_mailbox_domain.main.id
  local_part          = "john.doe"
  password_wo         = mailboxPassword
  password_wo_version = 1
  subscription_period = "monthly"
}
resource "scaleway_mailbox_alias" "contact" {
  mailbox_id  = scaleway_mailbox_mailbox.john.id
  local_part  = "contact"
  description = "Public contact address"
}

    Create Alias Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Alias(name: string, args: AliasArgs, opts?: CustomResourceOptions);
    @overload
def Alias(resource_name: str,
          args: AliasArgs,
          opts: Optional[ResourceOptions] = None)

@overload
def Alias(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          local_part: Optional[str] = None,
          mailbox_id: Optional[str] = None,
          description: Optional[str] = None)
    func NewAlias(ctx *Context, name string, args AliasArgs, opts ...ResourceOption) (*Alias, error)
    public Alias(string name, AliasArgs args, CustomResourceOptions? opts = null)
    public Alias(String name, AliasArgs args)
public Alias(String name, AliasArgs args, CustomResourceOptions options)

    type: scaleway:mailbox:Alias
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "scaleway_mailbox_alias" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args AliasArgs
    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 AliasArgs
    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 AliasArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AliasArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AliasArgs
    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 aliasResource = new Scaleway.Mailbox.Alias("aliasResource", new()
{
    LocalPart = "string",
    MailboxId = "string",
    Description = "string",
});

    example, err := mailbox.NewAlias(ctx, "aliasResource", &mailbox.AliasArgs{
	LocalPart:   pulumi.String("string"),
	MailboxId:   pulumi.String("string"),
	Description: pulumi.String("string"),
})

    resource "scaleway_mailbox_alias" "aliasResource" {
  lifecycle {
    create_before_destroy = true
  }
  local_part  = "string"
  mailbox_id  = "string"
  description = "string"
}

    var aliasResource = new Alias("aliasResource", AliasArgs.builder()
    .localPart("string")
    .mailboxId("string")
    .description("string")
    .build());

    alias_resource = scaleway.mailbox.Alias("aliasResource",
    local_part="string",
    mailbox_id="string",
    description="string")

    const aliasResource = new scaleway.mailbox.Alias("aliasResource", {
    localPart: "string",
    mailboxId: "string",
    description: "string",
});

    type: scaleway:mailbox:Alias
properties:
    description: string
    localPart: string
    mailboxId: string

    Alias 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 Alias resource accepts the following input properties:

    LocalPart string
    Local part of the alias email address (part before the @). Must be 1–64 characters. Changing this value forces a new alias to be created.
    MailboxId string
    UUID of the scaleway.mailbox.Mailbox to which this alias belongs.
    Description string
    Description of the alias. Can be updated in place. Omit the attribute to leave it empty (do not set an empty string).
    LocalPart string
    Local part of the alias email address (part before the @). Must be 1–64 characters. Changing this value forces a new alias to be created.
    MailboxId string
    UUID of the scaleway.mailbox.Mailbox to which this alias belongs.
    Description string
    Description of the alias. Can be updated in place. Omit the attribute to leave it empty (do not set an empty string).
    local_part string
    Local part of the alias email address (part before the @). Must be 1–64 characters. Changing this value forces a new alias to be created.
    mailbox_id string
    UUID of the scaleway.mailbox.Mailbox to which this alias belongs.
    description string
    Description of the alias. Can be updated in place. Omit the attribute to leave it empty (do not set an empty string).
    localPart String
    Local part of the alias email address (part before the @). Must be 1–64 characters. Changing this value forces a new alias to be created.
    mailboxId String
    UUID of the scaleway.mailbox.Mailbox to which this alias belongs.
    description String
    Description of the alias. Can be updated in place. Omit the attribute to leave it empty (do not set an empty string).
    localPart string
    Local part of the alias email address (part before the @). Must be 1–64 characters. Changing this value forces a new alias to be created.
    mailboxId string
    UUID of the scaleway.mailbox.Mailbox to which this alias belongs.
    description string
    Description of the alias. Can be updated in place. Omit the attribute to leave it empty (do not set an empty string).
    local_part str
    Local part of the alias email address (part before the @). Must be 1–64 characters. Changing this value forces a new alias to be created.
    mailbox_id str
    UUID of the scaleway.mailbox.Mailbox to which this alias belongs.
    description str
    Description of the alias. Can be updated in place. Omit the attribute to leave it empty (do not set an empty string).
    localPart String
    Local part of the alias email address (part before the @). Must be 1–64 characters. Changing this value forces a new alias to be created.
    mailboxId String
    UUID of the scaleway.mailbox.Mailbox to which this alias belongs.
    description String
    Description of the alias. Can be updated in place. Omit the attribute to leave it empty (do not set an empty string).

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Alias resource produces the following output properties:

    CreatedAt string
    Date and time of alias creation (RFC 3339 format).
    Email string
    Full email address of the alias (local_part@domain).
    Id string
    The provider-assigned unique ID for this managed resource.
    Status string
    Current status of the alias:
    UpdatedAt string
    Date and time of last update (RFC 3339 format).
    CreatedAt string
    Date and time of alias creation (RFC 3339 format).
    Email string
    Full email address of the alias (local_part@domain).
    Id string
    The provider-assigned unique ID for this managed resource.
    Status string
    Current status of the alias:
    UpdatedAt string
    Date and time of last update (RFC 3339 format).
    created_at string
    Date and time of alias creation (RFC 3339 format).
    email string
    Full email address of the alias (local_part@domain).
    id string
    The provider-assigned unique ID for this managed resource.
    status string
    Current status of the alias:
    updated_at string
    Date and time of last update (RFC 3339 format).
    createdAt String
    Date and time of alias creation (RFC 3339 format).
    email String
    Full email address of the alias (local_part@domain).
    id String
    The provider-assigned unique ID for this managed resource.
    status String
    Current status of the alias:
    updatedAt String
    Date and time of last update (RFC 3339 format).
    createdAt string
    Date and time of alias creation (RFC 3339 format).
    email string
    Full email address of the alias (local_part@domain).
    id string
    The provider-assigned unique ID for this managed resource.
    status string
    Current status of the alias:
    updatedAt string
    Date and time of last update (RFC 3339 format).
    created_at str
    Date and time of alias creation (RFC 3339 format).
    email str
    Full email address of the alias (local_part@domain).
    id str
    The provider-assigned unique ID for this managed resource.
    status str
    Current status of the alias:
    updated_at str
    Date and time of last update (RFC 3339 format).
    createdAt String
    Date and time of alias creation (RFC 3339 format).
    email String
    Full email address of the alias (local_part@domain).
    id String
    The provider-assigned unique ID for this managed resource.
    status String
    Current status of the alias:
    updatedAt String
    Date and time of last update (RFC 3339 format).

    Look up Existing Alias Resource

    Get an existing Alias 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?: AliasState, opts?: CustomResourceOptions): Alias
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        created_at: Optional[str] = None,
        description: Optional[str] = None,
        email: Optional[str] = None,
        local_part: Optional[str] = None,
        mailbox_id: Optional[str] = None,
        status: Optional[str] = None,
        updated_at: Optional[str] = None) -> Alias
    func GetAlias(ctx *Context, name string, id IDInput, state *AliasState, opts ...ResourceOption) (*Alias, error)
    public static Alias Get(string name, Input<string> id, AliasState? state, CustomResourceOptions? opts = null)
    public static Alias get(String name, Output<String> id, AliasState state, CustomResourceOptions options)
    resources:  _:    type: scaleway:mailbox:Alias    get:      id: ${id}
    import {
  to = scaleway_mailbox_alias.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.
    The following state arguments are supported:
    CreatedAt string
    Date and time of alias creation (RFC 3339 format).
    Description string
    Description of the alias. Can be updated in place. Omit the attribute to leave it empty (do not set an empty string).
    Email string
    Full email address of the alias (local_part@domain).
    LocalPart string
    Local part of the alias email address (part before the @). Must be 1–64 characters. Changing this value forces a new alias to be created.
    MailboxId string
    UUID of the scaleway.mailbox.Mailbox to which this alias belongs.
    Status string
    Current status of the alias:
    UpdatedAt string
    Date and time of last update (RFC 3339 format).
    CreatedAt string
    Date and time of alias creation (RFC 3339 format).
    Description string
    Description of the alias. Can be updated in place. Omit the attribute to leave it empty (do not set an empty string).
    Email string
    Full email address of the alias (local_part@domain).
    LocalPart string
    Local part of the alias email address (part before the @). Must be 1–64 characters. Changing this value forces a new alias to be created.
    MailboxId string
    UUID of the scaleway.mailbox.Mailbox to which this alias belongs.
    Status string
    Current status of the alias:
    UpdatedAt string
    Date and time of last update (RFC 3339 format).
    created_at string
    Date and time of alias creation (RFC 3339 format).
    description string
    Description of the alias. Can be updated in place. Omit the attribute to leave it empty (do not set an empty string).
    email string
    Full email address of the alias (local_part@domain).
    local_part string
    Local part of the alias email address (part before the @). Must be 1–64 characters. Changing this value forces a new alias to be created.
    mailbox_id string
    UUID of the scaleway.mailbox.Mailbox to which this alias belongs.
    status string
    Current status of the alias:
    updated_at string
    Date and time of last update (RFC 3339 format).
    createdAt String
    Date and time of alias creation (RFC 3339 format).
    description String
    Description of the alias. Can be updated in place. Omit the attribute to leave it empty (do not set an empty string).
    email String
    Full email address of the alias (local_part@domain).
    localPart String
    Local part of the alias email address (part before the @). Must be 1–64 characters. Changing this value forces a new alias to be created.
    mailboxId String
    UUID of the scaleway.mailbox.Mailbox to which this alias belongs.
    status String
    Current status of the alias:
    updatedAt String
    Date and time of last update (RFC 3339 format).
    createdAt string
    Date and time of alias creation (RFC 3339 format).
    description string
    Description of the alias. Can be updated in place. Omit the attribute to leave it empty (do not set an empty string).
    email string
    Full email address of the alias (local_part@domain).
    localPart string
    Local part of the alias email address (part before the @). Must be 1–64 characters. Changing this value forces a new alias to be created.
    mailboxId string
    UUID of the scaleway.mailbox.Mailbox to which this alias belongs.
    status string
    Current status of the alias:
    updatedAt string
    Date and time of last update (RFC 3339 format).
    created_at str
    Date and time of alias creation (RFC 3339 format).
    description str
    Description of the alias. Can be updated in place. Omit the attribute to leave it empty (do not set an empty string).
    email str
    Full email address of the alias (local_part@domain).
    local_part str
    Local part of the alias email address (part before the @). Must be 1–64 characters. Changing this value forces a new alias to be created.
    mailbox_id str
    UUID of the scaleway.mailbox.Mailbox to which this alias belongs.
    status str
    Current status of the alias:
    updated_at str
    Date and time of last update (RFC 3339 format).
    createdAt String
    Date and time of alias creation (RFC 3339 format).
    description String
    Description of the alias. Can be updated in place. Omit the attribute to leave it empty (do not set an empty string).
    email String
    Full email address of the alias (local_part@domain).
    localPart String
    Local part of the alias email address (part before the @). Must be 1–64 characters. Changing this value forces a new alias to be created.
    mailboxId String
    UUID of the scaleway.mailbox.Mailbox to which this alias belongs.
    status String
    Current status of the alias:
    updatedAt String
    Date and time of last update (RFC 3339 format).

    Import

    Aliases can be imported using their UUID:

    $ pulumi import scaleway:mailbox/alias:Alias contact 11111111-1111-1111-1111-111111111111

    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 scaleway Terraform Provider.
    scaleway logo
    Viewing docs for Scaleway v1.60.0
    published on Saturday, Oct 24, 2026 by pulumiverse
    Schema (JSON)
    pulumiverse/pulumi-scaleway

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial