1. Packages
  2. Civo
  3. API Docs
  4. getObjectStore
Civo v2.3.19 published on Tuesday, Jul 16, 2024 by Pulumi

civo.getObjectStore

Explore with Pulumi AI

civo logo
Civo v2.3.19 published on Tuesday, Jul 16, 2024 by Pulumi

    Get information of an Object Store for use in other resources. This data source provides all of the Object Store’s properties as configured on your Civo account.

    Note: This data source returns a single Object Store. When specifying a name, an error will be raised if more than one Object Stores with the same name found.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as civo from "@pulumi/civo";
    
    const backup = civo.getObjectStore({
        name: "backup-server",
    });
    
    import pulumi
    import pulumi_civo as civo
    
    backup = civo.get_object_store(name="backup-server")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-civo/sdk/v2/go/civo"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := civo.LookupObjectStore(ctx, &civo.LookupObjectStoreArgs{
    			Name: pulumi.StringRef("backup-server"),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Civo = Pulumi.Civo;
    
    return await Deployment.RunAsync(() => 
    {
        var backup = Civo.GetObjectStore.Invoke(new()
        {
            Name = "backup-server",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.civo.CivoFunctions;
    import com.pulumi.civo.inputs.GetObjectStoreArgs;
    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 backup = CivoFunctions.getObjectStore(GetObjectStoreArgs.builder()
                .name("backup-server")
                .build());
    
        }
    }
    
    variables:
      backup:
        fn::invoke:
          Function: civo:getObjectStore
          Arguments:
            name: backup-server
    

    Using getObjectStore

    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 getObjectStore(args: GetObjectStoreArgs, opts?: InvokeOptions): Promise<GetObjectStoreResult>
    function getObjectStoreOutput(args: GetObjectStoreOutputArgs, opts?: InvokeOptions): Output<GetObjectStoreResult>
    def get_object_store(id: Optional[str] = None,
                         name: Optional[str] = None,
                         region: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetObjectStoreResult
    def get_object_store_output(id: Optional[pulumi.Input[str]] = None,
                         name: Optional[pulumi.Input[str]] = None,
                         region: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetObjectStoreResult]
    func LookupObjectStore(ctx *Context, args *LookupObjectStoreArgs, opts ...InvokeOption) (*LookupObjectStoreResult, error)
    func LookupObjectStoreOutput(ctx *Context, args *LookupObjectStoreOutputArgs, opts ...InvokeOption) LookupObjectStoreResultOutput

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

    public static class GetObjectStore 
    {
        public static Task<GetObjectStoreResult> InvokeAsync(GetObjectStoreArgs args, InvokeOptions? opts = null)
        public static Output<GetObjectStoreResult> Invoke(GetObjectStoreInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetObjectStoreResult> getObjectStore(GetObjectStoreArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: civo:index/getObjectStore:getObjectStore
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Id string
    The ID of the Object Store
    Name string
    The name of the Object Store
    Region string
    The region of an existing Object Store
    Id string
    The ID of the Object Store
    Name string
    The name of the Object Store
    Region string
    The region of an existing Object Store
    id String
    The ID of the Object Store
    name String
    The name of the Object Store
    region String
    The region of an existing Object Store
    id string
    The ID of the Object Store
    name string
    The name of the Object Store
    region string
    The region of an existing Object Store
    id str
    The ID of the Object Store
    name str
    The name of the Object Store
    region str
    The region of an existing Object Store
    id String
    The ID of the Object Store
    name String
    The name of the Object Store
    region String
    The region of an existing Object Store

    getObjectStore Result

    The following output properties are available:

    AccessKeyId string
    The access key ID from the Object Store credential. If this is not set, a new credential will be created.
    BucketUrl string
    The endpoint of the Object Store
    MaxSizeGb int
    The maximum size of the Object Store
    Status string
    The status of the Object Store
    Id string
    The ID of the Object Store
    Name string
    The name of the Object Store
    Region string
    The region of an existing Object Store
    AccessKeyId string
    The access key ID from the Object Store credential. If this is not set, a new credential will be created.
    BucketUrl string
    The endpoint of the Object Store
    MaxSizeGb int
    The maximum size of the Object Store
    Status string
    The status of the Object Store
    Id string
    The ID of the Object Store
    Name string
    The name of the Object Store
    Region string
    The region of an existing Object Store
    accessKeyId String
    The access key ID from the Object Store credential. If this is not set, a new credential will be created.
    bucketUrl String
    The endpoint of the Object Store
    maxSizeGb Integer
    The maximum size of the Object Store
    status String
    The status of the Object Store
    id String
    The ID of the Object Store
    name String
    The name of the Object Store
    region String
    The region of an existing Object Store
    accessKeyId string
    The access key ID from the Object Store credential. If this is not set, a new credential will be created.
    bucketUrl string
    The endpoint of the Object Store
    maxSizeGb number
    The maximum size of the Object Store
    status string
    The status of the Object Store
    id string
    The ID of the Object Store
    name string
    The name of the Object Store
    region string
    The region of an existing Object Store
    access_key_id str
    The access key ID from the Object Store credential. If this is not set, a new credential will be created.
    bucket_url str
    The endpoint of the Object Store
    max_size_gb int
    The maximum size of the Object Store
    status str
    The status of the Object Store
    id str
    The ID of the Object Store
    name str
    The name of the Object Store
    region str
    The region of an existing Object Store
    accessKeyId String
    The access key ID from the Object Store credential. If this is not set, a new credential will be created.
    bucketUrl String
    The endpoint of the Object Store
    maxSizeGb Number
    The maximum size of the Object Store
    status String
    The status of the Object Store
    id String
    The ID of the Object Store
    name String
    The name of the Object Store
    region String
    The region of an existing Object Store

    Package Details

    Repository
    Civo pulumi/pulumi-civo
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the civo Terraform Provider.
    civo logo
    Civo v2.3.19 published on Tuesday, Jul 16, 2024 by Pulumi