@pulumi/ns1/provider.d.ts

A Pulumi package for creating and managing ns1 cloud resources.

import * as pulumi from "@pulumi/pulumi";
/**
 * The provider type for the ns1 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 ns1 API key (required)
     */
    readonly apikey: pulumi.Output<string | undefined>;
    /**
     * URL prefix (including version) for API calls
     */
    readonly endpoint: pulumi.Output<string | undefined>;
    /**
     * User-Agent string to use in NS1 API requests
     */
    readonly userAgent: 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<Provider.TerraformConfigResult>;
}
/**
 * The set of arguments for constructing a Provider resource.
 */
export interface ProviderArgs {
    /**
     * The ns1 API key (required)
     */
    apikey?: pulumi.Input<string>;
    /**
     * URL prefix (including version) for API calls
     */
    endpoint?: pulumi.Input<string>;
    /**
     * Don't validate server SSL/TLS certificate
     */
    ignoreSsl?: pulumi.Input<boolean>;
    /**
     * Tune response to rate limits, see docs
     */
    rateLimitParallelism?: pulumi.Input<number>;
    /**
     * Maximum retries for 50x errors (-1 to disable)
     */
    retryMax?: pulumi.Input<number>;
    /**
     * User-Agent string to use in NS1 API requests
     */
    userAgent?: pulumi.Input<string>;
}
export declare namespace Provider {
    /**
     * The results of the Provider.terraformConfig method.
     */
    interface TerraformConfigResult {
        readonly result: {
            [key: string]: any;
        };
    }
}