Docs Packages
  1. Packages
  2. InfluxDB
  3. API Docs
  4. getBuckets
InfluxDB v1.2.0 published on Tuesday, Apr 16, 2024 by komminarlabs
komminarlabs/pulumi-influxdb

influxdb.getBuckets

Explore with Pulumi AI

influxdb logo
InfluxDB v1.2.0 published on Tuesday, Apr 16, 2024 by komminarlabs
komminarlabs/pulumi-influxdb

    Lists buckets. InfluxDB retrieves buckets owned by the organization associated with the authorization (API token).

    Using getBuckets

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getBuckets(opts?: InvokeOptions): Promise<GetBucketsResult>
function getBucketsOutput(opts?: InvokeOptions): Output<GetBucketsResult>
    def get_buckets(opts: Optional[InvokeOptions] = None) -> GetBucketsResult
def get_buckets_output(opts: Optional[InvokeOptions] = None) -> Output[GetBucketsResult]
    func GetBuckets(ctx *Context, opts ...InvokeOption) (*GetBucketsResult, error)
func GetBucketsOutput(ctx *Context, opts ...InvokeOption) GetBucketsResultOutput

    > Note: This function is named GetBuckets in the Go SDK.

    public static class GetBuckets 
{
    public static Task<GetBucketsResult> InvokeAsync(InvokeOptions? opts = null)
    public static Output<GetBucketsResult> Invoke(InvokeOptions? opts = null)
}
    public static CompletableFuture<GetBucketsResult> getBuckets(InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: influxdb:index/getBuckets:getBuckets
  arguments:
    # arguments dictionary

    getBuckets Result

    The following output properties are available:

    Buckets List<KomminarLabs.InfluxDB.Outputs.GetBucketsBucket>
    Id string
    The provider-assigned unique ID for this managed resource.
    Buckets []GetBucketsBucket
    Id string
    The provider-assigned unique ID for this managed resource.
    buckets List<GetBucketsBucket>
    id String
    The provider-assigned unique ID for this managed resource.
    buckets GetBucketsBucket[]
    id string
    The provider-assigned unique ID for this managed resource.
    buckets Sequence[GetBucketsBucket]
    id str
    The provider-assigned unique ID for this managed resource.
    buckets List<Property Map>
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    GetBucketsBucket

    CreatedAt string
    Bucket creation date.
    Description string
    A description of the bucket.
    Id string
    A Bucket ID.
    Name string
    A Bucket name.
    OrgId string
    An organization ID.
    RetentionPeriod int
    The duration in seconds for how long data will be kept in the database. 0 represents infinite retention.
    Type string
    The Bucket type.
    UpdatedAt string
    Last bucket update date.
    CreatedAt string
    Bucket creation date.
    Description string
    A description of the bucket.
    Id string
    A Bucket ID.
    Name string
    A Bucket name.
    OrgId string
    An organization ID.
    RetentionPeriod int
    The duration in seconds for how long data will be kept in the database. 0 represents infinite retention.
    Type string
    The Bucket type.
    UpdatedAt string
    Last bucket update date.
    createdAt String
    Bucket creation date.
    description String
    A description of the bucket.
    id String
    A Bucket ID.
    name String
    A Bucket name.
    orgId String
    An organization ID.
    retentionPeriod Integer
    The duration in seconds for how long data will be kept in the database. 0 represents infinite retention.
    type String
    The Bucket type.
    updatedAt String
    Last bucket update date.
    createdAt string
    Bucket creation date.
    description string
    A description of the bucket.
    id string
    A Bucket ID.
    name string
    A Bucket name.
    orgId string
    An organization ID.
    retentionPeriod number
    The duration in seconds for how long data will be kept in the database. 0 represents infinite retention.
    type string
    The Bucket type.
    updatedAt string
    Last bucket update date.
    created_at str
    Bucket creation date.
    description str
    A description of the bucket.
    id str
    A Bucket ID.
    name str
    A Bucket name.
    org_id str
    An organization ID.
    retention_period int
    The duration in seconds for how long data will be kept in the database. 0 represents infinite retention.
    type str
    The Bucket type.
    updated_at str
    Last bucket update date.
    createdAt String
    Bucket creation date.
    description String
    A description of the bucket.
    id String
    A Bucket ID.
    name String
    A Bucket name.
    orgId String
    An organization ID.
    retentionPeriod Number
    The duration in seconds for how long data will be kept in the database. 0 represents infinite retention.
    type String
    The Bucket type.
    updatedAt String
    Last bucket update date.

    Package Details

    Repository
    influxdb komminarlabs/pulumi-influxdb
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the influxdb Terraform Provider.
    influxdb logo
    InfluxDB v1.2.0 published on Tuesday, Apr 16, 2024 by komminarlabs
    komminarlabs/pulumi-influxdb