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

    Data source one or more domain CNAME records.

    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
    

    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

    getCnameRecord Result

    The following output properties are available:

    ContactIds List<double>
    DomainId string
    GeoLocation Dictionary<string, string>
    GtdRegion double
    Host string
    Id string
    Name string
    Noanswer bool
    Note string
    Pools List<double>
    RecordFailoverDisableFlag string
    RecordFailoverFailoverType string
    RecordOption string
    SourceType string
    Ttl double
    Type string
    RecordFailoverValues List<GetCnameRecordRecordFailoverValue>
    contactIds List<Double>
    domainId String
    geoLocation Map<String,String>
    gtdRegion Double
    host String
    id String
    name String
    noanswer Boolean
    note String
    pools List<Double>
    recordFailoverDisableFlag String
    recordFailoverFailoverType String
    recordOption String
    sourceType String
    ttl Double
    type String
    recordFailoverValues List<GetCnameRecordRecordFailoverValue>
    contactIds number[]
    domainId string
    geoLocation {[key: string]: string}
    gtdRegion number
    host string
    id string
    name string
    noanswer boolean
    note string
    pools number[]
    recordFailoverDisableFlag string
    recordFailoverFailoverType string
    recordOption string
    sourceType string
    ttl number
    type string
    recordFailoverValues GetCnameRecordRecordFailoverValue[]
    contactIds List<Number>
    domainId String
    geoLocation Map<String>
    gtdRegion Number
    host String
    id String
    name String
    noanswer Boolean
    note String
    pools List<Number>
    recordFailoverDisableFlag String
    recordFailoverFailoverType String
    recordOption String
    sourceType String
    ttl Number
    type String
    recordFailoverValues List<Property Map>

    Supporting Types

    GetCnameRecordRecordFailoverValue

    CheckId double
    DisableFlag string
    SortOrder string
    Value string
    CheckId float64
    DisableFlag string
    SortOrder string
    Value string
    checkId Double
    disableFlag String
    sortOrder String
    value String
    checkId number
    disableFlag string
    sortOrder string
    value string
    checkId Number
    disableFlag String
    sortOrder String
    value String

    Package Details

    Repository
    constellix constellix/terraform-provider-constellix
    License
    Notes
    This Pulumi package is based on the constellix Terraform Provider.
    Viewing docs for constellix 0.4.6
    published on Friday, Mar 7, 2025 by constellix
      Try Pulumi Cloud free. Your team will thank you.