Viewing docs for vkcs 0.19.0
published on Tuesday, Oct 27, 2026 by vk-cs
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
published on Tuesday, Oct 27, 2026 by vk-cs
A data source containing a KMS key
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as vkcs from "@pulumi/vkcs";
const key = vkcs.getKmsKey({
name: keyVkcsKmsKey.id,
});
export const keyDeletionAllowed = key.then(key => key.deletionAllowed);
import pulumi
import pulumi_vkcs as vkcs
key = vkcs.get_kms_key(name=key_vkcs_kms_key["id"])
pulumi.export("keyDeletionAllowed", key.deletion_allowed)
package main
import (
"github.com/pulumi/pulumi-terraform-provider/sdks/go/vkcs/vkcs"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
key, err := vkcs.LookupKmsKey(ctx, &vkcs.LookupKmsKeyArgs{
Name: keyVkcsKmsKey.Id,
}, nil)
if err != nil {
return err
}
ctx.Export("keyDeletionAllowed", key.DeletionAllowed)
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Vkcs = Pulumi.Vkcs;
return await Deployment.RunAsync(() =>
{
var key = Vkcs.GetKmsKey.Invoke(new()
{
Name = keyVkcsKmsKey.Id,
});
return new Dictionary<string, object?>
{
["keyDeletionAllowed"] = key.Apply(getKmsKeyResult => getKmsKeyResult.DeletionAllowed),
};
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.vkcs.VkcsFunctions;
import com.pulumi.vkcs.inputs.GetKmsKeyArgs;
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) {
final var key = VkcsFunctions.getKmsKey(GetKmsKeyArgs.builder()
.name(keyVkcsKmsKey.id())
.build());
ctx.export("keyDeletionAllowed", key.deletionAllowed());
}
}
variables:
key:
fn::invoke:
function: vkcs:getKmsKey
arguments:
name: ${keyVkcsKmsKey.id}
outputs:
keyDeletionAllowed: ${key.deletionAllowed}
Example coming soon!
Using getKmsKey
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 getKmsKey(args: GetKmsKeyArgs, opts?: InvokeOptions): Promise<GetKmsKeyResult>
function getKmsKeyOutput(args: GetKmsKeyOutputArgs, opts?: InvokeOutputOptions): Output<GetKmsKeyResult>def get_kms_key(name: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetKmsKeyResult
def get_kms_key_output(name: pulumi.Input[Optional[str]] = None,
opts: Optional[InvokeOutputOptions] = None) -> Output[GetKmsKeyResult]func LookupKmsKey(ctx *Context, args *LookupKmsKeyArgs, opts ...InvokeOption) (*LookupKmsKeyResult, error)
func LookupKmsKeyOutput(ctx *Context, args *LookupKmsKeyOutputArgs, opts ...InvokeOption) LookupKmsKeyResultOutput> Note: This function is named LookupKmsKey in the Go SDK.
public static class GetKmsKey
{
public static Task<GetKmsKeyResult> InvokeAsync(GetKmsKeyArgs args, InvokeOptions? opts = null)
public static Output<GetKmsKeyResult> Invoke(GetKmsKeyInvokeArgs args, InvokeOptions? opts = null)
public static Output<GetKmsKeyResult> Invoke(GetKmsKeyInvokeArgs args, InvokeOutputOptions opts)
}public static CompletableFuture<GetKmsKeyResult> getKmsKey(GetKmsKeyArgs args, InvokeOptions options)
public static Output<GetKmsKeyResult> getKmsKey(GetKmsKeyArgs args, InvokeOptions options)
public static Output<GetKmsKeyResult> getKmsKey(GetKmsKeyArgs args, InvokeOutputOptions options)
fn::invoke:
function: vkcs:index/getKmsKey:getKmsKey
arguments:
# arguments dictionarydata "vkcs_get_kms_key" "name" {
# arguments
}The following arguments are supported:
- Name string
- required string → Name of the KMS key to read.
- Name string
- required string → Name of the KMS key to read.
- name string
- required string → Name of the KMS key to read.
- name String
- required string → Name of the KMS key to read.
- name string
- required string → Name of the KMS key to read.
- name str
- required string → Name of the KMS key to read.
- name String
- required string → Name of the KMS key to read.
getKmsKey Result
The following output properties are available:
- Deletion
Allowed bool - boolean → Whether KMS allows the key to be deleted.
- Id string
- string → Name of the KMS key.
- Name string
- Type string
- string → Type of the key:
aes128-gcm96,aes256-gcm96,chacha20-poly1305, orxchacha20-poly1305.
- Deletion
Allowed bool - boolean → Whether KMS allows the key to be deleted.
- Id string
- string → Name of the KMS key.
- Name string
- Type string
- string → Type of the key:
aes128-gcm96,aes256-gcm96,chacha20-poly1305, orxchacha20-poly1305.
- deletion_
allowed bool - boolean → Whether KMS allows the key to be deleted.
- id string
- string → Name of the KMS key.
- name string
- type string
- string → Type of the key:
aes128-gcm96,aes256-gcm96,chacha20-poly1305, orxchacha20-poly1305.
- deletion
Allowed Boolean - boolean → Whether KMS allows the key to be deleted.
- id String
- string → Name of the KMS key.
- name String
- type String
- string → Type of the key:
aes128-gcm96,aes256-gcm96,chacha20-poly1305, orxchacha20-poly1305.
- deletion
Allowed boolean - boolean → Whether KMS allows the key to be deleted.
- id string
- string → Name of the KMS key.
- name string
- type string
- string → Type of the key:
aes128-gcm96,aes256-gcm96,chacha20-poly1305, orxchacha20-poly1305.
- deletion_
allowed bool - boolean → Whether KMS allows the key to be deleted.
- id str
- string → Name of the KMS key.
- name str
- type str
- string → Type of the key:
aes128-gcm96,aes256-gcm96,chacha20-poly1305, orxchacha20-poly1305.
- deletion
Allowed Boolean - boolean → Whether KMS allows the key to be deleted.
- id String
- string → Name of the KMS key.
- name String
- type String
- string → Type of the key:
aes128-gcm96,aes256-gcm96,chacha20-poly1305, orxchacha20-poly1305.
Package Details
- Repository
- vkcs vk-cs/terraform-provider-vkcs
- License
- Notes
- This Pulumi package is based on the
vkcsTerraform Provider.
vkcs
Viewing docs for vkcs 0.19.0
published on Tuesday, Oct 27, 2026 by vk-cs
published on Tuesday, Oct 27, 2026 by vk-cs