Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Ibm Provider
  3. API Docs
  4. ObjectStorageAccount
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

ibm.ObjectStorageAccount

Explore with Pulumi AI

ibm logo
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

    Retrieve the account name for an existing Object Storage instance within your IBM account. If no Object Storage instance exists, you can use this resource to order an Object Storage instance and to store the account name. For more information, about IBM Cloud Object Storage account, see exporting an image to IBM Cloud Object Storage.

    Do not use this resource for managing the lifecycle of an Object Storage instance in IBM. For lifecycle management, see Swift API or Swift resources.

    Example Usage

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

const foo = new ibm.ObjectStorageAccount("foo", {});

    import pulumi
import pulumi_ibm as ibm

foo = ibm.ObjectStorageAccount("foo")

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/ibm/ibm"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ibm.NewObjectStorageAccount(ctx, "foo", nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ibm = Pulumi.Ibm;

return await Deployment.RunAsync(() => 
{
    var foo = new Ibm.ObjectStorageAccount("foo");

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.ObjectStorageAccount;
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) {
        var foo = new ObjectStorageAccount("foo");

    }
}

    resources:
  foo:
    type: ibm:ObjectStorageAccount

    Argument reference

    Review the argument references that you can specify for your resource.

    • tags - (Optional, Array of String) Tags associated with the Object Storage Account instance.
      Note Tags are managed locally and not stored on the IBM Cloud service endpoint at this moment.

    Create ObjectStorageAccount Resource

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

    Constructor syntax

    new ObjectStorageAccount(name: string, args?: ObjectStorageAccountArgs, opts?: CustomResourceOptions);
    @overload
def ObjectStorageAccount(resource_name: str,
                         args: Optional[ObjectStorageAccountArgs] = None,
                         opts: Optional[ResourceOptions] = None)

@overload
def ObjectStorageAccount(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         local_note: Optional[str] = None,
                         object_storage_account_id: Optional[str] = None,
                         tags: Optional[Sequence[str]] = None)
    func NewObjectStorageAccount(ctx *Context, name string, args *ObjectStorageAccountArgs, opts ...ResourceOption) (*ObjectStorageAccount, error)
    public ObjectStorageAccount(string name, ObjectStorageAccountArgs? args = null, CustomResourceOptions? opts = null)
    public ObjectStorageAccount(String name, ObjectStorageAccountArgs args)
public ObjectStorageAccount(String name, ObjectStorageAccountArgs args, CustomResourceOptions options)

    type: ibm:ObjectStorageAccount
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 ObjectStorageAccountArgs
    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 ObjectStorageAccountArgs
    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 ObjectStorageAccountArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ObjectStorageAccountArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ObjectStorageAccountArgs
    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 objectStorageAccountResource = new Ibm.ObjectStorageAccount("objectStorageAccountResource", new()
{
    LocalNote = "string",
    ObjectStorageAccountId = "string",
    Tags = new[]
    {
        "string",
    },
});

    example, err := ibm.NewObjectStorageAccount(ctx, "objectStorageAccountResource", &ibm.ObjectStorageAccountArgs{
	LocalNote:              pulumi.String("string"),
	ObjectStorageAccountId: pulumi.String("string"),
	Tags: pulumi.StringArray{
		pulumi.String("string"),
	},
})

    var objectStorageAccountResource = new ObjectStorageAccount("objectStorageAccountResource", ObjectStorageAccountArgs.builder()
    .localNote("string")
    .objectStorageAccountId("string")
    .tags("string")
    .build());

    object_storage_account_resource = ibm.ObjectStorageAccount("objectStorageAccountResource",
    local_note="string",
    object_storage_account_id="string",
    tags=["string"])

    const objectStorageAccountResource = new ibm.ObjectStorageAccount("objectStorageAccountResource", {
    localNote: "string",
    objectStorageAccountId: "string",
    tags: ["string"],
});

    type: ibm:ObjectStorageAccount
properties:
    localNote: string
    objectStorageAccountId: string
    tags:
        - string

    ObjectStorageAccount Resource Properties

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

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The ObjectStorageAccount resource accepts the following input properties:

    LocalNote string
    ObjectStorageAccountId string
    (String) The Object Storage account name, which you can use with Swift resources.
    Tags List<string>
    LocalNote string
    ObjectStorageAccountId string
    (String) The Object Storage account name, which you can use with Swift resources.
    Tags []string
    localNote String
    objectStorageAccountId String
    (String) The Object Storage account name, which you can use with Swift resources.
    tags List<String>
    localNote string
    objectStorageAccountId string
    (String) The Object Storage account name, which you can use with Swift resources.
    tags string[]
    local_note str
    object_storage_account_id str
    (String) The Object Storage account name, which you can use with Swift resources.
    tags Sequence[str]
    localNote String
    objectStorageAccountId String
    (String) The Object Storage account name, which you can use with Swift resources.
    tags List<String>

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    id String
    The provider-assigned unique ID for this managed resource.
    name String

    Look up Existing ObjectStorageAccount Resource

    Get an existing ObjectStorageAccount 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?: ObjectStorageAccountState, opts?: CustomResourceOptions): ObjectStorageAccount
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        local_note: Optional[str] = None,
        name: Optional[str] = None,
        object_storage_account_id: Optional[str] = None,
        tags: Optional[Sequence[str]] = None) -> ObjectStorageAccount
    func GetObjectStorageAccount(ctx *Context, name string, id IDInput, state *ObjectStorageAccountState, opts ...ResourceOption) (*ObjectStorageAccount, error)
    public static ObjectStorageAccount Get(string name, Input<string> id, ObjectStorageAccountState? state, CustomResourceOptions? opts = null)
    public static ObjectStorageAccount get(String name, Output<String> id, ObjectStorageAccountState state, CustomResourceOptions options)
    resources:  _:    type: ibm:ObjectStorageAccount    get:      id: ${id}
    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:
    LocalNote string
    Name string
    ObjectStorageAccountId string
    (String) The Object Storage account name, which you can use with Swift resources.
    Tags List<string>
    LocalNote string
    Name string
    ObjectStorageAccountId string
    (String) The Object Storage account name, which you can use with Swift resources.
    Tags []string
    localNote String
    name String
    objectStorageAccountId String
    (String) The Object Storage account name, which you can use with Swift resources.
    tags List<String>
    localNote string
    name string
    objectStorageAccountId string
    (String) The Object Storage account name, which you can use with Swift resources.
    tags string[]
    local_note str
    name str
    object_storage_account_id str
    (String) The Object Storage account name, which you can use with Swift resources.
    tags Sequence[str]
    localNote String
    name String
    objectStorageAccountId String
    (String) The Object Storage account name, which you can use with Swift resources.
    tags List<String>

    Package Details

    Repository
    ibm ibm-cloud/terraform-provider-ibm
    License
    Notes
    This Pulumi package is based on the ibm Terraform Provider.
    ibm logo
    ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
    ibm-cloud/terraform-provider-ibm