1. Registry
  2. Packages
  3. Vkcs Provider
  4. API Docs
  5. getKmsSecret
Viewing docs for vkcs 0.19.0
published on Tuesday, Oct 27, 2026 by vk-cs
vkcs
Viewing docs for vkcs 0.19.0
published on Tuesday, Oct 27, 2026 by vk-cs

    Example Usage

    Using getKmsSecret

    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 getKmsSecret(args: GetKmsSecretArgs, opts?: InvokeOptions): Promise<GetKmsSecretResult>
    function getKmsSecretOutput(args: GetKmsSecretOutputArgs, opts?: InvokeOutputOptions): Output<GetKmsSecretResult>
    def get_kms_secret(path: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetKmsSecretResult
    def get_kms_secret_output(path: pulumi.Input[Optional[str]] = None,
                       opts: Optional[InvokeOutputOptions] = None) -> Output[GetKmsSecretResult]
    func LookupKmsSecret(ctx *Context, args *LookupKmsSecretArgs, opts ...InvokeOption) (*LookupKmsSecretResult, error)
    func LookupKmsSecretOutput(ctx *Context, args *LookupKmsSecretOutputArgs, opts ...InvokeOption) LookupKmsSecretResultOutput

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

    public static class GetKmsSecret 
    {
        public static Task<GetKmsSecretResult> InvokeAsync(GetKmsSecretArgs args, InvokeOptions? opts = null)
        public static Output<GetKmsSecretResult> Invoke(GetKmsSecretInvokeArgs args, InvokeOptions? opts = null)
        public static Output<GetKmsSecretResult> Invoke(GetKmsSecretInvokeArgs args, InvokeOutputOptions opts)
    }
    public static CompletableFuture<GetKmsSecretResult> getKmsSecret(GetKmsSecretArgs args, InvokeOptions options)
    public static Output<GetKmsSecretResult> getKmsSecret(GetKmsSecretArgs args, InvokeOptions options)
    public static Output<GetKmsSecretResult> getKmsSecret(GetKmsSecretArgs args, InvokeOutputOptions options)
    
    fn::invoke:
      function: vkcs:index/getKmsSecret:getKmsSecret
      arguments:
        # arguments dictionary
    data "vkcs_get_kms_secret" "name" {
        # arguments
    }

    The following arguments are supported:

    Path string
    required string → Identifier (path) of the secret within the KMS secret store.
    Path string
    required string → Identifier (path) of the secret within the KMS secret store.
    path string
    required string → Identifier (path) of the secret within the KMS secret store.
    path String
    required string → Identifier (path) of the secret within the KMS secret store.
    path string
    required string → Identifier (path) of the secret within the KMS secret store.
    path str
    required string → Identifier (path) of the secret within the KMS secret store.
    path String
    required string → Identifier (path) of the secret within the KMS secret store.

    getKmsSecret Result

    The following output properties are available:

    CreatedTime string
    string → Creation time returned in the secret metadata, formatted as a Go time string, for example 2026-09-01 10:00:00 +0000 UTC.
    DataJson string
    sensitive string → Secret data as a JSON object, represented as a string and populated from KMS when the data source is read. Use jsondecode to access its fields.
    DeleteProtection bool
    boolean → Whether the secret is protected from deletion.
    Id string
    string → Path of the KMS secret.
    Path string
    Version double
    number → Current version of the secret returned in its metadata.
    CreatedTime string
    string → Creation time returned in the secret metadata, formatted as a Go time string, for example 2026-09-01 10:00:00 +0000 UTC.
    DataJson string
    sensitive string → Secret data as a JSON object, represented as a string and populated from KMS when the data source is read. Use jsondecode to access its fields.
    DeleteProtection bool
    boolean → Whether the secret is protected from deletion.
    Id string
    string → Path of the KMS secret.
    Path string
    Version float64
    number → Current version of the secret returned in its metadata.
    created_time string
    string → Creation time returned in the secret metadata, formatted as a Go time string, for example 2026-09-01 10:00:00 +0000 UTC.
    data_json string
    sensitive string → Secret data as a JSON object, represented as a string and populated from KMS when the data source is read. Use jsondecode to access its fields.
    delete_protection bool
    boolean → Whether the secret is protected from deletion.
    id string
    string → Path of the KMS secret.
    path string
    version number
    number → Current version of the secret returned in its metadata.
    createdTime String
    string → Creation time returned in the secret metadata, formatted as a Go time string, for example 2026-09-01 10:00:00 +0000 UTC.
    dataJson String
    sensitive string → Secret data as a JSON object, represented as a string and populated from KMS when the data source is read. Use jsondecode to access its fields.
    deleteProtection Boolean
    boolean → Whether the secret is protected from deletion.
    id String
    string → Path of the KMS secret.
    path String
    version Double
    number → Current version of the secret returned in its metadata.
    createdTime string
    string → Creation time returned in the secret metadata, formatted as a Go time string, for example 2026-09-01 10:00:00 +0000 UTC.
    dataJson string
    sensitive string → Secret data as a JSON object, represented as a string and populated from KMS when the data source is read. Use jsondecode to access its fields.
    deleteProtection boolean
    boolean → Whether the secret is protected from deletion.
    id string
    string → Path of the KMS secret.
    path string
    version number
    number → Current version of the secret returned in its metadata.
    created_time str
    string → Creation time returned in the secret metadata, formatted as a Go time string, for example 2026-09-01 10:00:00 +0000 UTC.
    data_json str
    sensitive string → Secret data as a JSON object, represented as a string and populated from KMS when the data source is read. Use jsondecode to access its fields.
    delete_protection bool
    boolean → Whether the secret is protected from deletion.
    id str
    string → Path of the KMS secret.
    path str
    version float
    number → Current version of the secret returned in its metadata.
    createdTime String
    string → Creation time returned in the secret metadata, formatted as a Go time string, for example 2026-09-01 10:00:00 +0000 UTC.
    dataJson String
    sensitive string → Secret data as a JSON object, represented as a string and populated from KMS when the data source is read. Use jsondecode to access its fields.
    deleteProtection Boolean
    boolean → Whether the secret is protected from deletion.
    id String
    string → Path of the KMS secret.
    path String
    version Number
    number → Current version of the secret returned in its metadata.

    Package Details

    Repository
    vkcs vk-cs/terraform-provider-vkcs
    License
    Notes
    This Pulumi package is based on the vkcs Terraform Provider.
    vkcs
    Viewing docs for vkcs 0.19.0
    published on Tuesday, Oct 27, 2026 by vk-cs

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial