vkcs 0.9.3, Apr 15 25

vkcs 0.9.3 published on Tuesday, Apr 15, 2025 by vk-cs

vkcs.getKeymanagerSecret

Explore with Pulumi AI

vkcs 0.9.3 published on Tuesday, Apr 15, 2025 by vk-cs

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as vkcs from "@pulumi/vkcs";

const certificate = vkcs.getKeymanagerSecret({
    secretType: "certificate",
});

import pulumi
import pulumi_vkcs as vkcs

certificate = vkcs.get_keymanager_secret(secret_type="certificate")

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 {
		_, err := vkcs.LookupKeymanagerSecret(ctx, &vkcs.LookupKeymanagerSecretArgs{
			SecretType: pulumi.StringRef("certificate"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Vkcs = Pulumi.Vkcs;

return await Deployment.RunAsync(() => 
{
    var certificate = Vkcs.GetKeymanagerSecret.Invoke(new()
    {
        SecretType = "certificate",
    });

});

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.GetKeymanagerSecretArgs;
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 certificate = VkcsFunctions.getKeymanagerSecret(GetKeymanagerSecretArgs.builder()
            .secretType("certificate")
            .build());

    }
}

variables:
  certificate:
    fn::invoke:
      function: vkcs:getKeymanagerSecret
      arguments:
        secretType: certificate

Date Filters

The values for the expiration_filter, created_at_filter, and updated_at_filter parameters are comma-separated lists of time stamps in RFC3339 format. The time stamps can be prefixed with any of these comparison operators: gt: (greater-than), gte: (greater-than-or-equal), lt: (less-than), lte: (less-than-or-equal).

For example, to get a passphrase a Secret with CBC moda, that will expire in January of 2020:

import * as pulumi from "@pulumi/pulumi";
import * as vkcs from "@pulumi/vkcs";

const dateFilterExample = vkcs.getKeymanagerSecret({
    expirationFilter: "gt:2020-01-01T00:00:00Z",
    mode: "cbc",
    secretType: "passphrase",
});

import pulumi
import pulumi_vkcs as vkcs

date_filter_example = vkcs.get_keymanager_secret(expiration_filter="gt:2020-01-01T00:00:00Z",
    mode="cbc",
    secret_type="passphrase")

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 {
		_, err := vkcs.LookupKeymanagerSecret(ctx, &vkcs.LookupKeymanagerSecretArgs{
			ExpirationFilter: pulumi.StringRef("gt:2020-01-01T00:00:00Z"),
			Mode:             pulumi.StringRef("cbc"),
			SecretType:       pulumi.StringRef("passphrase"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Vkcs = Pulumi.Vkcs;

return await Deployment.RunAsync(() => 
{
    var dateFilterExample = Vkcs.GetKeymanagerSecret.Invoke(new()
    {
        ExpirationFilter = "gt:2020-01-01T00:00:00Z",
        Mode = "cbc",
        SecretType = "passphrase",
    });

});

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.GetKeymanagerSecretArgs;
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 dateFilterExample = VkcsFunctions.getKeymanagerSecret(GetKeymanagerSecretArgs.builder()
            .expirationFilter("gt:2020-01-01T00:00:00Z")
            .mode("cbc")
            .secretType("passphrase")
            .build());

    }
}

variables:
  dateFilterExample:
    fn::invoke:
      function: vkcs:getKeymanagerSecret
      arguments:
        expirationFilter: gt:2020-01-01T00:00:00Z
        mode: cbc
        secretType: passphrase

Using getKeymanagerSecret

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 getKeymanagerSecret(args: GetKeymanagerSecretArgs, opts?: InvokeOptions): Promise<GetKeymanagerSecretResult>
function getKeymanagerSecretOutput(args: GetKeymanagerSecretOutputArgs, opts?: InvokeOptions): Output<GetKeymanagerSecretResult>

def get_keymanager_secret(acl_only: Optional[bool] = None,
                          algorithm: Optional[str] = None,
                          bit_length: Optional[float] = None,
                          created_at_filter: Optional[str] = None,
                          expiration_filter: Optional[str] = None,
                          mode: Optional[str] = None,
                          name: Optional[str] = None,
                          region: Optional[str] = None,
                          secret_type: Optional[str] = None,
                          updated_at_filter: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetKeymanagerSecretResult
def get_keymanager_secret_output(acl_only: Optional[pulumi.Input[bool]] = None,
                          algorithm: Optional[pulumi.Input[str]] = None,
                          bit_length: Optional[pulumi.Input[float]] = None,
                          created_at_filter: Optional[pulumi.Input[str]] = None,
                          expiration_filter: Optional[pulumi.Input[str]] = None,
                          mode: Optional[pulumi.Input[str]] = None,
                          name: Optional[pulumi.Input[str]] = None,
                          region: Optional[pulumi.Input[str]] = None,
                          secret_type: Optional[pulumi.Input[str]] = None,
                          updated_at_filter: Optional[pulumi.Input[str]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetKeymanagerSecretResult]

func LookupKeymanagerSecret(ctx *Context, args *LookupKeymanagerSecretArgs, opts ...InvokeOption) (*LookupKeymanagerSecretResult, error)
func LookupKeymanagerSecretOutput(ctx *Context, args *LookupKeymanagerSecretOutputArgs, opts ...InvokeOption) LookupKeymanagerSecretResultOutput

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

public static class GetKeymanagerSecret 
{
    public static Task<GetKeymanagerSecretResult> InvokeAsync(GetKeymanagerSecretArgs args, InvokeOptions? opts = null)
    public static Output<GetKeymanagerSecretResult> Invoke(GetKeymanagerSecretInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetKeymanagerSecretResult> getKeymanagerSecret(GetKeymanagerSecretArgs args, InvokeOptions options)
public static Output<GetKeymanagerSecretResult> getKeymanagerSecret(GetKeymanagerSecretArgs args, InvokeOptions options)

fn::invoke:
  function: vkcs:index/getKeymanagerSecret:getKeymanagerSecret
  arguments:
    # arguments dictionary

The following arguments are supported:

AclOnly bool: optional boolean → Select the Secret with an ACL that contains the user. Project scope is ignored. Defaults to false.
Algorithm string: optional string → The Secret algorithm.
BitLength double: optional number → The Secret bit length.
CreatedAtFilter string: optional string → Date filter to select the Secret with created matching the specified criteria. See Date Filters below for more detail.
ExpirationFilter string: optional string → Date filter to select the Secret with expiration matching the specified criteria. See Date Filters below for more detail.
Mode string: optional string → The Secret mode.
Name string: optional string → The Secret name.
Region string: optional string → The region in which to obtain the service client. If omitted, the region argument of the provider is used.
SecretType string: optional string → The Secret type. For more information see Secret types.
UpdatedAtFilter string: optional string → Date filter to select the Secret with updated matching the specified criteria. See Date Filters below for more detail.

AclOnly bool: optional boolean → Select the Secret with an ACL that contains the user. Project scope is ignored. Defaults to false.
Algorithm string: optional string → The Secret algorithm.
BitLength float64: optional number → The Secret bit length.
CreatedAtFilter string: optional string → Date filter to select the Secret with created matching the specified criteria. See Date Filters below for more detail.
ExpirationFilter string: optional string → Date filter to select the Secret with expiration matching the specified criteria. See Date Filters below for more detail.
Mode string: optional string → The Secret mode.
Name string: optional string → The Secret name.
Region string: optional string → The region in which to obtain the service client. If omitted, the region argument of the provider is used.
SecretType string: optional string → The Secret type. For more information see Secret types.
UpdatedAtFilter string: optional string → Date filter to select the Secret with updated matching the specified criteria. See Date Filters below for more detail.

aclOnly Boolean: optional boolean → Select the Secret with an ACL that contains the user. Project scope is ignored. Defaults to false.
algorithm String: optional string → The Secret algorithm.
bitLength Double: optional number → The Secret bit length.
createdAtFilter String: optional string → Date filter to select the Secret with created matching the specified criteria. See Date Filters below for more detail.
expirationFilter String: optional string → Date filter to select the Secret with expiration matching the specified criteria. See Date Filters below for more detail.
mode String: optional string → The Secret mode.
name String: optional string → The Secret name.
region String: optional string → The region in which to obtain the service client. If omitted, the region argument of the provider is used.
secretType String: optional string → The Secret type. For more information see Secret types.
updatedAtFilter String: optional string → Date filter to select the Secret with updated matching the specified criteria. See Date Filters below for more detail.

aclOnly boolean: optional boolean → Select the Secret with an ACL that contains the user. Project scope is ignored. Defaults to false.
algorithm string: optional string → The Secret algorithm.
bitLength number: optional number → The Secret bit length.
createdAtFilter string: optional string → Date filter to select the Secret with created matching the specified criteria. See Date Filters below for more detail.
expirationFilter string: optional string → Date filter to select the Secret with expiration matching the specified criteria. See Date Filters below for more detail.
mode string: optional string → The Secret mode.
name string: optional string → The Secret name.
region string: optional string → The region in which to obtain the service client. If omitted, the region argument of the provider is used.
secretType string: optional string → The Secret type. For more information see Secret types.
updatedAtFilter string: optional string → Date filter to select the Secret with updated matching the specified criteria. See Date Filters below for more detail.

acl_only bool: optional boolean → Select the Secret with an ACL that contains the user. Project scope is ignored. Defaults to false.
algorithm str: optional string → The Secret algorithm.
bit_length float: optional number → The Secret bit length.
created_at_filter str: optional string → Date filter to select the Secret with created matching the specified criteria. See Date Filters below for more detail.
expiration_filter str: optional string → Date filter to select the Secret with expiration matching the specified criteria. See Date Filters below for more detail.
mode str: optional string → The Secret mode.
name str: optional string → The Secret name.
region str: optional string → The region in which to obtain the service client. If omitted, the region argument of the provider is used.
secret_type str: optional string → The Secret type. For more information see Secret types.
updated_at_filter str: optional string → Date filter to select the Secret with updated matching the specified criteria. See Date Filters below for more detail.

aclOnly Boolean: optional boolean → Select the Secret with an ACL that contains the user. Project scope is ignored. Defaults to false.
algorithm String: optional string → The Secret algorithm.
bitLength Number: optional number → The Secret bit length.
createdAtFilter String: optional string → Date filter to select the Secret with created matching the specified criteria. See Date Filters below for more detail.
expirationFilter String: optional string → Date filter to select the Secret with expiration matching the specified criteria. See Date Filters below for more detail.
mode String: optional string → The Secret mode.
name String: optional string → The Secret name.
region String: optional string → The region in which to obtain the service client. If omitted, the region argument of the provider is used.
secretType String: optional string → The Secret type. For more information see Secret types.
updatedAtFilter String: optional string → Date filter to select the Secret with updated matching the specified criteria. See Date Filters below for more detail.

getKeymanagerSecret Result

The following output properties are available:

Acls List<GetKeymanagerSecretAcl>: list → The list of ACLs assigned to a secret.
Algorithm string
BitLength double
ContentTypes Dictionary<string, string>: map of string → The map of the content types, assigned on the secret.
CreatedAt string: string → The date the secret was created.
CreatorId string: string → The creator of the secret.
Expiration string: string → The date the secret will expire.
Id string: string → ID of the resource.
Metadata Dictionary<string, string>: map of string → The map of metadata, assigned on the secret, which has been explicitly and implicitly added.
Mode string
Name string
Payload string: string → The secret payload.
PayloadContentEncoding string: string → The Secret encoding.
PayloadContentType string: string → The Secret content type.
Region string
SecretRef string: string → The secret reference / where to find the secret.
SecretType string
Status string: string → The status of the secret.
UpdatedAt string: string → The date the secret was last updated.
AclOnly bool
CreatedAtFilter string
ExpirationFilter string
UpdatedAtFilter string

Acls []GetKeymanagerSecretAcl: list → The list of ACLs assigned to a secret.
Algorithm string
BitLength float64
ContentTypes map[string]string: map of string → The map of the content types, assigned on the secret.
CreatedAt string: string → The date the secret was created.
CreatorId string: string → The creator of the secret.
Expiration string: string → The date the secret will expire.
Id string: string → ID of the resource.
Metadata map[string]string: map of string → The map of metadata, assigned on the secret, which has been explicitly and implicitly added.
Mode string
Name string
Payload string: string → The secret payload.
PayloadContentEncoding string: string → The Secret encoding.
PayloadContentType string: string → The Secret content type.
Region string
SecretRef string: string → The secret reference / where to find the secret.
SecretType string
Status string: string → The status of the secret.
UpdatedAt string: string → The date the secret was last updated.
AclOnly bool
CreatedAtFilter string
ExpirationFilter string
UpdatedAtFilter string

acls List<GetKeymanagerSecretAcl>: list → The list of ACLs assigned to a secret.
algorithm String
bitLength Double
contentTypes Map<String,String>: map of string → The map of the content types, assigned on the secret.
createdAt String: string → The date the secret was created.
creatorId String: string → The creator of the secret.
expiration String: string → The date the secret will expire.
id String: string → ID of the resource.
metadata Map<String,String>: map of string → The map of metadata, assigned on the secret, which has been explicitly and implicitly added.
mode String
name String
payload String: string → The secret payload.
payloadContentEncoding String: string → The Secret encoding.
payloadContentType String: string → The Secret content type.
region String
secretRef String: string → The secret reference / where to find the secret.
secretType String
status String: string → The status of the secret.
updatedAt String: string → The date the secret was last updated.
aclOnly Boolean
createdAtFilter String
expirationFilter String
updatedAtFilter String

acls GetKeymanagerSecretAcl[]: list → The list of ACLs assigned to a secret.
algorithm string
bitLength number
contentTypes {[key: string]: string}: map of string → The map of the content types, assigned on the secret.
createdAt string: string → The date the secret was created.
creatorId string: string → The creator of the secret.
expiration string: string → The date the secret will expire.
id string: string → ID of the resource.
metadata {[key: string]: string}: map of string → The map of metadata, assigned on the secret, which has been explicitly and implicitly added.
mode string
name string
payload string: string → The secret payload.
payloadContentEncoding string: string → The Secret encoding.
payloadContentType string: string → The Secret content type.
region string
secretRef string: string → The secret reference / where to find the secret.
secretType string
status string: string → The status of the secret.
updatedAt string: string → The date the secret was last updated.
aclOnly boolean
createdAtFilter string
expirationFilter string
updatedAtFilter string

acls Sequence[GetKeymanagerSecretAcl]: list → The list of ACLs assigned to a secret.
algorithm str
bit_length float
content_types Mapping[str, str]: map of string → The map of the content types, assigned on the secret.
created_at str: string → The date the secret was created.
creator_id str: string → The creator of the secret.
expiration str: string → The date the secret will expire.
id str: string → ID of the resource.
metadata Mapping[str, str]: map of string → The map of metadata, assigned on the secret, which has been explicitly and implicitly added.
mode str
name str
payload str: string → The secret payload.
payload_content_encoding str: string → The Secret encoding.
payload_content_type str: string → The Secret content type.
region str
secret_ref str: string → The secret reference / where to find the secret.
secret_type str
status str: string → The status of the secret.
updated_at str: string → The date the secret was last updated.
acl_only bool
created_at_filter str
expiration_filter str
updated_at_filter str

acls List<Property Map>: list → The list of ACLs assigned to a secret.
algorithm String
bitLength Number
contentTypes Map<String>: map of string → The map of the content types, assigned on the secret.
createdAt String: string → The date the secret was created.
creatorId String: string → The creator of the secret.
expiration String: string → The date the secret will expire.
id String: string → ID of the resource.
metadata Map<String>: map of string → The map of metadata, assigned on the secret, which has been explicitly and implicitly added.
mode String
name String
payload String: string → The secret payload.
payloadContentEncoding String: string → The Secret encoding.
payloadContentType String: string → The Secret content type.
region String
secretRef String: string → The secret reference / where to find the secret.
secretType String
status String: string → The status of the secret.
updatedAt String: string → The date the secret was last updated.
aclOnly Boolean
createdAtFilter String
expirationFilter String
updatedAtFilter String

Supporting Types

GetKeymanagerSecretAcl

Reads List<GetKeymanagerSecretAclRead>: list → Block that describes read operation.

Reads []GetKeymanagerSecretAclRead: list → Block that describes read operation.

reads List<GetKeymanagerSecretAclRead>: list → Block that describes read operation.

reads GetKeymanagerSecretAclRead[]: list → Block that describes read operation.

reads Sequence[GetKeymanagerSecretAclRead]: list → Block that describes read operation.

reads List<Property Map>: list → Block that describes read operation.

GetKeymanagerSecretAclRead

CreatedAt string: string → The date the secret was created.
UpdatedAt string: string → The date the secret was last updated.
ProjectAccess bool: boolean → Whether the container is accessible project wide. Defaults to true.
Users List<string>: set of string → The list of user IDs, which are allowed to access the container, when project_access is set to false.

CreatedAt string: string → The date the secret was created.
UpdatedAt string: string → The date the secret was last updated.
ProjectAccess bool: boolean → Whether the container is accessible project wide. Defaults to true.
Users []string: set of string → The list of user IDs, which are allowed to access the container, when project_access is set to false.

createdAt String: string → The date the secret was created.
updatedAt String: string → The date the secret was last updated.
projectAccess Boolean: boolean → Whether the container is accessible project wide. Defaults to true.
users List<String>: set of string → The list of user IDs, which are allowed to access the container, when project_access is set to false.

createdAt string: string → The date the secret was created.
updatedAt string: string → The date the secret was last updated.
projectAccess boolean: boolean → Whether the container is accessible project wide. Defaults to true.
users string[]: set of string → The list of user IDs, which are allowed to access the container, when project_access is set to false.

created_at str: string → The date the secret was created.
updated_at str: string → The date the secret was last updated.
project_access bool: boolean → Whether the container is accessible project wide. Defaults to true.
users Sequence[str]: set of string → The list of user IDs, which are allowed to access the container, when project_access is set to false.

createdAt String: string → The date the secret was created.
updatedAt String: string → The date the secret was last updated.
projectAccess Boolean: boolean → Whether the container is accessible project wide. Defaults to true.
users List<String>: set of string → The list of user IDs, which are allowed to access the container, when project_access is set to false.

Package Details

Repository: vkcs vk-cs/terraform-provider-vkcs
License
Notes: This Pulumi package is based on the vkcs Terraform Provider.

vkcs 0.9.3 published on Tuesday, Apr 15, 2025 by vk-cs

vk-cs/terraform-provider-vkcs

vkcs.getKeymanagerSecret

On this page

On this page

Example Usage

Date Filters

Using getKeymanagerSecret

getKeymanagerSecret Result

Supporting Types

GetKeymanagerSecretAcl

GetKeymanagerSecretAclRead

Package Details

On this page

On this page