Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. Volcengine
  3. API Docs
  4. tos
  5. BucketEncryption
Volcengine v0.0.35 published on Friday, Aug 29, 2025 by Volcengine
volcengine/pulumi-volcengine

volcengine.tos.BucketEncryption

Explore with Pulumi AI

volcengine logo
Volcengine v0.0.35 published on Friday, Aug 29, 2025 by Volcengine
volcengine/pulumi-volcengine

    Provides a resource to manage tos bucket encryption

    Example Usage

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

const fooBucket = new volcengine.tos.Bucket("fooBucket", {
    bucketName: "tf-acc-test-bucket",
    publicAcl: "private",
    azRedundancy: "multi-az",
    projectName: "default",
    tags: [{
        key: "k1",
        value: "v1",
    }],
});
const fooKeyring = new volcengine.kms.Keyring("fooKeyring", {
    keyringName: "acc-test-keyring",
    description: "acc-test",
    projectName: "default",
});
const fooBucketEncryption = new volcengine.tos.BucketEncryption("fooBucketEncryption", {
    bucketName: fooBucket.id,
    rule: {
        applyServerSideEncryptionByDefault: {
            sseAlgorithm: "kms",
            kmsDataEncryption: "AES256",
            kmsMasterKeyId: fooKeyring.id,
        },
    },
});

    import pulumi
import pulumi_volcengine as volcengine

foo_bucket = volcengine.tos.Bucket("fooBucket",
    bucket_name="tf-acc-test-bucket",
    public_acl="private",
    az_redundancy="multi-az",
    project_name="default",
    tags=[volcengine.tos.BucketTagArgs(
        key="k1",
        value="v1",
    )])
foo_keyring = volcengine.kms.Keyring("fooKeyring",
    keyring_name="acc-test-keyring",
    description="acc-test",
    project_name="default")
foo_bucket_encryption = volcengine.tos.BucketEncryption("fooBucketEncryption",
    bucket_name=foo_bucket.id,
    rule=volcengine.tos.BucketEncryptionRuleArgs(
        apply_server_side_encryption_by_default=volcengine.tos.BucketEncryptionRuleApplyServerSideEncryptionByDefaultArgs(
            sse_algorithm="kms",
            kms_data_encryption="AES256",
            kms_master_key_id=foo_keyring.id,
        ),
    ))

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		fooBucket, err := tos.NewBucket(ctx, "fooBucket", &tos.BucketArgs{
			BucketName:   pulumi.String("tf-acc-test-bucket"),
			PublicAcl:    pulumi.String("private"),
			AzRedundancy: pulumi.String("multi-az"),
			ProjectName:  pulumi.String("default"),
			Tags: tos.BucketTagArray{
				&tos.BucketTagArgs{
					Key:   pulumi.String("k1"),
					Value: pulumi.String("v1"),
				},
			},
		})
		if err != nil {
			return err
		}
		fooKeyring, err := kms.NewKeyring(ctx, "fooKeyring", &kms.KeyringArgs{
			KeyringName: pulumi.String("acc-test-keyring"),
			Description: pulumi.String("acc-test"),
			ProjectName: pulumi.String("default"),
		})
		if err != nil {
			return err
		}
		_, err = tos.NewBucketEncryption(ctx, "fooBucketEncryption", &tos.BucketEncryptionArgs{
			BucketName: fooBucket.ID(),
			Rule: &tos.BucketEncryptionRuleArgs{
				ApplyServerSideEncryptionByDefault: &tos.BucketEncryptionRuleApplyServerSideEncryptionByDefaultArgs{
					SseAlgorithm:      pulumi.String("kms"),
					KmsDataEncryption: pulumi.String("AES256"),
					KmsMasterKeyId:    fooKeyring.ID(),
				},
			},
		})
		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 fooBucket = new Volcengine.Tos.Bucket("fooBucket", new()
    {
        BucketName = "tf-acc-test-bucket",
        PublicAcl = "private",
        AzRedundancy = "multi-az",
        ProjectName = "default",
        Tags = new[]
        {
            new Volcengine.Tos.Inputs.BucketTagArgs
            {
                Key = "k1",
                Value = "v1",
            },
        },
    });

    var fooKeyring = new Volcengine.Kms.Keyring("fooKeyring", new()
    {
        KeyringName = "acc-test-keyring",
        Description = "acc-test",
        ProjectName = "default",
    });

    var fooBucketEncryption = new Volcengine.Tos.BucketEncryption("fooBucketEncryption", new()
    {
        BucketName = fooBucket.Id,
        Rule = new Volcengine.Tos.Inputs.BucketEncryptionRuleArgs
        {
            ApplyServerSideEncryptionByDefault = new Volcengine.Tos.Inputs.BucketEncryptionRuleApplyServerSideEncryptionByDefaultArgs
            {
                SseAlgorithm = "kms",
                KmsDataEncryption = "AES256",
                KmsMasterKeyId = fooKeyring.Id,
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.volcengine.tos.Bucket;
import com.pulumi.volcengine.tos.BucketArgs;
import com.pulumi.volcengine.tos.inputs.BucketTagArgs;
import com.pulumi.volcengine.kms.Keyring;
import com.pulumi.volcengine.kms.KeyringArgs;
import com.pulumi.volcengine.tos.BucketEncryption;
import com.pulumi.volcengine.tos.BucketEncryptionArgs;
import com.pulumi.volcengine.tos.inputs.BucketEncryptionRuleArgs;
import com.pulumi.volcengine.tos.inputs.BucketEncryptionRuleApplyServerSideEncryptionByDefaultArgs;
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 fooBucket = new Bucket("fooBucket", BucketArgs.builder()        
            .bucketName("tf-acc-test-bucket")
            .publicAcl("private")
            .azRedundancy("multi-az")
            .projectName("default")
            .tags(BucketTagArgs.builder()
                .key("k1")
                .value("v1")
                .build())
            .build());

        var fooKeyring = new Keyring("fooKeyring", KeyringArgs.builder()        
            .keyringName("acc-test-keyring")
            .description("acc-test")
            .projectName("default")
            .build());

        var fooBucketEncryption = new BucketEncryption("fooBucketEncryption", BucketEncryptionArgs.builder()        
            .bucketName(fooBucket.id())
            .rule(BucketEncryptionRuleArgs.builder()
                .applyServerSideEncryptionByDefault(BucketEncryptionRuleApplyServerSideEncryptionByDefaultArgs.builder()
                    .sseAlgorithm("kms")
                    .kmsDataEncryption("AES256")
                    .kmsMasterKeyId(fooKeyring.id())
                    .build())
                .build())
            .build());

    }
}

    resources:
  fooBucket:
    type: volcengine:tos:Bucket
    properties:
      bucketName: tf-acc-test-bucket
      publicAcl: private
      azRedundancy: multi-az
      projectName: default
      tags:
        - key: k1
          value: v1
  fooKeyring:
    type: volcengine:kms:Keyring
    properties:
      keyringName: acc-test-keyring
      description: acc-test
      projectName: default
  fooBucketEncryption:
    type: volcengine:tos:BucketEncryption
    properties:
      bucketName: ${fooBucket.id}
      rule:
        applyServerSideEncryptionByDefault:
          sseAlgorithm: kms
          kmsDataEncryption: AES256
          kmsMasterKeyId: ${fooKeyring.id}

    Create BucketEncryption Resource

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

    Constructor syntax

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

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

    type: volcengine:tos:BucketEncryption
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 BucketEncryptionArgs
    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 BucketEncryptionArgs
    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 BucketEncryptionArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args BucketEncryptionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args BucketEncryptionArgs
    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 bucketEncryptionResource = new Volcengine.Tos.BucketEncryption("bucketEncryptionResource", new()
{
    BucketName = "string",
    Rule = new Volcengine.Tos.Inputs.BucketEncryptionRuleArgs
    {
        ApplyServerSideEncryptionByDefault = new Volcengine.Tos.Inputs.BucketEncryptionRuleApplyServerSideEncryptionByDefaultArgs
        {
            SseAlgorithm = "string",
            KmsDataEncryption = "string",
            KmsMasterKeyId = "string",
        },
    },
});

    example, err := tos.NewBucketEncryption(ctx, "bucketEncryptionResource", &tos.BucketEncryptionArgs{
	BucketName: pulumi.String("string"),
	Rule: &tos.BucketEncryptionRuleArgs{
		ApplyServerSideEncryptionByDefault: &tos.BucketEncryptionRuleApplyServerSideEncryptionByDefaultArgs{
			SseAlgorithm:      pulumi.String("string"),
			KmsDataEncryption: pulumi.String("string"),
			KmsMasterKeyId:    pulumi.String("string"),
		},
	},
})

    var bucketEncryptionResource = new BucketEncryption("bucketEncryptionResource", BucketEncryptionArgs.builder()
    .bucketName("string")
    .rule(BucketEncryptionRuleArgs.builder()
        .applyServerSideEncryptionByDefault(BucketEncryptionRuleApplyServerSideEncryptionByDefaultArgs.builder()
            .sseAlgorithm("string")
            .kmsDataEncryption("string")
            .kmsMasterKeyId("string")
            .build())
        .build())
    .build());

    bucket_encryption_resource = volcengine.tos.BucketEncryption("bucketEncryptionResource",
    bucket_name="string",
    rule={
        "apply_server_side_encryption_by_default": {
            "sse_algorithm": "string",
            "kms_data_encryption": "string",
            "kms_master_key_id": "string",
        },
    })

    const bucketEncryptionResource = new volcengine.tos.BucketEncryption("bucketEncryptionResource", {
    bucketName: "string",
    rule: {
        applyServerSideEncryptionByDefault: {
            sseAlgorithm: "string",
            kmsDataEncryption: "string",
            kmsMasterKeyId: "string",
        },
    },
});

    type: volcengine:tos:BucketEncryption
properties:
    bucketName: string
    rule:
        applyServerSideEncryptionByDefault:
            kmsDataEncryption: string
            kmsMasterKeyId: string
            sseAlgorithm: string

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

    BucketName string
    The name of the bucket.
    Rule BucketEncryptionRule
    The rule of the bucket encryption.
    BucketName string
    The name of the bucket.
    Rule BucketEncryptionRuleArgs
    The rule of the bucket encryption.
    bucketName String
    The name of the bucket.
    rule BucketEncryptionRule
    The rule of the bucket encryption.
    bucketName string
    The name of the bucket.
    rule BucketEncryptionRule
    The rule of the bucket encryption.
    bucket_name str
    The name of the bucket.
    rule BucketEncryptionRuleArgs
    The rule of the bucket encryption.
    bucketName String
    The name of the bucket.
    rule Property Map
    The rule of the bucket encryption.

    Outputs

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

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

    Supporting Types

    BucketEncryptionRule, BucketEncryptionRuleArgs

    applyServerSideEncryptionByDefault Property Map
    The server side encryption configuration.

    BucketEncryptionRuleApplyServerSideEncryptionByDefault, BucketEncryptionRuleApplyServerSideEncryptionByDefaultArgs

    SseAlgorithm string
    The server side encryption algorithm. Valid values: kms, AES256, SM4.
    KmsDataEncryption string
    The kms data encryption. Valid values: AES256, SM4. Default is AES256.
    KmsMasterKeyId string
    The kms master key id. This field is required when sse_algorithm is kms. The format is trn:kms:<region>:<accountID>:keyrings/<keyring>/keys/<key>.
    SseAlgorithm string
    The server side encryption algorithm. Valid values: kms, AES256, SM4.
    KmsDataEncryption string
    The kms data encryption. Valid values: AES256, SM4. Default is AES256.
    KmsMasterKeyId string
    The kms master key id. This field is required when sse_algorithm is kms. The format is trn:kms:<region>:<accountID>:keyrings/<keyring>/keys/<key>.
    sseAlgorithm String
    The server side encryption algorithm. Valid values: kms, AES256, SM4.
    kmsDataEncryption String
    The kms data encryption. Valid values: AES256, SM4. Default is AES256.
    kmsMasterKeyId String
    The kms master key id. This field is required when sse_algorithm is kms. The format is trn:kms:<region>:<accountID>:keyrings/<keyring>/keys/<key>.
    sseAlgorithm string
    The server side encryption algorithm. Valid values: kms, AES256, SM4.
    kmsDataEncryption string
    The kms data encryption. Valid values: AES256, SM4. Default is AES256.
    kmsMasterKeyId string
    The kms master key id. This field is required when sse_algorithm is kms. The format is trn:kms:<region>:<accountID>:keyrings/<keyring>/keys/<key>.
    sse_algorithm str
    The server side encryption algorithm. Valid values: kms, AES256, SM4.
    kms_data_encryption str
    The kms data encryption. Valid values: AES256, SM4. Default is AES256.
    kms_master_key_id str
    The kms master key id. This field is required when sse_algorithm is kms. The format is trn:kms:<region>:<accountID>:keyrings/<keyring>/keys/<key>.
    sseAlgorithm String
    The server side encryption algorithm. Valid values: kms, AES256, SM4.
    kmsDataEncryption String
    The kms data encryption. Valid values: AES256, SM4. Default is AES256.
    kmsMasterKeyId String
    The kms master key id. This field is required when sse_algorithm is kms. The format is trn:kms:<region>:<accountID>:keyrings/<keyring>/keys/<key>.

    Import

    TosBucketEncryption can be imported using the id, e.g.

    $ pulumi import volcengine:tos/bucketEncryption:BucketEncryption default resource_id

    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.35 published on Friday, Aug 29, 2025 by Volcengine
    volcengine/pulumi-volcengine