@pulumi/ns1
Version:
A Pulumi package for creating and managing ns1 cloud resources.
107 lines (106 loc) • 3.59 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Provides a NS1 Data Source resource. This can be used to create, modify, and delete data sources.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as ns1 from "@pulumi/ns1";
*
* const example = new ns1.DataSource("example", {
* name: "example",
* sourcetype: "nsone_v1",
* });
* ```
*
* ## NS1 Documentation
*
* [Datasource Api Doc](https://ns1.com/api#data-sources)
*
* ## Import
*
* ```sh
* $ pulumi import ns1:index/dataSource:DataSource <name> <datasource_id>`
* ```
*/
export declare class DataSource extends pulumi.CustomResource {
/**
* Get an existing DataSource 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?: DataSourceState, opts?: pulumi.CustomResourceOptions): DataSource;
/**
* Returns true if the given object is an instance of DataSource. 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 DataSource;
/**
* The data source configuration, determined by its type,
* matching the specification in `config` from /data/sourcetypes.
*/
readonly config: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* The free form name of the data source.
*/
readonly name: pulumi.Output<string>;
/**
* The data sources type, listed in API endpoint https://api.nsone.net/v1/data/sourcetypes.
*/
readonly sourcetype: pulumi.Output<string>;
/**
* Create a DataSource 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: DataSourceArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering DataSource resources.
*/
export interface DataSourceState {
/**
* The data source configuration, determined by its type,
* matching the specification in `config` from /data/sourcetypes.
*/
config?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* The free form name of the data source.
*/
name?: pulumi.Input<string>;
/**
* The data sources type, listed in API endpoint https://api.nsone.net/v1/data/sourcetypes.
*/
sourcetype?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a DataSource resource.
*/
export interface DataSourceArgs {
/**
* The data source configuration, determined by its type,
* matching the specification in `config` from /data/sourcetypes.
*/
config?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* The free form name of the data source.
*/
name?: pulumi.Input<string>;
/**
* The data sources type, listed in API endpoint https://api.nsone.net/v1/data/sourcetypes.
*/
sourcetype: pulumi.Input<string>;
}