influxdb.getBucket

Explore with Pulumi AI

InfluxDB v1.3.0 published on Monday, Mar 10, 2025 by komminarlabs

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.

TypeScript
Python
Go
C#
Java
YAML

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: A Bucket name.

Name string: A Bucket name.

name String: A Bucket name.

name string: A Bucket name.

name str: A Bucket name.

name String: A Bucket name.

getBucket Result

The following output properties are available:

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 v1.3.0 published on Monday, Mar 10, 2025 by komminarlabs

komminarlabs/pulumi-influxdb

influxdb.getBucket

On this page

On this page

Using getBucket

getBucket Result

Package Details

On this page

On this page