UNPKG

@pulumi/dnsimple

Version:

A Pulumi package for creating and managing dnsimple cloud resources.

207 lines (206 loc) 5.97 kB
import * as pulumi from "@pulumi/pulumi"; /** * Provides a DNSimple domain delegation signer record resource. * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as dnsimple from "@pulumi/dnsimple"; * * const foobar = new dnsimple.DsRecord("foobar", { * domain: dnsimple.domain, * algorithm: "8", * digest: "6CEEA0117A02480216EBF745A7B690F938860074E4AD11AF2AC573007205682B", * digestType: "2", * keyTag: "12345", * }); * ``` * * ## Import * * DNSimple DS record resources can be imported using their domain ID and numeric record ID. * * bash * * ```sh * $ pulumi import dnsimple:index/dsRecord:DsRecord resource_name example.com_5678 * ``` * * The record ID can be found within [DNSimple DNSSEC API](https://developer.dnsimple.com/v2/domains/dnssec/#listDomainDelegationSignerRecords). Check out [Authentication](https://developer.dnsimple.com/v2/#authentication) in API Overview for available options. * * bash * * curl -u 'EMAIL:PASSWORD' https://api.dnsimple.com/v2/1010/domains/example.com/ds_records | jq * * { * * "data": [ * * { * * "id": 24, * * "domain_id": 1010, * * "algorithm": "8", * * "digest": "C1F6E04A5A61FBF65BF9DC8294C363CF11C89E802D926BDAB79C55D27BEFA94F", * * "digest_type": "2", * * "keytag": "44620", * * "public_key": null, * * "created_at": "2017-03-03T13:49:58Z", * * "updated_at": "2017-03-03T13:49:58Z" * * } * * ], * * "pagination": { * * "current_page": 1, * * "per_page": 30, * * "total_entries": 1, * * "total_pages": 1 * * } * * } */ export declare class DsRecord extends pulumi.CustomResource { /** * Get an existing DsRecord 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?: DsRecordState, opts?: pulumi.CustomResourceOptions): DsRecord; /** * Returns true if the given object is an instance of DsRecord. 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 DsRecord; /** * DNSSEC algorithm number as a string. */ readonly algorithm: pulumi.Output<string>; /** * The time the DS record was created at. */ readonly createdAt: pulumi.Output<string>; /** * The hexidecimal representation of the digest of the corresponding DNSKEY record. */ readonly digest: pulumi.Output<string | undefined>; /** * DNSSEC digest type number as a string. */ readonly digestType: pulumi.Output<string | undefined>; /** * The domain name or numeric ID to create the delegation signer record for. */ readonly domain: pulumi.Output<string>; /** * A keytag that references the corresponding DNSKEY record. */ readonly keytag: pulumi.Output<string | undefined>; /** * A public key that references the corresponding DNSKEY record. * * # Attributes Reference */ readonly publicKey: pulumi.Output<string | undefined>; /** * The time the DS record was last updated at. */ readonly updatedAt: pulumi.Output<string>; /** * Create a DsRecord 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: DsRecordArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering DsRecord resources. */ export interface DsRecordState { /** * DNSSEC algorithm number as a string. */ algorithm?: pulumi.Input<string>; /** * The time the DS record was created at. */ createdAt?: pulumi.Input<string>; /** * The hexidecimal representation of the digest of the corresponding DNSKEY record. */ digest?: pulumi.Input<string>; /** * DNSSEC digest type number as a string. */ digestType?: pulumi.Input<string>; /** * The domain name or numeric ID to create the delegation signer record for. */ domain?: pulumi.Input<string>; /** * A keytag that references the corresponding DNSKEY record. */ keytag?: pulumi.Input<string>; /** * A public key that references the corresponding DNSKEY record. * * # Attributes Reference */ publicKey?: pulumi.Input<string>; /** * The time the DS record was last updated at. */ updatedAt?: pulumi.Input<string>; } /** * The set of arguments for constructing a DsRecord resource. */ export interface DsRecordArgs { /** * DNSSEC algorithm number as a string. */ algorithm: pulumi.Input<string>; /** * The hexidecimal representation of the digest of the corresponding DNSKEY record. */ digest?: pulumi.Input<string>; /** * DNSSEC digest type number as a string. */ digestType?: pulumi.Input<string>; /** * The domain name or numeric ID to create the delegation signer record for. */ domain: pulumi.Input<string>; /** * A keytag that references the corresponding DNSKEY record. */ keytag?: pulumi.Input<string>; /** * A public key that references the corresponding DNSKEY record. * * # Attributes Reference */ publicKey?: pulumi.Input<string>; }