1. Packages
  2. AWS
  3. API Docs
  4. workmail
  5. Organization
Viewing docs for AWS v7.24.0
published on Tuesday, Mar 31, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws

aws.workmail.Organization

aws logo
Viewing docs for AWS v7.24.0
published on Tuesday, Mar 31, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws

    Manages an AWS WorkMail Organization.

    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"});

    import pulumi
import pulumi_aws as aws

example = aws.workmail.Organization("example", organization_alias="example-org")

    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 {
		_, err := workmail.NewOrganization(ctx, "example", &workmail.OrganizationArgs{
			OrganizationAlias: pulumi.String("example-org"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    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",
    });

});

    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 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) {
        var example = new Organization("example", OrganizationArgs.builder()
            .organizationAlias("example-org")
            .build());

    }
}

    resources:
  example:
    type: aws:workmail:Organization
    properties:
      organizationAlias: example-org

    Create Organization Resource

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

    Constructor syntax

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

@overload
def Organization(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 organization_alias: Optional[str] = None,
                 delete_directory: Optional[bool] = None,
                 delete_identity_center_application: Optional[bool] = None,
                 directory_id: Optional[str] = None,
                 interoperability_enabled: Optional[bool] = None,
                 kms_key_arn: Optional[str] = None,
                 region: Optional[str] = None,
                 tags: Optional[Mapping[str, str]] = None,
                 timeouts: Optional[OrganizationTimeoutsArgs] = None)
    func NewOrganization(ctx *Context, name string, args OrganizationArgs, opts ...ResourceOption) (*Organization, error)
    public Organization(string name, OrganizationArgs args, CustomResourceOptions? opts = null)
    public Organization(String name, OrganizationArgs args)
public Organization(String name, OrganizationArgs args, CustomResourceOptions options)

    type: aws:workmail:Organization
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args OrganizationArgs
    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 OrganizationArgs
    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 OrganizationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args OrganizationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args OrganizationArgs
    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 awsOrganizationResource = new Aws.WorkMail.Organization("awsOrganizationResource", new()
{
    OrganizationAlias = "string",
    DeleteDirectory = false,
    DeleteIdentityCenterApplication = false,
    DirectoryId = "string",
    InteroperabilityEnabled = false,
    KmsKeyArn = "string",
    Region = "string",
    Tags = 
    {
        { "string", "string" },
    },
    Timeouts = new Aws.WorkMail.Inputs.OrganizationTimeoutsArgs
    {
        Create = "string",
        Delete = "string",
    },
});

    example, err := workmail.NewOrganization(ctx, "awsOrganizationResource", &workmail.OrganizationArgs{
	OrganizationAlias:               pulumi.String("string"),
	DeleteDirectory:                 pulumi.Bool(false),
	DeleteIdentityCenterApplication: pulumi.Bool(false),
	DirectoryId:                     pulumi.String("string"),
	InteroperabilityEnabled:         pulumi.Bool(false),
	KmsKeyArn:                       pulumi.String("string"),
	Region:                          pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Timeouts: &workmail.OrganizationTimeoutsArgs{
		Create: pulumi.String("string"),
		Delete: pulumi.String("string"),
	},
})

    var awsOrganizationResource = new com.pulumi.aws.workmail.Organization("awsOrganizationResource", com.pulumi.aws.workmail.OrganizationArgs.builder()
    .organizationAlias("string")
    .deleteDirectory(false)
    .deleteIdentityCenterApplication(false)
    .directoryId("string")
    .interoperabilityEnabled(false)
    .kmsKeyArn("string")
    .region("string")
    .tags(Map.of("string", "string"))
    .timeouts(OrganizationTimeoutsArgs.builder()
        .create("string")
        .delete("string")
        .build())
    .build());

    aws_organization_resource = aws.workmail.Organization("awsOrganizationResource",
    organization_alias="string",
    delete_directory=False,
    delete_identity_center_application=False,
    directory_id="string",
    interoperability_enabled=False,
    kms_key_arn="string",
    region="string",
    tags={
        "string": "string",
    },
    timeouts={
        "create": "string",
        "delete": "string",
    })

    const awsOrganizationResource = new aws.workmail.Organization("awsOrganizationResource", {
    organizationAlias: "string",
    deleteDirectory: false,
    deleteIdentityCenterApplication: false,
    directoryId: "string",
    interoperabilityEnabled: false,
    kmsKeyArn: "string",
    region: "string",
    tags: {
        string: "string",
    },
    timeouts: {
        create: "string",
        "delete": "string",
    },
});

    type: aws:workmail:Organization
properties:
    deleteDirectory: false
    deleteIdentityCenterApplication: false
    directoryId: string
    interoperabilityEnabled: false
    kmsKeyArn: string
    organizationAlias: string
    region: string
    tags:
        string: string
    timeouts:
        create: string
        delete: string

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

    OrganizationAlias string

    Alias for the organization. Must be unique globally. Changing this creates a new resource.

    The following arguments are optional:

    DeleteDirectory bool
    Whether to delete the AWS Directory Service directory associated with the organization on destroy. To update this value after creation, run pulumi up before running terraform destroy. Defaults to false.
    DeleteIdentityCenterApplication bool
    Whether to delete the IAM Identity Center application associated with the organization on destroy. To update this value after creation, run pulumi up before running terraform destroy. Defaults to false.
    DirectoryId string
    ID of an existing directory to associate with the organization. Changing this creates a new resource.
    InteroperabilityEnabled bool
    Whether to enable interoperability between WorkMail and Microsoft Exchange. Changing this creates a new resource.
    KmsKeyArn string
    ARN of a customer-managed KMS key to encrypt the organization's data. If omitted, AWS managed keys are used. Changing this creates a new resource.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    Tags Dictionary<string, string>
    A map of tags to assign to the resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    Timeouts OrganizationTimeouts
    OrganizationAlias string

    Alias for the organization. Must be unique globally. Changing this creates a new resource.

    The following arguments are optional:

    DeleteDirectory bool
    Whether to delete the AWS Directory Service directory associated with the organization on destroy. To update this value after creation, run pulumi up before running terraform destroy. Defaults to false.
    DeleteIdentityCenterApplication bool
    Whether to delete the IAM Identity Center application associated with the organization on destroy. To update this value after creation, run pulumi up before running terraform destroy. Defaults to false.
    DirectoryId string
    ID of an existing directory to associate with the organization. Changing this creates a new resource.
    InteroperabilityEnabled bool
    Whether to enable interoperability between WorkMail and Microsoft Exchange. Changing this creates a new resource.
    KmsKeyArn string
    ARN of a customer-managed KMS key to encrypt the organization's data. If omitted, AWS managed keys are used. Changing this creates a new resource.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    Tags map[string]string
    A map of tags to assign to the resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    Timeouts OrganizationTimeoutsArgs
    organizationAlias String

    Alias for the organization. Must be unique globally. Changing this creates a new resource.

    The following arguments are optional:

    deleteDirectory Boolean
    Whether to delete the AWS Directory Service directory associated with the organization on destroy. To update this value after creation, run pulumi up before running terraform destroy. Defaults to false.
    deleteIdentityCenterApplication Boolean
    Whether to delete the IAM Identity Center application associated with the organization on destroy. To update this value after creation, run pulumi up before running terraform destroy. Defaults to false.
    directoryId String
    ID of an existing directory to associate with the organization. Changing this creates a new resource.
    interoperabilityEnabled Boolean
    Whether to enable interoperability between WorkMail and Microsoft Exchange. Changing this creates a new resource.
    kmsKeyArn String
    ARN of a customer-managed KMS key to encrypt the organization's data. If omitted, AWS managed keys are used. Changing this creates a new resource.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    tags Map<String,String>
    A map of tags to assign to the resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    timeouts OrganizationTimeouts
    organizationAlias string

    Alias for the organization. Must be unique globally. Changing this creates a new resource.

    The following arguments are optional:

    deleteDirectory boolean
    Whether to delete the AWS Directory Service directory associated with the organization on destroy. To update this value after creation, run pulumi up before running terraform destroy. Defaults to false.
    deleteIdentityCenterApplication boolean
    Whether to delete the IAM Identity Center application associated with the organization on destroy. To update this value after creation, run pulumi up before running terraform destroy. Defaults to false.
    directoryId string
    ID of an existing directory to associate with the organization. Changing this creates a new resource.
    interoperabilityEnabled boolean
    Whether to enable interoperability between WorkMail and Microsoft Exchange. Changing this creates a new resource.
    kmsKeyArn string
    ARN of a customer-managed KMS key to encrypt the organization's data. If omitted, AWS managed keys are used. Changing this creates a new resource.
    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    tags {[key: string]: string}
    A map of tags to assign to the resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    timeouts OrganizationTimeouts
    organization_alias str

    Alias for the organization. Must be unique globally. Changing this creates a new resource.

    The following arguments are optional:

    delete_directory bool
    Whether to delete the AWS Directory Service directory associated with the organization on destroy. To update this value after creation, run pulumi up before running terraform destroy. Defaults to false.
    delete_identity_center_application bool
    Whether to delete the IAM Identity Center application associated with the organization on destroy. To update this value after creation, run pulumi up before running terraform destroy. Defaults to false.
    directory_id str
    ID of an existing directory to associate with the organization. Changing this creates a new resource.
    interoperability_enabled bool
    Whether to enable interoperability between WorkMail and Microsoft Exchange. Changing this creates a new resource.
    kms_key_arn str
    ARN of a customer-managed KMS key to encrypt the organization's data. If omitted, AWS managed keys are used. Changing this creates a new resource.
    region str
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    tags Mapping[str, str]
    A map of tags to assign to the resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    timeouts OrganizationTimeoutsArgs
    organizationAlias String

    Alias for the organization. Must be unique globally. Changing this creates a new resource.

    The following arguments are optional:

    deleteDirectory Boolean
    Whether to delete the AWS Directory Service directory associated with the organization on destroy. To update this value after creation, run pulumi up before running terraform destroy. Defaults to false.
    deleteIdentityCenterApplication Boolean
    Whether to delete the IAM Identity Center application associated with the organization on destroy. To update this value after creation, run pulumi up before running terraform destroy. Defaults to false.
    directoryId String
    ID of an existing directory to associate with the organization. Changing this creates a new resource.
    interoperabilityEnabled Boolean
    Whether to enable interoperability between WorkMail and Microsoft Exchange. Changing this creates a new resource.
    kmsKeyArn String
    ARN of a customer-managed KMS key to encrypt the organization's data. If omitted, AWS managed keys are used. Changing this creates a new resource.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    tags Map<String>
    A map of tags to assign to the resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    timeouts Property Map

    Outputs

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

    Arn string
    ARN of the Organization.
    CompletedDate string
    Date and time (RFC3339) at which the organization became active.
    DefaultMailDomain string
    Default mail domain for the organization.
    DirectoryType string
    Type of the associated directory.
    Id string
    The provider-assigned unique ID for this managed resource.
    MigrationAdmin string
    User ID of the migration admin if migration is enabled.
    OrganizationId string
    ID of the WorkMail Organization.
    State string
    State of the organization.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    Arn string
    ARN of the Organization.
    CompletedDate string
    Date and time (RFC3339) at which the organization became active.
    DefaultMailDomain string
    Default mail domain for the organization.
    DirectoryType string
    Type of the associated directory.
    Id string
    The provider-assigned unique ID for this managed resource.
    MigrationAdmin string
    User ID of the migration admin if migration is enabled.
    OrganizationId string
    ID of the WorkMail Organization.
    State string
    State of the organization.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    arn String
    ARN of the Organization.
    completedDate String
    Date and time (RFC3339) at which the organization became active.
    defaultMailDomain String
    Default mail domain for the organization.
    directoryType String
    Type of the associated directory.
    id String
    The provider-assigned unique ID for this managed resource.
    migrationAdmin String
    User ID of the migration admin if migration is enabled.
    organizationId String
    ID of the WorkMail Organization.
    state String
    State of the organization.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    arn string
    ARN of the Organization.
    completedDate string
    Date and time (RFC3339) at which the organization became active.
    defaultMailDomain string
    Default mail domain for the organization.
    directoryType string
    Type of the associated directory.
    id string
    The provider-assigned unique ID for this managed resource.
    migrationAdmin string
    User ID of the migration admin if migration is enabled.
    organizationId string
    ID of the WorkMail Organization.
    state string
    State of the organization.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    arn str
    ARN of the Organization.
    completed_date str
    Date and time (RFC3339) at which the organization became active.
    default_mail_domain str
    Default mail domain for the organization.
    directory_type str
    Type of the associated directory.
    id str
    The provider-assigned unique ID for this managed resource.
    migration_admin str
    User ID of the migration admin if migration is enabled.
    organization_id str
    ID of the WorkMail Organization.
    state str
    State of the organization.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    arn String
    ARN of the Organization.
    completedDate String
    Date and time (RFC3339) at which the organization became active.
    defaultMailDomain String
    Default mail domain for the organization.
    directoryType String
    Type of the associated directory.
    id String
    The provider-assigned unique ID for this managed resource.
    migrationAdmin String
    User ID of the migration admin if migration is enabled.
    organizationId String
    ID of the WorkMail Organization.
    state String
    State of the organization.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.

    Look up Existing Organization Resource

    Get an existing Organization 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?: OrganizationState, opts?: CustomResourceOptions): Organization
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        completed_date: Optional[str] = None,
        default_mail_domain: Optional[str] = None,
        delete_directory: Optional[bool] = None,
        delete_identity_center_application: Optional[bool] = None,
        directory_id: Optional[str] = None,
        directory_type: Optional[str] = None,
        interoperability_enabled: Optional[bool] = None,
        kms_key_arn: Optional[str] = None,
        migration_admin: Optional[str] = None,
        organization_alias: Optional[str] = None,
        organization_id: Optional[str] = None,
        region: Optional[str] = None,
        state: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None,
        timeouts: Optional[OrganizationTimeoutsArgs] = None) -> Organization
    func GetOrganization(ctx *Context, name string, id IDInput, state *OrganizationState, opts ...ResourceOption) (*Organization, error)
    public static Organization Get(string name, Input<string> id, OrganizationState? state, CustomResourceOptions? opts = null)
    public static Organization get(String name, Output<String> id, OrganizationState state, CustomResourceOptions options)
    resources:  _:    type: aws:workmail:Organization    get:      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:
    Arn string
    ARN of the Organization.
    CompletedDate string
    Date and time (RFC3339) at which the organization became active.
    DefaultMailDomain string
    Default mail domain for the organization.
    DeleteDirectory bool
    Whether to delete the AWS Directory Service directory associated with the organization on destroy. To update this value after creation, run pulumi up before running terraform destroy. Defaults to false.
    DeleteIdentityCenterApplication bool
    Whether to delete the IAM Identity Center application associated with the organization on destroy. To update this value after creation, run pulumi up before running terraform destroy. Defaults to false.
    DirectoryId string
    ID of an existing directory to associate with the organization. Changing this creates a new resource.
    DirectoryType string
    Type of the associated directory.
    InteroperabilityEnabled bool
    Whether to enable interoperability between WorkMail and Microsoft Exchange. Changing this creates a new resource.
    KmsKeyArn string
    ARN of a customer-managed KMS key to encrypt the organization's data. If omitted, AWS managed keys are used. Changing this creates a new resource.
    MigrationAdmin string
    User ID of the migration admin if migration is enabled.
    OrganizationAlias string

    Alias for the organization. Must be unique globally. Changing this creates a new resource.

    The following arguments are optional:

    OrganizationId string
    ID of the WorkMail Organization.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    State string
    State of the organization.
    Tags Dictionary<string, string>
    A map of tags to assign to the resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    Timeouts OrganizationTimeouts
    Arn string
    ARN of the Organization.
    CompletedDate string
    Date and time (RFC3339) at which the organization became active.
    DefaultMailDomain string
    Default mail domain for the organization.
    DeleteDirectory bool
    Whether to delete the AWS Directory Service directory associated with the organization on destroy. To update this value after creation, run pulumi up before running terraform destroy. Defaults to false.
    DeleteIdentityCenterApplication bool
    Whether to delete the IAM Identity Center application associated with the organization on destroy. To update this value after creation, run pulumi up before running terraform destroy. Defaults to false.
    DirectoryId string
    ID of an existing directory to associate with the organization. Changing this creates a new resource.
    DirectoryType string
    Type of the associated directory.
    InteroperabilityEnabled bool
    Whether to enable interoperability between WorkMail and Microsoft Exchange. Changing this creates a new resource.
    KmsKeyArn string
    ARN of a customer-managed KMS key to encrypt the organization's data. If omitted, AWS managed keys are used. Changing this creates a new resource.
    MigrationAdmin string
    User ID of the migration admin if migration is enabled.
    OrganizationAlias string

    Alias for the organization. Must be unique globally. Changing this creates a new resource.

    The following arguments are optional:

    OrganizationId string
    ID of the WorkMail Organization.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    State string
    State of the organization.
    Tags map[string]string
    A map of tags to assign to the resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    Timeouts OrganizationTimeoutsArgs
    arn String
    ARN of the Organization.
    completedDate String
    Date and time (RFC3339) at which the organization became active.
    defaultMailDomain String
    Default mail domain for the organization.
    deleteDirectory Boolean
    Whether to delete the AWS Directory Service directory associated with the organization on destroy. To update this value after creation, run pulumi up before running terraform destroy. Defaults to false.
    deleteIdentityCenterApplication Boolean
    Whether to delete the IAM Identity Center application associated with the organization on destroy. To update this value after creation, run pulumi up before running terraform destroy. Defaults to false.
    directoryId String
    ID of an existing directory to associate with the organization. Changing this creates a new resource.
    directoryType String
    Type of the associated directory.
    interoperabilityEnabled Boolean
    Whether to enable interoperability between WorkMail and Microsoft Exchange. Changing this creates a new resource.
    kmsKeyArn String
    ARN of a customer-managed KMS key to encrypt the organization's data. If omitted, AWS managed keys are used. Changing this creates a new resource.
    migrationAdmin String
    User ID of the migration admin if migration is enabled.
    organizationAlias String

    Alias for the organization. Must be unique globally. Changing this creates a new resource.

    The following arguments are optional:

    organizationId String
    ID of the WorkMail Organization.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    state String
    State of the organization.
    tags Map<String,String>
    A map of tags to assign to the resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    timeouts OrganizationTimeouts
    arn string
    ARN of the Organization.
    completedDate string
    Date and time (RFC3339) at which the organization became active.
    defaultMailDomain string
    Default mail domain for the organization.
    deleteDirectory boolean
    Whether to delete the AWS Directory Service directory associated with the organization on destroy. To update this value after creation, run pulumi up before running terraform destroy. Defaults to false.
    deleteIdentityCenterApplication boolean
    Whether to delete the IAM Identity Center application associated with the organization on destroy. To update this value after creation, run pulumi up before running terraform destroy. Defaults to false.
    directoryId string
    ID of an existing directory to associate with the organization. Changing this creates a new resource.
    directoryType string
    Type of the associated directory.
    interoperabilityEnabled boolean
    Whether to enable interoperability between WorkMail and Microsoft Exchange. Changing this creates a new resource.
    kmsKeyArn string
    ARN of a customer-managed KMS key to encrypt the organization's data. If omitted, AWS managed keys are used. Changing this creates a new resource.
    migrationAdmin string
    User ID of the migration admin if migration is enabled.
    organizationAlias string

    Alias for the organization. Must be unique globally. Changing this creates a new resource.

    The following arguments are optional:

    organizationId string
    ID of the WorkMail Organization.
    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    state string
    State of the organization.
    tags {[key: string]: string}
    A map of tags to assign to the resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    timeouts OrganizationTimeouts
    arn str
    ARN of the Organization.
    completed_date str
    Date and time (RFC3339) at which the organization became active.
    default_mail_domain str
    Default mail domain for the organization.
    delete_directory bool
    Whether to delete the AWS Directory Service directory associated with the organization on destroy. To update this value after creation, run pulumi up before running terraform destroy. Defaults to false.
    delete_identity_center_application bool
    Whether to delete the IAM Identity Center application associated with the organization on destroy. To update this value after creation, run pulumi up before running terraform destroy. Defaults to false.
    directory_id str
    ID of an existing directory to associate with the organization. Changing this creates a new resource.
    directory_type str
    Type of the associated directory.
    interoperability_enabled bool
    Whether to enable interoperability between WorkMail and Microsoft Exchange. Changing this creates a new resource.
    kms_key_arn str
    ARN of a customer-managed KMS key to encrypt the organization's data. If omitted, AWS managed keys are used. Changing this creates a new resource.
    migration_admin str
    User ID of the migration admin if migration is enabled.
    organization_alias str

    Alias for the organization. Must be unique globally. Changing this creates a new resource.

    The following arguments are optional:

    organization_id str
    ID of the WorkMail Organization.
    region str
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    state str
    State of the organization.
    tags Mapping[str, str]
    A map of tags to assign to the resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    timeouts OrganizationTimeoutsArgs
    arn String
    ARN of the Organization.
    completedDate String
    Date and time (RFC3339) at which the organization became active.
    defaultMailDomain String
    Default mail domain for the organization.
    deleteDirectory Boolean
    Whether to delete the AWS Directory Service directory associated with the organization on destroy. To update this value after creation, run pulumi up before running terraform destroy. Defaults to false.
    deleteIdentityCenterApplication Boolean
    Whether to delete the IAM Identity Center application associated with the organization on destroy. To update this value after creation, run pulumi up before running terraform destroy. Defaults to false.
    directoryId String
    ID of an existing directory to associate with the organization. Changing this creates a new resource.
    directoryType String
    Type of the associated directory.
    interoperabilityEnabled Boolean
    Whether to enable interoperability between WorkMail and Microsoft Exchange. Changing this creates a new resource.
    kmsKeyArn String
    ARN of a customer-managed KMS key to encrypt the organization's data. If omitted, AWS managed keys are used. Changing this creates a new resource.
    migrationAdmin String
    User ID of the migration admin if migration is enabled.
    organizationAlias String

    Alias for the organization. Must be unique globally. Changing this creates a new resource.

    The following arguments are optional:

    organizationId String
    ID of the WorkMail Organization.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    state String
    State of the organization.
    tags Map<String>
    A map of tags to assign to the resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    timeouts Property Map

    Supporting Types

    OrganizationTimeouts, OrganizationTimeoutsArgs

    Create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    Delete string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    Create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    Delete string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    create String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    create str
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete str
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    create String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.

    Import

    Identity Schema

    Required

    • organizationId - (String) ID of the WorkMail Organization.

    Optional

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

    Using pulumi import, import WorkMail Organization using the organizationId. For example:

    $ pulumi import aws:workmail/organization:Organization example m-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

    NOTE: The kmsKeyArn, deleteDirectory, and deleteIdentityCenterApplication attributes are not returned by the AWS API and will not be set after import. Add them back to your configuration manually if needed.

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo
    Viewing docs for AWS v7.24.0
    published on Tuesday, Mar 31, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-aws
      Try Pulumi Cloud free. Your team will thank you.