1. Packages
  2. Constellix Provider
  3. API Docs
  4. getMxRecord
constellix 0.4.6 published on Friday, Mar 7, 2025 by constellix

constellix.getMxRecord

Explore with Pulumi AI

Data source for MX record

Example Usage

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

const datamx = constellix.getMxRecord({
    domainId: data.constellix_domain.first.id,
    name: "mxdatasource",
    sourceType: "domains",
});
Copy
import pulumi
import pulumi_constellix as constellix

datamx = constellix.get_mx_record(domain_id=data["constellix_domain"]["first"]["id"],
    name="mxdatasource",
    source_type="domains")
Copy
package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/constellix/constellix"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := constellix.LookupMxRecord(ctx, &constellix.LookupMxRecordArgs{
			DomainId:   data.Constellix_domain.First.Id,
			Name:       "mxdatasource",
			SourceType: "domains",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Constellix = Pulumi.Constellix;

return await Deployment.RunAsync(() => 
{
    var datamx = Constellix.GetMxRecord.Invoke(new()
    {
        DomainId = data.Constellix_domain.First.Id,
        Name = "mxdatasource",
        SourceType = "domains",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.constellix.ConstellixFunctions;
import com.pulumi.constellix.inputs.GetMxRecordArgs;
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) {
        final var datamx = ConstellixFunctions.getMxRecord(GetMxRecordArgs.builder()
            .domainId(data.constellix_domain().first().id())
            .name("mxdatasource")
            .sourceType("domains")
            .build());

    }
}
Copy
variables:
  datamx:
    fn::invoke:
      function: constellix:getMxRecord
      arguments:
        domainId: ${data.constellix_domain.first.id}
        name: mxdatasource
        sourceType: domains
Copy

Argument Reference

  • name - (Required) Name of record. Name should be unique.
  • source_type - (Required) “domains” for Domain records and “template” for Template records
  • domain_id - (Required) Record id of MX record

Attribute Reference

  • ttl - (Optional) TTL must be in between 0 and 2147483647
  • source_type - (Required) “domains” for Domain records and “template” for Template records
  • roundrobin - (Optional) Set
  • roundrobin.value - (Optional) The mail server that will accept mail for the host that is specified in the name field. Your domain name is automatically appended to your value if it does not end it a dot.
  • roundrobin.level - (Optional) Level must be in between 0 and 65535. The MX level determines the order (by priority) that remote mail servers will attempt to deliver email. The mail server with the lowest MX level will be the first priority.
  • roundrobin.disable_flag - (Optional) Enable or Disable the roundrobin object. Default is false. Atleast one roundrobin object should be false.
  • name - (Required) Name of record. Name should be unique.
  • noanswer - (Optional) Shows if record is enabled or disabled. Default is false (Active)
  • note - (Optional) Record note
  • gtd_region - (Optional) Shows id of GTD region in which record is to be created.
  • type - (Optional) Record type MX

Using getMxRecord

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getMxRecord(args: GetMxRecordArgs, opts?: InvokeOptions): Promise<GetMxRecordResult>
function getMxRecordOutput(args: GetMxRecordOutputArgs, opts?: InvokeOptions): Output<GetMxRecordResult>
Copy
def get_mx_record(domain_id: Optional[str] = None,
                  gtd_region: Optional[float] = None,
                  id: Optional[str] = None,
                  name: Optional[str] = None,
                  noanswer: Optional[bool] = None,
                  note: Optional[str] = None,
                  roundrobins: Optional[Sequence[GetMxRecordRoundrobin]] = None,
                  source_type: Optional[str] = None,
                  ttl: Optional[float] = None,
                  type: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetMxRecordResult
def get_mx_record_output(domain_id: Optional[pulumi.Input[str]] = None,
                  gtd_region: Optional[pulumi.Input[float]] = None,
                  id: Optional[pulumi.Input[str]] = None,
                  name: Optional[pulumi.Input[str]] = None,
                  noanswer: Optional[pulumi.Input[bool]] = None,
                  note: Optional[pulumi.Input[str]] = None,
                  roundrobins: Optional[pulumi.Input[Sequence[pulumi.Input[GetMxRecordRoundrobinArgs]]]] = None,
                  source_type: Optional[pulumi.Input[str]] = None,
                  ttl: Optional[pulumi.Input[float]] = None,
                  type: Optional[pulumi.Input[str]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetMxRecordResult]
Copy
func LookupMxRecord(ctx *Context, args *LookupMxRecordArgs, opts ...InvokeOption) (*LookupMxRecordResult, error)
func LookupMxRecordOutput(ctx *Context, args *LookupMxRecordOutputArgs, opts ...InvokeOption) LookupMxRecordResultOutput
Copy

> Note: This function is named LookupMxRecord in the Go SDK.

public static class GetMxRecord 
{
    public static Task<GetMxRecordResult> InvokeAsync(GetMxRecordArgs args, InvokeOptions? opts = null)
    public static Output<GetMxRecordResult> Invoke(GetMxRecordInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetMxRecordResult> getMxRecord(GetMxRecordArgs args, InvokeOptions options)
public static Output<GetMxRecordResult> getMxRecord(GetMxRecordArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: constellix:index/getMxRecord:getMxRecord
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

DomainId This property is required. string
Name This property is required. string
SourceType This property is required. string
GtdRegion double
Id string
Noanswer bool
Note string
Roundrobins List<GetMxRecordRoundrobin>
Ttl double
Type string
DomainId This property is required. string
Name This property is required. string
SourceType This property is required. string
GtdRegion float64
Id string
Noanswer bool
Note string
Roundrobins []GetMxRecordRoundrobin
Ttl float64
Type string
domainId This property is required. String
name This property is required. String
sourceType This property is required. String
gtdRegion Double
id String
noanswer Boolean
note String
roundrobins List<GetMxRecordRoundrobin>
ttl Double
type String
domainId This property is required. string
name This property is required. string
sourceType This property is required. string
gtdRegion number
id string
noanswer boolean
note string
roundrobins GetMxRecordRoundrobin[]
ttl number
type string
domain_id This property is required. str
name This property is required. str
source_type This property is required. str
gtd_region float
id str
noanswer bool
note str
roundrobins Sequence[GetMxRecordRoundrobin]
ttl float
type str
domainId This property is required. String
name This property is required. String
sourceType This property is required. String
gtdRegion Number
id String
noanswer Boolean
note String
roundrobins List<Property Map>
ttl Number
type String

getMxRecord Result

The following output properties are available:

DomainId string
GtdRegion double
Id string
Name string
Noanswer bool
Note string
SourceType string
Ttl double
Type string
Roundrobins List<GetMxRecordRoundrobin>
DomainId string
GtdRegion float64
Id string
Name string
Noanswer bool
Note string
SourceType string
Ttl float64
Type string
Roundrobins []GetMxRecordRoundrobin
domainId String
gtdRegion Double
id String
name String
noanswer Boolean
note String
sourceType String
ttl Double
type String
roundrobins List<GetMxRecordRoundrobin>
domainId string
gtdRegion number
id string
name string
noanswer boolean
note string
sourceType string
ttl number
type string
roundrobins GetMxRecordRoundrobin[]
domainId String
gtdRegion Number
id String
name String
noanswer Boolean
note String
sourceType String
ttl Number
type String
roundrobins List<Property Map>

Supporting Types

GetMxRecordRoundrobin

DisableFlag This property is required. string
Level This property is required. string
Value This property is required. string
DisableFlag This property is required. string
Level This property is required. string
Value This property is required. string
disableFlag This property is required. String
level This property is required. String
value This property is required. String
disableFlag This property is required. string
level This property is required. string
value This property is required. string
disable_flag This property is required. str
level This property is required. str
value This property is required. str
disableFlag This property is required. String
level This property is required. String
value This property is required. String

Package Details

Repository
constellix constellix/terraform-provider-constellix
License
Notes
This Pulumi package is based on the constellix Terraform Provider.