@pulumi/sumologic/getPartition.js

A Pulumi package for creating and managing sumologic cloud resources.

"use strict";
// *** WARNING: this file was generated by the Pulumi Terraform Bridge (tfgen) Tool. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
Object.defineProperty(exports, "__esModule", { value: true });
exports.getPartitionOutput = exports.getPartition = void 0;
const pulumi = require("@pulumi/pulumi");
const utilities = require("./utilities");
/**
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as sumologic from "@pulumi/sumologic";
 *
 * const _this = sumologic.getPartition({
 *     id: "1234567890",
 * });
 * ```
 *
 * A partition can be looked up by `id`.
 *
 * ## Attributes reference
 *
 * The following attributes are exported:
 *
 * - `name` - The name of the partition.
 * - `routingExpression` - The query that defines the data to be included in the partition.
 * - `analyticsTier` - The Data Tier where the data in the partition will reside. Possible values are: `continuous`, `frequent`, `infrequent`
 * - `retentionPeriod` - The number of days to retain data in the partition.
 * - `isCompliant` - Whether the partition is used for compliance or audit purposes.
 * - `isIncludedInDefaultSearch` - Whether the partition is included in the default search scope.
 * - `totalBytes` - The size of the data in the partition in bytes.
 * - `isActive` - Whether the partition is currently active or decommissioned.
 * - `indexType` - The type of partition index. Possible values are: `DefaultIndex`, `AuditIndex`or `Partition`
 * - `dataForwardingId` - The ID of the data forwarding configuration to be used by the partition.
 *
 * [1]: https://help.sumologic.com/docs/manage/partitions/data-tiers/
 */
function getPartition(args, opts) {
    opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {});
    return pulumi.runtime.invoke("sumologic:index/getPartition:getPartition", {
        "id": args.id,
    }, opts);
}
exports.getPartition = getPartition;
/**
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as sumologic from "@pulumi/sumologic";
 *
 * const _this = sumologic.getPartition({
 *     id: "1234567890",
 * });
 * ```
 *
 * A partition can be looked up by `id`.
 *
 * ## Attributes reference
 *
 * The following attributes are exported:
 *
 * - `name` - The name of the partition.
 * - `routingExpression` - The query that defines the data to be included in the partition.
 * - `analyticsTier` - The Data Tier where the data in the partition will reside. Possible values are: `continuous`, `frequent`, `infrequent`
 * - `retentionPeriod` - The number of days to retain data in the partition.
 * - `isCompliant` - Whether the partition is used for compliance or audit purposes.
 * - `isIncludedInDefaultSearch` - Whether the partition is included in the default search scope.
 * - `totalBytes` - The size of the data in the partition in bytes.
 * - `isActive` - Whether the partition is currently active or decommissioned.
 * - `indexType` - The type of partition index. Possible values are: `DefaultIndex`, `AuditIndex`or `Partition`
 * - `dataForwardingId` - The ID of the data forwarding configuration to be used by the partition.
 *
 * [1]: https://help.sumologic.com/docs/manage/partitions/data-tiers/
 */
function getPartitionOutput(args, opts) {
    opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {});
    return pulumi.runtime.invokeOutput("sumologic:index/getPartition:getPartition", {
        "id": args.id,
    }, opts);
}
exports.getPartitionOutput = getPartitionOutput;
//# sourceMappingURL=getPartition.js.map