Group class

Manages an AWS WorkMail Group.

Example Usage

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

const example = new aws.workmail.Organization("example", {
    organizationAlias: "example-workmail-org",
    deleteDirectory: true,
});
const exampleGroup = new aws.workmail.Group("example", {
    organizationId: example.organizationId,
    email: pulumi.interpolate`engineering@${example.defaultMailDomain}`,
    name: "engineering",
});
import pulumi
import pulumi_aws as aws

example = aws.workmail.Organization("example",
    organization_alias="example-workmail-org",
    delete_directory=True)
example_group = aws.workmail.Group("example",
    organization_id=example.organization_id,
    email=example.default_mail_domain.apply(lambda default_mail_domain: f"engineering@{default_mail_domain}"),
    name="engineering")
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-workmail-org",
        DeleteDirectory = true,
    });

    var exampleGroup = new Aws.WorkMail.Group("example", new()
    {
        OrganizationId = example.OrganizationId,
        Email = example.DefaultMailDomain.Apply(defaultMailDomain => $"engineering@{defaultMailDomain}"),
        Name = "engineering",
    });

});
package main

import (
	"fmt"

	"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-workmail-org"),
			DeleteDirectory:   pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		_, err = workmail.NewGroup(ctx, "example", &workmail.GroupArgs{
			OrganizationId: example.OrganizationId,
			Email: example.DefaultMailDomain.ApplyT(func(defaultMailDomain string) (string, error) {
				return fmt.Sprintf("engineering@%v", defaultMailDomain), nil
			}).(pulumi.StringOutput),
			Name: pulumi.String("engineering"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_workmail_organization" "example" {
  organization_alias = "example-workmail-org"
  delete_directory   = true
}
resource "aws_workmail_group" "example" {
  organization_id = aws_workmail_organization.example.organization_id
  email           ="engineering@${aws_workmail_organization.example.default_mail_domain}"
  name            = "engineering"
}
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.Group;
import com.pulumi.aws.workmail.GroupArgs;
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-workmail-org")
            .deleteDirectory(true)
            .build());

        var exampleGroup = new Group("exampleGroup", GroupArgs.builder()
            .organizationId(example.organizationId())
            .email(example.defaultMailDomain().applyValue(_defaultMailDomain -> String.format("engineering@%s", _defaultMailDomain)))
            .name("engineering")
            .build());

    }
}
resources:
  example:
    type: aws:workmail:Organization
    properties:
      organizationAlias: example-workmail-org
      deleteDirectory: true
  exampleGroup:
    type: aws:workmail:Group
    name: example
    properties:
      organizationId: ${example.organizationId}
      email: engineering@${example.defaultMailDomain}
      name: engineering

Import

Identity Schema

Required

  • groupId - Identifier of the group.
  • organizationId - Identifier of the WorkMail organization where the group is managed.

Optional

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

Using pulumi import, import WorkMail Group using organization_id,group_id. For example:

$ pulumi import aws:workmail/group:Group example m-1234567890abcdef,S-1-1-12-1234567890-123456789-123456789-1234

Constructors

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

Properties

childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
disabledDate ↔ Output<String>
Timestamp when the group was disabled from WorkMail use.
latefinal
email ↔ Output<String>
Primary email address used to register the group with WorkMail.
latefinal
enabledDate ↔ Output<String>
Timestamp when the group was enabled for WorkMail use.
latefinal
groupId ↔ Output<String>
Identifier of the group.
latefinal
hashCode → int
The hash code for this object.
no setterinherited
hiddenFromGlobalAddressList ↔ Output<bool>
Whether to hide the group from the global address list.
latefinal
id ↔ Output<String>
getter/setter pairinherited
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
name ↔ Output<String>
Name of the group.
latefinal
organizationId ↔ Output<String>
Identifier of the WorkMail organization where the group is managed.
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>
Current WorkMail state of the group.
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, {GroupState? state, CustomResourceOptions? options}) → Group
Gets an existing Group resource's state with the given name and id.