1. Packages
  2. Packages
  3. Volcenginecc Provider
  4. API Docs
  5. kms
  6. KeyRing
Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcenginecc

volcenginecc.kms.KeyRing

volcenginecc logo
Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcenginecc

    A collection for managing user keys; users place keys of the same type or purpose in the same keyring for easier management

    Example Usage

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

const kmskeyringDemo = new volcenginecc.kms.KeyRing("kmskeyringDemo", {
    description: "this is a test update",
    keyringName: "ccapi-test",
    keyringType: "CustomKeyring",
    projectName: "default",
});

    import pulumi
import pulumi_volcenginecc as volcenginecc

kmskeyring_demo = volcenginecc.kms.KeyRing("kmskeyringDemo",
    description="this is a test update",
    keyring_name="ccapi-test",
    keyring_type="CustomKeyring",
    project_name="default")

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := kms.NewKeyRing(ctx, "kmskeyringDemo", &kms.KeyRingArgs{
			Description: pulumi.String("this is a test update"),
			KeyringName: pulumi.String("ccapi-test"),
			KeyringType: pulumi.String("CustomKeyring"),
			ProjectName: pulumi.String("default"),
		})
		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 kmskeyringDemo = new Volcenginecc.Kms.KeyRing("kmskeyringDemo", new()
    {
        Description = "this is a test update",
        KeyringName = "ccapi-test",
        KeyringType = "CustomKeyring",
        ProjectName = "default",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.volcengine.volcenginecc.kms.KeyRing;
import com.volcengine.volcenginecc.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 kmskeyringDemo = new KeyRing("kmskeyringDemo", KeyRingArgs.builder()
            .description("this is a test update")
            .keyringName("ccapi-test")
            .keyringType("CustomKeyring")
            .projectName("default")
            .build());

    }
}

    resources:
  kmskeyringDemo:
    type: volcenginecc:kms:KeyRing
    properties:
      description: this is a test update
      keyringName: ccapi-test
      keyringType: CustomKeyring
      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: volcenginecc: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 Volcenginecc.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());

    key_ring_resource = volcenginecc.kms.KeyRing("keyRingResource",
    keyring_name="string",
    description="string",
    keyring_type="string",
    project_name="string")

    const keyRingResource = new volcenginecc.kms.KeyRing("keyRingResource", {
    keyringName: "string",
    description: "string",
    keyringType: "string",
    projectName: "string",
});

    type: volcenginecc: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
    Keyring name, length: 2–31 characters. Valid characters: [a-zA-Z0-9-_]
    Description string
    Keyring description, length: 0–8192 characters
    KeyringType string
    Keyring type, value: CustomKeyring
    ProjectName string
    Project name, default value: default
    KeyringName string
    Keyring name, length: 2–31 characters. Valid characters: [a-zA-Z0-9-_]
    Description string
    Keyring description, length: 0–8192 characters
    KeyringType string
    Keyring type, value: CustomKeyring
    ProjectName string
    Project name, default value: default
    keyringName String
    Keyring name, length: 2–31 characters. Valid characters: [a-zA-Z0-9-_]
    description String
    Keyring description, length: 0–8192 characters
    keyringType String
    Keyring type, value: CustomKeyring
    projectName String
    Project name, default value: default
    keyringName string
    Keyring name, length: 2–31 characters. Valid characters: [a-zA-Z0-9-_]
    description string
    Keyring description, length: 0–8192 characters
    keyringType string
    Keyring type, value: CustomKeyring
    projectName string
    Project name, default value: default
    keyring_name str
    Keyring name, length: 2–31 characters. Valid characters: [a-zA-Z0-9-_]
    description str
    Keyring description, length: 0–8192 characters
    keyring_type str
    Keyring type, value: CustomKeyring
    project_name str
    Project name, default value: default
    keyringName String
    Keyring name, length: 2–31 characters. Valid characters: [a-zA-Z0-9-_]
    description String
    Keyring description, length: 0–8192 characters
    keyringType String
    Keyring type, value: CustomKeyring
    projectName String
    Project name, default value: default

    Outputs

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

    CreateDate int
    Keyring creation date
    Id string
    The provider-assigned unique ID for this managed resource.
    KeyCount int
    Number of keys in keyring
    KeyRingId string
    Keyring unique identifier, in UUID format
    Uid string
    Keyring tenant ID
    UpdateDate int
    Keyring update date
    CreateDate int
    Keyring creation date
    Id string
    The provider-assigned unique ID for this managed resource.
    KeyCount int
    Number of keys in keyring
    KeyRingId string
    Keyring unique identifier, in UUID format
    Uid string
    Keyring tenant ID
    UpdateDate int
    Keyring update date
    createDate Integer
    Keyring creation date
    id String
    The provider-assigned unique ID for this managed resource.
    keyCount Integer
    Number of keys in keyring
    keyRingId String
    Keyring unique identifier, in UUID format
    uid String
    Keyring tenant ID
    updateDate Integer
    Keyring update date
    createDate number
    Keyring creation date
    id string
    The provider-assigned unique ID for this managed resource.
    keyCount number
    Number of keys in keyring
    keyRingId string
    Keyring unique identifier, in UUID format
    uid string
    Keyring tenant ID
    updateDate number
    Keyring update date
    create_date int
    Keyring creation date
    id str
    The provider-assigned unique ID for this managed resource.
    key_count int
    Number of keys in keyring
    key_ring_id str
    Keyring unique identifier, in UUID format
    uid str
    Keyring tenant ID
    update_date int
    Keyring update date
    createDate Number
    Keyring creation date
    id String
    The provider-assigned unique ID for this managed resource.
    keyCount Number
    Number of keys in keyring
    keyRingId String
    Keyring unique identifier, in UUID format
    uid String
    Keyring tenant ID
    updateDate Number
    Keyring update date

    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,
        create_date: Optional[int] = None,
        description: Optional[str] = None,
        key_count: Optional[int] = None,
        key_ring_id: Optional[str] = None,
        keyring_name: Optional[str] = None,
        keyring_type: Optional[str] = None,
        project_name: 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: volcenginecc: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:
    CreateDate int
    Keyring creation date
    Description string
    Keyring description, length: 0–8192 characters
    KeyCount int
    Number of keys in keyring
    KeyRingId string
    Keyring unique identifier, in UUID format
    KeyringName string
    Keyring name, length: 2–31 characters. Valid characters: [a-zA-Z0-9-_]
    KeyringType string
    Keyring type, value: CustomKeyring
    ProjectName string
    Project name, default value: default
    Uid string
    Keyring tenant ID
    UpdateDate int
    Keyring update date
    CreateDate int
    Keyring creation date
    Description string
    Keyring description, length: 0–8192 characters
    KeyCount int
    Number of keys in keyring
    KeyRingId string
    Keyring unique identifier, in UUID format
    KeyringName string
    Keyring name, length: 2–31 characters. Valid characters: [a-zA-Z0-9-_]
    KeyringType string
    Keyring type, value: CustomKeyring
    ProjectName string
    Project name, default value: default
    Uid string
    Keyring tenant ID
    UpdateDate int
    Keyring update date
    createDate Integer
    Keyring creation date
    description String
    Keyring description, length: 0–8192 characters
    keyCount Integer
    Number of keys in keyring
    keyRingId String
    Keyring unique identifier, in UUID format
    keyringName String
    Keyring name, length: 2–31 characters. Valid characters: [a-zA-Z0-9-_]
    keyringType String
    Keyring type, value: CustomKeyring
    projectName String
    Project name, default value: default
    uid String
    Keyring tenant ID
    updateDate Integer
    Keyring update date
    createDate number
    Keyring creation date
    description string
    Keyring description, length: 0–8192 characters
    keyCount number
    Number of keys in keyring
    keyRingId string
    Keyring unique identifier, in UUID format
    keyringName string
    Keyring name, length: 2–31 characters. Valid characters: [a-zA-Z0-9-_]
    keyringType string
    Keyring type, value: CustomKeyring
    projectName string
    Project name, default value: default
    uid string
    Keyring tenant ID
    updateDate number
    Keyring update date
    create_date int
    Keyring creation date
    description str
    Keyring description, length: 0–8192 characters
    key_count int
    Number of keys in keyring
    key_ring_id str
    Keyring unique identifier, in UUID format
    keyring_name str
    Keyring name, length: 2–31 characters. Valid characters: [a-zA-Z0-9-_]
    keyring_type str
    Keyring type, value: CustomKeyring
    project_name str
    Project name, default value: default
    uid str
    Keyring tenant ID
    update_date int
    Keyring update date
    createDate Number
    Keyring creation date
    description String
    Keyring description, length: 0–8192 characters
    keyCount Number
    Number of keys in keyring
    keyRingId String
    Keyring unique identifier, in UUID format
    keyringName String
    Keyring name, length: 2–31 characters. Valid characters: [a-zA-Z0-9-_]
    keyringType String
    Keyring type, value: CustomKeyring
    projectName String
    Project name, default value: default
    uid String
    Keyring tenant ID
    updateDate Number
    Keyring update date

    Import

    $ pulumi import volcenginecc:kms/keyRing:KeyRing example "key_ring_id"

    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.32
    published on Thursday, Apr 23, 2026 by Volcengine
    Schema (JSON)
    volcengine/pulumi-volcenginecc
      Try Pulumi Cloud free. Your team will thank you.