1. Packages
  2. Packages
  3. Powerscale Provider
  4. API Docs
  5. getS3Bucket
Viewing docs for powerscale 1.8.1
published on Wednesday, Apr 1, 2026 by dell
Viewing docs for powerscale 1.8.1
published on Wednesday, Apr 1, 2026 by dell

    Access S3 Buckets. This datasource is used to query the existing S3 Bucket from PowerScale array. The information fetched from this datasource can be used for getting the details or for further processing in resource block. PowerScale S3 Bucket map to the PowerScale file system as base directory for Objects.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as powerscale from "@pulumi/powerscale";
    
    //Copyright (c) 2024 Dell Inc., or its subsidiaries. All Rights Reserved.
    //
    //Licensed under the Mozilla Public License Version 2.0 (the "License");
    //you may not use this file except in compliance with the License.
    //You may obtain a copy of the License at
    //
    //    http://mozilla.org/MPL/2.0/
    //
    //
    //Unless required by applicable law or agreed to in writing, software
    //distributed under the License is distributed on an "AS IS" BASIS,
    //WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    //See the License for the specific language governing permissions and
    //limitations under the License.
    // This Terraform DataSource is used to query the details of existing S3 Bucket from PowerScale array.
    // Returns a list of PowerScale s3 bucket based on filter block
    const exampleS3Buckets = powerscale.getS3Bucket({
        filter: {},
    });
    export const powerscaleS3Bucket = exampleS3Buckets;
    // Returns all of the PowerScale S3 Bucket in default zone
    const all = powerscale.getS3Bucket({});
    export const powerscaleS3BucketAll = all;
    
    import pulumi
    import pulumi_powerscale as powerscale
    
    #Copyright (c) 2024 Dell Inc., or its subsidiaries. All Rights Reserved.
    #
    #Licensed under the Mozilla Public License Version 2.0 (the "License");
    #you may not use this file except in compliance with the License.
    #You may obtain a copy of the License at
    #
    #    http://mozilla.org/MPL/2.0/
    #
    #
    #Unless required by applicable law or agreed to in writing, software
    #distributed under the License is distributed on an "AS IS" BASIS,
    #WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    #See the License for the specific language governing permissions and
    #limitations under the License.
    # This Terraform DataSource is used to query the details of existing S3 Bucket from PowerScale array.
    # Returns a list of PowerScale s3 bucket based on filter block
    example_s3_buckets = powerscale.get_s3_bucket(filter={})
    pulumi.export("powerscaleS3Bucket", example_s3_buckets)
    # Returns all of the PowerScale S3 Bucket in default zone
    all = powerscale.get_s3_bucket()
    pulumi.export("powerscaleS3BucketAll", all)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/powerscale/powerscale"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		// Copyright (c) 2024 Dell Inc., or its subsidiaries. All Rights Reserved.
    		//
    		// Licensed under the Mozilla Public License Version 2.0 (the "License");
    		// you may not use this file except in compliance with the License.
    		// You may obtain a copy of the License at
    		//
    		//	http://mozilla.org/MPL/2.0/
    		//
    		// Unless required by applicable law or agreed to in writing, software
    		// distributed under the License is distributed on an "AS IS" BASIS,
    		// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    		// See the License for the specific language governing permissions and
    		// limitations under the License.
    		// This Terraform DataSource is used to query the details of existing S3 Bucket from PowerScale array.
    		// Returns a list of PowerScale s3 bucket based on filter block
    		exampleS3Buckets, err := powerscale.LookupS3Bucket(ctx, &powerscale.LookupS3BucketArgs{
    			Filter: powerscale.GetS3BucketFilter{},
    		}, nil)
    		if err != nil {
    			return err
    		}
    		ctx.Export("powerscaleS3Bucket", exampleS3Buckets)
    		// Returns all of the PowerScale S3 Bucket in default zone
    		all, err := powerscale.LookupS3Bucket(ctx, &powerscale.LookupS3BucketArgs{}, nil)
    		if err != nil {
    			return err
    		}
    		ctx.Export("powerscaleS3BucketAll", all)
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Powerscale = Pulumi.Powerscale;
    
    return await Deployment.RunAsync(() => 
    {
        //Copyright (c) 2024 Dell Inc., or its subsidiaries. All Rights Reserved.
        //
        //Licensed under the Mozilla Public License Version 2.0 (the "License");
        //you may not use this file except in compliance with the License.
        //You may obtain a copy of the License at
        //
        //    http://mozilla.org/MPL/2.0/
        //
        //
        //Unless required by applicable law or agreed to in writing, software
        //distributed under the License is distributed on an "AS IS" BASIS,
        //WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
        //See the License for the specific language governing permissions and
        //limitations under the License.
        // This Terraform DataSource is used to query the details of existing S3 Bucket from PowerScale array.
        // Returns a list of PowerScale s3 bucket based on filter block
        var exampleS3Buckets = Powerscale.GetS3Bucket.Invoke(new()
        {
            Filter = null,
        });
    
        // Returns all of the PowerScale S3 Bucket in default zone
        var all = Powerscale.GetS3Bucket.Invoke();
    
        return new Dictionary<string, object?>
        {
            ["powerscaleS3Bucket"] = exampleS3Buckets,
            ["powerscaleS3BucketAll"] = all,
        };
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.powerscale.PowerscaleFunctions;
    import com.pulumi.powerscale.inputs.GetS3BucketArgs;
    import com.pulumi.powerscale.inputs.GetS3BucketFilterArgs;
    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) {
            //Copyright (c) 2024 Dell Inc., or its subsidiaries. All Rights Reserved.
            //
            //Licensed under the Mozilla Public License Version 2.0 (the "License");
            //you may not use this file except in compliance with the License.
            //You may obtain a copy of the License at
            //
            //    http://mozilla.org/MPL/2.0/
            //
            //
            //Unless required by applicable law or agreed to in writing, software
            //distributed under the License is distributed on an "AS IS" BASIS,
            //WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
            //See the License for the specific language governing permissions and
            //limitations under the License.
            // This Terraform DataSource is used to query the details of existing S3 Bucket from PowerScale array.
            // Returns a list of PowerScale s3 bucket based on filter block
            final var exampleS3Buckets = PowerscaleFunctions.getS3Bucket(GetS3BucketArgs.builder()
                .filter(GetS3BucketFilterArgs.builder()
                    .build())
                .build());
    
            ctx.export("powerscaleS3Bucket", exampleS3Buckets);
            // Returns all of the PowerScale S3 Bucket in default zone
            final var all = PowerscaleFunctions.getS3Bucket(GetS3BucketArgs.builder()
                .build());
    
            ctx.export("powerscaleS3BucketAll", all);
        }
    }
    
    variables:
      # /*
      # Copyright (c) 2024 Dell Inc., or its subsidiaries. All Rights Reserved.
    
      # Licensed under the Mozilla Public License Version 2.0 (the "License");
      # you may not use this file except in compliance with the License.
      # You may obtain a copy of the License at
    
      #     http://mozilla.org/MPL/2.0/
    
    
      # Unless required by applicable law or agreed to in writing, software
      # distributed under the License is distributed on an "AS IS" BASIS,
      # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
      # See the License for the specific language governing permissions and
      # limitations under the License.
      # */
    
    
      # This Terraform DataSource is used to query the details of existing S3 Bucket from PowerScale array.
    
      # Returns a list of PowerScale s3 bucket based on filter block
      exampleS3Buckets:
        fn::invoke:
          function: powerscale:getS3Bucket
          arguments:
            filter: {}
      # Returns all of the PowerScale S3 Bucket in default zone
      all:
        fn::invoke:
          function: powerscale:getS3Bucket
          arguments: {}
    outputs:
      # Output value of above block by executing 'terraform output' command
      # The user can use the fetched information by the variable data.powerscale_s3_bucket.example_s3_buckets
      powerscaleS3Bucket: ${exampleS3Buckets}
      # Output value of above block by executing 'terraform output' command
      # The user can use the fetched information by the variable data.powerscale_s3_bucket.all
      powerscaleS3BucketAll: ${all}
    

    Using getS3Bucket

    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 getS3Bucket(args: GetS3BucketArgs, opts?: InvokeOptions): Promise<GetS3BucketResult>
    function getS3BucketOutput(args: GetS3BucketOutputArgs, opts?: InvokeOptions): Output<GetS3BucketResult>
    def get_s3_bucket(filter: Optional[GetS3BucketFilter] = None,
                      opts: Optional[InvokeOptions] = None) -> GetS3BucketResult
    def get_s3_bucket_output(filter: pulumi.Input[Optional[GetS3BucketFilterArgs]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetS3BucketResult]
    func LookupS3Bucket(ctx *Context, args *LookupS3BucketArgs, opts ...InvokeOption) (*LookupS3BucketResult, error)
    func LookupS3BucketOutput(ctx *Context, args *LookupS3BucketOutputArgs, opts ...InvokeOption) LookupS3BucketResultOutput

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

    public static class GetS3Bucket 
    {
        public static Task<GetS3BucketResult> InvokeAsync(GetS3BucketArgs args, InvokeOptions? opts = null)
        public static Output<GetS3BucketResult> Invoke(GetS3BucketInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetS3BucketResult> getS3Bucket(GetS3BucketArgs args, InvokeOptions options)
    public static Output<GetS3BucketResult> getS3Bucket(GetS3BucketArgs args, InvokeOptions options)
    
    fn::invoke:
      function: powerscale:index/getS3Bucket:getS3Bucket
      arguments:
        # arguments dictionary

    The following arguments are supported:

    getS3Bucket Result

    The following output properties are available:

    Id string
    Identifier
    S3Buckets []GetS3BucketS3Bucket
    List of S3 Buckets
    Filter GetS3BucketFilter
    id string
    Identifier
    s3Buckets GetS3BucketS3Bucket[]
    List of S3 Buckets
    filter GetS3BucketFilter
    id String
    Identifier
    s3Buckets List<Property Map>
    List of S3 Buckets
    filter Property Map

    Supporting Types

    GetS3BucketFilter

    Owner string
    Specifies the name of the owner.
    Zone string
    Specifies which access zone to use.
    Owner string
    Specifies the name of the owner.
    Zone string
    Specifies which access zone to use.
    owner String
    Specifies the name of the owner.
    zone String
    Specifies which access zone to use.
    owner string
    Specifies the name of the owner.
    zone string
    Specifies which access zone to use.
    owner str
    Specifies the name of the owner.
    zone str
    Specifies which access zone to use.
    owner String
    Specifies the name of the owner.
    zone String
    Specifies which access zone to use.

    GetS3BucketS3Bucket

    Acls List<GetS3BucketS3BucketAcl>
    Specifies properties for an S3 Access Control Entry.
    Description string
    Description for this S3 bucket.
    Id string
    Bucket ID.
    Name string
    Bucket name.
    ObjectAclPolicy string
    Set behavior of modifying object acls
    Owner string
    Specifies the name of the owner.
    Path string
    Path of bucket within /ifs.
    Zid double
    Zone ID
    Acls []GetS3BucketS3BucketAcl
    Specifies properties for an S3 Access Control Entry.
    Description string
    Description for this S3 bucket.
    Id string
    Bucket ID.
    Name string
    Bucket name.
    ObjectAclPolicy string
    Set behavior of modifying object acls
    Owner string
    Specifies the name of the owner.
    Path string
    Path of bucket within /ifs.
    Zid float64
    Zone ID
    acls List<GetS3BucketS3BucketAcl>
    Specifies properties for an S3 Access Control Entry.
    description String
    Description for this S3 bucket.
    id String
    Bucket ID.
    name String
    Bucket name.
    objectAclPolicy String
    Set behavior of modifying object acls
    owner String
    Specifies the name of the owner.
    path String
    Path of bucket within /ifs.
    zid Double
    Zone ID
    acls GetS3BucketS3BucketAcl[]
    Specifies properties for an S3 Access Control Entry.
    description string
    Description for this S3 bucket.
    id string
    Bucket ID.
    name string
    Bucket name.
    objectAclPolicy string
    Set behavior of modifying object acls
    owner string
    Specifies the name of the owner.
    path string
    Path of bucket within /ifs.
    zid number
    Zone ID
    acls Sequence[GetS3BucketS3BucketAcl]
    Specifies properties for an S3 Access Control Entry.
    description str
    Description for this S3 bucket.
    id str
    Bucket ID.
    name str
    Bucket name.
    object_acl_policy str
    Set behavior of modifying object acls
    owner str
    Specifies the name of the owner.
    path str
    Path of bucket within /ifs.
    zid float
    Zone ID
    acls List<Property Map>
    Specifies properties for an S3 Access Control Entry.
    description String
    Description for this S3 bucket.
    id String
    Bucket ID.
    name String
    Bucket name.
    objectAclPolicy String
    Set behavior of modifying object acls
    owner String
    Specifies the name of the owner.
    path String
    Path of bucket within /ifs.
    zid Number
    Zone ID

    GetS3BucketS3BucketAcl

    Grantee GetS3BucketS3BucketAclGrantee
    Specifies the persona of the file group.
    Permission string
    Specifies the S3 rights being allowed.
    Grantee GetS3BucketS3BucketAclGrantee
    Specifies the persona of the file group.
    Permission string
    Specifies the S3 rights being allowed.
    grantee GetS3BucketS3BucketAclGrantee
    Specifies the persona of the file group.
    permission String
    Specifies the S3 rights being allowed.
    grantee GetS3BucketS3BucketAclGrantee
    Specifies the persona of the file group.
    permission string
    Specifies the S3 rights being allowed.
    grantee GetS3BucketS3BucketAclGrantee
    Specifies the persona of the file group.
    permission str
    Specifies the S3 rights being allowed.
    grantee Property Map
    Specifies the persona of the file group.
    permission String
    Specifies the S3 rights being allowed.

    GetS3BucketS3BucketAclGrantee

    Id string
    Specifies the serialized form of a persona, which can be 'UID:0', 'USER:name', 'GID:0', 'GROUP:wheel', or 'SID:S-1-1'.
    Name string
    Specifies the persona name, which must be combined with a type.
    Type string
    Specifies the type of persona, which must be combined with a name.
    Id string
    Specifies the serialized form of a persona, which can be 'UID:0', 'USER:name', 'GID:0', 'GROUP:wheel', or 'SID:S-1-1'.
    Name string
    Specifies the persona name, which must be combined with a type.
    Type string
    Specifies the type of persona, which must be combined with a name.
    id String
    Specifies the serialized form of a persona, which can be 'UID:0', 'USER:name', 'GID:0', 'GROUP:wheel', or 'SID:S-1-1'.
    name String
    Specifies the persona name, which must be combined with a type.
    type String
    Specifies the type of persona, which must be combined with a name.
    id string
    Specifies the serialized form of a persona, which can be 'UID:0', 'USER:name', 'GID:0', 'GROUP:wheel', or 'SID:S-1-1'.
    name string
    Specifies the persona name, which must be combined with a type.
    type string
    Specifies the type of persona, which must be combined with a name.
    id str
    Specifies the serialized form of a persona, which can be 'UID:0', 'USER:name', 'GID:0', 'GROUP:wheel', or 'SID:S-1-1'.
    name str
    Specifies the persona name, which must be combined with a type.
    type str
    Specifies the type of persona, which must be combined with a name.
    id String
    Specifies the serialized form of a persona, which can be 'UID:0', 'USER:name', 'GID:0', 'GROUP:wheel', or 'SID:S-1-1'.
    name String
    Specifies the persona name, which must be combined with a type.
    type String
    Specifies the type of persona, which must be combined with a name.

    Package Details

    Repository
    powerscale dell/terraform-provider-powerscale
    License
    Notes
    This Pulumi package is based on the powerscale Terraform Provider.
    Viewing docs for powerscale 1.8.1
    published on Wednesday, Apr 1, 2026 by dell
      Try Pulumi Cloud free. Your team will thank you.