1. Packages
  2. Alibaba Cloud Provider
  3. API Docs
  4. oss
  5. BucketTransferAcceleration
Viewing docs for Alibaba Cloud v3.97.0
published on Saturday, Mar 14, 2026 by Pulumi
alicloud logo
Viewing docs for Alibaba Cloud v3.97.0
published on Saturday, Mar 14, 2026 by Pulumi

    Provides a OSS Bucket Transfer Acceleration resource. Transfer acceleration configuration of a bucket.

    For information about OSS Bucket Transfer Acceleration and how to use it, see What is Bucket Transfer Acceleration.

    NOTE: Available since v1.224.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 defaultBucketTransferAcceleration = new alicloud.oss.BucketTransferAcceleration("default", {
        bucket: createBucket.bucket,
        enabled: true,
    });
    
    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_transfer_acceleration = alicloud.oss.BucketTransferAcceleration("default",
        bucket=create_bucket.bucket,
        enabled=True)
    
    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.NewBucketTransferAcceleration(ctx, "default", &oss.BucketTransferAccelerationArgs{
    			Bucket:  createBucket.Bucket,
    			Enabled: pulumi.Bool(true),
    		})
    		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 defaultBucketTransferAcceleration = new AliCloud.Oss.BucketTransferAcceleration("default", new()
        {
            Bucket = createBucket.BucketName,
            Enabled = true,
        });
    
    });
    
    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.BucketTransferAcceleration;
    import com.pulumi.alicloud.oss.BucketTransferAccelerationArgs;
    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 defaultBucketTransferAcceleration = new BucketTransferAcceleration("defaultBucketTransferAcceleration", BucketTransferAccelerationArgs.builder()
                .bucket(createBucket.bucket())
                .enabled(true)
                .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}
      defaultBucketTransferAcceleration:
        type: alicloud:oss:BucketTransferAcceleration
        name: default
        properties:
          bucket: ${createBucket.bucket}
          enabled: true
    

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

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

    📚 Need more examples? VIEW MORE EXAMPLES

    Create BucketTransferAcceleration Resource

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

    Constructor syntax

    new BucketTransferAcceleration(name: string, args: BucketTransferAccelerationArgs, opts?: CustomResourceOptions);
    @overload
    def BucketTransferAcceleration(resource_name: str,
                                   args: BucketTransferAccelerationInitArgs,
                                   opts: Optional[ResourceOptions] = None)
    
    @overload
    def BucketTransferAcceleration(resource_name: str,
                                   opts: Optional[ResourceOptions] = None,
                                   bucket: Optional[str] = None,
                                   enabled: Optional[bool] = None)
    func NewBucketTransferAcceleration(ctx *Context, name string, args BucketTransferAccelerationArgs, opts ...ResourceOption) (*BucketTransferAcceleration, error)
    public BucketTransferAcceleration(string name, BucketTransferAccelerationArgs args, CustomResourceOptions? opts = null)
    public BucketTransferAcceleration(String name, BucketTransferAccelerationArgs args)
    public BucketTransferAcceleration(String name, BucketTransferAccelerationArgs args, CustomResourceOptions options)
    
    type: alicloud:oss:BucketTransferAcceleration
    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 BucketTransferAccelerationArgs
    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 BucketTransferAccelerationInitArgs
    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 BucketTransferAccelerationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args BucketTransferAccelerationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args BucketTransferAccelerationArgs
    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 bucketTransferAccelerationResource = new AliCloud.Oss.BucketTransferAcceleration("bucketTransferAccelerationResource", new()
    {
        Bucket = "string",
        Enabled = false,
    });
    
    example, err := oss.NewBucketTransferAcceleration(ctx, "bucketTransferAccelerationResource", &oss.BucketTransferAccelerationArgs{
    	Bucket:  pulumi.String("string"),
    	Enabled: pulumi.Bool(false),
    })
    
    var bucketTransferAccelerationResource = new BucketTransferAcceleration("bucketTransferAccelerationResource", BucketTransferAccelerationArgs.builder()
        .bucket("string")
        .enabled(false)
        .build());
    
    bucket_transfer_acceleration_resource = alicloud.oss.BucketTransferAcceleration("bucketTransferAccelerationResource",
        bucket="string",
        enabled=False)
    
    const bucketTransferAccelerationResource = new alicloud.oss.BucketTransferAcceleration("bucketTransferAccelerationResource", {
        bucket: "string",
        enabled: false,
    });
    
    type: alicloud:oss:BucketTransferAcceleration
    properties:
        bucket: string
        enabled: false
    

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

    Bucket string
    The name of the Bucket.
    Enabled bool
    Specifies whether to enable transfer acceleration for the bucket. Valid values: true: transfer acceleration for the bucket is enabled. false: transfer acceleration for the bucket is disabled.
    Bucket string
    The name of the Bucket.
    Enabled bool
    Specifies whether to enable transfer acceleration for the bucket. Valid values: true: transfer acceleration for the bucket is enabled. false: transfer acceleration for the bucket is disabled.
    bucket String
    The name of the Bucket.
    enabled Boolean
    Specifies whether to enable transfer acceleration for the bucket. Valid values: true: transfer acceleration for the bucket is enabled. false: transfer acceleration for the bucket is disabled.
    bucket string
    The name of the Bucket.
    enabled boolean
    Specifies whether to enable transfer acceleration for the bucket. Valid values: true: transfer acceleration for the bucket is enabled. false: transfer acceleration for the bucket is disabled.
    bucket str
    The name of the Bucket.
    enabled bool
    Specifies whether to enable transfer acceleration for the bucket. Valid values: true: transfer acceleration for the bucket is enabled. false: transfer acceleration for the bucket is disabled.
    bucket String
    The name of the Bucket.
    enabled Boolean
    Specifies whether to enable transfer acceleration for the bucket. Valid values: true: transfer acceleration for the bucket is enabled. false: transfer acceleration for the bucket is disabled.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the BucketTransferAcceleration 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 BucketTransferAcceleration Resource

    Get an existing BucketTransferAcceleration 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?: BucketTransferAccelerationState, opts?: CustomResourceOptions): BucketTransferAcceleration
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            bucket: Optional[str] = None,
            enabled: Optional[bool] = None) -> BucketTransferAcceleration
    func GetBucketTransferAcceleration(ctx *Context, name string, id IDInput, state *BucketTransferAccelerationState, opts ...ResourceOption) (*BucketTransferAcceleration, error)
    public static BucketTransferAcceleration Get(string name, Input<string> id, BucketTransferAccelerationState? state, CustomResourceOptions? opts = null)
    public static BucketTransferAcceleration get(String name, Output<String> id, BucketTransferAccelerationState state, CustomResourceOptions options)
    resources:  _:    type: alicloud:oss:BucketTransferAcceleration    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.
    Enabled bool
    Specifies whether to enable transfer acceleration for the bucket. Valid values: true: transfer acceleration for the bucket is enabled. false: transfer acceleration for the bucket is disabled.
    Bucket string
    The name of the Bucket.
    Enabled bool
    Specifies whether to enable transfer acceleration for the bucket. Valid values: true: transfer acceleration for the bucket is enabled. false: transfer acceleration for the bucket is disabled.
    bucket String
    The name of the Bucket.
    enabled Boolean
    Specifies whether to enable transfer acceleration for the bucket. Valid values: true: transfer acceleration for the bucket is enabled. false: transfer acceleration for the bucket is disabled.
    bucket string
    The name of the Bucket.
    enabled boolean
    Specifies whether to enable transfer acceleration for the bucket. Valid values: true: transfer acceleration for the bucket is enabled. false: transfer acceleration for the bucket is disabled.
    bucket str
    The name of the Bucket.
    enabled bool
    Specifies whether to enable transfer acceleration for the bucket. Valid values: true: transfer acceleration for the bucket is enabled. false: transfer acceleration for the bucket is disabled.
    bucket String
    The name of the Bucket.
    enabled Boolean
    Specifies whether to enable transfer acceleration for the bucket. Valid values: true: transfer acceleration for the bucket is enabled. false: transfer acceleration for the bucket is disabled.

    Import

    OSS Bucket Transfer Acceleration can be imported using the id, e.g.

    $ pulumi import alicloud:oss/bucketTransferAcceleration:BucketTransferAcceleration 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
      Try Pulumi Cloud free. Your team will thank you.