@pulumi/signalfx/orgToken.d.ts

A Pulumi package for creating and managing SignalFx resources.

import * as pulumi from "@pulumi/pulumi";
import * as inputs from "./types/input";
import * as outputs from "./types/output";
/**
 * Manage Splunk Observability Cloud org tokens.
 *
 * > **NOTE** When managing Org tokens, use a session token of an administrator to authenticate the Splunk Observability Cloud provider. See [Operations that require a session token for an administrator](https://dev.splunk.com/observability/docs/administration/authtokens#Operations-that-require-a-session-token-for-an-administrator).
 *
 * ## Example
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as signalfx from "@pulumi/signalfx";
 *
 * const myteamkey0 = new signalfx.OrgToken("myteamkey0", {
 *     name: "TeamIDKey",
 *     description: "My team's rad key",
 *     notifications: ["Email,foo-alerts@bar.com"],
 *     hostOrUsageLimits: {
 *         hostLimit: 100,
 *         hostNotificationThreshold: 90,
 *         containerLimit: 200,
 *         containerNotificationThreshold: 180,
 *         customMetricsLimit: 1000,
 *         customMetricsNotificationThreshold: 900,
 *         highResMetricsLimit: 1000,
 *         highResMetricsNotificationThreshold: 900,
 *     },
 * });
 * ```
 */
export declare class OrgToken extends pulumi.CustomResource {
    /**
     * Get an existing OrgToken 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?: OrgTokenState, opts?: pulumi.CustomResourceOptions): OrgToken;
    /**
     * Returns true if the given object is an instance of OrgToken.  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 OrgToken;
    /**
     * Authentication scope, ex: INGEST, API, RUM ... (Optional)
     */
    readonly authScopes: pulumi.Output<string[]>;
    /**
     * Description of the token.
     */
    readonly description: pulumi.Output<string | undefined>;
    /**
     * Flag that controls enabling the token. If set to `true`, the token is disabled, and you can't use it for authentication. Defaults to `false`.
     */
    readonly disabled: pulumi.Output<boolean | undefined>;
    /**
     * Specify DPM-based limits for this token.
     */
    readonly dpmLimits: pulumi.Output<outputs.OrgTokenDpmLimits | undefined>;
    /**
     * Specify Usage-based limits for this token.
     */
    readonly hostOrUsageLimits: pulumi.Output<outputs.OrgTokenHostOrUsageLimits | undefined>;
    /**
     * Name of the token.
     */
    readonly name: pulumi.Output<string>;
    /**
     * Where to send notifications about this token's limits. See the Notification Format laid out in detectors.
     */
    readonly notifications: pulumi.Output<string[] | undefined>;
    /**
     * The secret token created by the API. You cannot set this value.
     */
    readonly secret: pulumi.Output<string>;
    /**
     * Create a OrgToken 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?: OrgTokenArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering OrgToken resources.
 */
export interface OrgTokenState {
    /**
     * Authentication scope, ex: INGEST, API, RUM ... (Optional)
     */
    authScopes?: pulumi.Input<pulumi.Input<string>[]>;
    /**
     * Description of the token.
     */
    description?: pulumi.Input<string>;
    /**
     * Flag that controls enabling the token. If set to `true`, the token is disabled, and you can't use it for authentication. Defaults to `false`.
     */
    disabled?: pulumi.Input<boolean>;
    /**
     * Specify DPM-based limits for this token.
     */
    dpmLimits?: pulumi.Input<inputs.OrgTokenDpmLimits>;
    /**
     * Specify Usage-based limits for this token.
     */
    hostOrUsageLimits?: pulumi.Input<inputs.OrgTokenHostOrUsageLimits>;
    /**
     * Name of the token.
     */
    name?: pulumi.Input<string>;
    /**
     * Where to send notifications about this token's limits. See the Notification Format laid out in detectors.
     */
    notifications?: pulumi.Input<pulumi.Input<string>[]>;
    /**
     * The secret token created by the API. You cannot set this value.
     */
    secret?: pulumi.Input<string>;
}
/**
 * The set of arguments for constructing a OrgToken resource.
 */
export interface OrgTokenArgs {
    /**
     * Authentication scope, ex: INGEST, API, RUM ... (Optional)
     */
    authScopes?: pulumi.Input<pulumi.Input<string>[]>;
    /**
     * Description of the token.
     */
    description?: pulumi.Input<string>;
    /**
     * Flag that controls enabling the token. If set to `true`, the token is disabled, and you can't use it for authentication. Defaults to `false`.
     */
    disabled?: pulumi.Input<boolean>;
    /**
     * Specify DPM-based limits for this token.
     */
    dpmLimits?: pulumi.Input<inputs.OrgTokenDpmLimits>;
    /**
     * Specify Usage-based limits for this token.
     */
    hostOrUsageLimits?: pulumi.Input<inputs.OrgTokenHostOrUsageLimits>;
    /**
     * Name of the token.
     */
    name?: pulumi.Input<string>;
    /**
     * Where to send notifications about this token's limits. See the Notification Format laid out in detectors.
     */
    notifications?: pulumi.Input<pulumi.Input<string>[]>;
}