@pulumi/linode
Version:
A Pulumi package for creating and managing linode cloud resources.
236 lines (235 loc) • 11.4 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Provides a Linode Domain resource. This can be used to create, modify, and delete Linode Domains through Linode's managed DNS service.
* For more information, see [DNS Manager](https://www.linode.com/docs/platform/manager/dns-manager/) and the [Linode APIv4 docs](https://techdocs.akamai.com/linode-api/reference/post-domain).
*
* ## Example Usage
*
* The following example shows how one might use this resource to configure a Domain Record attached to a Linode Domain.
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as linode from "@pulumi/linode";
*
* const foobar = new linode.Domain("foobar", {
* type: "master",
* domain: "foobar.example",
* soaEmail: "example@foobar.example",
* tags: [
* "foo",
* "bar",
* ],
* });
* const foobarDomainRecord = new linode.DomainRecord("foobar", {
* domainId: foobar.id,
* name: "www",
* recordType: "CNAME",
* target: "foobar.example",
* });
* ```
*
* ## Import
*
* Linodes Domains can be imported using the Linode Domain `id`, e.g.
*
* ```sh
* $ pulumi import linode:index/domain:Domain foobar 1234567
* ```
*/
export declare class Domain extends pulumi.CustomResource {
/**
* Get an existing Domain resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: DomainState, opts?: pulumi.CustomResourceOptions): Domain;
/**
* Returns true if the given object is an instance of Domain. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is Domain;
/**
* The list of IPs that may perform a zone transfer for this Domain. This is potentially dangerous, and should be set to an empty list unless you intend to use it.
*/
readonly axfrIps: pulumi.Output<string[] | undefined>;
/**
* A description for this Domain. This is for display purposes only.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* The domain this Domain represents. These must be unique in our system; you cannot have two Domains representing the same domain.
*/
readonly domain: pulumi.Output<string>;
/**
* The amount of time in seconds that may pass before this Domain is no longer authoritative. Valid values are 0, 30, 120, 300, 3600, 7200, 14400, 28800, 57600, 86400, 172800, 345600, 604800, 1209600, and 2419200 - any other value will be rounded to the nearest valid value.
*/
readonly expireSec: pulumi.Output<number | undefined>;
/**
* The group this Domain belongs to. This is for display purposes only.
*/
readonly group: pulumi.Output<string | undefined>;
/**
* The IP addresses representing the master DNS for this Domain.
*
* - - -
*/
readonly masterIps: pulumi.Output<string[] | undefined>;
/**
* The amount of time in seconds before this Domain should be refreshed. Valid values are 0, 30, 120, 300, 3600, 7200, 14400, 28800, 57600, 86400, 172800, 345600, 604800, 1209600, and 2419200 - any other value will be rounded to the nearest valid value.
*/
readonly refreshSec: pulumi.Output<number | undefined>;
/**
* The interval, in seconds, at which a failed refresh should be retried. Valid values are 0, 30, 120, 300, 3600, 7200, 14400, 28800, 57600, 86400, 172800, 345600, 604800, 1209600, and 2419200 - any other value will be rounded to the nearest valid value.
*/
readonly retrySec: pulumi.Output<number | undefined>;
/**
* Start of Authority email address. This is required for master Domains.
*/
readonly soaEmail: pulumi.Output<string | undefined>;
/**
* Used to control whether this Domain is currently being rendered (defaults to "active").
*/
readonly status: pulumi.Output<string>;
/**
* A list of tags applied to this object. Tags are case-insensitive and are for organizational purposes only.
*/
readonly tags: pulumi.Output<string[]>;
/**
* 'Time to Live' - the amount of time in seconds that this Domain's records may be cached by resolvers or other domain servers. Valid values are 0, 30, 120, 300, 3600, 7200, 14400, 28800, 57600, 86400, 172800, 345600, 604800, 1209600, and 2419200 - any other value will be rounded to the nearest valid value.
*/
readonly ttlSec: pulumi.Output<number | undefined>;
/**
* 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).
*/
readonly type: pulumi.Output<string>;
/**
* Create a Domain resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: DomainArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Domain resources.
*/
export interface DomainState {
/**
* The list of IPs that may perform a zone transfer for this Domain. This is potentially dangerous, and should be set to an empty list unless you intend to use it.
*/
axfrIps?: pulumi.Input<pulumi.Input<string>[]>;
/**
* A description for this Domain. This is for display purposes only.
*/
description?: pulumi.Input<string>;
/**
* The domain this Domain represents. These must be unique in our system; you cannot have two Domains representing the same domain.
*/
domain?: pulumi.Input<string>;
/**
* The amount of time in seconds that may pass before this Domain is no longer authoritative. Valid values are 0, 30, 120, 300, 3600, 7200, 14400, 28800, 57600, 86400, 172800, 345600, 604800, 1209600, and 2419200 - any other value will be rounded to the nearest valid value.
*/
expireSec?: pulumi.Input<number>;
/**
* The group this Domain belongs to. This is for display purposes only.
*/
group?: pulumi.Input<string>;
/**
* The IP addresses representing the master DNS for this Domain.
*
* - - -
*/
masterIps?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The amount of time in seconds before this Domain should be refreshed. Valid values are 0, 30, 120, 300, 3600, 7200, 14400, 28800, 57600, 86400, 172800, 345600, 604800, 1209600, and 2419200 - any other value will be rounded to the nearest valid value.
*/
refreshSec?: pulumi.Input<number>;
/**
* The interval, in seconds, at which a failed refresh should be retried. Valid values are 0, 30, 120, 300, 3600, 7200, 14400, 28800, 57600, 86400, 172800, 345600, 604800, 1209600, and 2419200 - any other value will be rounded to the nearest valid value.
*/
retrySec?: pulumi.Input<number>;
/**
* Start of Authority email address. This is required for master Domains.
*/
soaEmail?: pulumi.Input<string>;
/**
* Used to control whether this Domain is currently being rendered (defaults to "active").
*/
status?: pulumi.Input<string>;
/**
* A list of tags applied to this object. Tags are case-insensitive and are for organizational purposes only.
*/
tags?: pulumi.Input<pulumi.Input<string>[]>;
/**
* 'Time to Live' - the amount of time in seconds that this Domain's records may be cached by resolvers or other domain servers. Valid values are 0, 30, 120, 300, 3600, 7200, 14400, 28800, 57600, 86400, 172800, 345600, 604800, 1209600, and 2419200 - any other value will be rounded to the nearest valid value.
*/
ttlSec?: pulumi.Input<number>;
/**
* 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).
*/
type?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a Domain resource.
*/
export interface DomainArgs {
/**
* The list of IPs that may perform a zone transfer for this Domain. This is potentially dangerous, and should be set to an empty list unless you intend to use it.
*/
axfrIps?: pulumi.Input<pulumi.Input<string>[]>;
/**
* A description for this Domain. This is for display purposes only.
*/
description?: pulumi.Input<string>;
/**
* The domain this Domain represents. These must be unique in our system; you cannot have two Domains representing the same domain.
*/
domain: pulumi.Input<string>;
/**
* The amount of time in seconds that may pass before this Domain is no longer authoritative. Valid values are 0, 30, 120, 300, 3600, 7200, 14400, 28800, 57600, 86400, 172800, 345600, 604800, 1209600, and 2419200 - any other value will be rounded to the nearest valid value.
*/
expireSec?: pulumi.Input<number>;
/**
* The group this Domain belongs to. This is for display purposes only.
*/
group?: pulumi.Input<string>;
/**
* The IP addresses representing the master DNS for this Domain.
*
* - - -
*/
masterIps?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The amount of time in seconds before this Domain should be refreshed. Valid values are 0, 30, 120, 300, 3600, 7200, 14400, 28800, 57600, 86400, 172800, 345600, 604800, 1209600, and 2419200 - any other value will be rounded to the nearest valid value.
*/
refreshSec?: pulumi.Input<number>;
/**
* The interval, in seconds, at which a failed refresh should be retried. Valid values are 0, 30, 120, 300, 3600, 7200, 14400, 28800, 57600, 86400, 172800, 345600, 604800, 1209600, and 2419200 - any other value will be rounded to the nearest valid value.
*/
retrySec?: pulumi.Input<number>;
/**
* Start of Authority email address. This is required for master Domains.
*/
soaEmail?: pulumi.Input<string>;
/**
* Used to control whether this Domain is currently being rendered (defaults to "active").
*/
status?: pulumi.Input<string>;
/**
* A list of tags applied to this object. Tags are case-insensitive and are for organizational purposes only.
*/
tags?: pulumi.Input<pulumi.Input<string>[]>;
/**
* 'Time to Live' - the amount of time in seconds that this Domain's records may be cached by resolvers or other domain servers. Valid values are 0, 30, 120, 300, 3600, 7200, 14400, 28800, 57600, 86400, 172800, 345600, 604800, 1209600, and 2419200 - any other value will be rounded to the nearest valid value.
*/
ttlSec?: pulumi.Input<number>;
/**
* 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).
*/
type: pulumi.Input<string>;
}