@volcengine/pulumi/kms/getKeyMaterials.d.ts

A Pulumi package for creating and managing volcengine cloud resources.

import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
 * Use this data source to query detailed information of kms key materials
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as volcengine from "@pulumi/volcengine";
 *
 * const default = volcengine.kms.getKeyMaterials({
 *     keyName: "Test-3",
 *     keyringName: "Tf-test-1",
 *     wrappingAlgorithm: "RSAES_OAEP_SHA_256",
 *     wrappingKeySpec: "RSA_2048",
 * });
 * ```
 */
export declare function getKeyMaterials(args?: GetKeyMaterialsArgs, opts?: pulumi.InvokeOptions): Promise<GetKeyMaterialsResult>;
/**
 * A collection of arguments for invoking getKeyMaterials.
 */
export interface GetKeyMaterialsArgs {
    /**
     * The id of key. When keyId is not specified, both keyringName and keyName must be specified.
     */
    keyId?: string;
    /**
     * The name of key.
     */
    keyName?: string;
    /**
     * The name of keyring.
     */
    keyringName?: string;
    /**
     * File name where to save data source results.
     */
    outputFile?: string;
    /**
     * The wrapping algorithm. Valid values: `RSAES_OAEP_SHA_256`, `RSAES_OAEP_SHA_1`, `RSAES_PKCS1_V1_5`, `SM2PKE`. Default value: `RSAES_OAEP_SHA_256`. When the wrappingKeySpec is EC_SM2, only SM2PKE is supported.
     */
    wrappingAlgorithm?: string;
    /**
     * The wrapping key spec. Valid values: `RSA_2048`, `EC_SM2`. Default value: `RSA_2048`. When the user's master key protection level is SOFTWARE, selecting EC_SM2 is prohibited.
     */
    wrappingKeySpec?: string;
}
/**
 * A collection of values returned by getKeyMaterials.
 */
export interface GetKeyMaterialsResult {
    /**
     * The provider-assigned unique ID for this managed resource.
     */
    readonly id: string;
    /**
     * The import parameters info.
     */
    readonly importParameters: outputs.kms.GetKeyMaterialsImportParameter[];
    /**
     * The id of key.
     */
    readonly keyId?: string;
    readonly keyName?: string;
    readonly keyringName?: string;
    readonly outputFile?: string;
    /**
     * The total count of query.
     */
    readonly totalCount: number;
    readonly wrappingAlgorithm?: string;
    readonly wrappingKeySpec?: string;
}
/**
 * Use this data source to query detailed information of kms key materials
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as volcengine from "@pulumi/volcengine";
 *
 * const default = volcengine.kms.getKeyMaterials({
 *     keyName: "Test-3",
 *     keyringName: "Tf-test-1",
 *     wrappingAlgorithm: "RSAES_OAEP_SHA_256",
 *     wrappingKeySpec: "RSA_2048",
 * });
 * ```
 */
export declare function getKeyMaterialsOutput(args?: GetKeyMaterialsOutputArgs, opts?: pulumi.InvokeOptions): pulumi.Output<GetKeyMaterialsResult>;
/**
 * A collection of arguments for invoking getKeyMaterials.
 */
export interface GetKeyMaterialsOutputArgs {
    /**
     * The id of key. When keyId is not specified, both keyringName and keyName must be specified.
     */
    keyId?: pulumi.Input<string>;
    /**
     * The name of key.
     */
    keyName?: pulumi.Input<string>;
    /**
     * The name of keyring.
     */
    keyringName?: pulumi.Input<string>;
    /**
     * File name where to save data source results.
     */
    outputFile?: pulumi.Input<string>;
    /**
     * The wrapping algorithm. Valid values: `RSAES_OAEP_SHA_256`, `RSAES_OAEP_SHA_1`, `RSAES_PKCS1_V1_5`, `SM2PKE`. Default value: `RSAES_OAEP_SHA_256`. When the wrappingKeySpec is EC_SM2, only SM2PKE is supported.
     */
    wrappingAlgorithm?: pulumi.Input<string>;
    /**
     * The wrapping key spec. Valid values: `RSA_2048`, `EC_SM2`. Default value: `RSA_2048`. When the user's master key protection level is SOFTWARE, selecting EC_SM2 is prohibited.
     */
    wrappingKeySpec?: pulumi.Input<string>;
}