1. Packages
  2. Volcengine
  3. API Docs
  4. kms
  5. SecretBackup
Volcengine v0.0.46 published on Friday, Feb 27, 2026 by Volcengine
volcengine logo
Volcengine v0.0.46 published on Friday, Feb 27, 2026 by Volcengine

    Provides a resource to manage kms secret backup

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as volcengine from "@volcengine/pulumi";
    
    const _default = new volcengine.kms.SecretBackup("default", {secretName: "Test-1"});
    
    import pulumi
    import pulumi_volcengine as volcengine
    
    default = volcengine.kms.SecretBackup("default", secret_name="Test-1")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    	"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/kms"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := kms.NewSecretBackup(ctx, "default", &kms.SecretBackupArgs{
    			SecretName: pulumi.String("Test-1"),
    		})
    		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 @default = new Volcengine.Kms.SecretBackup("default", new()
        {
            SecretName = "Test-1",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.volcengine.kms.SecretBackup;
    import com.pulumi.volcengine.kms.SecretBackupArgs;
    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 default_ = new SecretBackup("default", SecretBackupArgs.builder()        
                .secretName("Test-1")
                .build());
    
        }
    }
    
    resources:
      default:
        type: volcengine:kms:SecretBackup
        properties:
          secretName: Test-1
    

    Create SecretBackup Resource

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

    Constructor syntax

    new SecretBackup(name: string, args: SecretBackupArgs, opts?: CustomResourceOptions);
    @overload
    def SecretBackup(resource_name: str,
                     args: SecretBackupArgs,
                     opts: Optional[ResourceOptions] = None)
    
    @overload
    def SecretBackup(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     secret_name: Optional[str] = None)
    func NewSecretBackup(ctx *Context, name string, args SecretBackupArgs, opts ...ResourceOption) (*SecretBackup, error)
    public SecretBackup(string name, SecretBackupArgs args, CustomResourceOptions? opts = null)
    public SecretBackup(String name, SecretBackupArgs args)
    public SecretBackup(String name, SecretBackupArgs args, CustomResourceOptions options)
    
    type: volcengine:kms:SecretBackup
    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 SecretBackupArgs
    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 SecretBackupArgs
    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 SecretBackupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SecretBackupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SecretBackupArgs
    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 secretBackupResource = new Volcengine.Kms.SecretBackup("secretBackupResource", new()
    {
        SecretName = "string",
    });
    
    example, err := kms.NewSecretBackup(ctx, "secretBackupResource", &kms.SecretBackupArgs{
    	SecretName: pulumi.String("string"),
    })
    
    var secretBackupResource = new SecretBackup("secretBackupResource", SecretBackupArgs.builder()
        .secretName("string")
        .build());
    
    secret_backup_resource = volcengine.kms.SecretBackup("secretBackupResource", secret_name="string")
    
    const secretBackupResource = new volcengine.kms.SecretBackup("secretBackupResource", {secretName: "string"});
    
    type: volcengine:kms:SecretBackup
    properties:
        secretName: string
    

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

    SecretName string
    The name of the secret to backup.
    SecretName string
    The name of the secret to backup.
    secretName String
    The name of the secret to backup.
    secretName string
    The name of the secret to backup.
    secret_name str
    The name of the secret to backup.
    secretName String
    The name of the secret to backup.

    Outputs

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

    BackupData string
    The full backup data of the secret. JSON format.
    Id string
    The provider-assigned unique ID for this managed resource.
    SecretDataKey string
    The ciphertext of the data key used to encrypt the secret value, Base64 encoded.
    Signature string
    The signature of the backup_data. Base64 encoded.
    BackupData string
    The full backup data of the secret. JSON format.
    Id string
    The provider-assigned unique ID for this managed resource.
    SecretDataKey string
    The ciphertext of the data key used to encrypt the secret value, Base64 encoded.
    Signature string
    The signature of the backup_data. Base64 encoded.
    backupData String
    The full backup data of the secret. JSON format.
    id String
    The provider-assigned unique ID for this managed resource.
    secretDataKey String
    The ciphertext of the data key used to encrypt the secret value, Base64 encoded.
    signature String
    The signature of the backup_data. Base64 encoded.
    backupData string
    The full backup data of the secret. JSON format.
    id string
    The provider-assigned unique ID for this managed resource.
    secretDataKey string
    The ciphertext of the data key used to encrypt the secret value, Base64 encoded.
    signature string
    The signature of the backup_data. Base64 encoded.
    backup_data str
    The full backup data of the secret. JSON format.
    id str
    The provider-assigned unique ID for this managed resource.
    secret_data_key str
    The ciphertext of the data key used to encrypt the secret value, Base64 encoded.
    signature str
    The signature of the backup_data. Base64 encoded.
    backupData String
    The full backup data of the secret. JSON format.
    id String
    The provider-assigned unique ID for this managed resource.
    secretDataKey String
    The ciphertext of the data key used to encrypt the secret value, Base64 encoded.
    signature String
    The signature of the backup_data. Base64 encoded.

    Look up Existing SecretBackup Resource

    Get an existing SecretBackup 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?: SecretBackupState, opts?: CustomResourceOptions): SecretBackup
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            backup_data: Optional[str] = None,
            secret_data_key: Optional[str] = None,
            secret_name: Optional[str] = None,
            signature: Optional[str] = None) -> SecretBackup
    func GetSecretBackup(ctx *Context, name string, id IDInput, state *SecretBackupState, opts ...ResourceOption) (*SecretBackup, error)
    public static SecretBackup Get(string name, Input<string> id, SecretBackupState? state, CustomResourceOptions? opts = null)
    public static SecretBackup get(String name, Output<String> id, SecretBackupState state, CustomResourceOptions options)
    resources:  _:    type: volcengine:kms:SecretBackup    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:
    BackupData string
    The full backup data of the secret. JSON format.
    SecretDataKey string
    The ciphertext of the data key used to encrypt the secret value, Base64 encoded.
    SecretName string
    The name of the secret to backup.
    Signature string
    The signature of the backup_data. Base64 encoded.
    BackupData string
    The full backup data of the secret. JSON format.
    SecretDataKey string
    The ciphertext of the data key used to encrypt the secret value, Base64 encoded.
    SecretName string
    The name of the secret to backup.
    Signature string
    The signature of the backup_data. Base64 encoded.
    backupData String
    The full backup data of the secret. JSON format.
    secretDataKey String
    The ciphertext of the data key used to encrypt the secret value, Base64 encoded.
    secretName String
    The name of the secret to backup.
    signature String
    The signature of the backup_data. Base64 encoded.
    backupData string
    The full backup data of the secret. JSON format.
    secretDataKey string
    The ciphertext of the data key used to encrypt the secret value, Base64 encoded.
    secretName string
    The name of the secret to backup.
    signature string
    The signature of the backup_data. Base64 encoded.
    backup_data str
    The full backup data of the secret. JSON format.
    secret_data_key str
    The ciphertext of the data key used to encrypt the secret value, Base64 encoded.
    secret_name str
    The name of the secret to backup.
    signature str
    The signature of the backup_data. Base64 encoded.
    backupData String
    The full backup data of the secret. JSON format.
    secretDataKey String
    The ciphertext of the data key used to encrypt the secret value, Base64 encoded.
    secretName String
    The name of the secret to backup.
    signature String
    The signature of the backup_data. Base64 encoded.

    Import

    KmsSecretBackup can be imported using the secret_name, e.g.

    $ pulumi import volcengine:kms/secretBackup:SecretBackup default ecs-secret-test
    

    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.46 published on Friday, Feb 27, 2026 by Volcengine
      Meet Neo: Your AI Platform Teammate