Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Email
  5. EmailDomain
Oracle Cloud Infrastructure v2.29.0 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-oci

oci.Email.EmailDomain

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.29.0 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-oci

This resource provides the Email Domain resource in Oracle Cloud Infrastructure Email service.

Creates a new email domain. Avoid entering confidential information.

Example Usage

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

const testEmailDomain = new oci.email.EmailDomain("test_email_domain", {
    compartmentId: compartmentId,
    name: emailDomainName,
    definedTags: {
        "Operations.CostCenter": "42",
    },
    description: emailDomainDescription,
    domainVerificationId: testDomainVerification.id,
    freeformTags: {
        Department: "Finance",
    },
});
Copy
import pulumi
import pulumi_oci as oci

test_email_domain = oci.email.EmailDomain("test_email_domain",
    compartment_id=compartment_id,
    name=email_domain_name,
    defined_tags={
        "Operations.CostCenter": "42",
    },
    description=email_domain_description,
    domain_verification_id=test_domain_verification["id"],
    freeform_tags={
        "Department": "Finance",
    })
Copy
package main

import (
	"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/email"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := email.NewEmailDomain(ctx, "test_email_domain", &email.EmailDomainArgs{
			CompartmentId: pulumi.Any(compartmentId),
			Name:          pulumi.Any(emailDomainName),
			DefinedTags: pulumi.StringMap{
				"Operations.CostCenter": pulumi.String("42"),
			},
			Description:          pulumi.Any(emailDomainDescription),
			DomainVerificationId: pulumi.Any(testDomainVerification.Id),
			FreeformTags: pulumi.StringMap{
				"Department": pulumi.String("Finance"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testEmailDomain = new Oci.Email.EmailDomain("test_email_domain", new()
    {
        CompartmentId = compartmentId,
        Name = emailDomainName,
        DefinedTags = 
        {
            { "Operations.CostCenter", "42" },
        },
        Description = emailDomainDescription,
        DomainVerificationId = testDomainVerification.Id,
        FreeformTags = 
        {
            { "Department", "Finance" },
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Email.EmailDomain;
import com.pulumi.oci.Email.EmailDomainArgs;
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 testEmailDomain = new EmailDomain("testEmailDomain", EmailDomainArgs.builder()
            .compartmentId(compartmentId)
            .name(emailDomainName)
            .definedTags(Map.of("Operations.CostCenter", "42"))
            .description(emailDomainDescription)
            .domainVerificationId(testDomainVerification.id())
            .freeformTags(Map.of("Department", "Finance"))
            .build());

    }
}
Copy
resources:
  testEmailDomain:
    type: oci:Email:EmailDomain
    name: test_email_domain
    properties:
      compartmentId: ${compartmentId}
      name: ${emailDomainName}
      definedTags:
        Operations.CostCenter: '42'
      description: ${emailDomainDescription}
      domainVerificationId: ${testDomainVerification.id}
      freeformTags:
        Department: Finance
Copy

Create EmailDomain Resource

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

Constructor syntax

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

@overload
def EmailDomain(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                compartment_id: Optional[str] = None,
                defined_tags: Optional[Mapping[str, str]] = None,
                description: Optional[str] = None,
                domain_verification_id: Optional[str] = None,
                freeform_tags: Optional[Mapping[str, str]] = None,
                name: Optional[str] = None)
func NewEmailDomain(ctx *Context, name string, args EmailDomainArgs, opts ...ResourceOption) (*EmailDomain, error)
public EmailDomain(string name, EmailDomainArgs args, CustomResourceOptions? opts = null)
public EmailDomain(String name, EmailDomainArgs args)
public EmailDomain(String name, EmailDomainArgs args, CustomResourceOptions options)

type: oci:Email:EmailDomain
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. EmailDomainArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. EmailDomainArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. EmailDomainArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. EmailDomainArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. EmailDomainArgs
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 emailDomainResource = new Oci.Email.EmailDomain("emailDomainResource", new()
{
    CompartmentId = "string",
    DefinedTags = 
    {
        { "string", "string" },
    },
    Description = "string",
    DomainVerificationId = "string",
    FreeformTags = 
    {
        { "string", "string" },
    },
    Name = "string",
});
Copy
example, err := Email.NewEmailDomain(ctx, "emailDomainResource", &Email.EmailDomainArgs{
	CompartmentId: pulumi.String("string"),
	DefinedTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Description:          pulumi.String("string"),
	DomainVerificationId: pulumi.String("string"),
	FreeformTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Name: pulumi.String("string"),
})
Copy
var emailDomainResource = new EmailDomain("emailDomainResource", EmailDomainArgs.builder()
    .compartmentId("string")
    .definedTags(Map.of("string", "string"))
    .description("string")
    .domainVerificationId("string")
    .freeformTags(Map.of("string", "string"))
    .name("string")
    .build());
Copy
email_domain_resource = oci.email.EmailDomain("emailDomainResource",
    compartment_id="string",
    defined_tags={
        "string": "string",
    },
    description="string",
    domain_verification_id="string",
    freeform_tags={
        "string": "string",
    },
    name="string")
Copy
const emailDomainResource = new oci.email.EmailDomain("emailDomainResource", {
    compartmentId: "string",
    definedTags: {
        string: "string",
    },
    description: "string",
    domainVerificationId: "string",
    freeformTags: {
        string: "string",
    },
    name: "string",
});
Copy
type: oci:Email:EmailDomain
properties:
    compartmentId: string
    definedTags:
        string: string
    description: string
    domainVerificationId: string
    freeformTags:
        string: string
    name: string
Copy

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

CompartmentId This property is required. string
(Updatable) The OCID of the compartment for this email domain.
DefinedTags Dictionary<string, string>
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
Description string
(Updatable) A string that describes the details about the domain. It does not have to be unique, and you can change it. Avoid entering confidential information.
DomainVerificationId string
(Updatable) Id for Domain in Domain Management (under governance) if DOMAINID verification method used.
FreeformTags Dictionary<string, string>
(Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
Name Changes to this property will trigger replacement. string

The name of the email domain in the Internet Domain Name System (DNS). The email domain name must be unique in the region for this tenancy. Domain names limited to ASCII characters use alphanumeric, dash ("-"), and dot (".") characters. The dash and dot are only allowed between alphanumeric characters. For details, see RFC 5321, section 4.1.2 Non-ASCII domain names should adopt IDNA2008 normalization (RFC 5891-5892).

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

CompartmentId This property is required. string
(Updatable) The OCID of the compartment for this email domain.
DefinedTags map[string]string
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
Description string
(Updatable) A string that describes the details about the domain. It does not have to be unique, and you can change it. Avoid entering confidential information.
DomainVerificationId string
(Updatable) Id for Domain in Domain Management (under governance) if DOMAINID verification method used.
FreeformTags map[string]string
(Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
Name Changes to this property will trigger replacement. string

The name of the email domain in the Internet Domain Name System (DNS). The email domain name must be unique in the region for this tenancy. Domain names limited to ASCII characters use alphanumeric, dash ("-"), and dot (".") characters. The dash and dot are only allowed between alphanumeric characters. For details, see RFC 5321, section 4.1.2 Non-ASCII domain names should adopt IDNA2008 normalization (RFC 5891-5892).

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

compartmentId This property is required. String
(Updatable) The OCID of the compartment for this email domain.
definedTags Map<String,String>
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
description String
(Updatable) A string that describes the details about the domain. It does not have to be unique, and you can change it. Avoid entering confidential information.
domainVerificationId String
(Updatable) Id for Domain in Domain Management (under governance) if DOMAINID verification method used.
freeformTags Map<String,String>
(Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
name Changes to this property will trigger replacement. String

The name of the email domain in the Internet Domain Name System (DNS). The email domain name must be unique in the region for this tenancy. Domain names limited to ASCII characters use alphanumeric, dash ("-"), and dot (".") characters. The dash and dot are only allowed between alphanumeric characters. For details, see RFC 5321, section 4.1.2 Non-ASCII domain names should adopt IDNA2008 normalization (RFC 5891-5892).

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

compartmentId This property is required. string
(Updatable) The OCID of the compartment for this email domain.
definedTags {[key: string]: string}
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
description string
(Updatable) A string that describes the details about the domain. It does not have to be unique, and you can change it. Avoid entering confidential information.
domainVerificationId string
(Updatable) Id for Domain in Domain Management (under governance) if DOMAINID verification method used.
freeformTags {[key: string]: string}
(Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
name Changes to this property will trigger replacement. string

The name of the email domain in the Internet Domain Name System (DNS). The email domain name must be unique in the region for this tenancy. Domain names limited to ASCII characters use alphanumeric, dash ("-"), and dot (".") characters. The dash and dot are only allowed between alphanumeric characters. For details, see RFC 5321, section 4.1.2 Non-ASCII domain names should adopt IDNA2008 normalization (RFC 5891-5892).

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

compartment_id This property is required. str
(Updatable) The OCID of the compartment for this email domain.
defined_tags Mapping[str, str]
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
description str
(Updatable) A string that describes the details about the domain. It does not have to be unique, and you can change it. Avoid entering confidential information.
domain_verification_id str
(Updatable) Id for Domain in Domain Management (under governance) if DOMAINID verification method used.
freeform_tags Mapping[str, str]
(Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
name Changes to this property will trigger replacement. str

The name of the email domain in the Internet Domain Name System (DNS). The email domain name must be unique in the region for this tenancy. Domain names limited to ASCII characters use alphanumeric, dash ("-"), and dot (".") characters. The dash and dot are only allowed between alphanumeric characters. For details, see RFC 5321, section 4.1.2 Non-ASCII domain names should adopt IDNA2008 normalization (RFC 5891-5892).

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

compartmentId This property is required. String
(Updatable) The OCID of the compartment for this email domain.
definedTags Map<String>
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
description String
(Updatable) A string that describes the details about the domain. It does not have to be unique, and you can change it. Avoid entering confidential information.
domainVerificationId String
(Updatable) Id for Domain in Domain Management (under governance) if DOMAINID verification method used.
freeformTags Map<String>
(Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
name Changes to this property will trigger replacement. String

The name of the email domain in the Internet Domain Name System (DNS). The email domain name must be unique in the region for this tenancy. Domain names limited to ASCII characters use alphanumeric, dash ("-"), and dot (".") characters. The dash and dot are only allowed between alphanumeric characters. For details, see RFC 5321, section 4.1.2 Non-ASCII domain names should adopt IDNA2008 normalization (RFC 5891-5892).

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

Outputs

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

ActiveDkimId string
The OCID of the DKIM key that will be used to sign mail sent from this email domain.
DomainVerificationStatus string
The current domain verification status.
Id string
The provider-assigned unique ID for this managed resource.
IsSpf bool
Value of the SPF field. For more information about SPF, please see SPF Authentication.
State string
The current state of the email domain.
SystemTags Dictionary<string, string>
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
TimeCreated string
The time the email domain was created, expressed in RFC 3339 timestamp format, "YYYY-MM-ddThh:mmZ". Example: 2021-02-12T22:47:12.613Z
ActiveDkimId string
The OCID of the DKIM key that will be used to sign mail sent from this email domain.
DomainVerificationStatus string
The current domain verification status.
Id string
The provider-assigned unique ID for this managed resource.
IsSpf bool
Value of the SPF field. For more information about SPF, please see SPF Authentication.
State string
The current state of the email domain.
SystemTags map[string]string
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
TimeCreated string
The time the email domain was created, expressed in RFC 3339 timestamp format, "YYYY-MM-ddThh:mmZ". Example: 2021-02-12T22:47:12.613Z
activeDkimId String
The OCID of the DKIM key that will be used to sign mail sent from this email domain.
domainVerificationStatus String
The current domain verification status.
id String
The provider-assigned unique ID for this managed resource.
isSpf Boolean
Value of the SPF field. For more information about SPF, please see SPF Authentication.
state String
The current state of the email domain.
systemTags Map<String,String>
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated String
The time the email domain was created, expressed in RFC 3339 timestamp format, "YYYY-MM-ddThh:mmZ". Example: 2021-02-12T22:47:12.613Z
activeDkimId string
The OCID of the DKIM key that will be used to sign mail sent from this email domain.
domainVerificationStatus string
The current domain verification status.
id string
The provider-assigned unique ID for this managed resource.
isSpf boolean
Value of the SPF field. For more information about SPF, please see SPF Authentication.
state string
The current state of the email domain.
systemTags {[key: string]: string}
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated string
The time the email domain was created, expressed in RFC 3339 timestamp format, "YYYY-MM-ddThh:mmZ". Example: 2021-02-12T22:47:12.613Z
active_dkim_id str
The OCID of the DKIM key that will be used to sign mail sent from this email domain.
domain_verification_status str
The current domain verification status.
id str
The provider-assigned unique ID for this managed resource.
is_spf bool
Value of the SPF field. For more information about SPF, please see SPF Authentication.
state str
The current state of the email domain.
system_tags Mapping[str, str]
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
time_created str
The time the email domain was created, expressed in RFC 3339 timestamp format, "YYYY-MM-ddThh:mmZ". Example: 2021-02-12T22:47:12.613Z
activeDkimId String
The OCID of the DKIM key that will be used to sign mail sent from this email domain.
domainVerificationStatus String
The current domain verification status.
id String
The provider-assigned unique ID for this managed resource.
isSpf Boolean
Value of the SPF field. For more information about SPF, please see SPF Authentication.
state String
The current state of the email domain.
systemTags Map<String>
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated String
The time the email domain was created, expressed in RFC 3339 timestamp format, "YYYY-MM-ddThh:mmZ". Example: 2021-02-12T22:47:12.613Z

Look up Existing EmailDomain Resource

Get an existing EmailDomain 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?: EmailDomainState, opts?: CustomResourceOptions): EmailDomain
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        active_dkim_id: Optional[str] = None,
        compartment_id: Optional[str] = None,
        defined_tags: Optional[Mapping[str, str]] = None,
        description: Optional[str] = None,
        domain_verification_id: Optional[str] = None,
        domain_verification_status: Optional[str] = None,
        freeform_tags: Optional[Mapping[str, str]] = None,
        is_spf: Optional[bool] = None,
        name: Optional[str] = None,
        state: Optional[str] = None,
        system_tags: Optional[Mapping[str, str]] = None,
        time_created: Optional[str] = None) -> EmailDomain
func GetEmailDomain(ctx *Context, name string, id IDInput, state *EmailDomainState, opts ...ResourceOption) (*EmailDomain, error)
public static EmailDomain Get(string name, Input<string> id, EmailDomainState? state, CustomResourceOptions? opts = null)
public static EmailDomain get(String name, Output<String> id, EmailDomainState state, CustomResourceOptions options)
resources:  _:    type: oci:Email:EmailDomain    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
ActiveDkimId string
The OCID of the DKIM key that will be used to sign mail sent from this email domain.
CompartmentId string
(Updatable) The OCID of the compartment for this email domain.
DefinedTags Dictionary<string, string>
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
Description string
(Updatable) A string that describes the details about the domain. It does not have to be unique, and you can change it. Avoid entering confidential information.
DomainVerificationId string
(Updatable) Id for Domain in Domain Management (under governance) if DOMAINID verification method used.
DomainVerificationStatus string
The current domain verification status.
FreeformTags Dictionary<string, string>
(Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
IsSpf bool
Value of the SPF field. For more information about SPF, please see SPF Authentication.
Name Changes to this property will trigger replacement. string

The name of the email domain in the Internet Domain Name System (DNS). The email domain name must be unique in the region for this tenancy. Domain names limited to ASCII characters use alphanumeric, dash ("-"), and dot (".") characters. The dash and dot are only allowed between alphanumeric characters. For details, see RFC 5321, section 4.1.2 Non-ASCII domain names should adopt IDNA2008 normalization (RFC 5891-5892).

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

State string
The current state of the email domain.
SystemTags Dictionary<string, string>
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
TimeCreated string
The time the email domain was created, expressed in RFC 3339 timestamp format, "YYYY-MM-ddThh:mmZ". Example: 2021-02-12T22:47:12.613Z
ActiveDkimId string
The OCID of the DKIM key that will be used to sign mail sent from this email domain.
CompartmentId string
(Updatable) The OCID of the compartment for this email domain.
DefinedTags map[string]string
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
Description string
(Updatable) A string that describes the details about the domain. It does not have to be unique, and you can change it. Avoid entering confidential information.
DomainVerificationId string
(Updatable) Id for Domain in Domain Management (under governance) if DOMAINID verification method used.
DomainVerificationStatus string
The current domain verification status.
FreeformTags map[string]string
(Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
IsSpf bool
Value of the SPF field. For more information about SPF, please see SPF Authentication.
Name Changes to this property will trigger replacement. string

The name of the email domain in the Internet Domain Name System (DNS). The email domain name must be unique in the region for this tenancy. Domain names limited to ASCII characters use alphanumeric, dash ("-"), and dot (".") characters. The dash and dot are only allowed between alphanumeric characters. For details, see RFC 5321, section 4.1.2 Non-ASCII domain names should adopt IDNA2008 normalization (RFC 5891-5892).

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

State string
The current state of the email domain.
SystemTags map[string]string
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
TimeCreated string
The time the email domain was created, expressed in RFC 3339 timestamp format, "YYYY-MM-ddThh:mmZ". Example: 2021-02-12T22:47:12.613Z
activeDkimId String
The OCID of the DKIM key that will be used to sign mail sent from this email domain.
compartmentId String
(Updatable) The OCID of the compartment for this email domain.
definedTags Map<String,String>
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
description String
(Updatable) A string that describes the details about the domain. It does not have to be unique, and you can change it. Avoid entering confidential information.
domainVerificationId String
(Updatable) Id for Domain in Domain Management (under governance) if DOMAINID verification method used.
domainVerificationStatus String
The current domain verification status.
freeformTags Map<String,String>
(Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
isSpf Boolean
Value of the SPF field. For more information about SPF, please see SPF Authentication.
name Changes to this property will trigger replacement. String

The name of the email domain in the Internet Domain Name System (DNS). The email domain name must be unique in the region for this tenancy. Domain names limited to ASCII characters use alphanumeric, dash ("-"), and dot (".") characters. The dash and dot are only allowed between alphanumeric characters. For details, see RFC 5321, section 4.1.2 Non-ASCII domain names should adopt IDNA2008 normalization (RFC 5891-5892).

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

state String
The current state of the email domain.
systemTags Map<String,String>
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated String
The time the email domain was created, expressed in RFC 3339 timestamp format, "YYYY-MM-ddThh:mmZ". Example: 2021-02-12T22:47:12.613Z
activeDkimId string
The OCID of the DKIM key that will be used to sign mail sent from this email domain.
compartmentId string
(Updatable) The OCID of the compartment for this email domain.
definedTags {[key: string]: string}
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
description string
(Updatable) A string that describes the details about the domain. It does not have to be unique, and you can change it. Avoid entering confidential information.
domainVerificationId string
(Updatable) Id for Domain in Domain Management (under governance) if DOMAINID verification method used.
domainVerificationStatus string
The current domain verification status.
freeformTags {[key: string]: string}
(Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
isSpf boolean
Value of the SPF field. For more information about SPF, please see SPF Authentication.
name Changes to this property will trigger replacement. string

The name of the email domain in the Internet Domain Name System (DNS). The email domain name must be unique in the region for this tenancy. Domain names limited to ASCII characters use alphanumeric, dash ("-"), and dot (".") characters. The dash and dot are only allowed between alphanumeric characters. For details, see RFC 5321, section 4.1.2 Non-ASCII domain names should adopt IDNA2008 normalization (RFC 5891-5892).

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

state string
The current state of the email domain.
systemTags {[key: string]: string}
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated string
The time the email domain was created, expressed in RFC 3339 timestamp format, "YYYY-MM-ddThh:mmZ". Example: 2021-02-12T22:47:12.613Z
active_dkim_id str
The OCID of the DKIM key that will be used to sign mail sent from this email domain.
compartment_id str
(Updatable) The OCID of the compartment for this email domain.
defined_tags Mapping[str, str]
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
description str
(Updatable) A string that describes the details about the domain. It does not have to be unique, and you can change it. Avoid entering confidential information.
domain_verification_id str
(Updatable) Id for Domain in Domain Management (under governance) if DOMAINID verification method used.
domain_verification_status str
The current domain verification status.
freeform_tags Mapping[str, str]
(Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
is_spf bool
Value of the SPF field. For more information about SPF, please see SPF Authentication.
name Changes to this property will trigger replacement. str

The name of the email domain in the Internet Domain Name System (DNS). The email domain name must be unique in the region for this tenancy. Domain names limited to ASCII characters use alphanumeric, dash ("-"), and dot (".") characters. The dash and dot are only allowed between alphanumeric characters. For details, see RFC 5321, section 4.1.2 Non-ASCII domain names should adopt IDNA2008 normalization (RFC 5891-5892).

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

state str
The current state of the email domain.
system_tags Mapping[str, str]
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
time_created str
The time the email domain was created, expressed in RFC 3339 timestamp format, "YYYY-MM-ddThh:mmZ". Example: 2021-02-12T22:47:12.613Z
activeDkimId String
The OCID of the DKIM key that will be used to sign mail sent from this email domain.
compartmentId String
(Updatable) The OCID of the compartment for this email domain.
definedTags Map<String>
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
description String
(Updatable) A string that describes the details about the domain. It does not have to be unique, and you can change it. Avoid entering confidential information.
domainVerificationId String
(Updatable) Id for Domain in Domain Management (under governance) if DOMAINID verification method used.
domainVerificationStatus String
The current domain verification status.
freeformTags Map<String>
(Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
isSpf Boolean
Value of the SPF field. For more information about SPF, please see SPF Authentication.
name Changes to this property will trigger replacement. String

The name of the email domain in the Internet Domain Name System (DNS). The email domain name must be unique in the region for this tenancy. Domain names limited to ASCII characters use alphanumeric, dash ("-"), and dot (".") characters. The dash and dot are only allowed between alphanumeric characters. For details, see RFC 5321, section 4.1.2 Non-ASCII domain names should adopt IDNA2008 normalization (RFC 5891-5892).

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

state String
The current state of the email domain.
systemTags Map<String>
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated String
The time the email domain was created, expressed in RFC 3339 timestamp format, "YYYY-MM-ddThh:mmZ". Example: 2021-02-12T22:47:12.613Z

Import

EmailDomains can be imported using the id, e.g.

$ pulumi import oci:Email/emailDomain:EmailDomain test_email_domain "id"
Copy

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

Package Details

Repository
oci pulumi/pulumi-oci
License
Apache-2.0
Notes
This Pulumi package is based on the oci Terraform Provider.
Oracle Cloud Infrastructure v2.29.0 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-oci