digitalocean.getRecords
Explore with Pulumi AI
Retrieve information about all DNS records within a domain, with the ability to filter and sort the results. If no filters are specified, all records will be returned.
Using getRecords
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 getRecords(args: GetRecordsArgs, opts?: InvokeOptions): Promise<GetRecordsResult>
function getRecordsOutput(args: GetRecordsOutputArgs, opts?: InvokeOptions): Output<GetRecordsResult>
def get_records(domain: Optional[str] = None,
filters: Optional[Sequence[GetRecordsFilter]] = None,
sorts: Optional[Sequence[GetRecordsSort]] = None,
opts: Optional[InvokeOptions] = None) -> GetRecordsResult
def get_records_output(domain: Optional[pulumi.Input[str]] = None,
filters: Optional[pulumi.Input[Sequence[pulumi.Input[GetRecordsFilterArgs]]]] = None,
sorts: Optional[pulumi.Input[Sequence[pulumi.Input[GetRecordsSortArgs]]]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetRecordsResult]
func GetRecords(ctx *Context, args *GetRecordsArgs, opts ...InvokeOption) (*GetRecordsResult, error)
func GetRecordsOutput(ctx *Context, args *GetRecordsOutputArgs, opts ...InvokeOption) GetRecordsResultOutput
> Note: This function is named GetRecords
in the Go SDK.
public static class GetRecords
{
public static Task<GetRecordsResult> InvokeAsync(GetRecordsArgs args, InvokeOptions? opts = null)
public static Output<GetRecordsResult> Invoke(GetRecordsInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetRecordsResult> getRecords(GetRecordsArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: digitalocean:index/getRecords:getRecords
arguments:
# arguments dictionary
The following arguments are supported:
- Domain string
The domain name to search for DNS records
- Filters
List<Pulumi.
Digital Ocean. Inputs. Get Records Filter> Filter the results. The
filter
block is documented below.- Sorts
List<Pulumi.
Digital Ocean. Inputs. Get Records Sort> Sort the results. The
sort
block is documented below.
- Domain string
The domain name to search for DNS records
- Filters
[]Get
Records Filter Filter the results. The
filter
block is documented below.- Sorts
[]Get
Records Sort Sort the results. The
sort
block is documented below.
- domain String
The domain name to search for DNS records
- filters
List<Get
Records Filter> Filter the results. The
filter
block is documented below.- sorts
List<Get
Records Sort> Sort the results. The
sort
block is documented below.
- domain string
The domain name to search for DNS records
- filters
Get
Records Filter[] Filter the results. The
filter
block is documented below.- sorts
Get
Records Sort[] Sort the results. The
sort
block is documented below.
- domain str
The domain name to search for DNS records
- filters
Sequence[Get
Records Filter] Filter the results. The
filter
block is documented below.- sorts
Sequence[Get
Records Sort] Sort the results. The
sort
block is documented below.
- domain String
The domain name to search for DNS records
- filters List<Property Map>
Filter the results. The
filter
block is documented below.- sorts List<Property Map>
Sort the results. The
sort
block is documented below.
getRecords Result
The following output properties are available:
- Domain string
Domain of the DNS record.
- Id string
The provider-assigned unique ID for this managed resource.
- Records
List<Pulumi.
Digital Ocean. Outputs. Get Records Record> - Filters
List<Pulumi.
Digital Ocean. Outputs. Get Records Filter> - Sorts
List<Pulumi.
Digital Ocean. Outputs. Get Records Sort>
- Domain string
Domain of the DNS record.
- Id string
The provider-assigned unique ID for this managed resource.
- Records
[]Get
Records Record - Filters
[]Get
Records Filter - Sorts
[]Get
Records Sort
- domain String
Domain of the DNS record.
- id String
The provider-assigned unique ID for this managed resource.
- records
List<Get
Records Record> - filters
List<Get
Records Filter> - sorts
List<Get
Records Sort>
- domain string
Domain of the DNS record.
- id string
The provider-assigned unique ID for this managed resource.
- records
Get
Records Record[] - filters
Get
Records Filter[] - sorts
Get
Records Sort[]
- domain str
Domain of the DNS record.
- id str
The provider-assigned unique ID for this managed resource.
- records
Sequence[Get
Records Record] - filters
Sequence[Get
Records Filter] - sorts
Sequence[Get
Records Sort]
- domain String
Domain of the DNS record.
- id String
The provider-assigned unique ID for this managed resource.
- records List<Property Map>
- filters List<Property Map>
- sorts List<Property Map>
Supporting Types
GetRecordsFilter
- Key string
Filter the DNS records by this key. This may be one of
domain
,flags
,name
,port
,priority
,tag
,ttl
,type
,value
, orweight
.- Values List<string>
A list of values to match against the
key
field. Only retrieves DNS records where thekey
field takes on one or more of the values provided here.- All bool
Set to
true
to require that a field match all of thevalues
instead of just one or more of them. This is useful when matching against multi-valued fields such as lists or sets where you want to ensure that all of thevalues
are present in the list or set.- Match
By string One of
exact
(default),re
, orsubstring
. For string-typed fields, specifyre
to match by using thevalues
as regular expressions, or specifysubstring
to match by treating thevalues
as substrings to find within the string field.
- Key string
Filter the DNS records by this key. This may be one of
domain
,flags
,name
,port
,priority
,tag
,ttl
,type
,value
, orweight
.- Values []string
A list of values to match against the
key
field. Only retrieves DNS records where thekey
field takes on one or more of the values provided here.- All bool
Set to
true
to require that a field match all of thevalues
instead of just one or more of them. This is useful when matching against multi-valued fields such as lists or sets where you want to ensure that all of thevalues
are present in the list or set.- Match
By string One of
exact
(default),re
, orsubstring
. For string-typed fields, specifyre
to match by using thevalues
as regular expressions, or specifysubstring
to match by treating thevalues
as substrings to find within the string field.
- key String
Filter the DNS records by this key. This may be one of
domain
,flags
,name
,port
,priority
,tag
,ttl
,type
,value
, orweight
.- values List<String>
A list of values to match against the
key
field. Only retrieves DNS records where thekey
field takes on one or more of the values provided here.- all Boolean
Set to
true
to require that a field match all of thevalues
instead of just one or more of them. This is useful when matching against multi-valued fields such as lists or sets where you want to ensure that all of thevalues
are present in the list or set.- match
By String One of
exact
(default),re
, orsubstring
. For string-typed fields, specifyre
to match by using thevalues
as regular expressions, or specifysubstring
to match by treating thevalues
as substrings to find within the string field.
- key string
Filter the DNS records by this key. This may be one of
domain
,flags
,name
,port
,priority
,tag
,ttl
,type
,value
, orweight
.- values string[]
A list of values to match against the
key
field. Only retrieves DNS records where thekey
field takes on one or more of the values provided here.- all boolean
Set to
true
to require that a field match all of thevalues
instead of just one or more of them. This is useful when matching against multi-valued fields such as lists or sets where you want to ensure that all of thevalues
are present in the list or set.- match
By string One of
exact
(default),re
, orsubstring
. For string-typed fields, specifyre
to match by using thevalues
as regular expressions, or specifysubstring
to match by treating thevalues
as substrings to find within the string field.
- key str
Filter the DNS records by this key. This may be one of
domain
,flags
,name
,port
,priority
,tag
,ttl
,type
,value
, orweight
.- values Sequence[str]
A list of values to match against the
key
field. Only retrieves DNS records where thekey
field takes on one or more of the values provided here.- all bool
Set to
true
to require that a field match all of thevalues
instead of just one or more of them. This is useful when matching against multi-valued fields such as lists or sets where you want to ensure that all of thevalues
are present in the list or set.- match_
by str One of
exact
(default),re
, orsubstring
. For string-typed fields, specifyre
to match by using thevalues
as regular expressions, or specifysubstring
to match by treating thevalues
as substrings to find within the string field.
- key String
Filter the DNS records by this key. This may be one of
domain
,flags
,name
,port
,priority
,tag
,ttl
,type
,value
, orweight
.- values List<String>
A list of values to match against the
key
field. Only retrieves DNS records where thekey
field takes on one or more of the values provided here.- all Boolean
Set to
true
to require that a field match all of thevalues
instead of just one or more of them. This is useful when matching against multi-valued fields such as lists or sets where you want to ensure that all of thevalues
are present in the list or set.- match
By String One of
exact
(default),re
, orsubstring
. For string-typed fields, specifyre
to match by using thevalues
as regular expressions, or specifysubstring
to match by treating thevalues
as substrings to find within the string field.
GetRecordsRecord
- Domain string
The domain name to search for DNS records
- Flags int
An unsigned integer between 0-255 used for CAA records.
- Id int
The ID of the record.
- Name string
The name of the DNS record.
- Port int
The port for SRV records.
- Priority int
The priority for SRV and MX records.
- Tag string
The parameter tag for CAA records.
- Ttl int
This value is the time to live for the record, in seconds. This defines the time frame that clients can cache queried information before a refresh should be requested.
- Type string
The type of the DNS record.
- Value string
Variable data depending on record type. For example, the "data" value for an A record would be the IPv4 address to which the domain will be mapped. For a CAA record, it would contain the domain name of the CA being granted permission to issue certificates.
- Weight int
The weight for SRV records.
- Domain string
The domain name to search for DNS records
- Flags int
An unsigned integer between 0-255 used for CAA records.
- Id int
The ID of the record.
- Name string
The name of the DNS record.
- Port int
The port for SRV records.
- Priority int
The priority for SRV and MX records.
- Tag string
The parameter tag for CAA records.
- Ttl int
This value is the time to live for the record, in seconds. This defines the time frame that clients can cache queried information before a refresh should be requested.
- Type string
The type of the DNS record.
- Value string
Variable data depending on record type. For example, the "data" value for an A record would be the IPv4 address to which the domain will be mapped. For a CAA record, it would contain the domain name of the CA being granted permission to issue certificates.
- Weight int
The weight for SRV records.
- domain String
The domain name to search for DNS records
- flags Integer
An unsigned integer between 0-255 used for CAA records.
- id Integer
The ID of the record.
- name String
The name of the DNS record.
- port Integer
The port for SRV records.
- priority Integer
The priority for SRV and MX records.
- tag String
The parameter tag for CAA records.
- ttl Integer
This value is the time to live for the record, in seconds. This defines the time frame that clients can cache queried information before a refresh should be requested.
- type String
The type of the DNS record.
- value String
Variable data depending on record type. For example, the "data" value for an A record would be the IPv4 address to which the domain will be mapped. For a CAA record, it would contain the domain name of the CA being granted permission to issue certificates.
- weight Integer
The weight for SRV records.
- domain string
The domain name to search for DNS records
- flags number
An unsigned integer between 0-255 used for CAA records.
- id number
The ID of the record.
- name string
The name of the DNS record.
- port number
The port for SRV records.
- priority number
The priority for SRV and MX records.
- tag string
The parameter tag for CAA records.
- ttl number
This value is the time to live for the record, in seconds. This defines the time frame that clients can cache queried information before a refresh should be requested.
- type string
The type of the DNS record.
- value string
Variable data depending on record type. For example, the "data" value for an A record would be the IPv4 address to which the domain will be mapped. For a CAA record, it would contain the domain name of the CA being granted permission to issue certificates.
- weight number
The weight for SRV records.
- domain str
The domain name to search for DNS records
- flags int
An unsigned integer between 0-255 used for CAA records.
- id int
The ID of the record.
- name str
The name of the DNS record.
- port int
The port for SRV records.
- priority int
The priority for SRV and MX records.
- tag str
The parameter tag for CAA records.
- ttl int
This value is the time to live for the record, in seconds. This defines the time frame that clients can cache queried information before a refresh should be requested.
- type str
The type of the DNS record.
- value str
Variable data depending on record type. For example, the "data" value for an A record would be the IPv4 address to which the domain will be mapped. For a CAA record, it would contain the domain name of the CA being granted permission to issue certificates.
- weight int
The weight for SRV records.
- domain String
The domain name to search for DNS records
- flags Number
An unsigned integer between 0-255 used for CAA records.
- id Number
The ID of the record.
- name String
The name of the DNS record.
- port Number
The port for SRV records.
- priority Number
The priority for SRV and MX records.
- tag String
The parameter tag for CAA records.
- ttl Number
This value is the time to live for the record, in seconds. This defines the time frame that clients can cache queried information before a refresh should be requested.
- type String
The type of the DNS record.
- value String
Variable data depending on record type. For example, the "data" value for an A record would be the IPv4 address to which the domain will be mapped. For a CAA record, it would contain the domain name of the CA being granted permission to issue certificates.
- weight Number
The weight for SRV records.
GetRecordsSort
Package Details
- Repository
- DigitalOcean pulumi/pulumi-digitalocean
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
digitalocean
Terraform Provider.