import * as pulumi from "@pulumi/pulumi"; import * as inputs from "./types/input"; import * as outputs from "./types/output"; /** * Creates and manages Scaleway Domain record.\ * For more information, see [the documentation](https://www.scaleway.com/en/docs/network/domains-and-dns/how-to/manage-dns-records/). * * ## Examples * * ### Basic * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as scaleway from "@lbrlabs/pulumi-scaleway"; * * const www = new scaleway.DomainRecord("www", { * data: "1.2.3.4", * dnsZone: "domain.tld", * ttl: 3600, * type: "A", * }); * const www2 = new scaleway.DomainRecord("www2", { * data: "1.2.3.5", * dnsZone: "domain.tld", * ttl: 3600, * type: "A", * }); * const mx = new scaleway.DomainRecord("mx", { * data: "mx.online.net.", * dnsZone: "domain.tld", * priority: 10, * ttl: 3600, * type: "MX", * }); * const mx2 = new scaleway.DomainRecord("mx2", { * data: "mx-cache.online.net.", * dnsZone: "domain.tld", * priority: 20, * ttl: 3600, * type: "MX", * }); * ``` * * ### With dynamic records * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as scaleway from "@lbrlabs/pulumi-scaleway"; * * const geoIp = new scaleway.DomainRecord("geoIp", { * data: "1.2.3.4", * dnsZone: "domain.tld", * geoIp: { * matches: [ * { * continents: ["EU"], * countries: ["FR"], * data: "1.2.3.5", * }, * { * continents: ["NA"], * data: "4.3.2.1", * }, * ], * }, * ttl: 3600, * type: "A", * }); * const httpService = new scaleway.DomainRecord("httpService", { * data: "1.2.3.4", * dnsZone: "domain.tld", * httpService: { * ips: [ * "1.2.3.5", * "1.2.3.6", * ], * mustContain: "up", * strategy: "hashed", * url: "http://mywebsite.com/health", * userAgent: "scw_service_up", * }, * ttl: 3600, * type: "A", * }); * const view = new scaleway.DomainRecord("view", { * data: "1.2.3.4", * dnsZone: "domain.tld", * ttl: 3600, * type: "A", * views: [ * { * data: "1.2.3.5", * subnet: "100.0.0.0/16", * }, * { * data: "1.2.3.6", * subnet: "100.1.0.0/16", * }, * ], * }); * const weighted = new scaleway.DomainRecord("weighted", { * data: "1.2.3.4", * dnsZone: "domain.tld", * ttl: 3600, * type: "A", * weighteds: [ * { * ip: "1.2.3.5", * weight: 1, * }, * { * ip: "1.2.3.6", * weight: 2, * }, * ], * }); * ``` * * ### Create an instance and add records with the new instance IP * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as scaleway from "@lbrlabs/pulumi-scaleway"; * * const config = new pulumi.Config(); * const projectId = config.require("projectId"); * const dnsZone = config.require("dnsZone"); * const publicIp = new scaleway.InstanceIp("publicIp", {projectId: projectId}); * const web = new scaleway.InstanceServer("web", { * projectId: projectId, * type: "DEV1-S", * image: "ubuntu_jammy", * tags: [ * "front", * "web", * ], * ipId: publicIp.id, * rootVolume: { * sizeInGb: 20, * }, * }); * const webA = new scaleway.DomainRecord("webA", { * dnsZone: dnsZone, * type: "A", * data: web.publicIp, * ttl: 3600, * }); * const webCname = new scaleway.DomainRecord("webCname", { * dnsZone: dnsZone, * type: "CNAME", * data: `web.${dnsZone}.`, * ttl: 3600, * }); * const webAlias = new scaleway.DomainRecord("webAlias", { * dnsZone: dnsZone, * type: "ALIAS", * data: `web.${dnsZone}.`, * ttl: 3600, * }); * ``` * * ## Multiple records * * Some record types can have multiple `data` with the same `name` (eg: `A`, `AAAA`, `MX`, `NS`...).\ * You can duplicate a resource `scaleway.DomainRecord` with the same `name`, the records will be added. * * Please note, some record (eg: `CNAME`, Multiple dynamic records of different types...) has to be unique. * * ## Import * * Record can be imported using the `{dns_zone}/{id}`, e.g. bash * * ```sh * $ pulumi import scaleway:index/domainRecord:DomainRecord www subdomain.domain.tld/11111111-1111-1111-1111-111111111111 * ``` */ export declare class DomainRecord extends pulumi.CustomResource { /** * Get an existing DomainRecord 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, state?: DomainRecordState, opts?: pulumi.CustomResourceOptions): DomainRecord; /** * Returns true if the given object is an instance of DomainRecord. 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 DomainRecord; /** * The content of the record (an IPv4 for an `A`, a string for a `TXT`...). */ readonly data: pulumi.Output; /** * The DNS Zone of the domain. If the DNS zone doesn't exist, it will be automatically created. */ readonly dnsZone: pulumi.Output; /** * The Geo IP feature provides DNS resolution, based on the user’s geographical location. You can define a default IP that resolves if no Geo IP rule matches, and specify IPs for each geographical zone. [Documentation and usage example](https://www.scaleway.com/en/docs/network/domains-and-dns/how-to/manage-dns-records/#geo-ip-records) */ readonly geoIp: pulumi.Output; /** * The DNS service checks the provided URL on the configured IPs and resolves the request to one of the IPs by excluding the ones not responding to the given string to check. [Documentation and usage example](https://www.scaleway.com/en/docs/network/domains-and-dns/how-to/manage-dns-records/#healthcheck-records) */ readonly httpService: pulumi.Output; /** * When destroying a resource, if only NS records remain and this is set to `false`, the zone will be deleted. Please note, each zone not deleted will [cost you money](https://www.scaleway.com/en/dns/) */ readonly keepEmptyZone: pulumi.Output; /** * The name of the record (can be an empty string for a root record). */ readonly name: pulumi.Output; /** * The priority of the record (mostly used with an `MX` record) */ readonly priority: pulumi.Output; /** * The project_id you want to attach the resource to */ readonly projectId: pulumi.Output; /** * Does the DNS zone is the root zone or not */ readonly rootZone: pulumi.Output; /** * Time To Live of the record in seconds. */ readonly ttl: pulumi.Output; /** * The type of the record (`A`, `AAAA`, `MX`, `CNAME`, `DNAME`, `ALIAS`, `NS`, `PTR`, `SRV`, `TXT`, `TLSA`, or `CAA`). */ readonly type: pulumi.Output; /** * The answer to a DNS request is based on the client’s (resolver) subnet. *(Can be more than 1)* [Documentation and usage example](https://www.scaleway.com/en/docs/network/domains-and-dns/how-to/manage-dns-records/#views-records) */ readonly views: pulumi.Output; /** * You provide a list of IPs with their corresponding weights. These weights are used to proportionally direct requests to each IP. Depending on the weight of a record more or fewer requests are answered with its related IP compared to the others in the list. *(Can be more than 1)* [Documentation and usage example](https://www.scaleway.com/en/docs/network/domains-and-dns/how-to/manage-dns-records/#weight-records) */ readonly weighteds: pulumi.Output; /** * Create a DomainRecord 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: DomainRecordArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering DomainRecord resources. */ export interface DomainRecordState { /** * The content of the record (an IPv4 for an `A`, a string for a `TXT`...). */ data?: pulumi.Input; /** * The DNS Zone of the domain. If the DNS zone doesn't exist, it will be automatically created. */ dnsZone?: pulumi.Input; /** * The Geo IP feature provides DNS resolution, based on the user’s geographical location. You can define a default IP that resolves if no Geo IP rule matches, and specify IPs for each geographical zone. [Documentation and usage example](https://www.scaleway.com/en/docs/network/domains-and-dns/how-to/manage-dns-records/#geo-ip-records) */ geoIp?: pulumi.Input; /** * The DNS service checks the provided URL on the configured IPs and resolves the request to one of the IPs by excluding the ones not responding to the given string to check. [Documentation and usage example](https://www.scaleway.com/en/docs/network/domains-and-dns/how-to/manage-dns-records/#healthcheck-records) */ httpService?: pulumi.Input; /** * When destroying a resource, if only NS records remain and this is set to `false`, the zone will be deleted. Please note, each zone not deleted will [cost you money](https://www.scaleway.com/en/dns/) */ keepEmptyZone?: pulumi.Input; /** * The name of the record (can be an empty string for a root record). */ name?: pulumi.Input; /** * The priority of the record (mostly used with an `MX` record) */ priority?: pulumi.Input; /** * The project_id you want to attach the resource to */ projectId?: pulumi.Input; /** * Does the DNS zone is the root zone or not */ rootZone?: pulumi.Input; /** * Time To Live of the record in seconds. */ ttl?: pulumi.Input; /** * The type of the record (`A`, `AAAA`, `MX`, `CNAME`, `DNAME`, `ALIAS`, `NS`, `PTR`, `SRV`, `TXT`, `TLSA`, or `CAA`). */ type?: pulumi.Input; /** * The answer to a DNS request is based on the client’s (resolver) subnet. *(Can be more than 1)* [Documentation and usage example](https://www.scaleway.com/en/docs/network/domains-and-dns/how-to/manage-dns-records/#views-records) */ views?: pulumi.Input[]>; /** * You provide a list of IPs with their corresponding weights. These weights are used to proportionally direct requests to each IP. Depending on the weight of a record more or fewer requests are answered with its related IP compared to the others in the list. *(Can be more than 1)* [Documentation and usage example](https://www.scaleway.com/en/docs/network/domains-and-dns/how-to/manage-dns-records/#weight-records) */ weighteds?: pulumi.Input[]>; } /** * The set of arguments for constructing a DomainRecord resource. */ export interface DomainRecordArgs { /** * The content of the record (an IPv4 for an `A`, a string for a `TXT`...). */ data: pulumi.Input; /** * The DNS Zone of the domain. If the DNS zone doesn't exist, it will be automatically created. */ dnsZone: pulumi.Input; /** * The Geo IP feature provides DNS resolution, based on the user’s geographical location. You can define a default IP that resolves if no Geo IP rule matches, and specify IPs for each geographical zone. [Documentation and usage example](https://www.scaleway.com/en/docs/network/domains-and-dns/how-to/manage-dns-records/#geo-ip-records) */ geoIp?: pulumi.Input; /** * The DNS service checks the provided URL on the configured IPs and resolves the request to one of the IPs by excluding the ones not responding to the given string to check. [Documentation and usage example](https://www.scaleway.com/en/docs/network/domains-and-dns/how-to/manage-dns-records/#healthcheck-records) */ httpService?: pulumi.Input; /** * When destroying a resource, if only NS records remain and this is set to `false`, the zone will be deleted. Please note, each zone not deleted will [cost you money](https://www.scaleway.com/en/dns/) */ keepEmptyZone?: pulumi.Input; /** * The name of the record (can be an empty string for a root record). */ name?: pulumi.Input; /** * The priority of the record (mostly used with an `MX` record) */ priority?: pulumi.Input; /** * The project_id you want to attach the resource to */ projectId?: pulumi.Input; /** * Time To Live of the record in seconds. */ ttl?: pulumi.Input; /** * The type of the record (`A`, `AAAA`, `MX`, `CNAME`, `DNAME`, `ALIAS`, `NS`, `PTR`, `SRV`, `TXT`, `TLSA`, or `CAA`). */ type: pulumi.Input; /** * The answer to a DNS request is based on the client’s (resolver) subnet. *(Can be more than 1)* [Documentation and usage example](https://www.scaleway.com/en/docs/network/domains-and-dns/how-to/manage-dns-records/#views-records) */ views?: pulumi.Input[]>; /** * You provide a list of IPs with their corresponding weights. These weights are used to proportionally direct requests to each IP. Depending on the weight of a record more or fewer requests are answered with its related IP compared to the others in the list. *(Can be more than 1)* [Documentation and usage example](https://www.scaleway.com/en/docs/network/domains-and-dns/how-to/manage-dns-records/#weight-records) */ weighteds?: pulumi.Input[]>; }