@komminarlabs/influxdb/bucket.d.ts

A Pulumi package for creating and managing InfluxDB resources.

import * as pulumi from "@pulumi/pulumi";
/**
 * Creates and manages a bucket.
 */
export declare class Bucket extends pulumi.CustomResource {
    /**
     * Get an existing Bucket 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?: BucketState, opts?: pulumi.CustomResourceOptions): Bucket;
    /**
     * Returns true if the given object is an instance of Bucket.  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 Bucket;
    /**
     * Bucket creation date.
     */
    readonly createdAt: pulumi.Output<string>;
    /**
     * A description of the bucket.
     */
    readonly description: pulumi.Output<string>;
    /**
     * A Bucket name.
     */
    readonly name: pulumi.Output<string>;
    /**
     * An organization ID.
     */
    readonly orgId: pulumi.Output<string>;
    /**
     * The duration in seconds for how long data will be kept in the database. The default duration is `2592000` (30 days). `0` represents infinite retention.
     */
    readonly retentionPeriod: pulumi.Output<number>;
    /**
     * The Bucket type. Valid values are `user` or `system`.
     */
    readonly type: pulumi.Output<string>;
    /**
     * Last bucket update date.
     */
    readonly updatedAt: pulumi.Output<string>;
    /**
     * Create a Bucket 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: BucketArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering Bucket resources.
 */
export interface BucketState {
    /**
     * Bucket creation date.
     */
    createdAt?: pulumi.Input<string>;
    /**
     * A description of the bucket.
     */
    description?: pulumi.Input<string>;
    /**
     * A Bucket name.
     */
    name?: pulumi.Input<string>;
    /**
     * An organization ID.
     */
    orgId?: pulumi.Input<string>;
    /**
     * The duration in seconds for how long data will be kept in the database. The default duration is `2592000` (30 days). `0` represents infinite retention.
     */
    retentionPeriod?: pulumi.Input<number>;
    /**
     * The Bucket type. Valid values are `user` or `system`.
     */
    type?: pulumi.Input<string>;
    /**
     * Last bucket update date.
     */
    updatedAt?: pulumi.Input<string>;
}
/**
 * The set of arguments for constructing a Bucket resource.
 */
export interface BucketArgs {
    /**
     * A description of the bucket.
     */
    description?: pulumi.Input<string>;
    /**
     * A Bucket name.
     */
    name?: pulumi.Input<string>;
    /**
     * An organization ID.
     */
    orgId: pulumi.Input<string>;
    /**
     * The duration in seconds for how long data will be kept in the database. The default duration is `2592000` (30 days). `0` represents infinite retention.
     */
    retentionPeriod?: pulumi.Input<number>;
    /**
     * The Bucket type. Valid values are `user` or `system`.
     */
    type?: pulumi.Input<string>;
}