1. Packages
  2. Alibaba Cloud Provider
  3. API Docs
  4. oss
  5. BucketRequestPayment
Viewing docs for Alibaba Cloud v3.97.0
published on Saturday, Mar 14, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-alicloud

alicloud.oss.BucketRequestPayment

alicloud logo
Viewing docs for Alibaba Cloud v3.97.0
published on Saturday, Mar 14, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-alicloud

    Provides a OSS Bucket Request Payment resource. Whether to enable pay-by-requester for a bucket.

    For information about OSS Bucket Request Payment and how to use it, see What is Bucket Request Payment.

    NOTE: Available since v1.222.0.

    Example Usage

    Basic Usage

    import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";
import * as random from "@pulumi/random";

const config = new pulumi.Config();
const name = config.get("name") || "terraform-example";
const _default = new random.index.Integer("default", {
    min: 10000,
    max: 99999,
});
const createBucket = new alicloud.oss.Bucket("CreateBucket", {
    storageClass: "Standard",
    bucket: `${name}-${_default.result}`,
});
const defaultBucketRequestPayment = new alicloud.oss.BucketRequestPayment("default", {
    payer: "Requester",
    bucket: createBucket.bucket,
});

    import pulumi
import pulumi_alicloud as alicloud
import pulumi_random as random

config = pulumi.Config()
name = config.get("name")
if name is None:
    name = "terraform-example"
default = random.index.Integer("default",
    min=10000,
    max=99999)
create_bucket = alicloud.oss.Bucket("CreateBucket",
    storage_class="Standard",
    bucket=f"{name}-{default['result']}")
default_bucket_request_payment = alicloud.oss.BucketRequestPayment("default",
    payer="Requester",
    bucket=create_bucket.bucket)

    package main

import (
	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/oss"
	"github.com/pulumi/pulumi-random/sdk/v4/go/random"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		cfg := config.New(ctx, "")
		name := "terraform-example"
		if param := cfg.Get("name"); param != "" {
			name = param
		}
		_default, err := random.NewInteger(ctx, "default", &random.IntegerArgs{
			Min: 10000,
			Max: 99999,
		})
		if err != nil {
			return err
		}
		createBucket, err := oss.NewBucket(ctx, "CreateBucket", &oss.BucketArgs{
			StorageClass: pulumi.String("Standard"),
			Bucket:       pulumi.Sprintf("%v-%v", name, _default.Result),
		})
		if err != nil {
			return err
		}
		_, err = oss.NewBucketRequestPayment(ctx, "default", &oss.BucketRequestPaymentArgs{
			Payer:  pulumi.String("Requester"),
			Bucket: createBucket.Bucket,
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AliCloud = Pulumi.AliCloud;
using Random = Pulumi.Random;

return await Deployment.RunAsync(() => 
{
    var config = new Config();
    var name = config.Get("name") ?? "terraform-example";
    var @default = new Random.Index.Integer("default", new()
    {
        Min = 10000,
        Max = 99999,
    });

    var createBucket = new AliCloud.Oss.Bucket("CreateBucket", new()
    {
        StorageClass = "Standard",
        BucketName = $"{name}-{@default.Result}",
    });

    var defaultBucketRequestPayment = new AliCloud.Oss.BucketRequestPayment("default", new()
    {
        Payer = "Requester",
        Bucket = createBucket.BucketName,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.random.Integer;
import com.pulumi.random.IntegerArgs;
import com.pulumi.alicloud.oss.Bucket;
import com.pulumi.alicloud.oss.BucketArgs;
import com.pulumi.alicloud.oss.BucketRequestPayment;
import com.pulumi.alicloud.oss.BucketRequestPaymentArgs;
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 config = ctx.config();
        final var name = config.get("name").orElse("terraform-example");
        var default_ = new Integer("default", IntegerArgs.builder()
            .min(10000)
            .max(99999)
            .build());

        var createBucket = new Bucket("createBucket", BucketArgs.builder()
            .storageClass("Standard")
            .bucket(String.format("%s-%s", name,default_.result()))
            .build());

        var defaultBucketRequestPayment = new BucketRequestPayment("defaultBucketRequestPayment", BucketRequestPaymentArgs.builder()
            .payer("Requester")
            .bucket(createBucket.bucket())
            .build());

    }
}

    configuration:
  name:
    type: string
    default: terraform-example
resources:
  default:
    type: random:Integer
    properties:
      min: 10000
      max: 99999
  createBucket:
    type: alicloud:oss:Bucket
    name: CreateBucket
    properties:
      storageClass: Standard
      bucket: ${name}-${default.result}
  defaultBucketRequestPayment:
    type: alicloud:oss:BucketRequestPayment
    name: default
    properties:
      payer: Requester
      bucket: ${createBucket.bucket}

    Deleting alicloud.oss.BucketRequestPayment or removing it from your configuration

    Terraform cannot destroy resource alicloud.oss.BucketRequestPayment. Terraform will remove this resource from the state file, however resources may remain.

    📚 Need more examples? VIEW MORE EXAMPLES

    Create BucketRequestPayment Resource

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

    Constructor syntax

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

@overload
def BucketRequestPayment(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         bucket: Optional[str] = None,
                         payer: Optional[str] = None)
    func NewBucketRequestPayment(ctx *Context, name string, args BucketRequestPaymentArgs, opts ...ResourceOption) (*BucketRequestPayment, error)
    public BucketRequestPayment(string name, BucketRequestPaymentArgs args, CustomResourceOptions? opts = null)
    public BucketRequestPayment(String name, BucketRequestPaymentArgs args)
public BucketRequestPayment(String name, BucketRequestPaymentArgs args, CustomResourceOptions options)

    type: alicloud:oss:BucketRequestPayment
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 BucketRequestPaymentArgs
    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 BucketRequestPaymentArgs
    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 BucketRequestPaymentArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args BucketRequestPaymentArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args BucketRequestPaymentArgs
    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 bucketRequestPaymentResource = new AliCloud.Oss.BucketRequestPayment("bucketRequestPaymentResource", new()
{
    Bucket = "string",
    Payer = "string",
});

    example, err := oss.NewBucketRequestPayment(ctx, "bucketRequestPaymentResource", &oss.BucketRequestPaymentArgs{
	Bucket: pulumi.String("string"),
	Payer:  pulumi.String("string"),
})

    var bucketRequestPaymentResource = new BucketRequestPayment("bucketRequestPaymentResource", BucketRequestPaymentArgs.builder()
    .bucket("string")
    .payer("string")
    .build());

    bucket_request_payment_resource = alicloud.oss.BucketRequestPayment("bucketRequestPaymentResource",
    bucket="string",
    payer="string")

    const bucketRequestPaymentResource = new alicloud.oss.BucketRequestPayment("bucketRequestPaymentResource", {
    bucket: "string",
    payer: "string",
});

    type: alicloud:oss:BucketRequestPayment
properties:
    bucket: string
    payer: string

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

    Bucket string
    The name of the bucket.
    Payer string
    The payer of the request and traffic fees.Valid values: BucketOwner: request and traffic fees are paid by the bucket owner. Requester: request and traffic fees are paid by the requester.
    Bucket string
    The name of the bucket.
    Payer string
    The payer of the request and traffic fees.Valid values: BucketOwner: request and traffic fees are paid by the bucket owner. Requester: request and traffic fees are paid by the requester.
    bucket String
    The name of the bucket.
    payer String
    The payer of the request and traffic fees.Valid values: BucketOwner: request and traffic fees are paid by the bucket owner. Requester: request and traffic fees are paid by the requester.
    bucket string
    The name of the bucket.
    payer string
    The payer of the request and traffic fees.Valid values: BucketOwner: request and traffic fees are paid by the bucket owner. Requester: request and traffic fees are paid by the requester.
    bucket str
    The name of the bucket.
    payer str
    The payer of the request and traffic fees.Valid values: BucketOwner: request and traffic fees are paid by the bucket owner. Requester: request and traffic fees are paid by the requester.
    bucket String
    The name of the bucket.
    payer String
    The payer of the request and traffic fees.Valid values: BucketOwner: request and traffic fees are paid by the bucket owner. Requester: request and traffic fees are paid by the requester.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing BucketRequestPayment Resource

    Get an existing BucketRequestPayment 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?: BucketRequestPaymentState, opts?: CustomResourceOptions): BucketRequestPayment
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        bucket: Optional[str] = None,
        payer: Optional[str] = None) -> BucketRequestPayment
    func GetBucketRequestPayment(ctx *Context, name string, id IDInput, state *BucketRequestPaymentState, opts ...ResourceOption) (*BucketRequestPayment, error)
    public static BucketRequestPayment Get(string name, Input<string> id, BucketRequestPaymentState? state, CustomResourceOptions? opts = null)
    public static BucketRequestPayment get(String name, Output<String> id, BucketRequestPaymentState state, CustomResourceOptions options)
    resources:  _:    type: alicloud:oss:BucketRequestPayment    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:
    Bucket string
    The name of the bucket.
    Payer string
    The payer of the request and traffic fees.Valid values: BucketOwner: request and traffic fees are paid by the bucket owner. Requester: request and traffic fees are paid by the requester.
    Bucket string
    The name of the bucket.
    Payer string
    The payer of the request and traffic fees.Valid values: BucketOwner: request and traffic fees are paid by the bucket owner. Requester: request and traffic fees are paid by the requester.
    bucket String
    The name of the bucket.
    payer String
    The payer of the request and traffic fees.Valid values: BucketOwner: request and traffic fees are paid by the bucket owner. Requester: request and traffic fees are paid by the requester.
    bucket string
    The name of the bucket.
    payer string
    The payer of the request and traffic fees.Valid values: BucketOwner: request and traffic fees are paid by the bucket owner. Requester: request and traffic fees are paid by the requester.
    bucket str
    The name of the bucket.
    payer str
    The payer of the request and traffic fees.Valid values: BucketOwner: request and traffic fees are paid by the bucket owner. Requester: request and traffic fees are paid by the requester.
    bucket String
    The name of the bucket.
    payer String
    The payer of the request and traffic fees.Valid values: BucketOwner: request and traffic fees are paid by the bucket owner. Requester: request and traffic fees are paid by the requester.

    Import

    OSS Bucket Request Payment can be imported using the id, e.g.

    $ pulumi import alicloud:oss/bucketRequestPayment:BucketRequestPayment example <id>

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

    Package Details

    Repository
    Alibaba Cloud pulumi/pulumi-alicloud
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the alicloud Terraform Provider.
    alicloud logo
    Viewing docs for Alibaba Cloud v3.97.0
    published on Saturday, Mar 14, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-alicloud
      Try Pulumi Cloud free. Your team will thank you.