Domain

Provides a Mailgun App resource. This can be used to create and manage applications on Mailgun.

After DNS records are set, domain verification should be triggered manually using PUT /domains/<domain>/verify

Example Usage

using Pulumi;
using Mailgun = Pulumi.Mailgun;

class MyStack : Stack
{
    public MyStack()
    {
        // Create a new Mailgun domain
        var @default = new Mailgun.Domain("default", new Mailgun.DomainArgs
        {
            Region = "us",
            SpamAction = "disabled",
        });
    }

}

Coming soon!

import pulumi
import pulumi_mailgun as mailgun

# Create a new Mailgun domain
default = mailgun.Domain("default",
    region="us",
    spam_action="disabled")

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

// Create a new Mailgun domain
const defaultDomain = new mailgun.Domain("default", {
    region: "us",
    spamAction: "disabled",
});

Create a Domain Resource

new Domain(name: string, args?: DomainArgs, opts?: CustomResourceOptions);

def Domain(resource_name, opts=None, name=None, region=None, spam_action=None, wildcard=None, __props__=None);

func NewDomain(ctx *Context, name string, args *DomainArgs, opts ...ResourceOption) (*Domain, error)

public Domain(string name, DomainArgs? args = null, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args DomainArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args DomainArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args DomainArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

Domain Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The Domain resource accepts the following input properties:

Name string: The domain to add to Mailgun
Region string: The region where domain will be created. Default value is us.
SpamAction string: disabled or tag Disable, no spam filtering will occur for inbound messages. Tag, messages will be tagged with a spam header.
Wildcard bool: Boolean that determines whether the domain will accept email for sub-domains.

Name string: The domain to add to Mailgun
Region string: The region where domain will be created. Default value is us.
SpamAction string: disabled or tag Disable, no spam filtering will occur for inbound messages. Tag, messages will be tagged with a spam header.
Wildcard bool: Boolean that determines whether the domain will accept email for sub-domains.

name string: The domain to add to Mailgun
region string: The region where domain will be created. Default value is us.
spamAction string: disabled or tag Disable, no spam filtering will occur for inbound messages. Tag, messages will be tagged with a spam header.
wildcard boolean: Boolean that determines whether the domain will accept email for sub-domains.

name str: The domain to add to Mailgun
region str: The region where domain will be created. Default value is us.
spam_action str: disabled or tag Disable, no spam filtering will occur for inbound messages. Tag, messages will be tagged with a spam header.
wildcard bool: Boolean that determines whether the domain will accept email for sub-domains.

Outputs

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

Id string: The provider-assigned unique ID for this managed resource.
ReceivingRecords List<DomainReceivingRecord>: A list of DNS records for receiving validation.
SendingRecords List<DomainSendingRecord>: A list of DNS records for sending validation.
SmtpLogin string: The login email for the SMTP server.
SmtpPassword string: The password to the SMTP server.

Id string: The provider-assigned unique ID for this managed resource.
ReceivingRecords []DomainReceivingRecord: A list of DNS records for receiving validation.
SendingRecords []DomainSendingRecord: A list of DNS records for sending validation.
SmtpLogin string: The login email for the SMTP server.
SmtpPassword string: The password to the SMTP server.

id string: The provider-assigned unique ID for this managed resource.
receivingRecords DomainReceivingRecord[]: A list of DNS records for receiving validation.
sendingRecords DomainSendingRecord[]: A list of DNS records for sending validation.
smtpLogin string: The login email for the SMTP server.
smtpPassword string: The password to the SMTP server.

id str: The provider-assigned unique ID for this managed resource.
receiving_records List[DomainReceivingRecord]: A list of DNS records for receiving validation.
sending_records List[DomainSendingRecord]: A list of DNS records for sending validation.
smtp_login str: The login email for the SMTP server.
smtp_password str: The password to the SMTP server.

Look up an Existing Domain Resource

Get an existing Domain 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?: DomainState, opts?: CustomResourceOptions): Domain

static get(resource_name, id, opts=None, name=None, receiving_records=None, region=None, sending_records=None, smtp_login=None, smtp_password=None, spam_action=None, wildcard=None, __props__=None);

func GetDomain(ctx *Context, name string, id IDInput, state *DomainState, opts ...ResourceOption) (*Domain, error)

public static Domain Get(string name, Input<string> id, DomainState? state, CustomResourceOptions? opts = null)

name: The unique name of the resulting resource.
id: 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: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: 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: The unique name of the resulting resource.
id: 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:

Name string: The domain to add to Mailgun
ReceivingRecords List<DomainReceivingRecordArgs>: A list of DNS records for receiving validation.
Region string: The region where domain will be created. Default value is us.
SendingRecords List<DomainSendingRecordArgs>: A list of DNS records for sending validation.
SmtpLogin string: The login email for the SMTP server.
SmtpPassword string: The password to the SMTP server.
SpamAction string: disabled or tag Disable, no spam filtering will occur for inbound messages. Tag, messages will be tagged with a spam header.
Wildcard bool: Boolean that determines whether the domain will accept email for sub-domains.

Name string: The domain to add to Mailgun
ReceivingRecords []DomainReceivingRecord: A list of DNS records for receiving validation.
Region string: The region where domain will be created. Default value is us.
SendingRecords []DomainSendingRecord: A list of DNS records for sending validation.
SmtpLogin string: The login email for the SMTP server.
SmtpPassword string: The password to the SMTP server.
SpamAction string: disabled or tag Disable, no spam filtering will occur for inbound messages. Tag, messages will be tagged with a spam header.
Wildcard bool: Boolean that determines whether the domain will accept email for sub-domains.

name string: The domain to add to Mailgun
receivingRecords DomainReceivingRecord[]: A list of DNS records for receiving validation.
region string: The region where domain will be created. Default value is us.
sendingRecords DomainSendingRecord[]: A list of DNS records for sending validation.
smtpLogin string: The login email for the SMTP server.
smtpPassword string: The password to the SMTP server.
spamAction string: disabled or tag Disable, no spam filtering will occur for inbound messages. Tag, messages will be tagged with a spam header.
wildcard boolean: Boolean that determines whether the domain will accept email for sub-domains.

name str: The domain to add to Mailgun
receiving_records List[DomainReceivingRecord]: A list of DNS records for receiving validation.
region str: The region where domain will be created. Default value is us.
sending_records List[DomainSendingRecord]: A list of DNS records for sending validation.
smtp_login str: The login email for the SMTP server.
smtp_password str: The password to the SMTP server.
spam_action str: disabled or tag Disable, no spam filtering will occur for inbound messages. Tag, messages will be tagged with a spam header.
wildcard bool: Boolean that determines whether the domain will accept email for sub-domains.

Supporting Types

DomainReceivingRecord

See the output API doc for this type.

Priority string: The priority of the record.
RecordType string: The record type.
Valid string: "valid" if the record is valid.
Value string: The value of the record.

Priority string: The priority of the record.
RecordType string: The record type.
Valid string: "valid" if the record is valid.
Value string: The value of the record.

priority string: The priority of the record.
recordType string: The record type.
valid string: "valid" if the record is valid.
value string: The value of the record.

priority str: The priority of the record.
recordType str: The record type.
valid str: "valid" if the record is valid.
value str: The value of the record.

DomainSendingRecord

See the output API doc for this type.

Name string: The domain to add to Mailgun
RecordType string: The record type.
Valid string: "valid" if the record is valid.
Value string: The value of the record.

Name string: The domain to add to Mailgun
RecordType string: The record type.
Valid string: "valid" if the record is valid.
Value string: The value of the record.

name string: The domain to add to Mailgun
recordType string: The record type.
valid string: "valid" if the record is valid.
value string: The value of the record.

name str: The domain to add to Mailgun
recordType str: The record type.
valid str: "valid" if the record is valid.
value str: The value of the record.

Package Details

Repository: https://github.com/pulumi/pulumi-mailgun
License: Apache-2.0
Notes: This Pulumi package is based on the mailgun Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud