1. Packages
  2. ImprovMX
  3. API Docs
  4. Domain
Viewing docs for ImprovMX v0.2.7
published on Tuesday, Mar 24, 2026 by lokkju
Schema (JSON)
lokkju/pulumi-improvmx

improvmx.Domain

improvmx logo
Viewing docs for ImprovMX v0.2.7
published on Tuesday, Mar 24, 2026 by lokkju
Schema (JSON)
lokkju/pulumi-improvmx

    Manages an ImprovMX domain for email forwarding.

    Create Domain Resource

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

    Constructor syntax

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

@overload
def Domain(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           domain: Optional[str] = None,
           notification_email: Optional[str] = None,
           webhook: Optional[str] = None)
    func NewDomain(ctx *Context, name string, args DomainArgs, opts ...ResourceOption) (*Domain, error)
    public Domain(string name, DomainArgs args, CustomResourceOptions? opts = null)
    public Domain(String name, DomainArgs args)
public Domain(String name, DomainArgs args, CustomResourceOptions options)

    type: improvmx:Domain
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    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.
    args DomainArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control 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.
    name String
    The unique name of the resource.
    args DomainArgs
    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 domainResource = new Improvmx.Index.Domain("domainResource", new()
{
    DomainName = "string",
    NotificationEmail = "string",
    Webhook = "string",
});

    example, err := improvmx.NewDomain(ctx, "domainResource", &improvmx.DomainArgs{
	Domain:            pulumi.String("string"),
	NotificationEmail: pulumi.String("string"),
	Webhook:           pulumi.String("string"),
})

    var domainResource = new Domain("domainResource", DomainArgs.builder()
    .domain("string")
    .notificationEmail("string")
    .webhook("string")
    .build());

    domain_resource = improvmx.Domain("domainResource",
    domain="string",
    notification_email="string",
    webhook="string")

    const domainResource = new improvmx.Domain("domainResource", {
    domain: "string",
    notificationEmail: "string",
    webhook: "string",
});

    type: improvmx:Domain
properties:
    domain: string
    notificationEmail: string
    webhook: string

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

    DomainName string
    The domain name to register with ImprovMX.
    NotificationEmail string
    Email address for delivery notifications.
    Webhook string
    Webhook URL for delivery notifications.
    Domain string
    The domain name to register with ImprovMX.
    NotificationEmail string
    Email address for delivery notifications.
    Webhook string
    Webhook URL for delivery notifications.
    domain String
    The domain name to register with ImprovMX.
    notificationEmail String
    Email address for delivery notifications.
    webhook String
    Webhook URL for delivery notifications.
    domain string
    The domain name to register with ImprovMX.
    notificationEmail string
    Email address for delivery notifications.
    webhook string
    Webhook URL for delivery notifications.
    domain str
    The domain name to register with ImprovMX.
    notification_email str
    Email address for delivery notifications.
    webhook str
    Webhook URL for delivery notifications.
    domain String
    The domain name to register with ImprovMX.
    notificationEmail String
    Email address for delivery notifications.
    webhook String
    Webhook URL for delivery notifications.

    Outputs

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

    Active bool
    Whether the domain's DNS is correctly configured.
    Display string
    Display name of the domain.
    Id string
    The provider-assigned unique ID for this managed resource.
    Active bool
    Whether the domain's DNS is correctly configured.
    Display string
    Display name of the domain.
    Id string
    The provider-assigned unique ID for this managed resource.
    active Boolean
    Whether the domain's DNS is correctly configured.
    display String
    Display name of the domain.
    id String
    The provider-assigned unique ID for this managed resource.
    active boolean
    Whether the domain's DNS is correctly configured.
    display string
    Display name of the domain.
    id string
    The provider-assigned unique ID for this managed resource.
    active bool
    Whether the domain's DNS is correctly configured.
    display str
    Display name of the domain.
    id str
    The provider-assigned unique ID for this managed resource.
    active Boolean
    Whether the domain's DNS is correctly configured.
    display String
    Display name of the domain.
    id String
    The provider-assigned unique ID for this managed resource.

    Package Details

    Repository
    improvmx lokkju/pulumi-improvmx
    License
    improvmx logo
    Viewing docs for ImprovMX v0.2.7
    published on Tuesday, Mar 24, 2026 by lokkju
    Schema (JSON)
    lokkju/pulumi-improvmx
      Try Pulumi Cloud free. Your team will thank you.