@pulumi/dnsimple
Version:
A Pulumi package for creating and managing dnsimple cloud resources.
282 lines • 9.36 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Provides a DNSimple contact resource.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as dnsimple from "@pulumi/dnsimple";
*
* const example = new dnsimple.Contact("example", {
* label: "Main Contact",
* firstName: "John",
* lastName: "Doe",
* organizationName: "Example Inc",
* jobTitle: "Manager",
* address1: "123 Main Street",
* address2: "Suite 100",
* city: "San Francisco",
* stateProvince: "California",
* postalCode: "94105",
* country: "US",
* phone: "+1.4155551234",
* fax: "+1.4155555678",
* email: "john@example.com",
* });
* ```
*
* ## Import
*
* DNSimple contacts can be imported using their numeric ID.
*
* ```sh
* $ pulumi import dnsimple:index/contact:Contact example 5678
* ```
*
* The contact ID can be found within the [DNSimple Contacts API](https://developer.dnsimple.com/v2/contacts/#listContacts). Check out [Authentication](https://developer.dnsimple.com/v2/#authentication) in API Overview for available options.
*/
export declare class Contact extends pulumi.CustomResource {
/**
* Get an existing Contact 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?: ContactState, opts?: pulumi.CustomResourceOptions): Contact;
/**
* Returns true if the given object is an instance of Contact. 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 Contact;
/**
* The account ID for the contact.
*/
readonly accountId: pulumi.Output<number>;
/**
* The primary address line (street address, building number, etc.).
*/
readonly address1: pulumi.Output<string>;
/**
* The secondary address line (apartment, suite, floor, etc.).
*/
readonly address2: pulumi.Output<string>;
/**
* The city where the contact is located.
*/
readonly city: pulumi.Output<string>;
/**
* The two-letter ISO country code (e.g., "US", "CA", "IT") for the contact's location.
*/
readonly country: pulumi.Output<string>;
/**
* Timestamp representing when this contact was created.
*/
readonly createdAt: pulumi.Output<string>;
/**
* The contact's email address.
*/
readonly email: pulumi.Output<string>;
/**
* The contact's fax number. Use international format with country code (e.g., "+1.8491234567" for US numbers).
*/
readonly fax: pulumi.Output<string>;
/**
* The fax number, normalized.
*/
readonly faxNormalized: pulumi.Output<string>;
/**
* The first name of the contact person.
*/
readonly firstName: pulumi.Output<string>;
/**
* The job title or position of the contact person within the organization.
*/
readonly jobTitle: pulumi.Output<string>;
/**
* A descriptive label for the contact to help identify it.
*/
readonly label: pulumi.Output<string>;
/**
* The last name of the contact person.
*/
readonly lastName: pulumi.Output<string>;
/**
* The name of the organization or company associated with the contact.
*/
readonly organizationName: pulumi.Output<string>;
/**
* The contact's phone number. Use international format with country code (e.g., "+1.4012345678" for US numbers).
*/
readonly phone: pulumi.Output<string>;
/**
* The phone number, normalized.
*/
readonly phoneNormalized: pulumi.Output<string>;
/**
* The postal code, ZIP code, or equivalent for the contact's location.
*/
readonly postalCode: pulumi.Output<string>;
/**
* The state, province, or region where the contact is located.
*/
readonly stateProvince: pulumi.Output<string>;
/**
* Timestamp representing when this contact was updated.
*/
readonly updatedAt: pulumi.Output<string>;
/**
* Create a Contact 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: ContactArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Contact resources.
*/
export interface ContactState {
/**
* The account ID for the contact.
*/
accountId?: pulumi.Input<number | undefined>;
/**
* The primary address line (street address, building number, etc.).
*/
address1?: pulumi.Input<string | undefined>;
/**
* The secondary address line (apartment, suite, floor, etc.).
*/
address2?: pulumi.Input<string | undefined>;
/**
* The city where the contact is located.
*/
city?: pulumi.Input<string | undefined>;
/**
* The two-letter ISO country code (e.g., "US", "CA", "IT") for the contact's location.
*/
country?: pulumi.Input<string | undefined>;
/**
* Timestamp representing when this contact was created.
*/
createdAt?: pulumi.Input<string | undefined>;
/**
* The contact's email address.
*/
email?: pulumi.Input<string | undefined>;
/**
* The contact's fax number. Use international format with country code (e.g., "+1.8491234567" for US numbers).
*/
fax?: pulumi.Input<string | undefined>;
/**
* The fax number, normalized.
*/
faxNormalized?: pulumi.Input<string | undefined>;
/**
* The first name of the contact person.
*/
firstName?: pulumi.Input<string | undefined>;
/**
* The job title or position of the contact person within the organization.
*/
jobTitle?: pulumi.Input<string | undefined>;
/**
* A descriptive label for the contact to help identify it.
*/
label?: pulumi.Input<string | undefined>;
/**
* The last name of the contact person.
*/
lastName?: pulumi.Input<string | undefined>;
/**
* The name of the organization or company associated with the contact.
*/
organizationName?: pulumi.Input<string | undefined>;
/**
* The contact's phone number. Use international format with country code (e.g., "+1.4012345678" for US numbers).
*/
phone?: pulumi.Input<string | undefined>;
/**
* The phone number, normalized.
*/
phoneNormalized?: pulumi.Input<string | undefined>;
/**
* The postal code, ZIP code, or equivalent for the contact's location.
*/
postalCode?: pulumi.Input<string | undefined>;
/**
* The state, province, or region where the contact is located.
*/
stateProvince?: pulumi.Input<string | undefined>;
/**
* Timestamp representing when this contact was updated.
*/
updatedAt?: pulumi.Input<string | undefined>;
}
/**
* The set of arguments for constructing a Contact resource.
*/
export interface ContactArgs {
/**
* The primary address line (street address, building number, etc.).
*/
address1: pulumi.Input<string>;
/**
* The secondary address line (apartment, suite, floor, etc.).
*/
address2?: pulumi.Input<string | undefined>;
/**
* The city where the contact is located.
*/
city: pulumi.Input<string>;
/**
* The two-letter ISO country code (e.g., "US", "CA", "IT") for the contact's location.
*/
country: pulumi.Input<string>;
/**
* The contact's email address.
*/
email: pulumi.Input<string>;
/**
* The contact's fax number. Use international format with country code (e.g., "+1.8491234567" for US numbers).
*/
fax?: pulumi.Input<string | undefined>;
/**
* The first name of the contact person.
*/
firstName: pulumi.Input<string>;
/**
* The job title or position of the contact person within the organization.
*/
jobTitle?: pulumi.Input<string | undefined>;
/**
* A descriptive label for the contact to help identify it.
*/
label?: pulumi.Input<string | undefined>;
/**
* The last name of the contact person.
*/
lastName: pulumi.Input<string>;
/**
* The name of the organization or company associated with the contact.
*/
organizationName?: pulumi.Input<string | undefined>;
/**
* The contact's phone number. Use international format with country code (e.g., "+1.4012345678" for US numbers).
*/
phone: pulumi.Input<string>;
/**
* The postal code, ZIP code, or equivalent for the contact's location.
*/
postalCode: pulumi.Input<string>;
/**
* The state, province, or region where the contact is located.
*/
stateProvince: pulumi.Input<string>;
}
//# sourceMappingURL=contact.d.ts.map