Domain class

Manages a mail domain registered to 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.Domain("example", {
    organizationId: exampleAwsWorkmailOrganization.id,
    domainName: "example.com",
});
import pulumi
import pulumi_aws as aws

example = aws.workmail.Domain("example",
    organization_id=example_aws_workmail_organization["id"],
    domain_name="example.com")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = new Aws.WorkMail.Domain("example", new()
    {
        OrganizationId = exampleAwsWorkmailOrganization.Id,
        DomainName = "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 {
		_, err := workmail.NewDomain(ctx, "example", &workmail.DomainArgs{
			OrganizationId: pulumi.Any(exampleAwsWorkmailOrganization.Id),
			DomainName:     pulumi.String("example.com"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_workmail_domain" "example" {
  organization_id = exampleAwsWorkmailOrganization.id
  domain_name     = "example.com"
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.workmail.Domain;
import com.pulumi.aws.workmail.DomainArgs;
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 Domain("example", DomainArgs.builder()
            .organizationId(exampleAwsWorkmailOrganization.id())
            .domainName("example.com")
            .build());

    }
}
resources:
  example:
    type: aws:workmail:Domain
    properties:
      organizationId: ${exampleAwsWorkmailOrganization.id}
      domainName: example.com

Import

Identity Schema

Required

  • domainName (String) Mail domain name.
  • 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 Domain using organization_id,domain_name. For example:

$ pulumi import aws:workmail/domain:Domain example "m-1234567890abcdef0,example.com"

Constructors

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

Properties

childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
dkimVerificationStatus ↔ Output<String>
DKIM verification status. Values: PENDING, VERIFIED, FAILED.
latefinal
domainName ↔ Output<String>
Mail domain name to register. Changing this forces a new resource.
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
isDefault ↔ Output<bool>
Whether this domain is the default mail domain for the organization.
latefinal
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
isTestDomain ↔ Output<bool>
Whether this is the auto-provisioned test domain.
latefinal
organizationId ↔ Output<String>
Identifier of the WorkMail organization. Changing this forces a new resource.
latefinal
ownershipVerificationStatus ↔ Output<String>
Domain ownership verification status. Values: PENDING, VERIFIED, FAILED.
latefinal
records ↔ Output<List<DomainRecord>>
List of DNS records required for domain verification. See records Block below.
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, {DomainState? state, CustomResourceOptions? options}) → Domain
Gets an existing Domain resource's state with the given name and id.