1. Packages
  2. Linode Provider
  3. API Docs
  4. getLinodeObjectStorageBucket
Linode v4.36.0 published on Thursday, Mar 27, 2025 by Pulumi

linode.getLinodeObjectStorageBucket

Explore with Pulumi AI

Provides information about a Linode Object Storage Bucket For more information, see the Linode APIv4 docs.

Example Usage

The following example shows how one might use this data source to access information about a Linode Object Storage Bucket.

import * as pulumi from "@pulumi/pulumi";
import * as linode from "@pulumi/linode";

const my_bucket = linode.getLinodeObjectStorageBucket({
    label: "my-bucket",
    region: "us-mia",
});
Copy
import pulumi
import pulumi_linode as linode

my_bucket = linode.get_linode_object_storage_bucket(label="my-bucket",
    region="us-mia")
Copy
package main

import (
	"github.com/pulumi/pulumi-linode/sdk/v4/go/linode"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := linode.GetLinodeObjectStorageBucket(ctx, &linode.GetLinodeObjectStorageBucketArgs{
			Label:  "my-bucket",
			Region: pulumi.StringRef("us-mia"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Linode = Pulumi.Linode;

return await Deployment.RunAsync(() => 
{
    var my_bucket = Linode.GetLinodeObjectStorageBucket.Invoke(new()
    {
        Label = "my-bucket",
        Region = "us-mia",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.linode.LinodeFunctions;
import com.pulumi.linode.inputs.GetLinodeObjectStorageBucketArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var my-bucket = LinodeFunctions.getLinodeObjectStorageBucket(GetLinodeObjectStorageBucketArgs.builder()
            .label("my-bucket")
            .region("us-mia")
            .build());

    }
}
Copy
variables:
  my-bucket:
    fn::invoke:
      function: linode:getLinodeObjectStorageBucket
      arguments:
        label: my-bucket
        region: us-mia
Copy

Using getLinodeObjectStorageBucket

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 getLinodeObjectStorageBucket(args: GetLinodeObjectStorageBucketArgs, opts?: InvokeOptions): Promise<GetLinodeObjectStorageBucketResult>
function getLinodeObjectStorageBucketOutput(args: GetLinodeObjectStorageBucketOutputArgs, opts?: InvokeOptions): Output<GetLinodeObjectStorageBucketResult>
Copy
def get_linode_object_storage_bucket(cluster: Optional[str] = None,
                                     label: Optional[str] = None,
                                     region: Optional[str] = None,
                                     opts: Optional[InvokeOptions] = None) -> GetLinodeObjectStorageBucketResult
def get_linode_object_storage_bucket_output(cluster: Optional[pulumi.Input[str]] = None,
                                     label: Optional[pulumi.Input[str]] = None,
                                     region: Optional[pulumi.Input[str]] = None,
                                     opts: Optional[InvokeOptions] = None) -> Output[GetLinodeObjectStorageBucketResult]
Copy
func GetLinodeObjectStorageBucket(ctx *Context, args *GetLinodeObjectStorageBucketArgs, opts ...InvokeOption) (*GetLinodeObjectStorageBucketResult, error)
func GetLinodeObjectStorageBucketOutput(ctx *Context, args *GetLinodeObjectStorageBucketOutputArgs, opts ...InvokeOption) GetLinodeObjectStorageBucketResultOutput
Copy

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

public static class GetLinodeObjectStorageBucket 
{
    public static Task<GetLinodeObjectStorageBucketResult> InvokeAsync(GetLinodeObjectStorageBucketArgs args, InvokeOptions? opts = null)
    public static Output<GetLinodeObjectStorageBucketResult> Invoke(GetLinodeObjectStorageBucketInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetLinodeObjectStorageBucketResult> getLinodeObjectStorageBucket(GetLinodeObjectStorageBucketArgs args, InvokeOptions options)
public static Output<GetLinodeObjectStorageBucketResult> getLinodeObjectStorageBucket(GetLinodeObjectStorageBucketArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: linode:index/getLinodeObjectStorageBucket:getLinodeObjectStorageBucket
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Label This property is required. string
The name of this bucket.
Cluster string
The ID of the Object Storage Cluster this bucket is in. Required if region is not configured.

Deprecated: The cluster attribute has been deprecated, please consider switching to the region attribute. For example, a cluster value of us-mia-1 can be translated to a region value of us-mia.

Region string
The ID of the region this bucket is in. Required if cluster is not configured.
Label This property is required. string
The name of this bucket.
Cluster string
The ID of the Object Storage Cluster this bucket is in. Required if region is not configured.

Deprecated: The cluster attribute has been deprecated, please consider switching to the region attribute. For example, a cluster value of us-mia-1 can be translated to a region value of us-mia.

Region string
The ID of the region this bucket is in. Required if cluster is not configured.
label This property is required. String
The name of this bucket.
cluster String
The ID of the Object Storage Cluster this bucket is in. Required if region is not configured.

Deprecated: The cluster attribute has been deprecated, please consider switching to the region attribute. For example, a cluster value of us-mia-1 can be translated to a region value of us-mia.

region String
The ID of the region this bucket is in. Required if cluster is not configured.
label This property is required. string
The name of this bucket.
cluster string
The ID of the Object Storage Cluster this bucket is in. Required if region is not configured.

Deprecated: The cluster attribute has been deprecated, please consider switching to the region attribute. For example, a cluster value of us-mia-1 can be translated to a region value of us-mia.

region string
The ID of the region this bucket is in. Required if cluster is not configured.
label This property is required. str
The name of this bucket.
cluster str
The ID of the Object Storage Cluster this bucket is in. Required if region is not configured.

Deprecated: The cluster attribute has been deprecated, please consider switching to the region attribute. For example, a cluster value of us-mia-1 can be translated to a region value of us-mia.

region str
The ID of the region this bucket is in. Required if cluster is not configured.
label This property is required. String
The name of this bucket.
cluster String
The ID of the Object Storage Cluster this bucket is in. Required if region is not configured.

Deprecated: The cluster attribute has been deprecated, please consider switching to the region attribute. For example, a cluster value of us-mia-1 can be translated to a region value of us-mia.

region String
The ID of the region this bucket is in. Required if cluster is not configured.

getLinodeObjectStorageBucket Result

The following output properties are available:

Cluster string

Deprecated: The cluster attribute has been deprecated, please consider switching to the region attribute. For example, a cluster value of us-mia-1 can be translated to a region value of us-mia.

Created string
EndpointType string
Hostname string
Id string
Label string
Objects int
Region string
S3Endpoint string
Size int
Cluster string

Deprecated: The cluster attribute has been deprecated, please consider switching to the region attribute. For example, a cluster value of us-mia-1 can be translated to a region value of us-mia.

Created string
EndpointType string
Hostname string
Id string
Label string
Objects int
Region string
S3Endpoint string
Size int
cluster String

Deprecated: The cluster attribute has been deprecated, please consider switching to the region attribute. For example, a cluster value of us-mia-1 can be translated to a region value of us-mia.

created String
endpointType String
hostname String
id String
label String
objects Integer
region String
s3Endpoint String
size Integer
cluster string

Deprecated: The cluster attribute has been deprecated, please consider switching to the region attribute. For example, a cluster value of us-mia-1 can be translated to a region value of us-mia.

created string
endpointType string
hostname string
id string
label string
objects number
region string
s3Endpoint string
size number
cluster str

Deprecated: The cluster attribute has been deprecated, please consider switching to the region attribute. For example, a cluster value of us-mia-1 can be translated to a region value of us-mia.

created str
endpoint_type str
hostname str
id str
label str
objects int
region str
s3_endpoint str
size int
cluster String

Deprecated: The cluster attribute has been deprecated, please consider switching to the region attribute. For example, a cluster value of us-mia-1 can be translated to a region value of us-mia.

created String
endpointType String
hostname String
id String
label String
objects Number
region String
s3Endpoint String
size Number

Package Details

Repository
Linode pulumi/pulumi-linode
License
Apache-2.0
Notes
This Pulumi package is based on the linode Terraform Provider.