@pulumi/dnsimple
Version:
A Pulumi package for creating and managing dnsimple cloud resources.
195 lines • 6.75 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Provides a DNSimple zone record resource.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as dnsimple from "@pulumi/dnsimple";
*
* // Add a record to the root domain
* const apex = new dnsimple.ZoneRecord("apex", {
* zoneName: "example.com",
* name: "",
* value: "192.0.2.1",
* type: "A",
* ttl: 3600,
* });
* // Add a record to a subdomain
* const www = new dnsimple.ZoneRecord("www", {
* zoneName: "example.com",
* name: "www",
* value: "192.0.2.1",
* type: "A",
* ttl: 3600,
* });
* // Add an MX record
* const mx = new dnsimple.ZoneRecord("mx", {
* zoneName: "example.com",
* name: "",
* value: "mail.example.com",
* type: "MX",
* priority: 10,
* ttl: 3600,
* });
* ```
*
* ## Import
*
* DNSimple zone records can be imported using the zone name and numeric record ID in the format `zoneNameRecordId`.
*
* **Importing record for example.com with record ID 1234:**
*
* ```sh
* $ pulumi import dnsimple:index/zoneRecord:ZoneRecord example example.com_1234
* ```
*
* The record ID can be found in the URL when editing a record on the DNSimple web dashboard, or via the [DNSimple Zone Records API](https://developer.dnsimple.com/v2/zones/records/#listZoneRecords).
*/
export declare class ZoneRecord extends pulumi.CustomResource {
/**
* Get an existing ZoneRecord 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?: ZoneRecordState, opts?: pulumi.CustomResourceOptions): ZoneRecord;
/**
* Returns true if the given object is an instance of ZoneRecord. 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 ZoneRecord;
/**
* The name of the record. Use `""` for the root domain.
*/
readonly name: pulumi.Output<string>;
readonly nameNormalized: pulumi.Output<string>;
/**
* The priority of the record. Only used for certain record types (e.g., `MX`, `SRV`).
*/
readonly priority: pulumi.Output<number>;
/**
* The fully qualified domain name (FQDN) of the record.
*/
readonly qualifiedName: pulumi.Output<string>;
/**
* A list of regions to serve the record from. You can find a list of supported values in our [developer documentation](https://developer.dnsimple.com/v2/zones/records/).
*/
readonly regions: pulumi.Output<string[] | undefined>;
/**
* The TTL of the record. Defaults to `3600`.
*/
readonly ttl: pulumi.Output<number>;
/**
* The type of the record (e.g., `A`, `AAAA`, `CNAME`, `MX`, `TXT`). **The record type must be specified in UPPERCASE.**
*/
readonly type: pulumi.Output<string>;
/**
* The value of the record.
*/
readonly value: pulumi.Output<string>;
/**
* The normalized value of the record.
*/
readonly valueNormalized: pulumi.Output<string>;
/**
* The zone ID of the record.
*/
readonly zoneId: pulumi.Output<string>;
/**
* The zone name to add the record to.
*/
readonly zoneName: pulumi.Output<string>;
/**
* Create a ZoneRecord 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: ZoneRecordArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering ZoneRecord resources.
*/
export interface ZoneRecordState {
/**
* The name of the record. Use `""` for the root domain.
*/
name?: pulumi.Input<string | undefined>;
nameNormalized?: pulumi.Input<string | undefined>;
/**
* The priority of the record. Only used for certain record types (e.g., `MX`, `SRV`).
*/
priority?: pulumi.Input<number | undefined>;
/**
* The fully qualified domain name (FQDN) of the record.
*/
qualifiedName?: pulumi.Input<string | undefined>;
/**
* A list of regions to serve the record from. You can find a list of supported values in our [developer documentation](https://developer.dnsimple.com/v2/zones/records/).
*/
regions?: pulumi.Input<pulumi.Input<string>[] | undefined>;
/**
* The TTL of the record. Defaults to `3600`.
*/
ttl?: pulumi.Input<number | undefined>;
/**
* The type of the record (e.g., `A`, `AAAA`, `CNAME`, `MX`, `TXT`). **The record type must be specified in UPPERCASE.**
*/
type?: pulumi.Input<string | undefined>;
/**
* The value of the record.
*/
value?: pulumi.Input<string | undefined>;
/**
* The normalized value of the record.
*/
valueNormalized?: pulumi.Input<string | undefined>;
/**
* The zone ID of the record.
*/
zoneId?: pulumi.Input<string | undefined>;
/**
* The zone name to add the record to.
*/
zoneName?: pulumi.Input<string | undefined>;
}
/**
* The set of arguments for constructing a ZoneRecord resource.
*/
export interface ZoneRecordArgs {
/**
* The name of the record. Use `""` for the root domain.
*/
name: pulumi.Input<string>;
/**
* The priority of the record. Only used for certain record types (e.g., `MX`, `SRV`).
*/
priority?: pulumi.Input<number | undefined>;
/**
* A list of regions to serve the record from. You can find a list of supported values in our [developer documentation](https://developer.dnsimple.com/v2/zones/records/).
*/
regions?: pulumi.Input<pulumi.Input<string>[] | undefined>;
/**
* The TTL of the record. Defaults to `3600`.
*/
ttl?: pulumi.Input<number | undefined>;
/**
* The type of the record (e.g., `A`, `AAAA`, `CNAME`, `MX`, `TXT`). **The record type must be specified in UPPERCASE.**
*/
type: pulumi.Input<string>;
/**
* The value of the record.
*/
value: pulumi.Input<string>;
/**
* The zone name to add the record to.
*/
zoneName: pulumi.Input<string>;
}
//# sourceMappingURL=zoneRecord.d.ts.map