Cloudflare v6.0.1, Apr 16 25

Cloudflare v6.0.1 published on Wednesday, Apr 16, 2025 by Pulumi

cloudflare.getDnsRecord

Explore with Pulumi AI

Cloudflare v6.0.1 published on Wednesday, Apr 16, 2025 by Pulumi

Example Usage

TypeScript
Python
Go
C#
Java
YAML

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

const exampleDnsRecord = cloudflare.getDnsRecord({
    zoneId: "023e105f4ecef8ad9ca31a8372d0c353",
    dnsRecordId: "023e105f4ecef8ad9ca31a8372d0c353",
});

import pulumi
import pulumi_cloudflare as cloudflare

example_dns_record = cloudflare.get_dns_record(zone_id="023e105f4ecef8ad9ca31a8372d0c353",
    dns_record_id="023e105f4ecef8ad9ca31a8372d0c353")

package main

import (
	"github.com/pulumi/pulumi-cloudflare/sdk/v6/go/cloudflare"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := cloudflare.LookupDnsRecord(ctx, &cloudflare.LookupDnsRecordArgs{
			ZoneId:      "023e105f4ecef8ad9ca31a8372d0c353",
			DnsRecordId: pulumi.StringRef("023e105f4ecef8ad9ca31a8372d0c353"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var exampleDnsRecord = Cloudflare.GetDnsRecord.Invoke(new()
    {
        ZoneId = "023e105f4ecef8ad9ca31a8372d0c353",
        DnsRecordId = "023e105f4ecef8ad9ca31a8372d0c353",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.cloudflare.CloudflareFunctions;
import com.pulumi.cloudflare.inputs.GetDnsRecordArgs;
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 exampleDnsRecord = CloudflareFunctions.getDnsRecord(GetDnsRecordArgs.builder()
            .zoneId("023e105f4ecef8ad9ca31a8372d0c353")
            .dnsRecordId("023e105f4ecef8ad9ca31a8372d0c353")
            .build());

    }
}

variables:
  exampleDnsRecord:
    fn::invoke:
      function: cloudflare:getDnsRecord
      arguments:
        zoneId: 023e105f4ecef8ad9ca31a8372d0c353
        dnsRecordId: 023e105f4ecef8ad9ca31a8372d0c353

Using getDnsRecord

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.

TypeScript
Python
Go
C#
Java
YAML

function getDnsRecord(args: GetDnsRecordArgs, opts?: InvokeOptions): Promise<GetDnsRecordResult>
function getDnsRecordOutput(args: GetDnsRecordOutputArgs, opts?: InvokeOptions): Output<GetDnsRecordResult>

def get_dns_record(dns_record_id: Optional[str] = None,
                   filter: Optional[GetDnsRecordFilter] = None,
                   zone_id: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetDnsRecordResult
def get_dns_record_output(dns_record_id: Optional[pulumi.Input[str]] = None,
                   filter: Optional[pulumi.Input[GetDnsRecordFilterArgs]] = None,
                   zone_id: Optional[pulumi.Input[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetDnsRecordResult]

func LookupDnsRecord(ctx *Context, args *LookupDnsRecordArgs, opts ...InvokeOption) (*LookupDnsRecordResult, error)
func LookupDnsRecordOutput(ctx *Context, args *LookupDnsRecordOutputArgs, opts ...InvokeOption) LookupDnsRecordResultOutput

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

public static class GetDnsRecord 
{
    public static Task<GetDnsRecordResult> InvokeAsync(GetDnsRecordArgs args, InvokeOptions? opts = null)
    public static Output<GetDnsRecordResult> Invoke(GetDnsRecordInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetDnsRecordResult> getDnsRecord(GetDnsRecordArgs args, InvokeOptions options)
public static Output<GetDnsRecordResult> getDnsRecord(GetDnsRecordArgs args, InvokeOptions options)

fn::invoke:
  function: cloudflare:index/getDnsRecord:getDnsRecord
  arguments:
    # arguments dictionary

The following arguments are supported:

ZoneId string: Identifier
DnsRecordId string: Identifier
Filter GetDnsRecordFilter

ZoneId string: Identifier
DnsRecordId string: Identifier
Filter GetDnsRecordFilter

zoneId String: Identifier
dnsRecordId String: Identifier
filter GetDnsRecordFilter

zoneId string: Identifier
dnsRecordId string: Identifier
filter GetDnsRecordFilter

zone_id str: Identifier
dns_record_id str: Identifier
filter GetDnsRecordFilter

zoneId String: Identifier
dnsRecordId String: Identifier
filter Property Map

getDnsRecord Result

The following output properties are available:

Comment string: Comments or notes about the DNS record. This field has no effect on DNS responses.
CommentModifiedOn string: When the record comment was last modified. Omitted if there is no comment.
Content string: A valid IPv4 address.
CreatedOn string: When the record was created.
Data GetDnsRecordData: Components of a CAA record.
Id string: Identifier
Meta string: Extra Cloudflare-specific information about the record.
ModifiedOn string: When the record was last modified.
Name string: DNS record name (or @ for the zone apex) in Punycode.
Priority double: Required for MX, SRV and URI records; unused by other record types. Records with lower priorities are preferred.
Proxiable bool: Whether the record can be proxied by Cloudflare or not.
Proxied bool: Whether the record is receiving the performance and security benefits of Cloudflare.
Settings GetDnsRecordSettings: Settings for the DNS record.
Tags List<string>: Custom tags for the DNS record. This field has no effect on DNS responses.
TagsModifiedOn string: When the record tags were last modified. Omitted if there are no tags.
Ttl double: Time To Live (TTL) of the DNS record in seconds. Setting to 1 means 'automatic'. Value must be between 60 and 86400, with the minimum reduced to 30 for Enterprise zones.
Type string: Record type. Available values: "A".
ZoneId string: Identifier
DnsRecordId string: Identifier
Filter GetDnsRecordFilter

Comment string: Comments or notes about the DNS record. This field has no effect on DNS responses.
CommentModifiedOn string: When the record comment was last modified. Omitted if there is no comment.
Content string: A valid IPv4 address.
CreatedOn string: When the record was created.
Data GetDnsRecordData: Components of a CAA record.
Id string: Identifier
Meta string: Extra Cloudflare-specific information about the record.
ModifiedOn string: When the record was last modified.
Name string: DNS record name (or @ for the zone apex) in Punycode.
Priority float64: Required for MX, SRV and URI records; unused by other record types. Records with lower priorities are preferred.
Proxiable bool: Whether the record can be proxied by Cloudflare or not.
Proxied bool: Whether the record is receiving the performance and security benefits of Cloudflare.
Settings GetDnsRecordSettings: Settings for the DNS record.
Tags []string: Custom tags for the DNS record. This field has no effect on DNS responses.
TagsModifiedOn string: When the record tags were last modified. Omitted if there are no tags.
Ttl float64: Time To Live (TTL) of the DNS record in seconds. Setting to 1 means 'automatic'. Value must be between 60 and 86400, with the minimum reduced to 30 for Enterprise zones.
Type string: Record type. Available values: "A".
ZoneId string: Identifier
DnsRecordId string: Identifier
Filter GetDnsRecordFilter

comment String: Comments or notes about the DNS record. This field has no effect on DNS responses.
commentModifiedOn String: When the record comment was last modified. Omitted if there is no comment.
content String: A valid IPv4 address.
createdOn String: When the record was created.
data GetDnsRecordData: Components of a CAA record.
id String: Identifier
meta String: Extra Cloudflare-specific information about the record.
modifiedOn String: When the record was last modified.
name String: DNS record name (or @ for the zone apex) in Punycode.
priority Double: Required for MX, SRV and URI records; unused by other record types. Records with lower priorities are preferred.
proxiable Boolean: Whether the record can be proxied by Cloudflare or not.
proxied Boolean: Whether the record is receiving the performance and security benefits of Cloudflare.
settings GetDnsRecordSettings: Settings for the DNS record.
tags List<String>: Custom tags for the DNS record. This field has no effect on DNS responses.
tagsModifiedOn String: When the record tags were last modified. Omitted if there are no tags.
ttl Double: Time To Live (TTL) of the DNS record in seconds. Setting to 1 means 'automatic'. Value must be between 60 and 86400, with the minimum reduced to 30 for Enterprise zones.
type String: Record type. Available values: "A".
zoneId String: Identifier
dnsRecordId String: Identifier
filter GetDnsRecordFilter

comment string: Comments or notes about the DNS record. This field has no effect on DNS responses.
commentModifiedOn string: When the record comment was last modified. Omitted if there is no comment.
content string: A valid IPv4 address.
createdOn string: When the record was created.
data GetDnsRecordData: Components of a CAA record.
id string: Identifier
meta string: Extra Cloudflare-specific information about the record.
modifiedOn string: When the record was last modified.
name string: DNS record name (or @ for the zone apex) in Punycode.
priority number: Required for MX, SRV and URI records; unused by other record types. Records with lower priorities are preferred.
proxiable boolean: Whether the record can be proxied by Cloudflare or not.
proxied boolean: Whether the record is receiving the performance and security benefits of Cloudflare.
settings GetDnsRecordSettings: Settings for the DNS record.
tags string[]: Custom tags for the DNS record. This field has no effect on DNS responses.
tagsModifiedOn string: When the record tags were last modified. Omitted if there are no tags.
ttl number: Time To Live (TTL) of the DNS record in seconds. Setting to 1 means 'automatic'. Value must be between 60 and 86400, with the minimum reduced to 30 for Enterprise zones.
type string: Record type. Available values: "A".
zoneId string: Identifier
dnsRecordId string: Identifier
filter GetDnsRecordFilter

comment str: Comments or notes about the DNS record. This field has no effect on DNS responses.
comment_modified_on str: When the record comment was last modified. Omitted if there is no comment.
content str: A valid IPv4 address.
created_on str: When the record was created.
data GetDnsRecordData: Components of a CAA record.
id str: Identifier
meta str: Extra Cloudflare-specific information about the record.
modified_on str: When the record was last modified.
name str: DNS record name (or @ for the zone apex) in Punycode.
priority float: Required for MX, SRV and URI records; unused by other record types. Records with lower priorities are preferred.
proxiable bool: Whether the record can be proxied by Cloudflare or not.
proxied bool: Whether the record is receiving the performance and security benefits of Cloudflare.
settings GetDnsRecordSettings: Settings for the DNS record.
tags Sequence[str]: Custom tags for the DNS record. This field has no effect on DNS responses.
tags_modified_on str: When the record tags were last modified. Omitted if there are no tags.
ttl float: Time To Live (TTL) of the DNS record in seconds. Setting to 1 means 'automatic'. Value must be between 60 and 86400, with the minimum reduced to 30 for Enterprise zones.
type str: Record type. Available values: "A".
zone_id str: Identifier
dns_record_id str: Identifier
filter GetDnsRecordFilter

comment String: Comments or notes about the DNS record. This field has no effect on DNS responses.
commentModifiedOn String: When the record comment was last modified. Omitted if there is no comment.
content String: A valid IPv4 address.
createdOn String: When the record was created.
data Property Map: Components of a CAA record.
id String: Identifier
meta String: Extra Cloudflare-specific information about the record.
modifiedOn String: When the record was last modified.
name String: DNS record name (or @ for the zone apex) in Punycode.
priority Number: Required for MX, SRV and URI records; unused by other record types. Records with lower priorities are preferred.
proxiable Boolean: Whether the record can be proxied by Cloudflare or not.
proxied Boolean: Whether the record is receiving the performance and security benefits of Cloudflare.
settings Property Map: Settings for the DNS record.
tags List<String>: Custom tags for the DNS record. This field has no effect on DNS responses.
tagsModifiedOn String: When the record tags were last modified. Omitted if there are no tags.
ttl Number: Time To Live (TTL) of the DNS record in seconds. Setting to 1 means 'automatic'. Value must be between 60 and 86400, with the minimum reduced to 30 for Enterprise zones.
type String: Record type. Available values: "A".
zoneId String: Identifier
dnsRecordId String: Identifier
filter Property Map

Supporting Types

GetDnsRecordData

Algorithm double: Algorithm.
Altitude double: Altitude of location in meters.
Certificate string: Certificate.
Digest string: Digest.
DigestType double: Digest Type.
Fingerprint string: fingerprint.
Flags object: Flags for the CAA record.
KeyTag double: Key Tag.
LatDegrees double: Degrees of latitude.
LatDirection string: Latitude direction. Available values: "N", "S".
LatMinutes double: Minutes of latitude.
LatSeconds double: Seconds of latitude.
LongDegrees double: Degrees of longitude.
LongDirection string: Longitude direction. Available values: "E", "W".
LongMinutes double: Minutes of longitude.
LongSeconds double: Seconds of longitude.
MatchingType double: Matching Type.
Order double: Order.
Port double: The port of the service.
PrecisionHorz double: Horizontal precision of location.
PrecisionVert double: Vertical precision of location.
Preference double: Preference.
Priority double: priority.
Protocol double: Protocol.
PublicKey string: Public Key.
Regex string: Regex.
Replacement string: Replacement.
Selector double: Selector.
Service string: Service.
Size double: Size of location in meters.
Tag string: Name of the property controlled by this record (e.g.: issue, issuewild, iodef).
Target string: target.
Type double: Type.
Usage double: Usage.
Value string: Value of the record. This field's semantics depend on the chosen tag.
Weight double: The record weight.

Algorithm float64: Algorithm.
Altitude float64: Altitude of location in meters.
Certificate string: Certificate.
Digest string: Digest.
DigestType float64: Digest Type.
Fingerprint string: fingerprint.
Flags interface{}: Flags for the CAA record.
KeyTag float64: Key Tag.
LatDegrees float64: Degrees of latitude.
LatDirection string: Latitude direction. Available values: "N", "S".
LatMinutes float64: Minutes of latitude.
LatSeconds float64: Seconds of latitude.
LongDegrees float64: Degrees of longitude.
LongDirection string: Longitude direction. Available values: "E", "W".
LongMinutes float64: Minutes of longitude.
LongSeconds float64: Seconds of longitude.
MatchingType float64: Matching Type.
Order float64: Order.
Port float64: The port of the service.
PrecisionHorz float64: Horizontal precision of location.
PrecisionVert float64: Vertical precision of location.
Preference float64: Preference.
Priority float64: priority.
Protocol float64: Protocol.
PublicKey string: Public Key.
Regex string: Regex.
Replacement string: Replacement.
Selector float64: Selector.
Service string: Service.
Size float64: Size of location in meters.
Tag string: Name of the property controlled by this record (e.g.: issue, issuewild, iodef).
Target string: target.
Type float64: Type.
Usage float64: Usage.
Value string: Value of the record. This field's semantics depend on the chosen tag.
Weight float64: The record weight.

algorithm Double: Algorithm.
altitude Double: Altitude of location in meters.
certificate String: Certificate.
digest String: Digest.
digestType Double: Digest Type.
fingerprint String: fingerprint.
flags Object: Flags for the CAA record.
keyTag Double: Key Tag.
latDegrees Double: Degrees of latitude.
latDirection String: Latitude direction. Available values: "N", "S".
latMinutes Double: Minutes of latitude.
latSeconds Double: Seconds of latitude.
longDegrees Double: Degrees of longitude.
longDirection String: Longitude direction. Available values: "E", "W".
longMinutes Double: Minutes of longitude.
longSeconds Double: Seconds of longitude.
matchingType Double: Matching Type.
order Double: Order.
port Double: The port of the service.
precisionHorz Double: Horizontal precision of location.
precisionVert Double: Vertical precision of location.
preference Double: Preference.
priority Double: priority.
protocol Double: Protocol.
publicKey String: Public Key.
regex String: Regex.
replacement String: Replacement.
selector Double: Selector.
service String: Service.
size Double: Size of location in meters.
tag String: Name of the property controlled by this record (e.g.: issue, issuewild, iodef).
target String: target.
type Double: Type.
usage Double: Usage.
value String: Value of the record. This field's semantics depend on the chosen tag.
weight Double: The record weight.

algorithm number: Algorithm.
altitude number: Altitude of location in meters.
certificate string: Certificate.
digest string: Digest.
digestType number: Digest Type.
fingerprint string: fingerprint.
flags any: Flags for the CAA record.
keyTag number: Key Tag.
latDegrees number: Degrees of latitude.
latDirection string: Latitude direction. Available values: "N", "S".
latMinutes number: Minutes of latitude.
latSeconds number: Seconds of latitude.
longDegrees number: Degrees of longitude.
longDirection string: Longitude direction. Available values: "E", "W".
longMinutes number: Minutes of longitude.
longSeconds number: Seconds of longitude.
matchingType number: Matching Type.
order number: Order.
port number: The port of the service.
precisionHorz number: Horizontal precision of location.
precisionVert number: Vertical precision of location.
preference number: Preference.
priority number: priority.
protocol number: Protocol.
publicKey string: Public Key.
regex string: Regex.
replacement string: Replacement.
selector number: Selector.
service string: Service.
size number: Size of location in meters.
tag string: Name of the property controlled by this record (e.g.: issue, issuewild, iodef).
target string: target.
type number: Type.
usage number: Usage.
value string: Value of the record. This field's semantics depend on the chosen tag.
weight number: The record weight.

algorithm float: Algorithm.
altitude float: Altitude of location in meters.
certificate str: Certificate.
digest str: Digest.
digest_type float: Digest Type.
fingerprint str: fingerprint.
flags Any: Flags for the CAA record.
key_tag float: Key Tag.
lat_degrees float: Degrees of latitude.
lat_direction str: Latitude direction. Available values: "N", "S".
lat_minutes float: Minutes of latitude.
lat_seconds float: Seconds of latitude.
long_degrees float: Degrees of longitude.
long_direction str: Longitude direction. Available values: "E", "W".
long_minutes float: Minutes of longitude.
long_seconds float: Seconds of longitude.
matching_type float: Matching Type.
order float: Order.
port float: The port of the service.
precision_horz float: Horizontal precision of location.
precision_vert float: Vertical precision of location.
preference float: Preference.
priority float: priority.
protocol float: Protocol.
public_key str: Public Key.
regex str: Regex.
replacement str: Replacement.
selector float: Selector.
service str: Service.
size float: Size of location in meters.
tag str: Name of the property controlled by this record (e.g.: issue, issuewild, iodef).
target str: target.
type float: Type.
usage float: Usage.
value str: Value of the record. This field's semantics depend on the chosen tag.
weight float: The record weight.

algorithm Number: Algorithm.
altitude Number: Altitude of location in meters.
certificate String: Certificate.
digest String: Digest.
digestType Number: Digest Type.
fingerprint String: fingerprint.
flags Any: Flags for the CAA record.
keyTag Number: Key Tag.
latDegrees Number: Degrees of latitude.
latDirection String: Latitude direction. Available values: "N", "S".
latMinutes Number: Minutes of latitude.
latSeconds Number: Seconds of latitude.
longDegrees Number: Degrees of longitude.
longDirection String: Longitude direction. Available values: "E", "W".
longMinutes Number: Minutes of longitude.
longSeconds Number: Seconds of longitude.
matchingType Number: Matching Type.
order Number: Order.
port Number: The port of the service.
precisionHorz Number: Horizontal precision of location.
precisionVert Number: Vertical precision of location.
preference Number: Preference.
priority Number: priority.
protocol Number: Protocol.
publicKey String: Public Key.
regex String: Regex.
replacement String: Replacement.
selector Number: Selector.
service String: Service.
size Number: Size of location in meters.
tag String: Name of the property controlled by this record (e.g.: issue, issuewild, iodef).
target String: target.
type Number: Type.
usage Number: Usage.
value String: Value of the record. This field's semantics depend on the chosen tag.
weight Number: The record weight.

GetDnsRecordFilter

Direction string: Direction to order DNS records in. Available values: "asc", "desc".
Match string: Whether to match all search requirements or at least one (any). If set to all, acts like a logical AND between filters. If set to any, acts like a logical OR instead. Note that the interaction between tag filters is controlled by the tag-match parameter instead. Available values: "any", "all".
Order string: Field to order DNS records by. Available values: "type", "name", "content", "ttl", "proxied".
Proxied bool: Whether the record is receiving the performance and security benefits of Cloudflare.
TagMatch string: Whether to match all tag search requirements or at least one (any). If set to all, acts like a logical AND between tag filters. If set to any, acts like a logical OR instead. Note that the regular match parameter is still used to combine the resulting condition with other filters that aren't related to tags. Available values: "any", "all".
Comment GetDnsRecordFilterComment
Content GetDnsRecordFilterContent
Name GetDnsRecordFilterName
Search string: Allows searching in multiple properties of a DNS record simultaneously. This parameter is intended for human users, not automation. Its exact behavior is intentionally left unspecified and is subject to change in the future. This parameter works independently of the match setting. For automated searches, please use the other available parameters.
Tag GetDnsRecordFilterTag
Type string: Record type. Available values: "A", "AAAA", "CAA", "CERT", "CNAME", "DNSKEY", "DS", "HTTPS", "LOC", "MX", "NAPTR", "NS", "OPENPGPKEY", "PTR", "SMIMEA", "SRV", "SSHFP", "SVCB", "TLSA", "TXT", "URI".

Direction string: Direction to order DNS records in. Available values: "asc", "desc".
Match string: Whether to match all search requirements or at least one (any). If set to all, acts like a logical AND between filters. If set to any, acts like a logical OR instead. Note that the interaction between tag filters is controlled by the tag-match parameter instead. Available values: "any", "all".
Order string: Field to order DNS records by. Available values: "type", "name", "content", "ttl", "proxied".
Proxied bool: Whether the record is receiving the performance and security benefits of Cloudflare.
TagMatch string: Whether to match all tag search requirements or at least one (any). If set to all, acts like a logical AND between tag filters. If set to any, acts like a logical OR instead. Note that the regular match parameter is still used to combine the resulting condition with other filters that aren't related to tags. Available values: "any", "all".
Comment GetDnsRecordFilterComment
Content GetDnsRecordFilterContent
Name GetDnsRecordFilterName
Search string: Allows searching in multiple properties of a DNS record simultaneously. This parameter is intended for human users, not automation. Its exact behavior is intentionally left unspecified and is subject to change in the future. This parameter works independently of the match setting. For automated searches, please use the other available parameters.
Tag GetDnsRecordFilterTag
Type string: Record type. Available values: "A", "AAAA", "CAA", "CERT", "CNAME", "DNSKEY", "DS", "HTTPS", "LOC", "MX", "NAPTR", "NS", "OPENPGPKEY", "PTR", "SMIMEA", "SRV", "SSHFP", "SVCB", "TLSA", "TXT", "URI".

direction String: Direction to order DNS records in. Available values: "asc", "desc".
match String: Whether to match all search requirements or at least one (any). If set to all, acts like a logical AND between filters. If set to any, acts like a logical OR instead. Note that the interaction between tag filters is controlled by the tag-match parameter instead. Available values: "any", "all".
order String: Field to order DNS records by. Available values: "type", "name", "content", "ttl", "proxied".
proxied Boolean: Whether the record is receiving the performance and security benefits of Cloudflare.
tagMatch String: Whether to match all tag search requirements or at least one (any). If set to all, acts like a logical AND between tag filters. If set to any, acts like a logical OR instead. Note that the regular match parameter is still used to combine the resulting condition with other filters that aren't related to tags. Available values: "any", "all".
comment GetDnsRecordFilterComment
content GetDnsRecordFilterContent
name GetDnsRecordFilterName
search String: Allows searching in multiple properties of a DNS record simultaneously. This parameter is intended for human users, not automation. Its exact behavior is intentionally left unspecified and is subject to change in the future. This parameter works independently of the match setting. For automated searches, please use the other available parameters.
tag GetDnsRecordFilterTag
type String: Record type. Available values: "A", "AAAA", "CAA", "CERT", "CNAME", "DNSKEY", "DS", "HTTPS", "LOC", "MX", "NAPTR", "NS", "OPENPGPKEY", "PTR", "SMIMEA", "SRV", "SSHFP", "SVCB", "TLSA", "TXT", "URI".

direction string: Direction to order DNS records in. Available values: "asc", "desc".
match string: Whether to match all search requirements or at least one (any). If set to all, acts like a logical AND between filters. If set to any, acts like a logical OR instead. Note that the interaction between tag filters is controlled by the tag-match parameter instead. Available values: "any", "all".
order string: Field to order DNS records by. Available values: "type", "name", "content", "ttl", "proxied".
proxied boolean: Whether the record is receiving the performance and security benefits of Cloudflare.
tagMatch string: Whether to match all tag search requirements or at least one (any). If set to all, acts like a logical AND between tag filters. If set to any, acts like a logical OR instead. Note that the regular match parameter is still used to combine the resulting condition with other filters that aren't related to tags. Available values: "any", "all".
comment GetDnsRecordFilterComment
content GetDnsRecordFilterContent
name GetDnsRecordFilterName
search string: Allows searching in multiple properties of a DNS record simultaneously. This parameter is intended for human users, not automation. Its exact behavior is intentionally left unspecified and is subject to change in the future. This parameter works independently of the match setting. For automated searches, please use the other available parameters.
tag GetDnsRecordFilterTag
type string: Record type. Available values: "A", "AAAA", "CAA", "CERT", "CNAME", "DNSKEY", "DS", "HTTPS", "LOC", "MX", "NAPTR", "NS", "OPENPGPKEY", "PTR", "SMIMEA", "SRV", "SSHFP", "SVCB", "TLSA", "TXT", "URI".

direction str: Direction to order DNS records in. Available values: "asc", "desc".
match str: Whether to match all search requirements or at least one (any). If set to all, acts like a logical AND between filters. If set to any, acts like a logical OR instead. Note that the interaction between tag filters is controlled by the tag-match parameter instead. Available values: "any", "all".
order str: Field to order DNS records by. Available values: "type", "name", "content", "ttl", "proxied".
proxied bool: Whether the record is receiving the performance and security benefits of Cloudflare.
tag_match str: Whether to match all tag search requirements or at least one (any). If set to all, acts like a logical AND between tag filters. If set to any, acts like a logical OR instead. Note that the regular match parameter is still used to combine the resulting condition with other filters that aren't related to tags. Available values: "any", "all".
comment GetDnsRecordFilterComment
content GetDnsRecordFilterContent
name GetDnsRecordFilterName
search str: Allows searching in multiple properties of a DNS record simultaneously. This parameter is intended for human users, not automation. Its exact behavior is intentionally left unspecified and is subject to change in the future. This parameter works independently of the match setting. For automated searches, please use the other available parameters.
tag GetDnsRecordFilterTag
type str: Record type. Available values: "A", "AAAA", "CAA", "CERT", "CNAME", "DNSKEY", "DS", "HTTPS", "LOC", "MX", "NAPTR", "NS", "OPENPGPKEY", "PTR", "SMIMEA", "SRV", "SSHFP", "SVCB", "TLSA", "TXT", "URI".

direction String: Direction to order DNS records in. Available values: "asc", "desc".
match String: Whether to match all search requirements or at least one (any). If set to all, acts like a logical AND between filters. If set to any, acts like a logical OR instead. Note that the interaction between tag filters is controlled by the tag-match parameter instead. Available values: "any", "all".
order String: Field to order DNS records by. Available values: "type", "name", "content", "ttl", "proxied".
proxied Boolean: Whether the record is receiving the performance and security benefits of Cloudflare.
tagMatch String: Whether to match all tag search requirements or at least one (any). If set to all, acts like a logical AND between tag filters. If set to any, acts like a logical OR instead. Note that the regular match parameter is still used to combine the resulting condition with other filters that aren't related to tags. Available values: "any", "all".
comment Property Map
content Property Map
name Property Map
search String: Allows searching in multiple properties of a DNS record simultaneously. This parameter is intended for human users, not automation. Its exact behavior is intentionally left unspecified and is subject to change in the future. This parameter works independently of the match setting. For automated searches, please use the other available parameters.
tag Property Map
type String: Record type. Available values: "A", "AAAA", "CAA", "CERT", "CNAME", "DNSKEY", "DS", "HTTPS", "LOC", "MX", "NAPTR", "NS", "OPENPGPKEY", "PTR", "SMIMEA", "SRV", "SSHFP", "SVCB", "TLSA", "TXT", "URI".

GetDnsRecordFilterComment

Absent string: If this parameter is present, only records without a comment are returned.
Contains string: Substring of the DNS record comment. Comment filters are case-insensitive.
Endswith string: Suffix of the DNS record comment. Comment filters are case-insensitive.
Exact string: Exact value of the DNS record comment. Comment filters are case-insensitive.
Present string: If this parameter is present, only records with a comment are returned.
Startswith string: Prefix of the DNS record comment. Comment filters are case-insensitive.

Absent string: If this parameter is present, only records without a comment are returned.
Contains string: Substring of the DNS record comment. Comment filters are case-insensitive.
Endswith string: Suffix of the DNS record comment. Comment filters are case-insensitive.
Exact string: Exact value of the DNS record comment. Comment filters are case-insensitive.
Present string: If this parameter is present, only records with a comment are returned.
Startswith string: Prefix of the DNS record comment. Comment filters are case-insensitive.

absent String: If this parameter is present, only records without a comment are returned.
contains String: Substring of the DNS record comment. Comment filters are case-insensitive.
endswith String: Suffix of the DNS record comment. Comment filters are case-insensitive.
exact String: Exact value of the DNS record comment. Comment filters are case-insensitive.
present String: If this parameter is present, only records with a comment are returned.
startswith String: Prefix of the DNS record comment. Comment filters are case-insensitive.

absent string: If this parameter is present, only records without a comment are returned.
contains string: Substring of the DNS record comment. Comment filters are case-insensitive.
endswith string: Suffix of the DNS record comment. Comment filters are case-insensitive.
exact string: Exact value of the DNS record comment. Comment filters are case-insensitive.
present string: If this parameter is present, only records with a comment are returned.
startswith string: Prefix of the DNS record comment. Comment filters are case-insensitive.

absent str: If this parameter is present, only records without a comment are returned.
contains str: Substring of the DNS record comment. Comment filters are case-insensitive.
endswith str: Suffix of the DNS record comment. Comment filters are case-insensitive.
exact str: Exact value of the DNS record comment. Comment filters are case-insensitive.
present str: If this parameter is present, only records with a comment are returned.
startswith str: Prefix of the DNS record comment. Comment filters are case-insensitive.

absent String: If this parameter is present, only records without a comment are returned.
contains String: Substring of the DNS record comment. Comment filters are case-insensitive.
endswith String: Suffix of the DNS record comment. Comment filters are case-insensitive.
exact String: Exact value of the DNS record comment. Comment filters are case-insensitive.
present String: If this parameter is present, only records with a comment are returned.
startswith String: Prefix of the DNS record comment. Comment filters are case-insensitive.

GetDnsRecordFilterContent

Contains string: Substring of the DNS record content. Content filters are case-insensitive.
Endswith string: Suffix of the DNS record content. Content filters are case-insensitive.
Exact string: Exact value of the DNS record content. Content filters are case-insensitive.
Startswith string: Prefix of the DNS record content. Content filters are case-insensitive.

Contains string: Substring of the DNS record content. Content filters are case-insensitive.
Endswith string: Suffix of the DNS record content. Content filters are case-insensitive.
Exact string: Exact value of the DNS record content. Content filters are case-insensitive.
Startswith string: Prefix of the DNS record content. Content filters are case-insensitive.

contains String: Substring of the DNS record content. Content filters are case-insensitive.
endswith String: Suffix of the DNS record content. Content filters are case-insensitive.
exact String: Exact value of the DNS record content. Content filters are case-insensitive.
startswith String: Prefix of the DNS record content. Content filters are case-insensitive.

contains string: Substring of the DNS record content. Content filters are case-insensitive.
endswith string: Suffix of the DNS record content. Content filters are case-insensitive.
exact string: Exact value of the DNS record content. Content filters are case-insensitive.
startswith string: Prefix of the DNS record content. Content filters are case-insensitive.

contains str: Substring of the DNS record content. Content filters are case-insensitive.
endswith str: Suffix of the DNS record content. Content filters are case-insensitive.
exact str: Exact value of the DNS record content. Content filters are case-insensitive.
startswith str: Prefix of the DNS record content. Content filters are case-insensitive.

contains String: Substring of the DNS record content. Content filters are case-insensitive.
endswith String: Suffix of the DNS record content. Content filters are case-insensitive.
exact String: Exact value of the DNS record content. Content filters are case-insensitive.
startswith String: Prefix of the DNS record content. Content filters are case-insensitive.

GetDnsRecordFilterName

Contains string: Substring of the DNS record name. Name filters are case-insensitive.
Endswith string: Suffix of the DNS record name. Name filters are case-insensitive.
Exact string: Exact value of the DNS record name. Name filters are case-insensitive.
Startswith string: Prefix of the DNS record name. Name filters are case-insensitive.

Contains string: Substring of the DNS record name. Name filters are case-insensitive.
Endswith string: Suffix of the DNS record name. Name filters are case-insensitive.
Exact string: Exact value of the DNS record name. Name filters are case-insensitive.
Startswith string: Prefix of the DNS record name. Name filters are case-insensitive.

contains String: Substring of the DNS record name. Name filters are case-insensitive.
endswith String: Suffix of the DNS record name. Name filters are case-insensitive.
exact String: Exact value of the DNS record name. Name filters are case-insensitive.
startswith String: Prefix of the DNS record name. Name filters are case-insensitive.

contains string: Substring of the DNS record name. Name filters are case-insensitive.
endswith string: Suffix of the DNS record name. Name filters are case-insensitive.
exact string: Exact value of the DNS record name. Name filters are case-insensitive.
startswith string: Prefix of the DNS record name. Name filters are case-insensitive.

contains str: Substring of the DNS record name. Name filters are case-insensitive.
endswith str: Suffix of the DNS record name. Name filters are case-insensitive.
exact str: Exact value of the DNS record name. Name filters are case-insensitive.
startswith str: Prefix of the DNS record name. Name filters are case-insensitive.

contains String: Substring of the DNS record name. Name filters are case-insensitive.
endswith String: Suffix of the DNS record name. Name filters are case-insensitive.
exact String: Exact value of the DNS record name. Name filters are case-insensitive.
startswith String: Prefix of the DNS record name. Name filters are case-insensitive.

GetDnsRecordFilterTag

Absent string: Name of a tag which must not be present on the DNS record. Tag filters are case-insensitive.
Contains string: A tag and value, of the form <tag-name>:<tag-value>. The API will only return DNS records that have a tag named <tag-name> whose value contains <tag-value>. Tag filters are case-insensitive.
Endswith string: A tag and value, of the form <tag-name>:<tag-value>. The API will only return DNS records that have a tag named <tag-name> whose value ends with <tag-value>. Tag filters are case-insensitive.
Exact string: A tag and value, of the form <tag-name>:<tag-value>. The API will only return DNS records that have a tag named <tag-name> whose value is <tag-value>. Tag filters are case-insensitive.
Present string: Name of a tag which must be present on the DNS record. Tag filters are case-insensitive.
Startswith string: A tag and value, of the form <tag-name>:<tag-value>. The API will only return DNS records that have a tag named <tag-name> whose value starts with <tag-value>. Tag filters are case-insensitive.

Absent string: Name of a tag which must not be present on the DNS record. Tag filters are case-insensitive.
Contains string: A tag and value, of the form <tag-name>:<tag-value>. The API will only return DNS records that have a tag named <tag-name> whose value contains <tag-value>. Tag filters are case-insensitive.
Endswith string: A tag and value, of the form <tag-name>:<tag-value>. The API will only return DNS records that have a tag named <tag-name> whose value ends with <tag-value>. Tag filters are case-insensitive.
Exact string: A tag and value, of the form <tag-name>:<tag-value>. The API will only return DNS records that have a tag named <tag-name> whose value is <tag-value>. Tag filters are case-insensitive.
Present string: Name of a tag which must be present on the DNS record. Tag filters are case-insensitive.
Startswith string: A tag and value, of the form <tag-name>:<tag-value>. The API will only return DNS records that have a tag named <tag-name> whose value starts with <tag-value>. Tag filters are case-insensitive.

absent String: Name of a tag which must not be present on the DNS record. Tag filters are case-insensitive.
contains String: A tag and value, of the form <tag-name>:<tag-value>. The API will only return DNS records that have a tag named <tag-name> whose value contains <tag-value>. Tag filters are case-insensitive.
endswith String: A tag and value, of the form <tag-name>:<tag-value>. The API will only return DNS records that have a tag named <tag-name> whose value ends with <tag-value>. Tag filters are case-insensitive.
exact String: A tag and value, of the form <tag-name>:<tag-value>. The API will only return DNS records that have a tag named <tag-name> whose value is <tag-value>. Tag filters are case-insensitive.
present String: Name of a tag which must be present on the DNS record. Tag filters are case-insensitive.
startswith String: A tag and value, of the form <tag-name>:<tag-value>. The API will only return DNS records that have a tag named <tag-name> whose value starts with <tag-value>. Tag filters are case-insensitive.

absent string: Name of a tag which must not be present on the DNS record. Tag filters are case-insensitive.
contains string: A tag and value, of the form <tag-name>:<tag-value>. The API will only return DNS records that have a tag named <tag-name> whose value contains <tag-value>. Tag filters are case-insensitive.
endswith string: A tag and value, of the form <tag-name>:<tag-value>. The API will only return DNS records that have a tag named <tag-name> whose value ends with <tag-value>. Tag filters are case-insensitive.
exact string: A tag and value, of the form <tag-name>:<tag-value>. The API will only return DNS records that have a tag named <tag-name> whose value is <tag-value>. Tag filters are case-insensitive.
present string: Name of a tag which must be present on the DNS record. Tag filters are case-insensitive.
startswith string: A tag and value, of the form <tag-name>:<tag-value>. The API will only return DNS records that have a tag named <tag-name> whose value starts with <tag-value>. Tag filters are case-insensitive.

absent str: Name of a tag which must not be present on the DNS record. Tag filters are case-insensitive.
contains str: A tag and value, of the form <tag-name>:<tag-value>. The API will only return DNS records that have a tag named <tag-name> whose value contains <tag-value>. Tag filters are case-insensitive.
endswith str: A tag and value, of the form <tag-name>:<tag-value>. The API will only return DNS records that have a tag named <tag-name> whose value ends with <tag-value>. Tag filters are case-insensitive.
exact str: A tag and value, of the form <tag-name>:<tag-value>. The API will only return DNS records that have a tag named <tag-name> whose value is <tag-value>. Tag filters are case-insensitive.
present str: Name of a tag which must be present on the DNS record. Tag filters are case-insensitive.
startswith str: A tag and value, of the form <tag-name>:<tag-value>. The API will only return DNS records that have a tag named <tag-name> whose value starts with <tag-value>. Tag filters are case-insensitive.

absent String: Name of a tag which must not be present on the DNS record. Tag filters are case-insensitive.
contains String: A tag and value, of the form <tag-name>:<tag-value>. The API will only return DNS records that have a tag named <tag-name> whose value contains <tag-value>. Tag filters are case-insensitive.
endswith String: A tag and value, of the form <tag-name>:<tag-value>. The API will only return DNS records that have a tag named <tag-name> whose value ends with <tag-value>. Tag filters are case-insensitive.
exact String: A tag and value, of the form <tag-name>:<tag-value>. The API will only return DNS records that have a tag named <tag-name> whose value is <tag-value>. Tag filters are case-insensitive.
present String: Name of a tag which must be present on the DNS record. Tag filters are case-insensitive.
startswith String: A tag and value, of the form <tag-name>:<tag-value>. The API will only return DNS records that have a tag named <tag-name> whose value starts with <tag-value>. Tag filters are case-insensitive.

GetDnsRecordSettings

FlattenCname bool: If enabled, causes the CNAME record to be resolved externally and the resulting address records (e.g., A and AAAA) to be returned instead of the CNAME record itself. This setting is unavailable for proxied records, since they are always flattened.
Ipv4Only bool: When enabled, only A records will be generated, and AAAA records will not be created. This setting is intended for exceptional cases. Note that this option only applies to proxied records and it has no effect on whether Cloudflare communicates with the origin using IPv4 or IPv6.
Ipv6Only bool: When enabled, only AAAA records will be generated, and A records will not be created. This setting is intended for exceptional cases. Note that this option only applies to proxied records and it has no effect on whether Cloudflare communicates with the origin using IPv4 or IPv6.

FlattenCname bool: If enabled, causes the CNAME record to be resolved externally and the resulting address records (e.g., A and AAAA) to be returned instead of the CNAME record itself. This setting is unavailable for proxied records, since they are always flattened.
Ipv4Only bool: When enabled, only A records will be generated, and AAAA records will not be created. This setting is intended for exceptional cases. Note that this option only applies to proxied records and it has no effect on whether Cloudflare communicates with the origin using IPv4 or IPv6.
Ipv6Only bool: When enabled, only AAAA records will be generated, and A records will not be created. This setting is intended for exceptional cases. Note that this option only applies to proxied records and it has no effect on whether Cloudflare communicates with the origin using IPv4 or IPv6.

flattenCname Boolean: If enabled, causes the CNAME record to be resolved externally and the resulting address records (e.g., A and AAAA) to be returned instead of the CNAME record itself. This setting is unavailable for proxied records, since they are always flattened.
ipv4Only Boolean: When enabled, only A records will be generated, and AAAA records will not be created. This setting is intended for exceptional cases. Note that this option only applies to proxied records and it has no effect on whether Cloudflare communicates with the origin using IPv4 or IPv6.
ipv6Only Boolean: When enabled, only AAAA records will be generated, and A records will not be created. This setting is intended for exceptional cases. Note that this option only applies to proxied records and it has no effect on whether Cloudflare communicates with the origin using IPv4 or IPv6.

flattenCname boolean: If enabled, causes the CNAME record to be resolved externally and the resulting address records (e.g., A and AAAA) to be returned instead of the CNAME record itself. This setting is unavailable for proxied records, since they are always flattened.
ipv4Only boolean: When enabled, only A records will be generated, and AAAA records will not be created. This setting is intended for exceptional cases. Note that this option only applies to proxied records and it has no effect on whether Cloudflare communicates with the origin using IPv4 or IPv6.
ipv6Only boolean: When enabled, only AAAA records will be generated, and A records will not be created. This setting is intended for exceptional cases. Note that this option only applies to proxied records and it has no effect on whether Cloudflare communicates with the origin using IPv4 or IPv6.

flatten_cname bool: If enabled, causes the CNAME record to be resolved externally and the resulting address records (e.g., A and AAAA) to be returned instead of the CNAME record itself. This setting is unavailable for proxied records, since they are always flattened.
ipv4_only bool: When enabled, only A records will be generated, and AAAA records will not be created. This setting is intended for exceptional cases. Note that this option only applies to proxied records and it has no effect on whether Cloudflare communicates with the origin using IPv4 or IPv6.
ipv6_only bool: When enabled, only AAAA records will be generated, and A records will not be created. This setting is intended for exceptional cases. Note that this option only applies to proxied records and it has no effect on whether Cloudflare communicates with the origin using IPv4 or IPv6.

flattenCname Boolean: If enabled, causes the CNAME record to be resolved externally and the resulting address records (e.g., A and AAAA) to be returned instead of the CNAME record itself. This setting is unavailable for proxied records, since they are always flattened.
ipv4Only Boolean: When enabled, only A records will be generated, and AAAA records will not be created. This setting is intended for exceptional cases. Note that this option only applies to proxied records and it has no effect on whether Cloudflare communicates with the origin using IPv4 or IPv6.
ipv6Only Boolean: When enabled, only AAAA records will be generated, and A records will not be created. This setting is intended for exceptional cases. Note that this option only applies to proxied records and it has no effect on whether Cloudflare communicates with the origin using IPv4 or IPv6.

Package Details

Repository: Cloudflare pulumi/pulumi-cloudflare
License: Apache-2.0
Notes: This Pulumi package is based on the cloudflare Terraform Provider.

Cloudflare v6.0.1 published on Wednesday, Apr 16, 2025 by Pulumi

pulumi/pulumi-cloudflare

cloudflare.getDnsRecord

On this page

On this page

Example Usage

Using getDnsRecord

getDnsRecord Result

Supporting Types

GetDnsRecordData

GetDnsRecordFilter

GetDnsRecordFilterComment

GetDnsRecordFilterContent

GetDnsRecordFilterName

GetDnsRecordFilterTag

GetDnsRecordSettings

Package Details

On this page

On this page