constellix.getCnameRecord

Explore with Pulumi AI

constellix 0.4.6 published on Friday, Mar 7, 2025 by constellix

constellix/terraform-provider-constellix

Example Usage

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

const firstrecord = constellix.getCnameRecord({
    domainId: constellix_domain.first_domain.id,
    name: "firstrecord",
    sourceType: "domains",
});

import pulumi
import pulumi_constellix as constellix

firstrecord = constellix.get_cname_record(domain_id=constellix_domain["first_domain"]["id"],
    name="firstrecord",
    source_type="domains")

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.LookupCnameRecord(ctx, &constellix.LookupCnameRecordArgs{
			DomainId:   constellix_domain.First_domain.Id,
			Name:       "firstrecord",
			SourceType: "domains",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Constellix = Pulumi.Constellix;

return await Deployment.RunAsync(() => 
{
    var firstrecord = Constellix.GetCnameRecord.Invoke(new()
    {
        DomainId = constellix_domain.First_domain.Id,
        Name = "firstrecord",
        SourceType = "domains",
    });

});

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.GetCnameRecordArgs;
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 firstrecord = ConstellixFunctions.getCnameRecord(GetCnameRecordArgs.builder()
            .domainId(constellix_domain.first_domain().id())
            .name("firstrecord")
            .sourceType("domains")
            .build());

    }
}

variables:
  firstrecord:
    fn::invoke:
      function: constellix:getCnameRecord
      arguments:
        domainId: ${constellix_domain.first_domain.id}
        name: firstrecord
        sourceType: domains

Attribute Reference

ttl - (Optional) TTL must be in between 0 and 2147483647.
geo_location - (Optional) Details of IP filter / Geo proximity to be applied. Default is null.
geo_location.geo_ip_user_region - (Optional) For Geo proximity to be applied. geoipUserRegion should not be provided.
geo_location.drop - (Optional) drop flag. Default is false.
geo_location.geo_ip_proximity - (Optional) a valid geoipProximity id.
geo_location.geo_ip_user_region - (Optional) For Geo IP Filter to be applied. geoipUserRegion should be [1].
geo_location.drop - (Optional) drop flag. Default is false.
geo_location.geo_ip_failover - (Optional) Flag to enable/disable Failover to nearest proximity when all the host fails. Works with the record type pools. It requires Geo Proximity to be enabled at the Domain level. Default is false.
geo_location.geo_ip_proximity - (Optional) for Geo IP Filter, geoipProximity must not be provided. please create an A record with “World (Default)” IP Filter first before a more specific IP Filter is applied. The “World (Default)” record would only be used if no matching Filter or Proximity records are found.
record_option - (Optional) Type of record. “roundRobin” for Standard record (Default). “failover” for Failover. “pools” for Pools. “roundRobinFailover” for Round Robin with Failover.
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 A.
contact_ids - (Optional) Applied contact list id. Only applicable to record with type roundRobin with failover and failover.
pools - (Optional) Ids of CNamepool.
record_failover - (Optional) To create a record failover object pass the following attributes.
record_failover_values - (Optional) Set.
record_failover_values.value - (Optional) Host name.
record_failover_values.checkid - (Optional) Sonar check id.
record_failover_values.sort_order - (Optional) Integer value which decides in which order the recordfailover should be sorted.
record_failover_values.disable_flag - (Optional) enable or disable the recordFailover value object. Default is false (Active). Atleast one recordFailover value object should be false.
record_failover_failover_type - (Optional) 1 for Normal (always lowest level). 2 for Off on any Failover event. 3 for One Way (move to higher level).
record_failover_disable_flag - (Optional) enable or disable the recordFailover object. Default is false (Active). Atleast one recordFailover object should be false.

Using getCnameRecord

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 getCnameRecord(args: GetCnameRecordArgs, opts?: InvokeOptions): Promise<GetCnameRecordResult>
function getCnameRecordOutput(args: GetCnameRecordOutputArgs, opts?: InvokeOptions): Output<GetCnameRecordResult>

def get_cname_record(contact_ids: Optional[Sequence[float]] = None,
                     domain_id: Optional[str] = None,
                     geo_location: Optional[Mapping[str, str]] = None,
                     gtd_region: Optional[float] = None,
                     host: Optional[str] = None,
                     id: Optional[str] = None,
                     name: Optional[str] = None,
                     noanswer: Optional[bool] = None,
                     note: Optional[str] = None,
                     pools: Optional[Sequence[float]] = None,
                     record_failover_disable_flag: Optional[str] = None,
                     record_failover_failover_type: Optional[str] = None,
                     record_failover_values: Optional[Sequence[GetCnameRecordRecordFailoverValue]] = None,
                     record_option: Optional[str] = None,
                     source_type: Optional[str] = None,
                     ttl: Optional[float] = None,
                     type: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetCnameRecordResult
def get_cname_record_output(contact_ids: Optional[pulumi.Input[Sequence[pulumi.Input[float]]]] = None,
                     domain_id: Optional[pulumi.Input[str]] = None,
                     geo_location: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
                     gtd_region: Optional[pulumi.Input[float]] = None,
                     host: Optional[pulumi.Input[str]] = 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,
                     pools: Optional[pulumi.Input[Sequence[pulumi.Input[float]]]] = None,
                     record_failover_disable_flag: Optional[pulumi.Input[str]] = None,
                     record_failover_failover_type: Optional[pulumi.Input[str]] = None,
                     record_failover_values: Optional[pulumi.Input[Sequence[pulumi.Input[GetCnameRecordRecordFailoverValueArgs]]]] = None,
                     record_option: Optional[pulumi.Input[str]] = 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[GetCnameRecordResult]

func LookupCnameRecord(ctx *Context, args *LookupCnameRecordArgs, opts ...InvokeOption) (*LookupCnameRecordResult, error)
func LookupCnameRecordOutput(ctx *Context, args *LookupCnameRecordOutputArgs, opts ...InvokeOption) LookupCnameRecordResultOutput

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

public static class GetCnameRecord 
{
    public static Task<GetCnameRecordResult> InvokeAsync(GetCnameRecordArgs args, InvokeOptions? opts = null)
    public static Output<GetCnameRecordResult> Invoke(GetCnameRecordInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetCnameRecordResult> getCnameRecord(GetCnameRecordArgs args, InvokeOptions options)
public static Output<GetCnameRecordResult> getCnameRecord(GetCnameRecordArgs args, InvokeOptions options)

fn::invoke:
  function: constellix:index/getCnameRecord:getCnameRecord
  arguments:
    # arguments dictionary

The following arguments are supported:

DomainId string: Domain id of the CName record.
Name string: Name of record. Name should be unique.
SourceType string: Type of the CName record. The values which can be applied are "domains" or "templates".
ContactIds List<double>
GeoLocation Dictionary<string, string>
GtdRegion double
Host string
Id string
Noanswer bool
Note string
Pools List<double>
RecordFailoverDisableFlag string
RecordFailoverFailoverType string
RecordFailoverValues List<GetCnameRecordRecordFailoverValue>
RecordOption string
Ttl double
Type string

DomainId string: Domain id of the CName record.
Name string: Name of record. Name should be unique.
SourceType string: Type of the CName record. The values which can be applied are "domains" or "templates".
ContactIds []float64
GeoLocation map[string]string
GtdRegion float64
Host string
Id string
Noanswer bool
Note string
Pools []float64
RecordFailoverDisableFlag string
RecordFailoverFailoverType string
RecordFailoverValues []GetCnameRecordRecordFailoverValue
RecordOption string
Ttl float64
Type string

domainId String: Domain id of the CName record.
name String: Name of record. Name should be unique.
sourceType String: Type of the CName record. The values which can be applied are "domains" or "templates".
contactIds List<Double>
geoLocation Map<String,String>
gtdRegion Double
host String
id String
noanswer Boolean
note String
pools List<Double>
recordFailoverDisableFlag String
recordFailoverFailoverType String
recordFailoverValues List<GetCnameRecordRecordFailoverValue>
recordOption String
ttl Double
type String

domainId string: Domain id of the CName record.
name string: Name of record. Name should be unique.
sourceType string: Type of the CName record. The values which can be applied are "domains" or "templates".
contactIds number[]
geoLocation {[key: string]: string}
gtdRegion number
host string
id string
noanswer boolean
note string
pools number[]
recordFailoverDisableFlag string
recordFailoverFailoverType string
recordFailoverValues GetCnameRecordRecordFailoverValue[]
recordOption string
ttl number
type string

domain_id str: Domain id of the CName record.
name str: Name of record. Name should be unique.
source_type str: Type of the CName record. The values which can be applied are "domains" or "templates".
contact_ids Sequence[float]
geo_location Mapping[str, str]
gtd_region float
host str
id str
noanswer bool
note str
pools Sequence[float]
record_failover_disable_flag str
record_failover_failover_type str
record_failover_values Sequence[GetCnameRecordRecordFailoverValue]
record_option str
ttl float
type str

domainId String: Domain id of the CName record.
name String: Name of record. Name should be unique.
sourceType String: Type of the CName record. The values which can be applied are "domains" or "templates".
contactIds List<Number>
geoLocation Map<String>
gtdRegion Number
host String
id String
noanswer Boolean
note String
pools List<Number>
recordFailoverDisableFlag String
recordFailoverFailoverType String
recordFailoverValues List<Property Map>
recordOption String
ttl Number
type String