Linode v4.30.1 published on Thursday, Nov 21, 2024 by Pulumi
linode.getDomains
Explore with Pulumi AI
Provides information about Linode Domains that match a set of filters. For more information, see the Linode APIv4 docs.
Example Usage
Get information about all Linode Cloud Domains with a specific tag:
import * as pulumi from "@pulumi/pulumi";
import * as linode from "@pulumi/linode";
const specific = linode.getDomains({
filters: [{
name: "tags",
values: ["test-tag"],
}],
});
export const domain = specific.then(specific => specific.domains?.[0]?.domain);
import pulumi
import pulumi_linode as linode
specific = linode.get_domains(filters=[{
"name": "tags",
"values": ["test-tag"],
}])
pulumi.export("domain", specific.domains[0].domain)
package main
import (
"github.com/pulumi/pulumi-linode/sdk/v4/go/linode"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
specific, err := linode.GetDomains(ctx, &linode.GetDomainsArgs{
Filters: []linode.GetDomainsFilter{
{
Name: "tags",
Values: []string{
"test-tag",
},
},
},
}, nil)
if err != nil {
return err
}
ctx.Export("domain", specific.Domains[0].Domain)
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Linode = Pulumi.Linode;
return await Deployment.RunAsync(() =>
{
var specific = Linode.GetDomains.Invoke(new()
{
Filters = new[]
{
new Linode.Inputs.GetDomainsFilterInputArgs
{
Name = "tags",
Values = new[]
{
"test-tag",
},
},
},
});
return new Dictionary<string, object?>
{
["domain"] = specific.Apply(getDomainsResult => getDomainsResult.Domains[0]?.Domain),
};
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.linode.LinodeFunctions;
import com.pulumi.linode.inputs.GetDomainsArgs;
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 specific = LinodeFunctions.getDomains(GetDomainsArgs.builder()
.filters(GetDomainsFilterArgs.builder()
.name("tags")
.values("test-tag")
.build())
.build());
ctx.export("domain", specific.applyValue(getDomainsResult -> getDomainsResult.domains()[0].domain()));
}
}
variables:
specific:
fn::invoke:
Function: linode:getDomains
Arguments:
filters:
- name: tags
values:
- test-tag
outputs:
domain: ${specific.domains[0].domain}
Filterable Fields
group
tags
domain
type
status
description
master_ips
axfr_ips
ttl_sec
retry_sec
expire_sec
refresh_sec
soa_email
Using getDomains
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 getDomains(args: GetDomainsArgs, opts?: InvokeOptions): Promise<GetDomainsResult>
function getDomainsOutput(args: GetDomainsOutputArgs, opts?: InvokeOptions): Output<GetDomainsResult>
def get_domains(domains: Optional[Sequence[GetDomainsDomain]] = None,
filters: Optional[Sequence[GetDomainsFilter]] = None,
order: Optional[str] = None,
order_by: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetDomainsResult
def get_domains_output(domains: Optional[pulumi.Input[Sequence[pulumi.Input[GetDomainsDomainArgs]]]] = None,
filters: Optional[pulumi.Input[Sequence[pulumi.Input[GetDomainsFilterArgs]]]] = None,
order: Optional[pulumi.Input[str]] = None,
order_by: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetDomainsResult]
func GetDomains(ctx *Context, args *GetDomainsArgs, opts ...InvokeOption) (*GetDomainsResult, error)
func GetDomainsOutput(ctx *Context, args *GetDomainsOutputArgs, opts ...InvokeOption) GetDomainsResultOutput
> Note: This function is named GetDomains
in the Go SDK.
public static class GetDomains
{
public static Task<GetDomainsResult> InvokeAsync(GetDomainsArgs args, InvokeOptions? opts = null)
public static Output<GetDomainsResult> Invoke(GetDomainsInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetDomainsResult> getDomains(GetDomainsArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: linode:index/getDomains:getDomains
arguments:
# arguments dictionary
The following arguments are supported:
- Domains
List<Get
Domains Domain> - Filters
List<Get
Domains Filter> - Order string
- The order in which results should be returned. (
asc
,desc
; defaultasc
) - Order
By string - The attribute to order the results by. See the Filterable Fields section for a list of valid fields.
- Domains
[]Get
Domains Domain - Filters
[]Get
Domains Filter - Order string
- The order in which results should be returned. (
asc
,desc
; defaultasc
) - Order
By string - The attribute to order the results by. See the Filterable Fields section for a list of valid fields.
- domains
List<Get
Domains Domain> - filters
List<Get
Domains Filter> - order String
- The order in which results should be returned. (
asc
,desc
; defaultasc
) - order
By String - The attribute to order the results by. See the Filterable Fields section for a list of valid fields.
- domains
Get
Domains Domain[] - filters
Get
Domains Filter[] - order string
- The order in which results should be returned. (
asc
,desc
; defaultasc
) - order
By string - The attribute to order the results by. See the Filterable Fields section for a list of valid fields.
- domains
Sequence[Get
Domains Domain] - filters
Sequence[Get
Domains Filter] - order str
- The order in which results should be returned. (
asc
,desc
; defaultasc
) - order_
by str - The attribute to order the results by. See the Filterable Fields section for a list of valid fields.
- domains List<Property Map>
- filters List<Property Map>
- order String
- The order in which results should be returned. (
asc
,desc
; defaultasc
) - order
By String - The attribute to order the results by. See the Filterable Fields section for a list of valid fields.
getDomains Result
The following output properties are available:
- Id string
- The unique ID of this Domain.
- Domains
List<Get
Domains Domain> - Filters
List<Get
Domains Filter> - Order string
- Order
By string
- Id string
- The unique ID of this Domain.
- Domains
[]Get
Domains Domain - Filters
[]Get
Domains Filter - Order string
- Order
By string
- id String
- The unique ID of this Domain.
- domains
List<Get
Domains Domain> - filters
List<Get
Domains Filter> - order String
- order
By String
- id string
- The unique ID of this Domain.
- domains
Get
Domains Domain[] - filters
Get
Domains Filter[] - order string
- order
By string
- id str
- The unique ID of this Domain.
- domains
Sequence[Get
Domains Domain] - filters
Sequence[Get
Domains Filter] - order str
- order_
by str
- id String
- The unique ID of this Domain.
- domains List<Property Map>
- filters List<Property Map>
- order String
- order
By String
Supporting Types
GetDomainsDomain
- Axfr
Ips List<string> - The list of IPs that may perform a zone transfer for this Domain.
- Description string
- A description for this Domain.
- Expire
Sec int - The amount of time in seconds that may pass before this Domain is no longer authoritative.
- Group string
- The group this Domain belongs to.
- Master
Ips List<string> - The IP addresses representing the master DNS for this Domain.
- Refresh
Sec int - The amount of time in seconds before this Domain should be refreshed.
- Retry
Sec int - The interval, in seconds, at which a failed refresh should be retried.
- Soa
Email string - Start of Authority email address.
- Status string
- Used to control whether this Domain is currently being rendered. (
disabled
,active
) - List<string>
- An array of tags applied to this object. Tags are case-insensitive and are for organizational purposes only.
- Ttl
Sec int - 'Time to Live'-the amount of time in seconds that this Domain's records may be cached by resolvers or other domain servers.
- Type string
- If this Domain represents the authoritative source of information for the domain it describes, or if it is a read-only copy of a master (also called a slave) (
master
,slave
) - Domain string
- The domain this Domain represents. These must be unique in our system; you cannot have two Domains representing the same domain
- Id int
- The unique ID of this Domain.
- Axfr
Ips []string - The list of IPs that may perform a zone transfer for this Domain.
- Description string
- A description for this Domain.
- Expire
Sec int - The amount of time in seconds that may pass before this Domain is no longer authoritative.
- Group string
- The group this Domain belongs to.
- Master
Ips []string - The IP addresses representing the master DNS for this Domain.
- Refresh
Sec int - The amount of time in seconds before this Domain should be refreshed.
- Retry
Sec int - The interval, in seconds, at which a failed refresh should be retried.
- Soa
Email string - Start of Authority email address.
- Status string
- Used to control whether this Domain is currently being rendered. (
disabled
,active
) - []string
- An array of tags applied to this object. Tags are case-insensitive and are for organizational purposes only.
- Ttl
Sec int - 'Time to Live'-the amount of time in seconds that this Domain's records may be cached by resolvers or other domain servers.
- Type string
- If this Domain represents the authoritative source of information for the domain it describes, or if it is a read-only copy of a master (also called a slave) (
master
,slave
) - Domain string
- The domain this Domain represents. These must be unique in our system; you cannot have two Domains representing the same domain
- Id int
- The unique ID of this Domain.
- axfr
Ips List<String> - The list of IPs that may perform a zone transfer for this Domain.
- description String
- A description for this Domain.
- expire
Sec Integer - The amount of time in seconds that may pass before this Domain is no longer authoritative.
- group String
- The group this Domain belongs to.
- master
Ips List<String> - The IP addresses representing the master DNS for this Domain.
- refresh
Sec Integer - The amount of time in seconds before this Domain should be refreshed.
- retry
Sec Integer - The interval, in seconds, at which a failed refresh should be retried.
- soa
Email String - Start of Authority email address.
- status String
- Used to control whether this Domain is currently being rendered. (
disabled
,active
) - List<String>
- An array of tags applied to this object. Tags are case-insensitive and are for organizational purposes only.
- ttl
Sec Integer - 'Time to Live'-the amount of time in seconds that this Domain's records may be cached by resolvers or other domain servers.
- type String
- If this Domain represents the authoritative source of information for the domain it describes, or if it is a read-only copy of a master (also called a slave) (
master
,slave
) - domain String
- The domain this Domain represents. These must be unique in our system; you cannot have two Domains representing the same domain
- id Integer
- The unique ID of this Domain.
- axfr
Ips string[] - The list of IPs that may perform a zone transfer for this Domain.
- description string
- A description for this Domain.
- expire
Sec number - The amount of time in seconds that may pass before this Domain is no longer authoritative.
- group string
- The group this Domain belongs to.
- master
Ips string[] - The IP addresses representing the master DNS for this Domain.
- refresh
Sec number - The amount of time in seconds before this Domain should be refreshed.
- retry
Sec number - The interval, in seconds, at which a failed refresh should be retried.
- soa
Email string - Start of Authority email address.
- status string
- Used to control whether this Domain is currently being rendered. (
disabled
,active
) - string[]
- An array of tags applied to this object. Tags are case-insensitive and are for organizational purposes only.
- ttl
Sec number - 'Time to Live'-the amount of time in seconds that this Domain's records may be cached by resolvers or other domain servers.
- type string
- If this Domain represents the authoritative source of information for the domain it describes, or if it is a read-only copy of a master (also called a slave) (
master
,slave
) - domain string
- The domain this Domain represents. These must be unique in our system; you cannot have two Domains representing the same domain
- id number
- The unique ID of this Domain.
- axfr_
ips Sequence[str] - The list of IPs that may perform a zone transfer for this Domain.
- description str
- A description for this Domain.
- expire_
sec int - The amount of time in seconds that may pass before this Domain is no longer authoritative.
- group str
- The group this Domain belongs to.
- master_
ips Sequence[str] - The IP addresses representing the master DNS for this Domain.
- refresh_
sec int - The amount of time in seconds before this Domain should be refreshed.
- retry_
sec int - The interval, in seconds, at which a failed refresh should be retried.
- soa_
email str - Start of Authority email address.
- status str
- Used to control whether this Domain is currently being rendered. (
disabled
,active
) - Sequence[str]
- An array of tags applied to this object. Tags are case-insensitive and are for organizational purposes only.
- ttl_
sec int - 'Time to Live'-the amount of time in seconds that this Domain's records may be cached by resolvers or other domain servers.
- type str
- If this Domain represents the authoritative source of information for the domain it describes, or if it is a read-only copy of a master (also called a slave) (
master
,slave
) - domain str
- The domain this Domain represents. These must be unique in our system; you cannot have two Domains representing the same domain
- id int
- The unique ID of this Domain.
- axfr
Ips List<String> - The list of IPs that may perform a zone transfer for this Domain.
- description String
- A description for this Domain.
- expire
Sec Number - The amount of time in seconds that may pass before this Domain is no longer authoritative.
- group String
- The group this Domain belongs to.
- master
Ips List<String> - The IP addresses representing the master DNS for this Domain.
- refresh
Sec Number - The amount of time in seconds before this Domain should be refreshed.
- retry
Sec Number - The interval, in seconds, at which a failed refresh should be retried.
- soa
Email String - Start of Authority email address.
- status String
- Used to control whether this Domain is currently being rendered. (
disabled
,active
) - List<String>
- An array of tags applied to this object. Tags are case-insensitive and are for organizational purposes only.
- ttl
Sec Number - 'Time to Live'-the amount of time in seconds that this Domain's records may be cached by resolvers or other domain servers.
- type String
- If this Domain represents the authoritative source of information for the domain it describes, or if it is a read-only copy of a master (also called a slave) (
master
,slave
) - domain String
- The domain this Domain represents. These must be unique in our system; you cannot have two Domains representing the same domain
- id Number
- The unique ID of this Domain.
GetDomainsFilter
- Name string
- The name of the field to filter by. See the Filterable Fields section for a complete list of filterable fields.
- Values List<string>
- A list of values for the filter to allow. These values should all be in string form.
- Match
By string - The method to match the field by. (
exact
,regex
,substring
; defaultexact
)
- Name string
- The name of the field to filter by. See the Filterable Fields section for a complete list of filterable fields.
- Values []string
- A list of values for the filter to allow. These values should all be in string form.
- Match
By string - The method to match the field by. (
exact
,regex
,substring
; defaultexact
)
- name String
- The name of the field to filter by. See the Filterable Fields section for a complete list of filterable fields.
- values List<String>
- A list of values for the filter to allow. These values should all be in string form.
- match
By String - The method to match the field by. (
exact
,regex
,substring
; defaultexact
)
- name string
- The name of the field to filter by. See the Filterable Fields section for a complete list of filterable fields.
- values string[]
- A list of values for the filter to allow. These values should all be in string form.
- match
By string - The method to match the field by. (
exact
,regex
,substring
; defaultexact
)
- name str
- The name of the field to filter by. See the Filterable Fields section for a complete list of filterable fields.
- values Sequence[str]
- A list of values for the filter to allow. These values should all be in string form.
- match_
by str - The method to match the field by. (
exact
,regex
,substring
; defaultexact
)
- name String
- The name of the field to filter by. See the Filterable Fields section for a complete list of filterable fields.
- values List<String>
- A list of values for the filter to allow. These values should all be in string form.
- match
By String - The method to match the field by. (
exact
,regex
,substring
; defaultexact
)
Package Details
- Repository
- Linode pulumi/pulumi-linode
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
linode
Terraform Provider.