InfluxDB v1.3.0 published on Monday, Mar 10, 2025 by komminarlabs
influxdb.getBuckets
Explore with Pulumi AI
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)
public static Output<GetBucketsResult> getBuckets(InvokeOptions options)
fn::invoke:
function: influxdb:index/getBuckets:getBuckets
arguments:
# arguments dictionary
getBuckets Result
The following output properties are available:
- Buckets
List<Komminar
Labs. Influx DB. Outputs. Get Buckets Bucket> - Id string
- The provider-assigned unique ID for this managed resource.
- Buckets
[]Get
Buckets Bucket - Id string
- The provider-assigned unique ID for this managed resource.
- buckets
List<Get
Buckets Bucket> - id String
- The provider-assigned unique ID for this managed resource.
- buckets
Get
Buckets Bucket[] - id string
- The provider-assigned unique ID for this managed resource.
- buckets
Sequence[Get
Buckets Bucket] - 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
- Created
At This property is required. string - Bucket creation date.
- Description
This property is required. string - A description of the bucket.
- Id
This property is required. string - A Bucket ID.
- Name
This property is required. string - A Bucket name.
- Org
Id This property is required. string - An organization ID.
- Retention
Period This property is required. int - The duration in seconds for how long data will be kept in the database.
0
represents infinite retention. - Type
This property is required. string - The Bucket type.
- Updated
At This property is required. string - Last bucket update date.
- Created
At This property is required. string - Bucket creation date.
- Description
This property is required. string - A description of the bucket.
- Id
This property is required. string - A Bucket ID.
- Name
This property is required. string - A Bucket name.
- Org
Id This property is required. string - An organization ID.
- Retention
Period This property is required. int - The duration in seconds for how long data will be kept in the database.
0
represents infinite retention. - Type
This property is required. string - The Bucket type.
- Updated
At This property is required. string - Last bucket update date.
- created
At This property is required. String - Bucket creation date.
- description
This property is required. String - A description of the bucket.
- id
This property is required. String - A Bucket ID.
- name
This property is required. String - A Bucket name.
- org
Id This property is required. String - An organization ID.
- retention
Period This property is required. Integer - The duration in seconds for how long data will be kept in the database.
0
represents infinite retention. - type
This property is required. String - The Bucket type.
- updated
At This property is required. String - Last bucket update date.
- created
At This property is required. string - Bucket creation date.
- description
This property is required. string - A description of the bucket.
- id
This property is required. string - A Bucket ID.
- name
This property is required. string - A Bucket name.
- org
Id This property is required. string - An organization ID.
- retention
Period This property is required. number - The duration in seconds for how long data will be kept in the database.
0
represents infinite retention. - type
This property is required. string - The Bucket type.
- updated
At This property is required. string - Last bucket update date.
- created_
at This property is required. str - Bucket creation date.
- description
This property is required. str - A description of the bucket.
- id
This property is required. str - A Bucket ID.
- name
This property is required. str - A Bucket name.
- org_
id This property is required. str - An organization ID.
- retention_
period This property is required. int - The duration in seconds for how long data will be kept in the database.
0
represents infinite retention. - type
This property is required. str - The Bucket type.
- updated_
at This property is required. str - Last bucket update date.
- created
At This property is required. String - Bucket creation date.
- description
This property is required. String - A description of the bucket.
- id
This property is required. String - A Bucket ID.
- name
This property is required. String - A Bucket name.
- org
Id This property is required. String - An organization ID.
- retention
Period This property is required. Number - The duration in seconds for how long data will be kept in the database.
0
represents infinite retention. - type
This property is required. String - The Bucket type.
- updated
At This property is required. 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.