pulumi-namecheap
Version:
A Pulumi provider for managing Namecheap domain records and DNS configuration, dynamically bridged from the Terraform Namecheap provider with support for A, AAAA, CNAME, MX, TXT records and email services.
80 lines • 2.69 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* The provider type for the namecheap package. By default, resources use package-wide configuration
* settings, however an explicit `Provider` instance may be created and passed during resource
* construction to achieve fine-grained programmatic control over provider settings. See the
* [documentation](https://www.pulumi.com/docs/reference/programming-model/#providers) for more information.
*/
export declare class Provider extends pulumi.ProviderResource {
/**
* Returns true if the given object is an instance of Provider. 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 Provider;
/**
* The namecheap API key
*/
readonly apiKey: pulumi.Output<string | undefined>;
/**
* A registered api user for namecheap
*/
readonly apiUser: pulumi.Output<string | undefined>;
/**
* Client IP address
*/
readonly clientIp: pulumi.Output<string | undefined>;
/**
* A registered user name for namecheap
*/
readonly userName: pulumi.Output<string | undefined>;
/**
* Create a Provider 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?: ProviderArgs, opts?: pulumi.ResourceOptions);
/**
* This function returns a Terraform config object with terraform-namecased keys,to be used with the Terraform Module Provider.
*/
terraformConfig(): pulumi.Output<{
[key: string]: any;
}>;
}
/**
* The set of arguments for constructing a Provider resource.
*/
export interface ProviderArgs {
/**
* The namecheap API key
*/
apiKey?: pulumi.Input<string | undefined>;
/**
* A registered api user for namecheap
*/
apiUser?: pulumi.Input<string | undefined>;
/**
* Client IP address
*/
clientIp?: pulumi.Input<string | undefined>;
/**
* Use sandbox API endpoints
*/
useSandbox?: pulumi.Input<boolean | undefined>;
/**
* A registered user name for namecheap
*/
userName?: pulumi.Input<string | undefined>;
}
export declare namespace Provider {
/**
* The results of the Provider.terraformConfig method.
*/
interface TerraformConfigResult {
readonly result: {
[key: string]: any;
};
}
}
//# sourceMappingURL=provider.d.ts.map