Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Vultr
  3. API Docs
  4. ObjectStorage
Vultr v2.21.1 published on Monday, Jul 22, 2024 by dirien
dirien/pulumi-vultr

vultr.ObjectStorage

Explore with Pulumi AI

vultr logo
Vultr v2.21.1 published on Monday, Jul 22, 2024 by dirien
dirien/pulumi-vultr

    Provides a Vultr private object storage resource. This can be used to create, read, update and delete object storage resources on your Vultr account.

    Example Usage

    Create a new object storage subscription.

    import * as pulumi from "@pulumi/pulumi";
import * as vultr from "@ediri/vultr";

const tf = new vultr.ObjectStorage("tf", {
    clusterId: 2,
    label: "vultr-object-storage",
});

    import pulumi
import ediri_vultr as vultr

tf = vultr.ObjectStorage("tf",
    cluster_id=2,
    label="vultr-object-storage")

    package main

import (
	"github.com/dirien/pulumi-vultr/sdk/v2/go/vultr"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := vultr.NewObjectStorage(ctx, "tf", &vultr.ObjectStorageArgs{
			ClusterId: pulumi.Int(2),
			Label:     pulumi.String("vultr-object-storage"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Vultr = ediri.Vultr;

return await Deployment.RunAsync(() => 
{
    var tf = new Vultr.ObjectStorage("tf", new()
    {
        ClusterId = 2,
        Label = "vultr-object-storage",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.vultr.ObjectStorage;
import com.pulumi.vultr.ObjectStorageArgs;
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 tf = new ObjectStorage("tf", ObjectStorageArgs.builder()
            .clusterId(2)
            .label("vultr-object-storage")
            .build());

    }
}

    resources:
  tf:
    type: vultr:ObjectStorage
    properties:
      clusterId: 2
      label: vultr-object-storage

    Create ObjectStorage Resource

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

    Constructor syntax

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

@overload
def ObjectStorage(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  cluster_id: Optional[int] = None,
                  label: Optional[str] = None)
    func NewObjectStorage(ctx *Context, name string, args ObjectStorageArgs, opts ...ResourceOption) (*ObjectStorage, error)
    public ObjectStorage(string name, ObjectStorageArgs args, CustomResourceOptions? opts = null)
    public ObjectStorage(String name, ObjectStorageArgs args)
public ObjectStorage(String name, ObjectStorageArgs args, CustomResourceOptions options)

    type: vultr:ObjectStorage
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 ObjectStorageArgs
    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 ObjectStorageArgs
    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 ObjectStorageArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ObjectStorageArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ObjectStorageArgs
    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 objectStorageResource = new Vultr.ObjectStorage("objectStorageResource", new()
{
    ClusterId = 0,
    Label = "string",
});

    example, err := vultr.NewObjectStorage(ctx, "objectStorageResource", &vultr.ObjectStorageArgs{
	ClusterId: pulumi.Int(0),
	Label:     pulumi.String("string"),
})

    var objectStorageResource = new ObjectStorage("objectStorageResource", ObjectStorageArgs.builder()
    .clusterId(0)
    .label("string")
    .build());

    object_storage_resource = vultr.ObjectStorage("objectStorageResource",
    cluster_id=0,
    label="string")

    const objectStorageResource = new vultr.ObjectStorage("objectStorageResource", {
    clusterId: 0,
    label: "string",
});

    type: vultr:ObjectStorage
properties:
    clusterId: 0
    label: string

    ObjectStorage 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 ObjectStorage resource accepts the following input properties:

    ClusterId int
    The region ID that you want the network to be created in.
    Label string
    The description you want to give your network.
    ClusterId int
    The region ID that you want the network to be created in.
    Label string
    The description you want to give your network.
    clusterId Integer
    The region ID that you want the network to be created in.
    label String
    The description you want to give your network.
    clusterId number
    The region ID that you want the network to be created in.
    label string
    The description you want to give your network.
    cluster_id int
    The region ID that you want the network to be created in.
    label str
    The description you want to give your network.
    clusterId Number
    The region ID that you want the network to be created in.
    label String
    The description you want to give your network.

    Outputs

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

    DateCreated string
    Date of creation for the object storage subscription.
    Id string
    The provider-assigned unique ID for this managed resource.
    Location string
    The location which this subscription resides in.
    Region string
    The region ID of the object storage subscription.
    S3AccessKey string
    Your access key.
    S3Hostname string
    The hostname for this subscription.
    S3SecretKey string
    Your secret key.
    Status string
    Current status of this object storage subscription.
    DateCreated string
    Date of creation for the object storage subscription.
    Id string
    The provider-assigned unique ID for this managed resource.
    Location string
    The location which this subscription resides in.
    Region string
    The region ID of the object storage subscription.
    S3AccessKey string
    Your access key.
    S3Hostname string
    The hostname for this subscription.
    S3SecretKey string
    Your secret key.
    Status string
    Current status of this object storage subscription.
    dateCreated String
    Date of creation for the object storage subscription.
    id String
    The provider-assigned unique ID for this managed resource.
    location String
    The location which this subscription resides in.
    region String
    The region ID of the object storage subscription.
    s3AccessKey String
    Your access key.
    s3Hostname String
    The hostname for this subscription.
    s3SecretKey String
    Your secret key.
    status String
    Current status of this object storage subscription.
    dateCreated string
    Date of creation for the object storage subscription.
    id string
    The provider-assigned unique ID for this managed resource.
    location string
    The location which this subscription resides in.
    region string
    The region ID of the object storage subscription.
    s3AccessKey string
    Your access key.
    s3Hostname string
    The hostname for this subscription.
    s3SecretKey string
    Your secret key.
    status string
    Current status of this object storage subscription.
    date_created str
    Date of creation for the object storage subscription.
    id str
    The provider-assigned unique ID for this managed resource.
    location str
    The location which this subscription resides in.
    region str
    The region ID of the object storage subscription.
    s3_access_key str
    Your access key.
    s3_hostname str
    The hostname for this subscription.
    s3_secret_key str
    Your secret key.
    status str
    Current status of this object storage subscription.
    dateCreated String
    Date of creation for the object storage subscription.
    id String
    The provider-assigned unique ID for this managed resource.
    location String
    The location which this subscription resides in.
    region String
    The region ID of the object storage subscription.
    s3AccessKey String
    Your access key.
    s3Hostname String
    The hostname for this subscription.
    s3SecretKey String
    Your secret key.
    status String
    Current status of this object storage subscription.

    Look up Existing ObjectStorage Resource

    Get an existing ObjectStorage 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?: ObjectStorageState, opts?: CustomResourceOptions): ObjectStorage
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        cluster_id: Optional[int] = None,
        date_created: Optional[str] = None,
        label: Optional[str] = None,
        location: Optional[str] = None,
        region: Optional[str] = None,
        s3_access_key: Optional[str] = None,
        s3_hostname: Optional[str] = None,
        s3_secret_key: Optional[str] = None,
        status: Optional[str] = None) -> ObjectStorage
    func GetObjectStorage(ctx *Context, name string, id IDInput, state *ObjectStorageState, opts ...ResourceOption) (*ObjectStorage, error)
    public static ObjectStorage Get(string name, Input<string> id, ObjectStorageState? state, CustomResourceOptions? opts = null)
    public static ObjectStorage get(String name, Output<String> id, ObjectStorageState 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:
    ClusterId int
    The region ID that you want the network to be created in.
    DateCreated string
    Date of creation for the object storage subscription.
    Label string
    The description you want to give your network.
    Location string
    The location which this subscription resides in.
    Region string
    The region ID of the object storage subscription.
    S3AccessKey string
    Your access key.
    S3Hostname string
    The hostname for this subscription.
    S3SecretKey string
    Your secret key.
    Status string
    Current status of this object storage subscription.
    ClusterId int
    The region ID that you want the network to be created in.
    DateCreated string
    Date of creation for the object storage subscription.
    Label string
    The description you want to give your network.
    Location string
    The location which this subscription resides in.
    Region string
    The region ID of the object storage subscription.
    S3AccessKey string
    Your access key.
    S3Hostname string
    The hostname for this subscription.
    S3SecretKey string
    Your secret key.
    Status string
    Current status of this object storage subscription.
    clusterId Integer
    The region ID that you want the network to be created in.
    dateCreated String
    Date of creation for the object storage subscription.
    label String
    The description you want to give your network.
    location String
    The location which this subscription resides in.
    region String
    The region ID of the object storage subscription.
    s3AccessKey String
    Your access key.
    s3Hostname String
    The hostname for this subscription.
    s3SecretKey String
    Your secret key.
    status String
    Current status of this object storage subscription.
    clusterId number
    The region ID that you want the network to be created in.
    dateCreated string
    Date of creation for the object storage subscription.
    label string
    The description you want to give your network.
    location string
    The location which this subscription resides in.
    region string
    The region ID of the object storage subscription.
    s3AccessKey string
    Your access key.
    s3Hostname string
    The hostname for this subscription.
    s3SecretKey string
    Your secret key.
    status string
    Current status of this object storage subscription.
    cluster_id int
    The region ID that you want the network to be created in.
    date_created str
    Date of creation for the object storage subscription.
    label str
    The description you want to give your network.
    location str
    The location which this subscription resides in.
    region str
    The region ID of the object storage subscription.
    s3_access_key str
    Your access key.
    s3_hostname str
    The hostname for this subscription.
    s3_secret_key str
    Your secret key.
    status str
    Current status of this object storage subscription.
    clusterId Number
    The region ID that you want the network to be created in.
    dateCreated String
    Date of creation for the object storage subscription.
    label String
    The description you want to give your network.
    location String
    The location which this subscription resides in.
    region String
    The region ID of the object storage subscription.
    s3AccessKey String
    Your access key.
    s3Hostname String
    The hostname for this subscription.
    s3SecretKey String
    Your secret key.
    status String
    Current status of this object storage subscription.

    Import

    Object Storage can be imported using the object storage ID, e.g.

    $ pulumi import vultr:index/objectStorage:ObjectStorage my_s3 0e04f918-575e-41cb-86f6-d729b354a5a1

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    vultr dirien/pulumi-vultr
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the vultr Terraform Provider.
    vultr logo
    Vultr v2.21.1 published on Monday, Jul 22, 2024 by dirien
    dirien/pulumi-vultr