@pulumi/ns1
Version:
A Pulumi package for creating and managing ns1 cloud resources.
93 lines (92 loc) • 3.08 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Provides a NS1 Global IP Whitelist resource.
*
* This can be used to create, modify, and delete Global IP Whitelists.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as ns1 from "@pulumi/ns1";
*
* const example = new ns1.AccountWhitelist("example", {
* name: "Example Whitelist",
* values: [
* "1.1.1.1",
* "2.2.2.2",
* ],
* });
* ```
*
* > You current source IP must be present in one of the whitelists to prevent locking yourself out.
*
* ## NS1 Documentation
*
* [Global IP Whitelist Doc](https://ns1.com/api?docId=2282)
*
* ## Import
*
* ```sh
* $ pulumi import ns1:index/accountWhitelist:AccountWhitelist example <ID>`
* ```
*/
export declare class AccountWhitelist extends pulumi.CustomResource {
/**
* Get an existing AccountWhitelist 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?: AccountWhitelistState, opts?: pulumi.CustomResourceOptions): AccountWhitelist;
/**
* Returns true if the given object is an instance of AccountWhitelist. 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 AccountWhitelist;
/**
* The free form name of the whitelist.
*/
readonly name: pulumi.Output<string>;
/**
* Array of IP addresses/networks from which to allow access.
*/
readonly values: pulumi.Output<string[]>;
/**
* Create a AccountWhitelist 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: AccountWhitelistArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering AccountWhitelist resources.
*/
export interface AccountWhitelistState {
/**
* The free form name of the whitelist.
*/
name?: pulumi.Input<string>;
/**
* Array of IP addresses/networks from which to allow access.
*/
values?: pulumi.Input<pulumi.Input<string>[]>;
}
/**
* The set of arguments for constructing a AccountWhitelist resource.
*/
export interface AccountWhitelistArgs {
/**
* The free form name of the whitelist.
*/
name?: pulumi.Input<string>;
/**
* Array of IP addresses/networks from which to allow access.
*/
values: pulumi.Input<pulumi.Input<string>[]>;
}