1. Packages
  2. Volcengine
  3. API Docs
  4. tos
  5. BucketObjectLockConfiguration
Volcengine v0.0.43 published on Friday, Jan 16, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcengine

volcengine.tos.BucketObjectLockConfiguration

volcengine logo
Volcengine v0.0.43 published on Friday, Jan 16, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcengine

    Provides a resource to manage tos bucket object lock configuration

    Example Usage

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

const foo = new volcengine.tos.BucketObjectLockConfiguration("foo", {
    bucketName: "tflyb7",
    rule: {
        defaultRetention: {
            days: 31,
            mode: "COMPLIANCE",
        },
    },
});

    import pulumi
import pulumi_volcengine as volcengine

foo = volcengine.tos.BucketObjectLockConfiguration("foo",
    bucket_name="tflyb7",
    rule=volcengine.tos.BucketObjectLockConfigurationRuleArgs(
        default_retention=volcengine.tos.BucketObjectLockConfigurationRuleDefaultRetentionArgs(
            days=31,
            mode="COMPLIANCE",
        ),
    ))

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := tos.NewBucketObjectLockConfiguration(ctx, "foo", &tos.BucketObjectLockConfigurationArgs{
			BucketName: pulumi.String("tflyb7"),
			Rule: &tos.BucketObjectLockConfigurationRuleArgs{
				DefaultRetention: &tos.BucketObjectLockConfigurationRuleDefaultRetentionArgs{
					Days: pulumi.Int(31),
					Mode: pulumi.String("COMPLIANCE"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var foo = new Volcengine.Tos.BucketObjectLockConfiguration("foo", new()
    {
        BucketName = "tflyb7",
        Rule = new Volcengine.Tos.Inputs.BucketObjectLockConfigurationRuleArgs
        {
            DefaultRetention = new Volcengine.Tos.Inputs.BucketObjectLockConfigurationRuleDefaultRetentionArgs
            {
                Days = 31,
                Mode = "COMPLIANCE",
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.volcengine.tos.BucketObjectLockConfiguration;
import com.pulumi.volcengine.tos.BucketObjectLockConfigurationArgs;
import com.pulumi.volcengine.tos.inputs.BucketObjectLockConfigurationRuleArgs;
import com.pulumi.volcengine.tos.inputs.BucketObjectLockConfigurationRuleDefaultRetentionArgs;
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 foo = new BucketObjectLockConfiguration("foo", BucketObjectLockConfigurationArgs.builder()        
            .bucketName("tflyb7")
            .rule(BucketObjectLockConfigurationRuleArgs.builder()
                .defaultRetention(BucketObjectLockConfigurationRuleDefaultRetentionArgs.builder()
                    .days(31)
                    .mode("COMPLIANCE")
                    .build())
                .build())
            .build());

    }
}

    resources:
  foo:
    type: volcengine:tos:BucketObjectLockConfiguration
    properties:
      bucketName: tflyb7
      rule:
        defaultRetention:
          days: 31
          mode: COMPLIANCE

    Create BucketObjectLockConfiguration Resource

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

    Constructor syntax

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

@overload
def BucketObjectLockConfiguration(resource_name: str,
                                  opts: Optional[ResourceOptions] = None,
                                  bucket_name: Optional[str] = None,
                                  rule: Optional[BucketObjectLockConfigurationRuleArgs] = None)
    func NewBucketObjectLockConfiguration(ctx *Context, name string, args BucketObjectLockConfigurationArgs, opts ...ResourceOption) (*BucketObjectLockConfiguration, error)
    public BucketObjectLockConfiguration(string name, BucketObjectLockConfigurationArgs args, CustomResourceOptions? opts = null)
    public BucketObjectLockConfiguration(String name, BucketObjectLockConfigurationArgs args)
public BucketObjectLockConfiguration(String name, BucketObjectLockConfigurationArgs args, CustomResourceOptions options)

    type: volcengine:tos:BucketObjectLockConfiguration
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 BucketObjectLockConfigurationArgs
    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 BucketObjectLockConfigurationArgs
    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 BucketObjectLockConfigurationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args BucketObjectLockConfigurationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args BucketObjectLockConfigurationArgs
    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 bucketObjectLockConfigurationResource = new Volcengine.Tos.BucketObjectLockConfiguration("bucketObjectLockConfigurationResource", new()
{
    BucketName = "string",
    Rule = new Volcengine.Tos.Inputs.BucketObjectLockConfigurationRuleArgs
    {
        DefaultRetention = new Volcengine.Tos.Inputs.BucketObjectLockConfigurationRuleDefaultRetentionArgs
        {
            Mode = "string",
            Days = 0,
            Years = 0,
        },
    },
});

    example, err := tos.NewBucketObjectLockConfiguration(ctx, "bucketObjectLockConfigurationResource", &tos.BucketObjectLockConfigurationArgs{
	BucketName: pulumi.String("string"),
	Rule: &tos.BucketObjectLockConfigurationRuleArgs{
		DefaultRetention: &tos.BucketObjectLockConfigurationRuleDefaultRetentionArgs{
			Mode:  pulumi.String("string"),
			Days:  pulumi.Int(0),
			Years: pulumi.Int(0),
		},
	},
})

    var bucketObjectLockConfigurationResource = new BucketObjectLockConfiguration("bucketObjectLockConfigurationResource", BucketObjectLockConfigurationArgs.builder()
    .bucketName("string")
    .rule(BucketObjectLockConfigurationRuleArgs.builder()
        .defaultRetention(BucketObjectLockConfigurationRuleDefaultRetentionArgs.builder()
            .mode("string")
            .days(0)
            .years(0)
            .build())
        .build())
    .build());

    bucket_object_lock_configuration_resource = volcengine.tos.BucketObjectLockConfiguration("bucketObjectLockConfigurationResource",
    bucket_name="string",
    rule={
        "default_retention": {
            "mode": "string",
            "days": 0,
            "years": 0,
        },
    })

    const bucketObjectLockConfigurationResource = new volcengine.tos.BucketObjectLockConfiguration("bucketObjectLockConfigurationResource", {
    bucketName: "string",
    rule: {
        defaultRetention: {
            mode: "string",
            days: 0,
            years: 0,
        },
    },
});

    type: volcengine:tos:BucketObjectLockConfiguration
properties:
    bucketName: string
    rule:
        defaultRetention:
            days: 0
            mode: string
            years: 0

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

    BucketName string
    The name of the TOS bucket.
    Rule BucketObjectLockConfigurationRule
    The object lock rule configuration.
    BucketName string
    The name of the TOS bucket.
    Rule BucketObjectLockConfigurationRuleArgs
    The object lock rule configuration.
    bucketName String
    The name of the TOS bucket.
    rule BucketObjectLockConfigurationRule
    The object lock rule configuration.
    bucketName string
    The name of the TOS bucket.
    rule BucketObjectLockConfigurationRule
    The object lock rule configuration.
    bucket_name str
    The name of the TOS bucket.
    rule BucketObjectLockConfigurationRuleArgs
    The object lock rule configuration.
    bucketName String
    The name of the TOS bucket.
    rule Property Map
    The object lock rule configuration.

    Outputs

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

    Get an existing BucketObjectLockConfiguration 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?: BucketObjectLockConfigurationState, opts?: CustomResourceOptions): BucketObjectLockConfiguration
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        bucket_name: Optional[str] = None,
        rule: Optional[BucketObjectLockConfigurationRuleArgs] = None) -> BucketObjectLockConfiguration
    func GetBucketObjectLockConfiguration(ctx *Context, name string, id IDInput, state *BucketObjectLockConfigurationState, opts ...ResourceOption) (*BucketObjectLockConfiguration, error)
    public static BucketObjectLockConfiguration Get(string name, Input<string> id, BucketObjectLockConfigurationState? state, CustomResourceOptions? opts = null)
    public static BucketObjectLockConfiguration get(String name, Output<String> id, BucketObjectLockConfigurationState state, CustomResourceOptions options)
    resources:  _:    type: volcengine:tos:BucketObjectLockConfiguration    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:
    BucketName string
    The name of the TOS bucket.
    Rule BucketObjectLockConfigurationRule
    The object lock rule configuration.
    BucketName string
    The name of the TOS bucket.
    Rule BucketObjectLockConfigurationRuleArgs
    The object lock rule configuration.
    bucketName String
    The name of the TOS bucket.
    rule BucketObjectLockConfigurationRule
    The object lock rule configuration.
    bucketName string
    The name of the TOS bucket.
    rule BucketObjectLockConfigurationRule
    The object lock rule configuration.
    bucket_name str
    The name of the TOS bucket.
    rule BucketObjectLockConfigurationRuleArgs
    The object lock rule configuration.
    bucketName String
    The name of the TOS bucket.
    rule Property Map
    The object lock rule configuration.

    Supporting Types

    BucketObjectLockConfigurationRule, BucketObjectLockConfigurationRuleArgs

    defaultRetention Property Map
    The default retention configuration.

    BucketObjectLockConfigurationRuleDefaultRetention, BucketObjectLockConfigurationRuleDefaultRetentionArgs

    Mode string
    The default retention mode. Valid values: COMPLIANCE, GOVERNANCE.
    Days int
    The number of days for the default retention period.
    Years int
    The number of years for the default retention period.
    Mode string
    The default retention mode. Valid values: COMPLIANCE, GOVERNANCE.
    Days int
    The number of days for the default retention period.
    Years int
    The number of years for the default retention period.
    mode String
    The default retention mode. Valid values: COMPLIANCE, GOVERNANCE.
    days Integer
    The number of days for the default retention period.
    years Integer
    The number of years for the default retention period.
    mode string
    The default retention mode. Valid values: COMPLIANCE, GOVERNANCE.
    days number
    The number of days for the default retention period.
    years number
    The number of years for the default retention period.
    mode str
    The default retention mode. Valid values: COMPLIANCE, GOVERNANCE.
    days int
    The number of days for the default retention period.
    years int
    The number of years for the default retention period.
    mode String
    The default retention mode. Valid values: COMPLIANCE, GOVERNANCE.
    days Number
    The number of days for the default retention period.
    years Number
    The number of years for the default retention period.

    Import

    TosBucketObjectLockConfiguration can be imported using the bucketName, e.g.

    $ pulumi import volcengine:tos/bucketObjectLockConfiguration:BucketObjectLockConfiguration default bucket_name

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

    Package Details

    Repository
    volcengine volcengine/pulumi-volcengine
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the volcengine Terraform Provider.
    volcengine logo
    Volcengine v0.0.43 published on Friday, Jan 16, 2026 by Volcengine
    Schema (JSON)
    volcengine/pulumi-volcengine
      Meet Neo: Your AI Platform Teammate