DefaultDomain class

Manages the default mail domain for an AWS WorkMail organization.

> NOTE: This does not register a domain for workmail. This resource requires a verified domain name to be used as default domain for 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"});
const exampleDefaultDomain = new aws.workmail.DefaultDomain("example", {
    organizationId: example.id,
    domainName: example.defaultMailDomain,
});
import pulumi
import pulumi_aws as aws

example = aws.workmail.Organization("example", organization_alias="example-org")
example_default_domain = aws.workmail.DefaultDomain("example",
    organization_id=example.id,
    domain_name=example.default_mail_domain)
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",
    });

    var exampleDefaultDomain = new Aws.WorkMail.DefaultDomain("example", new()
    {
        OrganizationId = example.Id,
        DomainName = example.DefaultMailDomain,
    });

});
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"),
		})
		if err != nil {
			return err
		}
		_, err = workmail.NewDefaultDomain(ctx, "example", &workmail.DefaultDomainArgs{
			OrganizationId: example.ID().ToIDOutput().ToStringOutput(),
			DomainName:     example.DefaultMailDomain,
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_workmail_organization" "example" {
  organization_alias = "example-org"
}
resource "aws_workmail_defaultdomain" "example" {
  organization_id = aws_workmail_organization.example.id
  domain_name     = aws_workmail_organization.example.default_mail_domain
}
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.DefaultDomain;
import com.pulumi.aws.workmail.DefaultDomainArgs;
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());

        var exampleDefaultDomain = new DefaultDomain("exampleDefaultDomain", DefaultDomainArgs.builder()
            .organizationId(example.id())
            .domainName(example.defaultMailDomain())
            .build());

    }
}
resources:
  example:
    type: aws:workmail:Organization
    properties:
      organizationAlias: example-org
  exampleDefaultDomain:
    type: aws:workmail:DefaultDomain
    name: example
    properties:
      organizationId: ${example.id}
      domainName: ${example.defaultMailDomain}

Import

Identity Schema

Required

  • organizationId (String) Identifier of the WorkMail organization.

Optional

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

Using pulumi import, import WorkMail Default Domain using the organization ID. For example:

$ pulumi import aws:workmail/defaultDomain:DefaultDomain example "m-1234567890abcdef0"

Constructors

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

Properties

childResources Set<Resource>
finalinherited
completionSources Map<String, IOutputCompletionSource>
latefinalinherited
domainName ↔ Output<String>
Mail domain name to set as the default.
latefinal
hashCode int
The hash code for this object.
no setterinherited
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
organizationId ↔ Output<String>
Identifier of the WorkMail organization. Changing this forces a new resource.
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
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, {DefaultDomainState? state, CustomResourceOptions? options}) DefaultDomain
Gets an existing DefaultDomain resource's state with the given name and id.