InfluxDB v1.2.0, Apr 16 24

InfluxDB v1.2.0 published on Tuesday, Apr 16, 2024 by komminarlabs

influxdb.Bucket

Explore with Pulumi AI

InfluxDB v1.2.0 published on Tuesday, Apr 16, 2024 by komminarlabs

Create Bucket Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Bucket(name: string, args: BucketArgs, opts?: CustomResourceOptions);

@overload
def Bucket(resource_name: str,
           args: BucketArgs,
           opts: Optional[ResourceOptions] = None)

@overload
def Bucket(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           org_id: Optional[str] = None,
           description: Optional[str] = None,
           name: Optional[str] = None,
           retention_period: Optional[int] = None,
           type: Optional[str] = None)

func NewBucket(ctx *Context, name string, args BucketArgs, opts ...ResourceOption) (*Bucket, error)

public Bucket(string name, BucketArgs args, CustomResourceOptions? opts = null)

public Bucket(String name, BucketArgs args)
public Bucket(String name, BucketArgs args, CustomResourceOptions options)

type: influxdb:Bucket
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name string: The unique name of the resource.
args BucketArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args BucketArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args BucketArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args BucketArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args BucketArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var bucketResource = new InfluxDB.Bucket("bucketResource", new()
{
    OrgId = "string",
    Description = "string",
    Name = "string",
    RetentionPeriod = 0,
    Type = "string",
});

example, err := influxdb.NewBucket(ctx, "bucketResource", &influxdb.BucketArgs{
	OrgId:           pulumi.String("string"),
	Description:     pulumi.String("string"),
	Name:            pulumi.String("string"),
	RetentionPeriod: pulumi.Int(0),
	Type:            pulumi.String("string"),
})

var bucketResource = new Bucket("bucketResource", BucketArgs.builder()
    .orgId("string")
    .description("string")
    .name("string")
    .retentionPeriod(0)
    .type("string")
    .build());

bucket_resource = influxdb.Bucket("bucketResource",
    org_id="string",
    description="string",
    name="string",
    retention_period=0,
    type="string")

const bucketResource = new influxdb.Bucket("bucketResource", {
    orgId: "string",
    description: "string",
    name: "string",
    retentionPeriod: 0,
    type: "string",
});

type: influxdb:Bucket
properties:
    description: string
    name: string
    orgId: string
    retentionPeriod: 0
    type: string

Bucket Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The Bucket resource accepts the following input properties:

OrgId string: An organization ID.
Description string: A description of the bucket.
Name string: A Bucket name.
RetentionPeriod int: 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.
Type string: The Bucket type. Valid values are user or system.

OrgId string: An organization ID.
Description string: A description of the bucket.
Name string: A Bucket name.
RetentionPeriod int: 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.
Type string: The Bucket type. Valid values are user or system.

orgId String: An organization ID.
description String: A description of the bucket.
name String: A Bucket name.
retentionPeriod Integer: 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.
type String: The Bucket type. Valid values are user or system.

orgId string: An organization ID.
description string: A description of the bucket.
name string: A Bucket name.
retentionPeriod number: 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.
type string: The Bucket type. Valid values are user or system.

org_id str: An organization ID.
description str: A description of the bucket.
name str: A Bucket name.
retention_period int: 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.
type str: The Bucket type. Valid values are user or system.

orgId String: An organization ID.
description String: A description of the bucket.
name String: A Bucket name.
retentionPeriod Number: 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.
type String: The Bucket type. Valid values are user or system.

Outputs

All input properties are implicitly available as output properties. Additionally, the Bucket resource produces the following output properties:

CreatedAt string: Bucket creation date.
Id string: The provider-assigned unique ID for this managed resource.
UpdatedAt string: Last bucket update date.

CreatedAt string: Bucket creation date.
Id string: The provider-assigned unique ID for this managed resource.
UpdatedAt string: Last bucket update date.

createdAt String: Bucket creation date.
id String: The provider-assigned unique ID for this managed resource.
updatedAt String: Last bucket update date.

createdAt string: Bucket creation date.
id string: The provider-assigned unique ID for this managed resource.
updatedAt string: Last bucket update date.

created_at str: Bucket creation date.
id str: The provider-assigned unique ID for this managed resource.
updated_at str: Last bucket update date.

createdAt String: Bucket creation date.
id String: The provider-assigned unique ID for this managed resource.
updatedAt String: Last bucket update date.

Look up Existing Bucket Resource

Get an existing Bucket resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: BucketState, opts?: CustomResourceOptions): Bucket

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        created_at: Optional[str] = None,
        description: Optional[str] = None,
        name: Optional[str] = None,
        org_id: Optional[str] = None,
        retention_period: Optional[int] = None,
        type: Optional[str] = None,
        updated_at: Optional[str] = None) -> Bucket

func GetBucket(ctx *Context, name string, id IDInput, state *BucketState, opts ...ResourceOption) (*Bucket, error)

public static Bucket Get(string name, Input<string> id, BucketState? state, CustomResourceOptions? opts = null)

public static Bucket get(String name, Output<String> id, BucketState state, CustomResourceOptions options)

Resource lookup is not supported in YAML

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

CreatedAt string: Bucket creation date.
Description string: A description of the bucket.
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. The default duration is 2592000 (30 days). 0 represents infinite retention.
Type string: The Bucket type. Valid values are user or system.
UpdatedAt string: Last bucket update date.

CreatedAt string: Bucket creation date.
Description string: A description of the bucket.
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. The default duration is 2592000 (30 days). 0 represents infinite retention.
Type string: The Bucket type. Valid values are user or system.
UpdatedAt string: Last bucket update date.

createdAt String: Bucket creation date.
description String: A description of the bucket.
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. The default duration is 2592000 (30 days). 0 represents infinite retention.
type String: The Bucket type. Valid values are user or system.
updatedAt String: Last bucket update date.

createdAt string: Bucket creation date.
description string: A description of the bucket.
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. The default duration is 2592000 (30 days). 0 represents infinite retention.
type string: The Bucket type. Valid values are user or system.
updatedAt string: Last bucket update date.

created_at str: Bucket creation date.
description str: A description of the bucket.
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. The default duration is 2592000 (30 days). 0 represents infinite retention.
type str: The Bucket type. Valid values are user or system.
updated_at str: Last bucket update date.

createdAt String: Bucket creation date.
description String: A description of the bucket.
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. The default duration is 2592000 (30 days). 0 represents infinite retention.
type String: The Bucket type. Valid values are user or system.
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.2.0 published on Tuesday, Apr 16, 2024 by komminarlabs

komminarlabs/pulumi-influxdb

influxdb.Bucket

On this page

On this page

Create Bucket Resource

Constructor syntax

Parameters

Constructor example

Bucket Resource Properties

Inputs

Outputs

Look up Existing Bucket Resource

Package Details

On this page

On this page