1. Packages
  2. Minio Provider
  3. API Docs
  4. S3Bucket
MinIO v0.16.3 published on Wednesday, Feb 12, 2025 by Pulumi

minio.S3Bucket

Explore with Pulumi AI

Example Usage

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

const stateTerraformS3 = new minio.S3Bucket("state_terraform_s3", {
    bucket: "state-terraform-s3",
    acl: "public",
});
export const minioId = stateTerraformS3.id;
export const minioUrl = stateTerraformS3.bucketDomainName;
Copy
import pulumi
import pulumi_minio as minio

state_terraform_s3 = minio.S3Bucket("state_terraform_s3",
    bucket="state-terraform-s3",
    acl="public")
pulumi.export("minioId", state_terraform_s3.id)
pulumi.export("minioUrl", state_terraform_s3.bucket_domain_name)
Copy
package main

import (
	"github.com/pulumi/pulumi-minio/sdk/go/minio"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		stateTerraformS3, err := minio.NewS3Bucket(ctx, "state_terraform_s3", &minio.S3BucketArgs{
			Bucket: pulumi.String("state-terraform-s3"),
			Acl:    pulumi.String("public"),
		})
		if err != nil {
			return err
		}
		ctx.Export("minioId", stateTerraformS3.ID())
		ctx.Export("minioUrl", stateTerraformS3.BucketDomainName)
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Minio = Pulumi.Minio;

return await Deployment.RunAsync(() => 
{
    var stateTerraformS3 = new Minio.S3Bucket("state_terraform_s3", new()
    {
        Bucket = "state-terraform-s3",
        Acl = "public",
    });

    return new Dictionary<string, object?>
    {
        ["minioId"] = stateTerraformS3.Id,
        ["minioUrl"] = stateTerraformS3.BucketDomainName,
    };
});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.minio.S3Bucket;
import com.pulumi.minio.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 stateTerraformS3 = new S3Bucket("stateTerraformS3", S3BucketArgs.builder()
            .bucket("state-terraform-s3")
            .acl("public")
            .build());

        ctx.export("minioId", stateTerraformS3.id());
        ctx.export("minioUrl", stateTerraformS3.bucketDomainName());
    }
}
Copy
resources:
  stateTerraformS3:
    type: minio:S3Bucket
    name: state_terraform_s3
    properties:
      bucket: state-terraform-s3
      acl: public
outputs:
  minioId: ${stateTerraformS3.id}
  minioUrl: ${stateTerraformS3.bucketDomainName}
Copy

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: Optional[S3BucketArgs] = None,
             opts: Optional[ResourceOptions] = None)

@overload
def S3Bucket(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             acl: Optional[str] = None,
             bucket: Optional[str] = None,
             bucket_prefix: Optional[str] = None,
             force_destroy: Optional[bool] = None,
             object_locking: Optional[bool] = None,
             quota: Optional[float] = None)
func NewS3Bucket(ctx *Context, name string, args *S3BucketArgs, opts ...ResourceOption) (*S3Bucket, error)
public S3Bucket(string name, S3BucketArgs? args = null, CustomResourceOptions? opts = null)
public S3Bucket(String name, S3BucketArgs args)
public S3Bucket(String name, S3BucketArgs args, CustomResourceOptions options)
type: minio:S3Bucket
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. String
The unique name of the resource.
args This property is required. 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 Minio.S3Bucket("s3bucketResource", new()
{
    Acl = "string",
    Bucket = "string",
    BucketPrefix = "string",
    ForceDestroy = false,
    ObjectLocking = false,
    Quota = 0,
});
Copy
example, err := minio.NewS3Bucket(ctx, "s3bucketResource", &minio.S3BucketArgs{
	Acl:           pulumi.String("string"),
	Bucket:        pulumi.String("string"),
	BucketPrefix:  pulumi.String("string"),
	ForceDestroy:  pulumi.Bool(false),
	ObjectLocking: pulumi.Bool(false),
	Quota:         pulumi.Float64(0),
})
Copy
var s3bucketResource = new S3Bucket("s3bucketResource", S3BucketArgs.builder()
    .acl("string")
    .bucket("string")
    .bucketPrefix("string")
    .forceDestroy(false)
    .objectLocking(false)
    .quota(0)
    .build());
Copy
s3bucket_resource = minio.S3Bucket("s3bucketResource",
    acl="string",
    bucket="string",
    bucket_prefix="string",
    force_destroy=False,
    object_locking=False,
    quota=0)
Copy
const s3bucketResource = new minio.S3Bucket("s3bucketResource", {
    acl: "string",
    bucket: "string",
    bucketPrefix: "string",
    forceDestroy: false,
    objectLocking: false,
    quota: 0,
});
Copy
type: minio:S3Bucket
properties:
    acl: string
    bucket: string
    bucketPrefix: string
    forceDestroy: false
    objectLocking: false
    quota: 0
Copy

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:

Acl string
Bucket Changes to this property will trigger replacement. string
BucketPrefix Changes to this property will trigger replacement. string
ForceDestroy bool
ObjectLocking bool
Quota double
Acl string
Bucket Changes to this property will trigger replacement. string
BucketPrefix Changes to this property will trigger replacement. string
ForceDestroy bool
ObjectLocking bool
Quota float64
acl String
bucket Changes to this property will trigger replacement. String
bucketPrefix Changes to this property will trigger replacement. String
forceDestroy Boolean
objectLocking Boolean
quota Double
acl string
bucket Changes to this property will trigger replacement. string
bucketPrefix Changes to this property will trigger replacement. string
forceDestroy boolean
objectLocking boolean
quota number
acl str
bucket Changes to this property will trigger replacement. str
bucket_prefix Changes to this property will trigger replacement. str
force_destroy bool
object_locking bool
quota float
acl String
bucket Changes to this property will trigger replacement. String
bucketPrefix Changes to this property will trigger replacement. String
forceDestroy Boolean
objectLocking Boolean
quota Number

Outputs

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

Arn string
BucketDomainName string
Id string
The provider-assigned unique ID for this managed resource.
Arn string
BucketDomainName string
Id string
The provider-assigned unique ID for this managed resource.
arn String
bucketDomainName String
id String
The provider-assigned unique ID for this managed resource.
arn string
bucketDomainName string
id string
The provider-assigned unique ID for this managed resource.
arn str
bucket_domain_name str
id str
The provider-assigned unique ID for this managed resource.
arn String
bucketDomainName String
id String
The provider-assigned unique ID for this managed resource.

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,
        acl: Optional[str] = None,
        arn: Optional[str] = None,
        bucket: Optional[str] = None,
        bucket_domain_name: Optional[str] = None,
        bucket_prefix: Optional[str] = None,
        force_destroy: Optional[bool] = None,
        object_locking: Optional[bool] = None,
        quota: Optional[float] = 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: minio:S3Bucket    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
Acl string
Arn string
Bucket Changes to this property will trigger replacement. string
BucketDomainName string
BucketPrefix Changes to this property will trigger replacement. string
ForceDestroy bool
ObjectLocking bool
Quota double
Acl string
Arn string
Bucket Changes to this property will trigger replacement. string
BucketDomainName string
BucketPrefix Changes to this property will trigger replacement. string
ForceDestroy bool
ObjectLocking bool
Quota float64
acl String
arn String
bucket Changes to this property will trigger replacement. String
bucketDomainName String
bucketPrefix Changes to this property will trigger replacement. String
forceDestroy Boolean
objectLocking Boolean
quota Double
acl string
arn string
bucket Changes to this property will trigger replacement. string
bucketDomainName string
bucketPrefix Changes to this property will trigger replacement. string
forceDestroy boolean
objectLocking boolean
quota number
acl str
arn str
bucket Changes to this property will trigger replacement. str
bucket_domain_name str
bucket_prefix Changes to this property will trigger replacement. str
force_destroy bool
object_locking bool
quota float
acl String
arn String
bucket Changes to this property will trigger replacement. String
bucketDomainName String
bucketPrefix Changes to this property will trigger replacement. String
forceDestroy Boolean
objectLocking Boolean
quota Number

Package Details

Repository
MinIO pulumi/pulumi-minio
License
Apache-2.0
Notes
This Pulumi package is based on the minio Terraform Provider.