pulumi-alicloud-kotlin/com.pulumi.alicloud.kms.kotlin/KmsFunctions/getKeys

getKeys

suspend fun getKeys(argument: GetKeysPlainArgs): GetKeysResult

This data source provides a list of KMS keys in an Alibaba Cloud account according to the specified filters.

Example Usage

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.alicloud.kms.KmsFunctions;
import com.pulumi.alicloud.kms.inputs.GetKeysArgs;
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 kmsKeysDs = KmsFunctions.getKeys(GetKeysArgs.builder()
            .descriptionRegex("Hello KMS")
            .outputFile("kms_keys.json")
            .build());
        ctx.export("firstKeyId", kmsKeysDs.applyValue(getKeysResult -> getKeysResult.keys()[0].id()));
    }
}
Content copied to clipboard

Return

A collection of values returned by getKeys.

Parameters

argument

A collection of arguments for invoking getKeys.

suspend fun getKeys(descriptionRegex: String? = null, enableDetails: Boolean? = null, filters: String? = null, ids: List<String>? = null, outputFile: String? = null, status: String? = null): GetKeysResult

Return

A collection of values returned by getKeys.

See also

Parameters

descriptionRegex

A regex string to filter the results by the KMS key description.

enableDetails
filters

The CMK filter. The filter consists of one or more key-value pairs. You can specify a maximum of 10 key-value pairs. More details see API ListKeys.

ids

A list of KMS key IDs.

outputFile

File name where to save data source results (after running pulumi preview).

status

Filter the results by status of the KMS keys. Valid values: Enabled, Disabled, PendingDeletion.

suspend fun getKeys(argument: suspend GetKeysPlainArgsBuilder.() -> Unit): GetKeysResult

Return

A collection of values returned by getKeys.

See also

Parameters

argument

Builder for com.pulumi.alicloud.kms.kotlin.inputs.GetKeysPlainArgs.