Organization class

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")
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 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
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_workmail_organization" "example" {
  organization_alias = "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.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")
            .build());

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

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.

Constructors

Organization(String name, {OrganizationArgs? args, CustomResourceOptions? options})
Creates a new Organization. name The Pulumi resource name. args Arguments used to configure this Organization. The set of arguments for Organization. options Resource options controlling this resource's behavior.
Organization.reference(String urn)
Creates a typed reference to an existing Organization resource.

Properties

arn ↔ Output<String>
ARN of the Organization.
latefinal
childResources → Set<Resource>
finalinherited
completedDate ↔ Output<String>
Date and time (RFC3339) at which the organization became active.
latefinal
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
defaultMailDomain ↔ Output<String>
Default mail domain for the organization.
latefinal
deleteDirectory ↔ Output<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.
latefinal
deleteIdentityCenterApplication ↔ Output<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.
latefinal
directoryId ↔ Output<String>
ID of an existing directory to associate with the organization. Changing this creates a new resource.
latefinal
directoryType ↔ Output<String>
Type of the associated directory.
latefinal
hashCode → int
The hash code for this object.
no setterinherited
id ↔ Output<String>
getter/setter pairinherited
interoperabilityEnabled ↔ Output<bool>
Whether to enable interoperability between WorkMail and Microsoft Exchange. Changing this creates a new resource.
latefinal
isCustom → bool
Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool
Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool
Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool
Whether this instance represents a resource value returned over RPC.
finalinherited
kmsKeyArn ↔ Output<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.
latefinal
migrationAdmin ↔ Output<String>
User ID of the migration admin if migration is enabled.
latefinal
organizationAlias ↔ Output<String>
Alias for the organization. Must be unique globally. Changing this creates a new resource.
latefinal
organizationId ↔ Output<String>
ID of the WorkMail Organization.
latefinal
region ↔ Output<String>
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
resourceTransforms → List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
state ↔ Output<String>
State of the organization.
latefinal
tags ↔ Output<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.
latefinal
tagsAll ↔ Output<Map<String, String>>
A map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
latefinal
timeouts ↔ Output<OrganizationTimeouts?>
latefinal
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>
latefinalinherited

Methods

failId(Object error) → void
Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void
Completes all output properties with error.
inherited
failUrn(Object error) → void
Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?
Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String
Returns this resource's logical name.
inherited
getResourceType() → String
Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>
Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void
Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void
Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void
Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>
Serializes resource properties for RPC transmission.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {OrganizationState? state, CustomResourceOptions? options}) → Organization
Gets an existing Organization resource's state with the given name and id.