User class

Manages an AWS WorkMail User.

This resource registers the user with WorkMail on create so the mailbox is enabled and ready for use. This results in the accumulation of costs, for more details, see pricing. On destroy, it deregisters the user before deletion.

Example Usage

Basic Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.workmail.Organization("example", {
    organizationAlias: "example-org",
    deleteDirectory: true,
});
const exampleUser = new aws.workmail.User("example", {
    organizationId: example.organizationId,
    name: "example-user",
    displayName: "Example User",
    email: "example-user@example.com",
});

import pulumi
import pulumi_aws as aws

example = aws.workmail.Organization("example",
    organization_alias="example-org",
    delete_directory=True)
example_user = aws.workmail.User("example",
    organization_id=example.organization_id,
    name="example-user",
    display_name="Example User",
    email="example-user@example.com")

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = new Aws.WorkMail.Organization("example", new()
    {
        OrganizationAlias = "example-org",
        DeleteDirectory = true,
    });

    var exampleUser = new Aws.WorkMail.User("example", new()
    {
        OrganizationId = example.OrganizationId,
        Name = "example-user",
        DisplayName = "Example User",
        Email = "example-user@example.com",
    });

});

package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/workmail"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := workmail.NewOrganization(ctx, "example", &workmail.OrganizationArgs{
			OrganizationAlias: pulumi.String("example-org"),
			DeleteDirectory:   pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		_, err = workmail.NewUser(ctx, "example", &workmail.UserArgs{
			OrganizationId: example.OrganizationId,
			Name:           pulumi.String("example-user"),
			DisplayName:    pulumi.String("Example User"),
			Email:          pulumi.String("example-user@example.com"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

resource "aws_workmail_organization" "example" {
  organization_alias = "example-org"
  delete_directory   = true
}
resource "aws_workmail_user" "example" {
  organization_id = aws_workmail_organization.example.organization_id
  name            = "example-user"
  display_name    = "Example User"
  email           = "example-user@example.com"
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.workmail.Organization;
import com.pulumi.aws.workmail.OrganizationArgs;
import com.pulumi.aws.workmail.User;
import com.pulumi.aws.workmail.UserArgs;
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 example = new Organization("example", OrganizationArgs.builder()
            .organizationAlias("example-org")
            .deleteDirectory(true)
            .build());

        var exampleUser = new User("exampleUser", UserArgs.builder()
            .organizationId(example.organizationId())
            .name("example-user")
            .displayName("Example User")
            .email("example-user@example.com")
            .build());

    }
}

resources:
  example:
    type: aws:workmail:Organization
    properties:
      organizationAlias: example-org
      deleteDirectory: true
  exampleUser:
    type: aws:workmail:User
    name: example
    properties:
      organizationId: ${example.organizationId}
      name: example-user
      displayName: Example User
      email: example-user@example.com

Import

Identity Schema

Required

• organizationId - Identifier of the WorkMail organization.
• userId - Identifier of the user.

Optional

• accountId (String) AWS Account where this resource is managed.
• region (String) Region where this resource is managed.

Using pulumi import, import WorkMail User using organization_id,user_id. For example:

$ pulumi import aws:workmail/user:User example m-1234567890abcdef1234567890abcdef,12345678-1234-1234-1234-123456789012