@pulumi/sumologic
Version:
A Pulumi package for creating and managing sumologic cloud resources.
140 lines (139 loc) • 4.2 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Provides a [Sumologic Token](https://help.sumologic.com/Manage/Security/Installation_Tokens).
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as sumologic from "@pulumi/sumologic";
*
* const exampleToken = new sumologic.Token("example_token", {
* name: "testToken",
* description: "Testing resource sumologic_token",
* status: "Active",
* type: "CollectorRegistration",
* });
* ```
*
* ## Import
*
* Tokens can be imported using the name, e.g.:
*
* hcl
*
* ```sh
* $ pulumi import sumologic:index/token:Token test id
* ```
*
* [1]: https://help.sumologic.com/Manage/Security/Installation_Tokens
*/
export declare class Token extends pulumi.CustomResource {
/**
* Get an existing Token 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?: TokenState, opts?: pulumi.CustomResourceOptions): Token;
/**
* Returns true if the given object is an instance of Token. 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 Token;
/**
* The description of the token.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* The encoded token for collector registration.
*/
readonly encodedTokenAndUrl: pulumi.Output<string>;
/**
* Display name of the token. This must be unique across all of the tokens.
*/
readonly name: pulumi.Output<string>;
/**
* Status of the token. Valid values:
* - `Active`
* - `Inactive`
*
* The following attributes are exported:
*/
readonly status: pulumi.Output<string>;
/**
* Type of the token. Valid value:
* - `CollectorRegistration`.
*/
readonly type: pulumi.Output<string>;
readonly version: pulumi.Output<number>;
/**
* Create a Token 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: TokenArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Token resources.
*/
export interface TokenState {
/**
* The description of the token.
*/
description?: pulumi.Input<string>;
/**
* The encoded token for collector registration.
*/
encodedTokenAndUrl?: pulumi.Input<string>;
/**
* Display name of the token. This must be unique across all of the tokens.
*/
name?: pulumi.Input<string>;
/**
* Status of the token. Valid values:
* - `Active`
* - `Inactive`
*
* The following attributes are exported:
*/
status?: pulumi.Input<string>;
/**
* Type of the token. Valid value:
* - `CollectorRegistration`.
*/
type?: pulumi.Input<string>;
version?: pulumi.Input<number>;
}
/**
* The set of arguments for constructing a Token resource.
*/
export interface TokenArgs {
/**
* The description of the token.
*/
description?: pulumi.Input<string>;
/**
* Display name of the token. This must be unique across all of the tokens.
*/
name?: pulumi.Input<string>;
/**
* Status of the token. Valid values:
* - `Active`
* - `Inactive`
*
* The following attributes are exported:
*/
status: pulumi.Input<string>;
/**
* Type of the token. Valid value:
* - `CollectorRegistration`.
*/
type: pulumi.Input<string>;
version?: pulumi.Input<number>;
}