@pulumi/sumologic
Version:
A Pulumi package for creating and managing sumologic cloud resources.
173 lines (172 loc) • 7.66 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "./types/input";
import * as outputs from "./types/output";
/**
* Provides a [Sumologic Lookup Table](https://help.sumologic.com/05Search/Lookup_Tables).
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as sumologic from "@pulumi/sumologic";
*
* const lookupTable = new sumologic.LookupTable("lookupTable", {
* name: "Sample Lookup Table",
* fields: [
* {
* fieldName: "FieldName1",
* fieldType: "boolean",
* },
* {
* fieldName: "FieldName2",
* fieldType: "string",
* },
* ],
* ttl: 100,
* primaryKeys: ["FieldName1"],
* parentFolderId: "<personal folder id>",
* sizeLimitAction: "DeleteOldData",
* description: "some description",
* });
* ```
*
* ## Attributes reference
*
* The following attributes are exported:
*
* - `id` - Unique identifier for the partition.
*
* ## Import
*
* Lookup Tables can be imported using the id, e.g.:
*
* hcl
*
* ```sh
* $ pulumi import sumologic:index/lookupTable:LookupTable test 1234567890
* ```
*
* [1]: https://help.sumologic.com/05Search/Lookup_Tables
*/
export declare class LookupTable extends pulumi.CustomResource {
/**
* Get an existing LookupTable 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?: LookupTableState, opts?: pulumi.CustomResourceOptions): LookupTable;
/**
* Returns true if the given object is an instance of LookupTable. 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 LookupTable;
/**
* The description of the lookup table.
*/
readonly description: pulumi.Output<string>;
/**
* The list of fields in the lookup table.
* - `fieldName` - (Required) The name of the field.
* - `fieldType` - (Required) The data type of the field. Supported types: boolean, int, long, double, string
* - `primaryKeys` - (Required) The names of the fields that make up the primary key for the lookup table. These will be a subset of the fields that the table will contain.
*/
readonly fields: pulumi.Output<outputs.LookupTableField[] | undefined>;
/**
* The name of the lookup table.
*/
readonly name: pulumi.Output<string>;
/**
* The parent-folder-path identifier of the lookup table in the Library.
*/
readonly parentFolderId: pulumi.Output<string | undefined>;
/**
* The primary key field names.
*/
readonly primaryKeys: pulumi.Output<string[] | undefined>;
readonly sizeLimitAction: pulumi.Output<string | undefined>;
/**
* A time to live for each entry in the lookup table (in minutes). 365 days is the maximum time to live for each entry that you can specify. Setting it to 0 means that the records will not expire automatically.
* - `sizeLimitAction` - (Optional) The action that needs to be taken when the size limit is reached for the table. The possible values can be StopIncomingMessages or DeleteOldData. DeleteOldData will start deleting old data once size limit is reached whereas StopIncomingMessages will discard all the updates made to the lookup table once size limit is reached.
*/
readonly ttl: pulumi.Output<number | undefined>;
/**
* Create a LookupTable 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: LookupTableArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering LookupTable resources.
*/
export interface LookupTableState {
/**
* The description of the lookup table.
*/
description?: pulumi.Input<string>;
/**
* The list of fields in the lookup table.
* - `fieldName` - (Required) The name of the field.
* - `fieldType` - (Required) The data type of the field. Supported types: boolean, int, long, double, string
* - `primaryKeys` - (Required) The names of the fields that make up the primary key for the lookup table. These will be a subset of the fields that the table will contain.
*/
fields?: pulumi.Input<pulumi.Input<inputs.LookupTableField>[]>;
/**
* The name of the lookup table.
*/
name?: pulumi.Input<string>;
/**
* The parent-folder-path identifier of the lookup table in the Library.
*/
parentFolderId?: pulumi.Input<string>;
/**
* The primary key field names.
*/
primaryKeys?: pulumi.Input<pulumi.Input<string>[]>;
sizeLimitAction?: pulumi.Input<string>;
/**
* A time to live for each entry in the lookup table (in minutes). 365 days is the maximum time to live for each entry that you can specify. Setting it to 0 means that the records will not expire automatically.
* - `sizeLimitAction` - (Optional) The action that needs to be taken when the size limit is reached for the table. The possible values can be StopIncomingMessages or DeleteOldData. DeleteOldData will start deleting old data once size limit is reached whereas StopIncomingMessages will discard all the updates made to the lookup table once size limit is reached.
*/
ttl?: pulumi.Input<number>;
}
/**
* The set of arguments for constructing a LookupTable resource.
*/
export interface LookupTableArgs {
/**
* The description of the lookup table.
*/
description: pulumi.Input<string>;
/**
* The list of fields in the lookup table.
* - `fieldName` - (Required) The name of the field.
* - `fieldType` - (Required) The data type of the field. Supported types: boolean, int, long, double, string
* - `primaryKeys` - (Required) The names of the fields that make up the primary key for the lookup table. These will be a subset of the fields that the table will contain.
*/
fields?: pulumi.Input<pulumi.Input<inputs.LookupTableField>[]>;
/**
* The name of the lookup table.
*/
name?: pulumi.Input<string>;
/**
* The parent-folder-path identifier of the lookup table in the Library.
*/
parentFolderId?: pulumi.Input<string>;
/**
* The primary key field names.
*/
primaryKeys?: pulumi.Input<pulumi.Input<string>[]>;
sizeLimitAction?: pulumi.Input<string>;
/**
* A time to live for each entry in the lookup table (in minutes). 365 days is the maximum time to live for each entry that you can specify. Setting it to 0 means that the records will not expire automatically.
* - `sizeLimitAction` - (Optional) The action that needs to be taken when the size limit is reached for the table. The possible values can be StopIncomingMessages or DeleteOldData. DeleteOldData will start deleting old data once size limit is reached whereas StopIncomingMessages will discard all the updates made to the lookup table once size limit is reached.
*/
ttl?: pulumi.Input<number>;
}