1. Packages
  2. Cloudflare Provider
  3. API Docs
  4. getDnsRecord
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

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

const exampleDnsRecord = cloudflare.getDnsRecord({
    zoneId: "023e105f4ecef8ad9ca31a8372d0c353",
    dnsRecordId: "023e105f4ecef8ad9ca31a8372d0c353",
});
Copy
import pulumi
import pulumi_cloudflare as cloudflare

example_dns_record = cloudflare.get_dns_record(zone_id="023e105f4ecef8ad9ca31a8372d0c353",
    dns_record_id="023e105f4ecef8ad9ca31a8372d0c353")
Copy
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
	})
}
Copy
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",
    });

});
Copy
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());

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

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.

function getDnsRecord(args: GetDnsRecordArgs, opts?: InvokeOptions): Promise<GetDnsRecordResult>
function getDnsRecordOutput(args: GetDnsRecordOutputArgs, opts?: InvokeOptions): Output<GetDnsRecordResult>
Copy
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]
Copy
func LookupDnsRecord(ctx *Context, args *LookupDnsRecordArgs, opts ...InvokeOption) (*LookupDnsRecordResult, error)
func LookupDnsRecordOutput(ctx *Context, args *LookupDnsRecordOutputArgs, opts ...InvokeOption) LookupDnsRecordResultOutput
Copy

> 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)
}
Copy
public static CompletableFuture<GetDnsRecordResult> getDnsRecord(GetDnsRecordArgs args, InvokeOptions options)
public static Output<GetDnsRecordResult> getDnsRecord(GetDnsRecordArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: cloudflare:index/getDnsRecord:getDnsRecord
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ZoneId This property is required. string
Identifier
DnsRecordId string
Identifier
Filter GetDnsRecordFilter
ZoneId This property is required. string
Identifier
DnsRecordId string
Identifier
Filter GetDnsRecordFilter
zoneId This property is required. String
Identifier
dnsRecordId String
Identifier
filter GetDnsRecordFilter
zoneId This property is required. string
Identifier
dnsRecordId string
Identifier
filter GetDnsRecordFilter
zone_id This property is required. str
Identifier
dns_record_id str
Identifier
filter GetDnsRecordFilter
zoneId This property is required. 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 This property is required. double
Algorithm.
Altitude This property is required. double
Altitude of location in meters.
Certificate This property is required. string
Certificate.
Digest This property is required. string
Digest.
DigestType This property is required. double
Digest Type.
Fingerprint This property is required. string
fingerprint.
Flags This property is required. object
Flags for the CAA record.
KeyTag This property is required. double
Key Tag.
LatDegrees This property is required. double
Degrees of latitude.
LatDirection This property is required. string
Latitude direction. Available values: "N", "S".
LatMinutes This property is required. double
Minutes of latitude.
LatSeconds This property is required. double
Seconds of latitude.
LongDegrees This property is required. double
Degrees of longitude.
LongDirection This property is required. string
Longitude direction. Available values: "E", "W".
LongMinutes This property is required. double
Minutes of longitude.
LongSeconds This property is required. double
Seconds of longitude.
MatchingType This property is required. double
Matching Type.
Order This property is required. double
Order.
Port This property is required. double
The port of the service.
PrecisionHorz This property is required. double
Horizontal precision of location.
PrecisionVert This property is required. double
Vertical precision of location.
Preference This property is required. double
Preference.
Priority This property is required. double
priority.
Protocol This property is required. double
Protocol.
PublicKey This property is required. string
Public Key.
Regex This property is required. string
Regex.
Replacement This property is required. string
Replacement.
Selector This property is required. double
Selector.
Service This property is required. string
Service.
Size This property is required. double
Size of location in meters.
Tag This property is required. string
Name of the property controlled by this record (e.g.: issue, issuewild, iodef).
Target This property is required. string
target.
Type This property is required. double
Type.
Usage This property is required. double
Usage.
Value This property is required. string
Value of the record. This field's semantics depend on the chosen tag.
Weight This property is required. double
The record weight.
Algorithm This property is required. float64
Algorithm.
Altitude This property is required. float64
Altitude of location in meters.
Certificate This property is required. string
Certificate.
Digest This property is required. string
Digest.
DigestType This property is required. float64
Digest Type.
Fingerprint This property is required. string
fingerprint.
Flags This property is required. interface{}
Flags for the CAA record.
KeyTag This property is required. float64
Key Tag.
LatDegrees This property is required. float64
Degrees of latitude.
LatDirection This property is required. string
Latitude direction. Available values: "N", "S".
LatMinutes This property is required. float64
Minutes of latitude.
LatSeconds This property is required. float64
Seconds of latitude.
LongDegrees This property is required. float64
Degrees of longitude.
LongDirection This property is required. string
Longitude direction. Available values: "E", "W".
LongMinutes This property is required. float64
Minutes of longitude.
LongSeconds This property is required. float64
Seconds of longitude.
MatchingType This property is required. float64
Matching Type.
Order This property is required. float64
Order.
Port This property is required. float64
The port of the service.
PrecisionHorz This property is required. float64
Horizontal precision of location.
PrecisionVert This property is required. float64
Vertical precision of location.
Preference This property is required. float64
Preference.
Priority This property is required. float64
priority.
Protocol This property is required. float64
Protocol.
PublicKey This property is required. string
Public Key.
Regex This property is required. string
Regex.
Replacement This property is required. string
Replacement.
Selector This property is required. float64
Selector.
Service This property is required. string
Service.
Size This property is required. float64
Size of location in meters.
Tag This property is required. string
Name of the property controlled by this record (e.g.: issue, issuewild, iodef).
Target This property is required. string
target.
Type This property is required. float64
Type.
Usage This property is required. float64
Usage.
Value This property is required. string
Value of the record. This field's semantics depend on the chosen tag.
Weight This property is required. float64
The record weight.
algorithm This property is required. Double
Algorithm.
altitude This property is required. Double
Altitude of location in meters.
certificate This property is required. String
Certificate.
digest This property is required. String
Digest.
digestType This property is required. Double
Digest Type.
fingerprint This property is required. String
fingerprint.
flags This property is required. Object
Flags for the CAA record.
keyTag This property is required. Double
Key Tag.
latDegrees This property is required. Double
Degrees of latitude.
latDirection This property is required. String
Latitude direction. Available values: "N", "S".
latMinutes This property is required. Double
Minutes of latitude.
latSeconds This property is required. Double
Seconds of latitude.
longDegrees This property is required. Double
Degrees of longitude.
longDirection This property is required. String
Longitude direction. Available values: "E", "W".
longMinutes This property is required. Double
Minutes of longitude.
longSeconds This property is required. Double
Seconds of longitude.
matchingType This property is required. Double
Matching Type.
order This property is required. Double
Order.
port This property is required. Double
The port of the service.
precisionHorz This property is required. Double
Horizontal precision of location.
precisionVert This property is required. Double
Vertical precision of location.
preference This property is required. Double
Preference.
priority This property is required. Double
priority.
protocol This property is required. Double
Protocol.
publicKey This property is required. String
Public Key.
regex This property is required. String
Regex.
replacement This property is required. String
Replacement.
selector This property is required. Double
Selector.
service This property is required. String
Service.
size This property is required. Double
Size of location in meters.
tag This property is required. String
Name of the property controlled by this record (e.g.: issue, issuewild, iodef).
target This property is required. String
target.
type This property is required. Double
Type.
usage This property is required. Double
Usage.
value This property is required. String
Value of the record. This field's semantics depend on the chosen tag.
weight This property is required. Double
The record weight.
algorithm This property is required. number
Algorithm.
altitude This property is required. number
Altitude of location in meters.
certificate This property is required. string
Certificate.
digest This property is required. string
Digest.
digestType This property is required. number
Digest Type.
fingerprint This property is required. string
fingerprint.
flags This property is required. any
Flags for the CAA record.
keyTag This property is required. number
Key Tag.
latDegrees This property is required. number
Degrees of latitude.
latDirection This property is required. string
Latitude direction. Available values: "N", "S".
latMinutes This property is required. number
Minutes of latitude.
latSeconds This property is required. number
Seconds of latitude.
longDegrees This property is required. number
Degrees of longitude.
longDirection This property is required. string
Longitude direction. Available values: "E", "W".
longMinutes This property is required. number
Minutes of longitude.
longSeconds This property is required. number
Seconds of longitude.
matchingType This property is required. number
Matching Type.
order This property is required. number
Order.
port This property is required. number
The port of the service.
precisionHorz This property is required. number
Horizontal precision of location.
precisionVert This property is required. number
Vertical precision of location.
preference This property is required. number
Preference.
priority This property is required. number
priority.
protocol This property is required. number
Protocol.
publicKey This property is required. string
Public Key.
regex This property is required. string
Regex.
replacement This property is required. string
Replacement.
selector This property is required. number
Selector.
service This property is required. string
Service.
size This property is required. number
Size of location in meters.
tag This property is required. string
Name of the property controlled by this record (e.g.: issue, issuewild, iodef).
target This property is required. string
target.
type This property is required. number
Type.
usage This property is required. number
Usage.
value This property is required. string
Value of the record. This field's semantics depend on the chosen tag.
weight This property is required. number
The record weight.
algorithm This property is required. float
Algorithm.
altitude This property is required. float
Altitude of location in meters.
certificate This property is required. str
Certificate.
digest This property is required. str
Digest.
digest_type This property is required. float
Digest Type.
fingerprint This property is required. str
fingerprint.
flags This property is required. Any
Flags for the CAA record.
key_tag This property is required. float
Key Tag.
lat_degrees This property is required. float
Degrees of latitude.
lat_direction This property is required. str
Latitude direction. Available values: "N", "S".
lat_minutes This property is required. float
Minutes of latitude.
lat_seconds This property is required. float
Seconds of latitude.
long_degrees This property is required. float
Degrees of longitude.
long_direction This property is required. str
Longitude direction. Available values: "E", "W".
long_minutes This property is required. float
Minutes of longitude.
long_seconds This property is required. float
Seconds of longitude.
matching_type This property is required. float
Matching Type.
order This property is required. float
Order.
port This property is required. float
The port of the service.
precision_horz This property is required. float
Horizontal precision of location.
precision_vert This property is required. float
Vertical precision of location.
preference This property is required. float
Preference.
priority This property is required. float
priority.
protocol This property is required. float
Protocol.
public_key This property is required. str
Public Key.
regex This property is required. str
Regex.
replacement This property is required. str
Replacement.
selector This property is required. float
Selector.
service This property is required. str
Service.
size This property is required. float
Size of location in meters.
tag This property is required. str
Name of the property controlled by this record (e.g.: issue, issuewild, iodef).
target This property is required. str
target.
type This property is required. float
Type.
usage This property is required. float
Usage.
value This property is required. str
Value of the record. This field's semantics depend on the chosen tag.
weight This property is required. float
The record weight.
algorithm This property is required. Number
Algorithm.
altitude This property is required. Number
Altitude of location in meters.
certificate This property is required. String
Certificate.
digest This property is required. String
Digest.
digestType This property is required. Number
Digest Type.
fingerprint This property is required. String
fingerprint.
flags This property is required. Any
Flags for the CAA record.
keyTag This property is required. Number
Key Tag.
latDegrees This property is required. Number
Degrees of latitude.
latDirection This property is required. String
Latitude direction. Available values: "N", "S".
latMinutes This property is required. Number
Minutes of latitude.
latSeconds This property is required. Number
Seconds of latitude.
longDegrees This property is required. Number
Degrees of longitude.
longDirection This property is required. String
Longitude direction. Available values: "E", "W".
longMinutes This property is required. Number
Minutes of longitude.
longSeconds This property is required. Number
Seconds of longitude.
matchingType This property is required. Number
Matching Type.
order This property is required. Number
Order.
port This property is required. Number
The port of the service.
precisionHorz This property is required. Number
Horizontal precision of location.
precisionVert This property is required. Number
Vertical precision of location.
preference This property is required. Number
Preference.
priority This property is required. Number
priority.
protocol This property is required. Number
Protocol.
publicKey This property is required. String
Public Key.
regex This property is required. String
Regex.
replacement This property is required. String
Replacement.
selector This property is required. Number
Selector.
service This property is required. String
Service.
size This property is required. Number
Size of location in meters.
tag This property is required. String
Name of the property controlled by this record (e.g.: issue, issuewild, iodef).
target This property is required. String
target.
type This property is required. Number
Type.
usage This property is required. Number
Usage.
value This property is required. String
Value of the record. This field's semantics depend on the chosen tag.
weight This property is required. Number
The record weight.

GetDnsRecordFilter

Direction This property is required. string
Direction to order DNS records in. Available values: "asc", "desc".
Match This property is required. 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 This property is required. string
Field to order DNS records by. Available values: "type", "name", "content", "ttl", "proxied".
Proxied This property is required. bool
Whether the record is receiving the performance and security benefits of Cloudflare.
TagMatch This property is required. 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 This property is required. string
Direction to order DNS records in. Available values: "asc", "desc".
Match This property is required. 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 This property is required. string
Field to order DNS records by. Available values: "type", "name", "content", "ttl", "proxied".
Proxied This property is required. bool
Whether the record is receiving the performance and security benefits of Cloudflare.
TagMatch This property is required. 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 This property is required. String
Direction to order DNS records in. Available values: "asc", "desc".
match This property is required. 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 This property is required. String
Field to order DNS records by. Available values: "type", "name", "content", "ttl", "proxied".
proxied This property is required. Boolean
Whether the record is receiving the performance and security benefits of Cloudflare.
tagMatch This property is required. 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 This property is required. string
Direction to order DNS records in. Available values: "asc", "desc".
match This property is required. 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 This property is required. string
Field to order DNS records by. Available values: "type", "name", "content", "ttl", "proxied".
proxied This property is required. boolean
Whether the record is receiving the performance and security benefits of Cloudflare.
tagMatch This property is required. 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 This property is required. str
Direction to order DNS records in. Available values: "asc", "desc".
match This property is required. 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 This property is required. str
Field to order DNS records by. Available values: "type", "name", "content", "ttl", "proxied".
proxied This property is required. bool
Whether the record is receiving the performance and security benefits of Cloudflare.
tag_match This property is required. 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 This property is required. String
Direction to order DNS records in. Available values: "asc", "desc".
match This property is required. 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 This property is required. String
Field to order DNS records by. Available values: "type", "name", "content", "ttl", "proxied".
proxied This property is required. Boolean
Whether the record is receiving the performance and security benefits of Cloudflare.
tagMatch This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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