1. Packages
  2. InfluxDB
  3. API Docs
  4. getBucket
InfluxDB v1.6.0 published on Wednesday, Oct 29, 2025 by thulasirajkomminar

influxdb.getBucket

Get Started
influxdb logo
InfluxDB v1.6.0 published on Wednesday, Oct 29, 2025 by thulasirajkomminar

    Using getBucket

    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 getBucket(args: GetBucketArgs, opts?: InvokeOptions): Promise<GetBucketResult>
    function getBucketOutput(args: GetBucketOutputArgs, opts?: InvokeOptions): Output<GetBucketResult>
    def get_bucket(name: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetBucketResult
    def get_bucket_output(name: Optional[pulumi.Input[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetBucketResult]
    func LookupBucket(ctx *Context, args *LookupBucketArgs, opts ...InvokeOption) (*LookupBucketResult, error)
    func LookupBucketOutput(ctx *Context, args *LookupBucketOutputArgs, opts ...InvokeOption) LookupBucketResultOutput

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

    public static class GetBucket 
    {
        public static Task<GetBucketResult> InvokeAsync(GetBucketArgs args, InvokeOptions? opts = null)
        public static Output<GetBucketResult> Invoke(GetBucketInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetBucketResult> getBucket(GetBucketArgs args, InvokeOptions options)
    public static Output<GetBucketResult> getBucket(GetBucketArgs args, InvokeOptions options)
    
    fn::invoke:
      function: influxdb:index/getBucket:getBucket
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Name string
    Name string
    name String
    name string
    name str
    name String

    getBucket Result

    The following output properties are available:

    CreatedAt string
    Description string
    Id string
    Name string
    OrgId string
    RetentionPeriod int
    Type string
    UpdatedAt string
    CreatedAt string
    Description string
    Id string
    Name string
    OrgId string
    RetentionPeriod int
    Type string
    UpdatedAt string
    createdAt String
    description String
    id String
    name String
    orgId String
    retentionPeriod Integer
    type String
    updatedAt String
    createdAt string
    description string
    id string
    name string
    orgId string
    retentionPeriod number
    type string
    updatedAt string
    createdAt String
    description String
    id String
    name String
    orgId String
    retentionPeriod Number
    type String
    updatedAt String

    Package Details

    Repository
    influxdb thulasirajkomminar/pulumi-influxdb
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the influxdb Terraform Provider.
    influxdb logo
    InfluxDB v1.6.0 published on Wednesday, Oct 29, 2025 by thulasirajkomminar
      Meet Neo: Your AI Platform Teammate