@pulumi/sumologic
Version:
A Pulumi package for creating and managing sumologic cloud resources.
73 lines (72 loc) • 3.31 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as outputs from "./types/output";
/**
* Provides a way to retrieve all [Sumologic Partitions](https://help.sumologic.com/docs/manage/partitions/data-tiers/).
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as sumologic from "@pulumi/sumologic";
*
* const partitions = sumologic.getPartitions({});
* ```
*
* ## 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/
*/
export declare function getPartitions(opts?: pulumi.InvokeOptions): Promise<GetPartitionsResult>;
/**
* A collection of values returned by getPartitions.
*/
export interface GetPartitionsResult {
/**
* The provider-assigned unique ID for this managed resource.
*/
readonly id: string;
readonly partitions: outputs.GetPartitionsPartition[];
}
/**
* Provides a way to retrieve all [Sumologic Partitions](https://help.sumologic.com/docs/manage/partitions/data-tiers/).
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as sumologic from "@pulumi/sumologic";
*
* const partitions = sumologic.getPartitions({});
* ```
*
* ## 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/
*/
export declare function getPartitionsOutput(opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetPartitionsResult>;