Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. DigitalOcean Provider
  3. API Docs
  4. getSpacesBucketObjects
DigitalOcean v4.40.2 published on Wednesday, Mar 19, 2025 by Pulumi
pulumi/pulumi-digitalocean

digitalocean.getSpacesBucketObjects

Explore with Pulumi AI

digitalocean logo
DigitalOcean v4.40.2 published on Wednesday, Mar 19, 2025 by Pulumi
pulumi/pulumi-digitalocean

    NOTE on max_keys: Retrieving very large numbers of keys can adversely affect the provider’s performance.

    The bucket-objects data source returns keys (i.e., file names) and other metadata about objects in a Spaces bucket.

    Using getSpacesBucketObjects

    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 getSpacesBucketObjects(args: GetSpacesBucketObjectsArgs, opts?: InvokeOptions): Promise<GetSpacesBucketObjectsResult>
function getSpacesBucketObjectsOutput(args: GetSpacesBucketObjectsOutputArgs, opts?: InvokeOptions): Output<GetSpacesBucketObjectsResult>
    def get_spaces_bucket_objects(bucket: Optional[str] = None,
                              delimiter: Optional[str] = None,
                              encoding_type: Optional[str] = None,
                              max_keys: Optional[int] = None,
                              prefix: Optional[str] = None,
                              region: Optional[str] = None,
                              opts: Optional[InvokeOptions] = None) -> GetSpacesBucketObjectsResult
def get_spaces_bucket_objects_output(bucket: Optional[pulumi.Input[str]] = None,
                              delimiter: Optional[pulumi.Input[str]] = None,
                              encoding_type: Optional[pulumi.Input[str]] = None,
                              max_keys: Optional[pulumi.Input[int]] = None,
                              prefix: Optional[pulumi.Input[str]] = None,
                              region: Optional[pulumi.Input[str]] = None,
                              opts: Optional[InvokeOptions] = None) -> Output[GetSpacesBucketObjectsResult]
    func GetSpacesBucketObjects(ctx *Context, args *GetSpacesBucketObjectsArgs, opts ...InvokeOption) (*GetSpacesBucketObjectsResult, error)
func GetSpacesBucketObjectsOutput(ctx *Context, args *GetSpacesBucketObjectsOutputArgs, opts ...InvokeOption) GetSpacesBucketObjectsResultOutput

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

    public static class GetSpacesBucketObjects 
{
    public static Task<GetSpacesBucketObjectsResult> InvokeAsync(GetSpacesBucketObjectsArgs args, InvokeOptions? opts = null)
    public static Output<GetSpacesBucketObjectsResult> Invoke(GetSpacesBucketObjectsInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetSpacesBucketObjectsResult> getSpacesBucketObjects(GetSpacesBucketObjectsArgs args, InvokeOptions options)
public static Output<GetSpacesBucketObjectsResult> getSpacesBucketObjects(GetSpacesBucketObjectsArgs args, InvokeOptions options)

    fn::invoke:
  function: digitalocean:index/getSpacesBucketObjects:getSpacesBucketObjects
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Bucket string
    Lists object keys in this Spaces bucket
    Region string
    The slug of the region where the bucket is stored.
    Delimiter string
    A character used to group keys (Default: none)
    EncodingType string
    Encodes keys using this method (Default: none; besides none, only "url" can be used)
    MaxKeys int
    Maximum object keys to return (Default: 1000)
    Prefix string
    Limits results to object keys with this prefix (Default: none)
    Bucket string
    Lists object keys in this Spaces bucket
    Region string
    The slug of the region where the bucket is stored.
    Delimiter string
    A character used to group keys (Default: none)
    EncodingType string
    Encodes keys using this method (Default: none; besides none, only "url" can be used)
    MaxKeys int
    Maximum object keys to return (Default: 1000)
    Prefix string
    Limits results to object keys with this prefix (Default: none)
    bucket String
    Lists object keys in this Spaces bucket
    region String
    The slug of the region where the bucket is stored.
    delimiter String
    A character used to group keys (Default: none)
    encodingType String
    Encodes keys using this method (Default: none; besides none, only "url" can be used)
    maxKeys Integer
    Maximum object keys to return (Default: 1000)
    prefix String
    Limits results to object keys with this prefix (Default: none)
    bucket string
    Lists object keys in this Spaces bucket
    region string
    The slug of the region where the bucket is stored.
    delimiter string
    A character used to group keys (Default: none)
    encodingType string
    Encodes keys using this method (Default: none; besides none, only "url" can be used)
    maxKeys number
    Maximum object keys to return (Default: 1000)
    prefix string
    Limits results to object keys with this prefix (Default: none)
    bucket str
    Lists object keys in this Spaces bucket
    region str
    The slug of the region where the bucket is stored.
    delimiter str
    A character used to group keys (Default: none)
    encoding_type str
    Encodes keys using this method (Default: none; besides none, only "url" can be used)
    max_keys int
    Maximum object keys to return (Default: 1000)
    prefix str
    Limits results to object keys with this prefix (Default: none)
    bucket String
    Lists object keys in this Spaces bucket
    region String
    The slug of the region where the bucket is stored.
    delimiter String
    A character used to group keys (Default: none)
    encodingType String
    Encodes keys using this method (Default: none; besides none, only "url" can be used)
    maxKeys Number
    Maximum object keys to return (Default: 1000)
    prefix String
    Limits results to object keys with this prefix (Default: none)

    getSpacesBucketObjects Result

    The following output properties are available:

    Bucket string
    CommonPrefixes List<string>
    List of any keys between prefix and the next occurrence of delimiter (i.e., similar to subdirectories of the prefix "directory"); the list is only returned when you specify delimiter
    Id string
    The provider-assigned unique ID for this managed resource.
    Keys List<string>
    List of strings representing object keys
    Owners List<string>
    List of strings representing object owner IDs
    Region string
    Delimiter string
    EncodingType string
    MaxKeys int
    Prefix string
    Bucket string
    CommonPrefixes []string
    List of any keys between prefix and the next occurrence of delimiter (i.e., similar to subdirectories of the prefix "directory"); the list is only returned when you specify delimiter
    Id string
    The provider-assigned unique ID for this managed resource.
    Keys []string
    List of strings representing object keys
    Owners []string
    List of strings representing object owner IDs
    Region string
    Delimiter string
    EncodingType string
    MaxKeys int
    Prefix string
    bucket String
    commonPrefixes List<String>
    List of any keys between prefix and the next occurrence of delimiter (i.e., similar to subdirectories of the prefix "directory"); the list is only returned when you specify delimiter
    id String
    The provider-assigned unique ID for this managed resource.
    keys List<String>
    List of strings representing object keys
    owners List<String>
    List of strings representing object owner IDs
    region String
    delimiter String
    encodingType String
    maxKeys Integer
    prefix String
    bucket string
    commonPrefixes string[]
    List of any keys between prefix and the next occurrence of delimiter (i.e., similar to subdirectories of the prefix "directory"); the list is only returned when you specify delimiter
    id string
    The provider-assigned unique ID for this managed resource.
    keys string[]
    List of strings representing object keys
    owners string[]
    List of strings representing object owner IDs
    region string
    delimiter string
    encodingType string
    maxKeys number
    prefix string
    bucket str
    common_prefixes Sequence[str]
    List of any keys between prefix and the next occurrence of delimiter (i.e., similar to subdirectories of the prefix "directory"); the list is only returned when you specify delimiter
    id str
    The provider-assigned unique ID for this managed resource.
    keys Sequence[str]
    List of strings representing object keys
    owners Sequence[str]
    List of strings representing object owner IDs
    region str
    delimiter str
    encoding_type str
    max_keys int
    prefix str
    bucket String
    commonPrefixes List<String>
    List of any keys between prefix and the next occurrence of delimiter (i.e., similar to subdirectories of the prefix "directory"); the list is only returned when you specify delimiter
    id String
    The provider-assigned unique ID for this managed resource.
    keys List<String>
    List of strings representing object keys
    owners List<String>
    List of strings representing object owner IDs
    region String
    delimiter String
    encodingType String
    maxKeys Number
    prefix String

    Package Details

    Repository
    DigitalOcean pulumi/pulumi-digitalocean
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the digitalocean Terraform Provider.
    digitalocean logo
    DigitalOcean v4.40.2 published on Wednesday, Mar 19, 2025 by Pulumi
    pulumi/pulumi-digitalocean