Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. Volcengine
  3. API Docs
  4. kms
  5. Keyring
Volcengine v0.0.34 published on Wednesday, Jul 2, 2025 by Volcengine
volcengine/pulumi-volcengine

volcengine.kms.Keyring

Explore with Pulumi AI

volcengine logo
Volcengine v0.0.34 published on Wednesday, Jul 2, 2025 by Volcengine
volcengine/pulumi-volcengine

    Provides a resource to manage kms keyring

    Example Usage

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

const foo = new volcengine.kms.Keyring("foo", {
    description: "tf-test",
    keyringName: "tf-test",
    projectName: "default",
});

    import pulumi
import pulumi_volcengine as volcengine

foo = volcengine.kms.Keyring("foo",
    description="tf-test",
    keyring_name="tf-test",
    project_name="default")

    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.NewKeyring(ctx, "foo", &kms.KeyringArgs{
			Description: pulumi.String("tf-test"),
			KeyringName: pulumi.String("tf-test"),
			ProjectName: pulumi.String("default"),
		})
		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.Kms.Keyring("foo", new()
    {
        Description = "tf-test",
        KeyringName = "tf-test",
        ProjectName = "default",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.volcengine.kms.Keyring;
import com.pulumi.volcengine.kms.KeyringArgs;
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 Keyring("foo", KeyringArgs.builder()        
            .description("tf-test")
            .keyringName("tf-test")
            .projectName("default")
            .build());

    }
}

    resources:
  foo:
    type: volcengine:kms:Keyring
    properties:
      description: tf-test
      keyringName: tf-test
      projectName: default

    Create Keyring Resource

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

    Constructor syntax

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

@overload
def Keyring(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            keyring_name: Optional[str] = None,
            description: Optional[str] = None,
            keyring_type: Optional[str] = None,
            project_name: Optional[str] = None)
    func NewKeyring(ctx *Context, name string, args KeyringArgs, opts ...ResourceOption) (*Keyring, error)
    public Keyring(string name, KeyringArgs args, CustomResourceOptions? opts = null)
    public Keyring(String name, KeyringArgs args)
public Keyring(String name, KeyringArgs args, CustomResourceOptions options)

    type: volcengine:kms:Keyring
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 KeyringArgs
    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 KeyringArgs
    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 KeyringArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args KeyringArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args KeyringArgs
    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 keyringResource = new Volcengine.Kms.Keyring("keyringResource", new()
{
    KeyringName = "string",
    Description = "string",
    KeyringType = "string",
    ProjectName = "string",
});

    example, err := kms.NewKeyring(ctx, "keyringResource", &kms.KeyringArgs{
	KeyringName: pulumi.String("string"),
	Description: pulumi.String("string"),
	KeyringType: pulumi.String("string"),
	ProjectName: pulumi.String("string"),
})

    var keyringResource = new Keyring("keyringResource", KeyringArgs.builder()
    .keyringName("string")
    .description("string")
    .keyringType("string")
    .projectName("string")
    .build());

    keyring_resource = volcengine.kms.Keyring("keyringResource",
    keyring_name="string",
    description="string",
    keyring_type="string",
    project_name="string")

    const keyringResource = new volcengine.kms.Keyring("keyringResource", {
    keyringName: "string",
    description: "string",
    keyringType: "string",
    projectName: "string",
});

    type: volcengine:kms:Keyring
properties:
    description: string
    keyringName: string
    keyringType: string
    projectName: string

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

    KeyringName string
    The name of the keyring.
    Description string
    The description of the keyring.
    KeyringType string
    The type of the keyring.
    ProjectName string
    The name of the project.
    KeyringName string
    The name of the keyring.
    Description string
    The description of the keyring.
    KeyringType string
    The type of the keyring.
    ProjectName string
    The name of the project.
    keyringName String
    The name of the keyring.
    description String
    The description of the keyring.
    keyringType String
    The type of the keyring.
    projectName String
    The name of the project.
    keyringName string
    The name of the keyring.
    description string
    The description of the keyring.
    keyringType string
    The type of the keyring.
    projectName string
    The name of the project.
    keyring_name str
    The name of the keyring.
    description str
    The description of the keyring.
    keyring_type str
    The type of the keyring.
    project_name str
    The name of the project.
    keyringName String
    The name of the keyring.
    description String
    The description of the keyring.
    keyringType String
    The type of the keyring.
    projectName String
    The name of the project.

    Outputs

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

    CreationDate int
    The date when the keyring was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    Trn string
    The information about the tenant resource name (TRN).
    Uid string
    The tenant ID of the keyring.
    UpdateDate int
    The date when the keyring was updated.
    CreationDate int
    The date when the keyring was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    Trn string
    The information about the tenant resource name (TRN).
    Uid string
    The tenant ID of the keyring.
    UpdateDate int
    The date when the keyring was updated.
    creationDate Integer
    The date when the keyring was created.
    id String
    The provider-assigned unique ID for this managed resource.
    trn String
    The information about the tenant resource name (TRN).
    uid String
    The tenant ID of the keyring.
    updateDate Integer
    The date when the keyring was updated.
    creationDate number
    The date when the keyring was created.
    id string
    The provider-assigned unique ID for this managed resource.
    trn string
    The information about the tenant resource name (TRN).
    uid string
    The tenant ID of the keyring.
    updateDate number
    The date when the keyring was updated.
    creation_date int
    The date when the keyring was created.
    id str
    The provider-assigned unique ID for this managed resource.
    trn str
    The information about the tenant resource name (TRN).
    uid str
    The tenant ID of the keyring.
    update_date int
    The date when the keyring was updated.
    creationDate Number
    The date when the keyring was created.
    id String
    The provider-assigned unique ID for this managed resource.
    trn String
    The information about the tenant resource name (TRN).
    uid String
    The tenant ID of the keyring.
    updateDate Number
    The date when the keyring was updated.

    Look up Existing Keyring Resource

    Get an existing Keyring 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?: KeyringState, opts?: CustomResourceOptions): Keyring
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        creation_date: Optional[int] = None,
        description: Optional[str] = None,
        keyring_name: Optional[str] = None,
        keyring_type: Optional[str] = None,
        project_name: Optional[str] = None,
        trn: Optional[str] = None,
        uid: Optional[str] = None,
        update_date: Optional[int] = None) -> Keyring
    func GetKeyring(ctx *Context, name string, id IDInput, state *KeyringState, opts ...ResourceOption) (*Keyring, error)
    public static Keyring Get(string name, Input<string> id, KeyringState? state, CustomResourceOptions? opts = null)
    public static Keyring get(String name, Output<String> id, KeyringState state, CustomResourceOptions options)
    resources:  _:    type: volcengine:kms:Keyring    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:
    CreationDate int
    The date when the keyring was created.
    Description string
    The description of the keyring.
    KeyringName string
    The name of the keyring.
    KeyringType string
    The type of the keyring.
    ProjectName string
    The name of the project.
    Trn string
    The information about the tenant resource name (TRN).
    Uid string
    The tenant ID of the keyring.
    UpdateDate int
    The date when the keyring was updated.
    CreationDate int
    The date when the keyring was created.
    Description string
    The description of the keyring.
    KeyringName string
    The name of the keyring.
    KeyringType string
    The type of the keyring.
    ProjectName string
    The name of the project.
    Trn string
    The information about the tenant resource name (TRN).
    Uid string
    The tenant ID of the keyring.
    UpdateDate int
    The date when the keyring was updated.
    creationDate Integer
    The date when the keyring was created.
    description String
    The description of the keyring.
    keyringName String
    The name of the keyring.
    keyringType String
    The type of the keyring.
    projectName String
    The name of the project.
    trn String
    The information about the tenant resource name (TRN).
    uid String
    The tenant ID of the keyring.
    updateDate Integer
    The date when the keyring was updated.
    creationDate number
    The date when the keyring was created.
    description string
    The description of the keyring.
    keyringName string
    The name of the keyring.
    keyringType string
    The type of the keyring.
    projectName string
    The name of the project.
    trn string
    The information about the tenant resource name (TRN).
    uid string
    The tenant ID of the keyring.
    updateDate number
    The date when the keyring was updated.
    creation_date int
    The date when the keyring was created.
    description str
    The description of the keyring.
    keyring_name str
    The name of the keyring.
    keyring_type str
    The type of the keyring.
    project_name str
    The name of the project.
    trn str
    The information about the tenant resource name (TRN).
    uid str
    The tenant ID of the keyring.
    update_date int
    The date when the keyring was updated.
    creationDate Number
    The date when the keyring was created.
    description String
    The description of the keyring.
    keyringName String
    The name of the keyring.
    keyringType String
    The type of the keyring.
    projectName String
    The name of the project.
    trn String
    The information about the tenant resource name (TRN).
    uid String
    The tenant ID of the keyring.
    updateDate Number
    The date when the keyring was updated.

    Import

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

    $ pulumi import volcengine:kms/keyring:Keyring 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.34 published on Wednesday, Jul 2, 2025 by Volcengine
    volcengine/pulumi-volcengine