1. Packages
  2. Bytepluscc Provider
  3. API Docs
  4. kms
  5. getKeyRing
Viewing docs for bytepluscc v0.0.16
published on Monday, Mar 9, 2026 by Byteplus
bytepluscc logo
Viewing docs for bytepluscc v0.0.16
published on Monday, Mar 9, 2026 by Byteplus

    Data Source schema for Byteplus::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: bytepluscc: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
    密钥环创建日期。
    Description string
    密钥环描述,长度为 0 - 8192 个字符。
    Id string
    Uniquely identifies the resource.
    KeyCount int
    密钥环密钥次数。
    KeyRingId string
    密钥环唯一标识符,UUID形式。
    KeyringName string
    密钥环名称,长度为 2 - 31 个字符。合法字符:[a-zA-Z0-9-_]。
    KeyringType string
    密钥环类型,取值:CustomKeyring。
    ProjectName string
    项目名称,默认值:default。
    Uid string
    密钥环租户ID。
    UpdateDate int
    密钥环更新日期。
    CreateDate int
    密钥环创建日期。
    Description string
    密钥环描述,长度为 0 - 8192 个字符。
    Id string
    Uniquely identifies the resource.
    KeyCount int
    密钥环密钥次数。
    KeyRingId string
    密钥环唯一标识符,UUID形式。
    KeyringName string
    密钥环名称,长度为 2 - 31 个字符。合法字符:[a-zA-Z0-9-_]。
    KeyringType string
    密钥环类型,取值:CustomKeyring。
    ProjectName string
    项目名称,默认值:default。
    Uid string
    密钥环租户ID。
    UpdateDate int
    密钥环更新日期。
    createDate Integer
    密钥环创建日期。
    description String
    密钥环描述,长度为 0 - 8192 个字符。
    id String
    Uniquely identifies the resource.
    keyCount Integer
    密钥环密钥次数。
    keyRingId String
    密钥环唯一标识符,UUID形式。
    keyringName String
    密钥环名称,长度为 2 - 31 个字符。合法字符:[a-zA-Z0-9-_]。
    keyringType String
    密钥环类型,取值:CustomKeyring。
    projectName String
    项目名称,默认值:default。
    uid String
    密钥环租户ID。
    updateDate Integer
    密钥环更新日期。
    createDate number
    密钥环创建日期。
    description string
    密钥环描述,长度为 0 - 8192 个字符。
    id string
    Uniquely identifies the resource.
    keyCount number
    密钥环密钥次数。
    keyRingId string
    密钥环唯一标识符,UUID形式。
    keyringName string
    密钥环名称,长度为 2 - 31 个字符。合法字符:[a-zA-Z0-9-_]。
    keyringType string
    密钥环类型,取值:CustomKeyring。
    projectName string
    项目名称,默认值:default。
    uid string
    密钥环租户ID。
    updateDate number
    密钥环更新日期。
    create_date int
    密钥环创建日期。
    description str
    密钥环描述,长度为 0 - 8192 个字符。
    id str
    Uniquely identifies the resource.
    key_count int
    密钥环密钥次数。
    key_ring_id str
    密钥环唯一标识符,UUID形式。
    keyring_name str
    密钥环名称,长度为 2 - 31 个字符。合法字符:[a-zA-Z0-9-_]。
    keyring_type str
    密钥环类型,取值:CustomKeyring。
    project_name str
    项目名称,默认值:default。
    uid str
    密钥环租户ID。
    update_date int
    密钥环更新日期。
    createDate Number
    密钥环创建日期。
    description String
    密钥环描述,长度为 0 - 8192 个字符。
    id String
    Uniquely identifies the resource.
    keyCount Number
    密钥环密钥次数。
    keyRingId String
    密钥环唯一标识符,UUID形式。
    keyringName String
    密钥环名称,长度为 2 - 31 个字符。合法字符:[a-zA-Z0-9-_]。
    keyringType String
    密钥环类型,取值:CustomKeyring。
    projectName String
    项目名称,默认值:default。
    uid String
    密钥环租户ID。
    updateDate Number
    密钥环更新日期。

    Package Details

    Repository
    bytepluscc byteplus-sdk/pulumi-bytepluscc
    License
    MPL-2.0
    Notes
    This Pulumi package is based on the bytepluscc Terraform Provider.
    bytepluscc logo
    Viewing docs for bytepluscc v0.0.16
    published on Monday, Mar 9, 2026 by Byteplus
      Try Pulumi Cloud free. Your team will thank you.