1. Packages
  2. Vultr
  3. API Docs
  4. getObjectStorageCluster
Vultr v2.21.1 published on Monday, Jul 22, 2024 by dirien

vultr.getObjectStorageCluster

Explore with Pulumi AI

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

    Get information about Object Storage Clusters on Vultr.

    Example Usage

    Get the information for an object storage cluster by region:

    import * as pulumi from "@pulumi/pulumi";
    import * as vultr from "@pulumi/vultr";
    
    const s3 = vultr.getObjectStorageCluster({
        filters: [{
            name: "region",
            values: ["ewr"],
        }],
    });
    
    import pulumi
    import pulumi_vultr as vultr
    
    s3 = vultr.get_object_storage_cluster(filters=[vultr.GetObjectStorageClusterFilterArgs(
        name="region",
        values=["ewr"],
    )])
    
    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.GetObjectStorageCluster(ctx, &vultr.GetObjectStorageClusterArgs{
    			Filters: []vultr.GetObjectStorageClusterFilter{
    				{
    					Name: "region",
    					Values: []string{
    						"ewr",
    					},
    				},
    			},
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Vultr = Pulumi.Vultr;
    
    return await Deployment.RunAsync(() => 
    {
        var s3 = Vultr.GetObjectStorageCluster.Invoke(new()
        {
            Filters = new[]
            {
                new Vultr.Inputs.GetObjectStorageClusterFilterInputArgs
                {
                    Name = "region",
                    Values = new[]
                    {
                        "ewr",
                    },
                },
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.vultr.VultrFunctions;
    import com.pulumi.vultr.inputs.GetObjectStorageClusterArgs;
    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 s3 = VultrFunctions.getObjectStorageCluster(GetObjectStorageClusterArgs.builder()
                .filters(GetObjectStorageClusterFilterArgs.builder()
                    .name("region")
                    .values("ewr")
                    .build())
                .build());
    
        }
    }
    
    variables:
      s3:
        fn::invoke:
          Function: vultr:getObjectStorageCluster
          Arguments:
            filters:
              - name: region
                values:
                  - ewr
    

    Using getObjectStorageCluster

    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 getObjectStorageCluster(args: GetObjectStorageClusterArgs, opts?: InvokeOptions): Promise<GetObjectStorageClusterResult>
    function getObjectStorageClusterOutput(args: GetObjectStorageClusterOutputArgs, opts?: InvokeOptions): Output<GetObjectStorageClusterResult>
    def get_object_storage_cluster(filters: Optional[Sequence[GetObjectStorageClusterFilter]] = None,
                                   opts: Optional[InvokeOptions] = None) -> GetObjectStorageClusterResult
    def get_object_storage_cluster_output(filters: Optional[pulumi.Input[Sequence[pulumi.Input[GetObjectStorageClusterFilterArgs]]]] = None,
                                   opts: Optional[InvokeOptions] = None) -> Output[GetObjectStorageClusterResult]
    func GetObjectStorageCluster(ctx *Context, args *GetObjectStorageClusterArgs, opts ...InvokeOption) (*GetObjectStorageClusterResult, error)
    func GetObjectStorageClusterOutput(ctx *Context, args *GetObjectStorageClusterOutputArgs, opts ...InvokeOption) GetObjectStorageClusterResultOutput

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

    public static class GetObjectStorageCluster 
    {
        public static Task<GetObjectStorageClusterResult> InvokeAsync(GetObjectStorageClusterArgs args, InvokeOptions? opts = null)
        public static Output<GetObjectStorageClusterResult> Invoke(GetObjectStorageClusterInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetObjectStorageClusterResult> getObjectStorageCluster(GetObjectStorageClusterArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: vultr:index/getObjectStorageCluster:getObjectStorageCluster
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Filters List<ediri.Vultr.Inputs.GetObjectStorageClusterFilter>
    Query parameters for finding operating systems.
    Filters []GetObjectStorageClusterFilter
    Query parameters for finding operating systems.
    filters List<GetObjectStorageClusterFilter>
    Query parameters for finding operating systems.
    filters GetObjectStorageClusterFilter[]
    Query parameters for finding operating systems.
    filters Sequence[GetObjectStorageClusterFilter]
    Query parameters for finding operating systems.
    filters List<Property Map>
    Query parameters for finding operating systems.

    getObjectStorageCluster Result

    The following output properties are available:

    Deploy string
    The Cluster is eligible for Object Storage deployment. (yes or no)
    Hostname string
    The cluster hostname.
    Id int
    The identifying cluster ID.
    Region string
    The region ID of the object storage cluster.
    Filters List<ediri.Vultr.Outputs.GetObjectStorageClusterFilter>
    Deploy string
    The Cluster is eligible for Object Storage deployment. (yes or no)
    Hostname string
    The cluster hostname.
    Id int
    The identifying cluster ID.
    Region string
    The region ID of the object storage cluster.
    Filters []GetObjectStorageClusterFilter
    deploy String
    The Cluster is eligible for Object Storage deployment. (yes or no)
    hostname String
    The cluster hostname.
    id Integer
    The identifying cluster ID.
    region String
    The region ID of the object storage cluster.
    filters List<GetObjectStorageClusterFilter>
    deploy string
    The Cluster is eligible for Object Storage deployment. (yes or no)
    hostname string
    The cluster hostname.
    id number
    The identifying cluster ID.
    region string
    The region ID of the object storage cluster.
    filters GetObjectStorageClusterFilter[]
    deploy str
    The Cluster is eligible for Object Storage deployment. (yes or no)
    hostname str
    The cluster hostname.
    id int
    The identifying cluster ID.
    region str
    The region ID of the object storage cluster.
    filters Sequence[GetObjectStorageClusterFilter]
    deploy String
    The Cluster is eligible for Object Storage deployment. (yes or no)
    hostname String
    The cluster hostname.
    id Number
    The identifying cluster ID.
    region String
    The region ID of the object storage cluster.
    filters List<Property Map>

    Supporting Types

    GetObjectStorageClusterFilter

    Name string
    Attribute name to filter with.
    Values List<string>
    One or more values filter with.
    Name string
    Attribute name to filter with.
    Values []string
    One or more values filter with.
    name String
    Attribute name to filter with.
    values List<String>
    One or more values filter with.
    name string
    Attribute name to filter with.
    values string[]
    One or more values filter with.
    name str
    Attribute name to filter with.
    values Sequence[str]
    One or more values filter with.
    name String
    Attribute name to filter with.
    values List<String>
    One or more values filter with.

    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