@pulumi/gcp/kms/getCryptoKeys.d.ts

A Pulumi package for creating and managing Google Cloud Platform resources.

import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
 * Provides access to all Google Cloud Platform KMS CryptoKeys in a given KeyRing. For more information see
 * [the official documentation](https://cloud.google.com/kms/docs/object-hierarchy#key)
 * and
 * [API](https://cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.cryptoKeys).
 *
 * A CryptoKey is an interface to key material which can be used to encrypt and decrypt data. A CryptoKey belongs to a
 * Google Cloud KMS KeyRing.
 */
export declare function getCryptoKeys(args: GetCryptoKeysArgs, opts?: pulumi.InvokeOptions): Promise<GetCryptoKeysResult>;
/**
 * A collection of arguments for invoking getCryptoKeys.
 */
export interface GetCryptoKeysArgs {
    /**
     * The filter argument is used to add a filter query parameter that limits which keys are retrieved by the data source: ?filter={{filter}}. When no value is provided there is no filtering.
     *
     * Example filter values if filtering on name. Note: names take the form projects/{{project}}/locations/{{location}}/keyRings/{{keyRing}}/cryptoKeys/{{cryptoKey}}.
     *
     * * `"name:my-key-"` will retrieve keys that contain "my-key-" anywhere in their name.
     * * `"name=projects/my-project/locations/global/keyRings/my-key-ring/cryptoKeys/my-key-1"` will only retrieve a key with that exact name.
     *
     * [See the documentation about using filters](https://cloud.google.com/kms/docs/sorting-and-filtering)
     */
    filter?: string;
    /**
     * The key ring that the keys belongs to. Format: 'projects/{{project}}/locations/{{location}}/keyRings/{{keyRing}}'.,
     */
    keyRing: string;
}
/**
 * A collection of values returned by getCryptoKeys.
 */
export interface GetCryptoKeysResult {
    readonly filter?: string;
    /**
     * The provider-assigned unique ID for this managed resource.
     */
    readonly id: string;
    readonly keyRing: string;
    /**
     * A list of all the retrieved keys from the provided key ring. This list is influenced by the provided filter argument.
     */
    readonly keys: outputs.kms.GetCryptoKeysKey[];
}
/**
 * Provides access to all Google Cloud Platform KMS CryptoKeys in a given KeyRing. For more information see
 * [the official documentation](https://cloud.google.com/kms/docs/object-hierarchy#key)
 * and
 * [API](https://cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.cryptoKeys).
 *
 * A CryptoKey is an interface to key material which can be used to encrypt and decrypt data. A CryptoKey belongs to a
 * Google Cloud KMS KeyRing.
 */
export declare function getCryptoKeysOutput(args: GetCryptoKeysOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetCryptoKeysResult>;
/**
 * A collection of arguments for invoking getCryptoKeys.
 */
export interface GetCryptoKeysOutputArgs {
    /**
     * The filter argument is used to add a filter query parameter that limits which keys are retrieved by the data source: ?filter={{filter}}. When no value is provided there is no filtering.
     *
     * Example filter values if filtering on name. Note: names take the form projects/{{project}}/locations/{{location}}/keyRings/{{keyRing}}/cryptoKeys/{{cryptoKey}}.
     *
     * * `"name:my-key-"` will retrieve keys that contain "my-key-" anywhere in their name.
     * * `"name=projects/my-project/locations/global/keyRings/my-key-ring/cryptoKeys/my-key-1"` will only retrieve a key with that exact name.
     *
     * [See the documentation about using filters](https://cloud.google.com/kms/docs/sorting-and-filtering)
     */
    filter?: pulumi.Input<string>;
    /**
     * The key ring that the keys belongs to. Format: 'projects/{{project}}/locations/{{location}}/keyRings/{{keyRing}}'.,
     */
    keyRing: pulumi.Input<string>;
}