1. Packages
  2. Packages
  3. Volcenginecc Provider
  4. API Docs
  5. kms
  6. getKeyRing
Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine
volcenginecc logo
Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine

    Data Source schema for Volcengine::KMS::KeyRing

    Using getKeyRing

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getKeyRing(args: GetKeyRingArgs, opts?: InvokeOptions): Promise<GetKeyRingResult>
    function getKeyRingOutput(args: GetKeyRingOutputArgs, opts?: InvokeOptions): Output<GetKeyRingResult>
    def get_key_ring(id: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetKeyRingResult
    def get_key_ring_output(id: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetKeyRingResult]
    func LookupKeyRing(ctx *Context, args *LookupKeyRingArgs, opts ...InvokeOption) (*LookupKeyRingResult, error)
    func LookupKeyRingOutput(ctx *Context, args *LookupKeyRingOutputArgs, opts ...InvokeOption) LookupKeyRingResultOutput

    > Note: This function is named LookupKeyRing in the Go SDK.

    public static class GetKeyRing 
    {
        public static Task<GetKeyRingResult> InvokeAsync(GetKeyRingArgs args, InvokeOptions? opts = null)
        public static Output<GetKeyRingResult> Invoke(GetKeyRingInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetKeyRingResult> getKeyRing(GetKeyRingArgs args, InvokeOptions options)
    public static Output<GetKeyRingResult> getKeyRing(GetKeyRingArgs args, InvokeOptions options)
    
    fn::invoke:
      function: volcenginecc:kms/getKeyRing:getKeyRing
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Id string
    Uniquely identifies the resource.
    Id string
    Uniquely identifies the resource.
    id String
    Uniquely identifies the resource.
    id string
    Uniquely identifies the resource.
    id str
    Uniquely identifies the resource.
    id String
    Uniquely identifies the resource.

    getKeyRing Result

    The following output properties are available:

    CreateDate int
    Keyring creation date
    Description string
    Keyring description, length: 0–8192 characters
    Id string
    Uniquely identifies the resource.
    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
    Id string
    Uniquely identifies the resource.
    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
    id String
    Uniquely identifies the resource.
    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
    id string
    Uniquely identifies the resource.
    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
    id str
    Uniquely identifies the resource.
    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
    id String
    Uniquely identifies the resource.
    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

    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
      Try Pulumi Cloud free. Your team will thank you.