Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Powerscale Provider
  3. API Docs
  4. S3Bucket
powerscale 1.7.1 published on Wednesday, Apr 30, 2025 by dell
dell/terraform-provider-powerscale

powerscale.S3Bucket

Explore with Pulumi AI

powerscale logo
powerscale 1.7.1 published on Wednesday, Apr 30, 2025 by dell
dell/terraform-provider-powerscale

    This resource is used to manage the S3 Bucket entity of PowerScale Array. PowerScale S3 Bucket map to the PowerScale file system as base directory for Objects. We can Create, Update and Delete the S3 Bucket using this resource. We can also import an existing S3 Bucket from PowerScale array.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as powerscale from "@pulumi/powerscale";

const s3BucketExample = new powerscale.S3Bucket("s3BucketExample", {path: "/ifs/s3_bucket_example"});

    import pulumi
import pulumi_powerscale as powerscale

s3_bucket_example = powerscale.S3Bucket("s3BucketExample", path="/ifs/s3_bucket_example")

    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 {
		_, err := powerscale.NewS3Bucket(ctx, "s3BucketExample", &powerscale.S3BucketArgs{
			Path: pulumi.String("/ifs/s3_bucket_example"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Powerscale = Pulumi.Powerscale;

return await Deployment.RunAsync(() => 
{
    var s3BucketExample = new Powerscale.S3Bucket("s3BucketExample", new()
    {
        Path = "/ifs/s3_bucket_example",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.powerscale.S3Bucket;
import com.pulumi.powerscale.S3BucketArgs;
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 s3BucketExample = new S3Bucket("s3BucketExample", S3BucketArgs.builder()
            .path("/ifs/s3_bucket_example")
            .build());

    }
}

    resources:
  s3BucketExample:
    type: powerscale:S3Bucket
    properties:
      path: /ifs/s3_bucket_example

    Create S3Bucket Resource

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

    Constructor syntax

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

@overload
def S3Bucket(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             path: Optional[str] = None,
             acls: Optional[Sequence[S3BucketAclArgs]] = None,
             create_path: Optional[bool] = None,
             description: Optional[str] = None,
             name: Optional[str] = None,
             object_acl_policy: Optional[str] = None,
             owner: Optional[str] = None,
             zone: Optional[str] = None)
    func NewS3Bucket(ctx *Context, name string, args S3BucketArgs, opts ...ResourceOption) (*S3Bucket, error)
    public S3Bucket(string name, S3BucketArgs args, CustomResourceOptions? opts = null)
    public S3Bucket(String name, S3BucketArgs args)
public S3Bucket(String name, S3BucketArgs args, CustomResourceOptions options)

    type: powerscale:S3Bucket
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 S3BucketArgs
    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 S3BucketArgs
    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 S3BucketArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args S3BucketArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args S3BucketArgs
    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 s3bucketResource = new Powerscale.S3Bucket("s3bucketResource", new()
{
    Path = "string",
    Acls = new[]
    {
        new Powerscale.Inputs.S3BucketAclArgs
        {
            Grantee = new Powerscale.Inputs.S3BucketAclGranteeArgs
            {
                Name = "string",
                Type = "string",
                Id = "string",
            },
            Permission = "string",
        },
    },
    CreatePath = false,
    Description = "string",
    Name = "string",
    ObjectAclPolicy = "string",
    Owner = "string",
    Zone = "string",
});

    example, err := powerscale.NewS3Bucket(ctx, "s3bucketResource", &powerscale.S3BucketArgs{
	Path: pulumi.String("string"),
	Acls: powerscale.S3BucketAclArray{
		&powerscale.S3BucketAclArgs{
			Grantee: &powerscale.S3BucketAclGranteeArgs{
				Name: pulumi.String("string"),
				Type: pulumi.String("string"),
				Id:   pulumi.String("string"),
			},
			Permission: pulumi.String("string"),
		},
	},
	CreatePath:      pulumi.Bool(false),
	Description:     pulumi.String("string"),
	Name:            pulumi.String("string"),
	ObjectAclPolicy: pulumi.String("string"),
	Owner:           pulumi.String("string"),
	Zone:            pulumi.String("string"),
})

    var s3bucketResource = new S3Bucket("s3bucketResource", S3BucketArgs.builder()
    .path("string")
    .acls(S3BucketAclArgs.builder()
        .grantee(S3BucketAclGranteeArgs.builder()
            .name("string")
            .type("string")
            .id("string")
            .build())
        .permission("string")
        .build())
    .createPath(false)
    .description("string")
    .name("string")
    .objectAclPolicy("string")
    .owner("string")
    .zone("string")
    .build());

    s3bucket_resource = powerscale.S3Bucket("s3bucketResource",
    path="string",
    acls=[{
        "grantee": {
            "name": "string",
            "type": "string",
            "id": "string",
        },
        "permission": "string",
    }],
    create_path=False,
    description="string",
    name="string",
    object_acl_policy="string",
    owner="string",
    zone="string")

    const s3bucketResource = new powerscale.S3Bucket("s3bucketResource", {
    path: "string",
    acls: [{
        grantee: {
            name: "string",
            type: "string",
            id: "string",
        },
        permission: "string",
    }],
    createPath: false,
    description: "string",
    name: "string",
    objectAclPolicy: "string",
    owner: "string",
    zone: "string",
});

    type: powerscale:S3Bucket
properties:
    acls:
        - grantee:
            id: string
            name: string
            type: string
          permission: string
    createPath: false
    description: string
    name: string
    objectAclPolicy: string
    owner: string
    path: string
    zone: string

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

    Path string
    Path of bucket within /ifs.
    Acls List<S3BucketAcl>
    Specifies properties for an S3 Access Control Entry.
    CreatePath bool
    Create path if does not exist.
    Description string
    Description for this S3 bucket.
    Name string
    Bucket name.
    ObjectAclPolicy string
    Set behavior of modifying object acls.
    Owner string
    Specifies the name of the owner.
    Zone string
    Zone Name.
    Path string
    Path of bucket within /ifs.
    Acls []S3BucketAclArgs
    Specifies properties for an S3 Access Control Entry.
    CreatePath bool
    Create path if does not exist.
    Description string
    Description for this S3 bucket.
    Name string
    Bucket name.
    ObjectAclPolicy string
    Set behavior of modifying object acls.
    Owner string
    Specifies the name of the owner.
    Zone string
    Zone Name.
    path String
    Path of bucket within /ifs.
    acls List<S3BucketAcl>
    Specifies properties for an S3 Access Control Entry.
    createPath Boolean
    Create path if does not exist.
    description String
    Description for this S3 bucket.
    name String
    Bucket name.
    objectAclPolicy String
    Set behavior of modifying object acls.
    owner String
    Specifies the name of the owner.
    zone String
    Zone Name.
    path string
    Path of bucket within /ifs.
    acls S3BucketAcl[]
    Specifies properties for an S3 Access Control Entry.
    createPath boolean
    Create path if does not exist.
    description string
    Description for this S3 bucket.
    name string
    Bucket name.
    objectAclPolicy string
    Set behavior of modifying object acls.
    owner string
    Specifies the name of the owner.
    zone string
    Zone Name.
    path str
    Path of bucket within /ifs.
    acls Sequence[S3BucketAclArgs]
    Specifies properties for an S3 Access Control Entry.
    create_path bool
    Create path if does not exist.
    description str
    Description for this S3 bucket.
    name str
    Bucket name.
    object_acl_policy str
    Set behavior of modifying object acls.
    owner str
    Specifies the name of the owner.
    zone str
    Zone Name.
    path String
    Path of bucket within /ifs.
    acls List<Property Map>
    Specifies properties for an S3 Access Control Entry.
    createPath Boolean
    Create path if does not exist.
    description String
    Description for this S3 bucket.
    name String
    Bucket name.
    objectAclPolicy String
    Set behavior of modifying object acls.
    owner String
    Specifies the name of the owner.
    zone String
    Zone Name.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Zid double
    Zone ID.
    Id string
    The provider-assigned unique ID for this managed resource.
    Zid float64
    Zone ID.
    id String
    The provider-assigned unique ID for this managed resource.
    zid Double
    Zone ID.
    id string
    The provider-assigned unique ID for this managed resource.
    zid number
    Zone ID.
    id str
    The provider-assigned unique ID for this managed resource.
    zid float
    Zone ID.
    id String
    The provider-assigned unique ID for this managed resource.
    zid Number
    Zone ID.

    Look up Existing S3Bucket Resource

    Get an existing S3Bucket 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?: S3BucketState, opts?: CustomResourceOptions): S3Bucket
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        acls: Optional[Sequence[S3BucketAclArgs]] = None,
        create_path: Optional[bool] = None,
        description: Optional[str] = None,
        name: Optional[str] = None,
        object_acl_policy: Optional[str] = None,
        owner: Optional[str] = None,
        path: Optional[str] = None,
        zid: Optional[float] = None,
        zone: Optional[str] = None) -> S3Bucket
    func GetS3Bucket(ctx *Context, name string, id IDInput, state *S3BucketState, opts ...ResourceOption) (*S3Bucket, error)
    public static S3Bucket Get(string name, Input<string> id, S3BucketState? state, CustomResourceOptions? opts = null)
    public static S3Bucket get(String name, Output<String> id, S3BucketState state, CustomResourceOptions options)
    resources:  _:    type: powerscale:S3Bucket    get:      id: ${id}
    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:
    Acls List<S3BucketAcl>
    Specifies properties for an S3 Access Control Entry.
    CreatePath bool
    Create path if does not exist.
    Description string
    Description for this S3 bucket.
    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.
    Zone string
    Zone Name.
    Acls []S3BucketAclArgs
    Specifies properties for an S3 Access Control Entry.
    CreatePath bool
    Create path if does not exist.
    Description string
    Description for this S3 bucket.
    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.
    Zone string
    Zone Name.
    acls List<S3BucketAcl>
    Specifies properties for an S3 Access Control Entry.
    createPath Boolean
    Create path if does not exist.
    description String
    Description for this S3 bucket.
    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.
    zone String
    Zone Name.
    acls S3BucketAcl[]
    Specifies properties for an S3 Access Control Entry.
    createPath boolean
    Create path if does not exist.
    description string
    Description for this S3 bucket.
    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.
    zone string
    Zone Name.
    acls Sequence[S3BucketAclArgs]
    Specifies properties for an S3 Access Control Entry.
    create_path bool
    Create path if does not exist.
    description str
    Description for this S3 bucket.
    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.
    zone str
    Zone Name.
    acls List<Property Map>
    Specifies properties for an S3 Access Control Entry.
    createPath Boolean
    Create path if does not exist.
    description String
    Description for this S3 bucket.
    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.
    zone String
    Zone Name.

    Supporting Types

    S3BucketAcl, S3BucketAclArgs

    Grantee S3BucketAclGrantee
    Specifies the persona of the file group.
    Permission string
    Specifies the S3 rights being allowed.
    Grantee S3BucketAclGrantee
    Specifies the persona of the file group.
    Permission string
    Specifies the S3 rights being allowed.
    grantee S3BucketAclGrantee
    Specifies the persona of the file group.
    permission String
    Specifies the S3 rights being allowed.
    grantee S3BucketAclGrantee
    Specifies the persona of the file group.
    permission string
    Specifies the S3 rights being allowed.
    grantee S3BucketAclGrantee
    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.

    S3BucketAclGrantee, S3BucketAclGranteeArgs

    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 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 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 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 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'.

    Import

    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.

    The command is

    $ pulumi import powerscale:index/s3Bucket:S3Bucket s3_bucket_example [<zoneID>]:<id>

    Example 1: is Optional, defaults to System:

    $ pulumi import powerscale:index/s3Bucket:S3Bucket s3_bucket_example example_s3_bucket_id

    Example 2:

    $ pulumi import powerscale:index/s3Bucket:S3Bucket s3_bucket_example zone_id:example_s3_bucket_id

    after running this command, populate the name field and other required parameters in the config file to start managing this resource.

    Note: running “terraform show” after importing shows the current config/state of the resource. You can copy/paste that config to make it easier to manage the resource.

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

    Package Details

    Repository
    powerscale dell/terraform-provider-powerscale
    License
    Notes
    This Pulumi package is based on the powerscale Terraform Provider.
    powerscale logo
    powerscale 1.7.1 published on Wednesday, Apr 30, 2025 by dell
    dell/terraform-provider-powerscale