1. Packages
  2. Packages
  3. Volcenginecc Provider
  4. API Docs
  5. tos
  6. BucketRename
Viewing docs for volcenginecc v0.0.50
published on Monday, Jul 20, 2026 by Volcengine
volcenginecc logo
Viewing docs for volcenginecc v0.0.50
published on Monday, Jul 20, 2026 by Volcengine

    Bucket RenameObject feature configuration. When enabled, you can call the RenameObject API to rename objects; this feature is mutually exclusive with versioning

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as volcenginecc from "@volcengine/pulumi-volcenginecc";
    
    const tOSBucketRenameDemo = new volcenginecc.tos.BucketRename("TOSBucketRenameDemo", {bucket: "ccapi-test-16"});
    
    import pulumi
    import pulumi_volcenginecc as volcenginecc
    
    t_os_bucket_rename_demo = volcenginecc.tos.BucketRename("TOSBucketRenameDemo", bucket="ccapi-test-16")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    	"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/tos"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := tos.NewBucketRename(ctx, "TOSBucketRenameDemo", &tos.BucketRenameArgs{
    			Bucket: pulumi.String("ccapi-test-16"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Volcenginecc = Volcengine.Pulumi.Volcenginecc;
    
    return await Deployment.RunAsync(() => 
    {
        var tOSBucketRenameDemo = new Volcenginecc.Tos.BucketRename("TOSBucketRenameDemo", new()
        {
            Bucket = "ccapi-test-16",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.volcengine.volcenginecc.tos.BucketRename;
    import com.volcengine.volcenginecc.tos.BucketRenameArgs;
    import java.util.ArrayList;
    import java.util.Arrays;
    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 tOSBucketRenameDemo = new BucketRename("tOSBucketRenameDemo", BucketRenameArgs.builder()
                .bucket("ccapi-test-16")
                .build());
    
        }
    }
    
    resources:
      tOSBucketRenameDemo:
        type: volcenginecc:tos:BucketRename
        name: TOSBucketRenameDemo
        properties:
          bucket: ccapi-test-16
    
    pulumi {
      required_providers {
        volcenginecc = {
          source = "pulumi/volcenginecc"
        }
      }
    }
    
    resource "volcenginecc_tos_bucketrename" "TOSBucketRenameDemo" {
      bucket = "ccapi-test-16"
    }
    

    Create BucketRename Resource

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

    Constructor syntax

    new BucketRename(name: string, args: BucketRenameArgs, opts?: CustomResourceOptions);
    @overload
    def BucketRename(resource_name: str,
                     args: BucketRenameArgs,
                     opts: Optional[ResourceOptions] = None)
    
    @overload
    def BucketRename(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     bucket: Optional[str] = None)
    func NewBucketRename(ctx *Context, name string, args BucketRenameArgs, opts ...ResourceOption) (*BucketRename, error)
    public BucketRename(string name, BucketRenameArgs args, CustomResourceOptions? opts = null)
    public BucketRename(String name, BucketRenameArgs args)
    public BucketRename(String name, BucketRenameArgs args, CustomResourceOptions options)
    
    type: volcenginecc:tos:BucketRename
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "volcenginecc_tos_bucket_rename" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args BucketRenameArgs
    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 BucketRenameArgs
    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 BucketRenameArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args BucketRenameArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args BucketRenameArgs
    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 bucketRenameResource = new Volcenginecc.Tos.BucketRename("bucketRenameResource", new()
    {
        Bucket = "string",
    });
    
    example, err := tos.NewBucketRename(ctx, "bucketRenameResource", &tos.BucketRenameArgs{
    	Bucket: pulumi.String("string"),
    })
    
    resource "volcenginecc_tos_bucket_rename" "bucketRenameResource" {
      lifecycle {
        create_before_destroy = true
      }
      bucket = "string"
    }
    
    var bucketRenameResource = new BucketRename("bucketRenameResource", BucketRenameArgs.builder()
        .bucket("string")
        .build());
    
    bucket_rename_resource = volcenginecc.tos.BucketRename("bucketRenameResource", bucket="string")
    
    const bucketRenameResource = new volcenginecc.tos.BucketRename("bucketRenameResource", {bucket: "string"});
    
    type: volcenginecc:tos:BucketRename
    properties:
        bucket: string
    

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

    Bucket string
    Bucket name
    Bucket string
    Bucket name
    bucket string
    Bucket name
    bucket String
    Bucket name
    bucket string
    Bucket name
    bucket str
    Bucket name
    bucket String
    Bucket name

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    RenameEnable bool
    Whether to enable RenameObject feature. true means enabled
    Id string
    The provider-assigned unique ID for this managed resource.
    RenameEnable bool
    Whether to enable RenameObject feature. true means enabled
    id string
    The provider-assigned unique ID for this managed resource.
    rename_enable bool
    Whether to enable RenameObject feature. true means enabled
    id String
    The provider-assigned unique ID for this managed resource.
    renameEnable Boolean
    Whether to enable RenameObject feature. true means enabled
    id string
    The provider-assigned unique ID for this managed resource.
    renameEnable boolean
    Whether to enable RenameObject feature. true means enabled
    id str
    The provider-assigned unique ID for this managed resource.
    rename_enable bool
    Whether to enable RenameObject feature. true means enabled
    id String
    The provider-assigned unique ID for this managed resource.
    renameEnable Boolean
    Whether to enable RenameObject feature. true means enabled

    Look up Existing BucketRename Resource

    Get an existing BucketRename 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?: BucketRenameState, opts?: CustomResourceOptions): BucketRename
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            bucket: Optional[str] = None,
            rename_enable: Optional[bool] = None) -> BucketRename
    func GetBucketRename(ctx *Context, name string, id IDInput, state *BucketRenameState, opts ...ResourceOption) (*BucketRename, error)
    public static BucketRename Get(string name, Input<string> id, BucketRenameState? state, CustomResourceOptions? opts = null)
    public static BucketRename get(String name, Output<String> id, BucketRenameState state, CustomResourceOptions options)
    resources:  _:    type: volcenginecc:tos:BucketRename    get:      id: ${id}
    import {
      to = volcenginecc_tos_bucket_rename.example
      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
    Bucket name
    RenameEnable bool
    Whether to enable RenameObject feature. true means enabled
    Bucket string
    Bucket name
    RenameEnable bool
    Whether to enable RenameObject feature. true means enabled
    bucket string
    Bucket name
    rename_enable bool
    Whether to enable RenameObject feature. true means enabled
    bucket String
    Bucket name
    renameEnable Boolean
    Whether to enable RenameObject feature. true means enabled
    bucket string
    Bucket name
    renameEnable boolean
    Whether to enable RenameObject feature. true means enabled
    bucket str
    Bucket name
    rename_enable bool
    Whether to enable RenameObject feature. true means enabled
    bucket String
    Bucket name
    renameEnable Boolean
    Whether to enable RenameObject feature. true means enabled

    Import

    $ pulumi import volcenginecc:tos/bucketRename:BucketRename example "bucket"
    

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

    Package Details

    Repository
    volcenginecc volcengine/pulumi-volcenginecc
    License
    MPL-2.0
    Notes
    This Pulumi package is based on the volcenginecc Terraform Provider.
    volcenginecc logo
    Viewing docs for volcenginecc v0.0.50
    published on Monday, Jul 20, 2026 by Volcengine

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial