@pulumi/yandex/iamServiceAccountApiKey.d.ts

A Pulumi package for creating and managing yandex cloud resources.

import * as pulumi from "@pulumi/pulumi";
/**
 * Allows management of a [Yandex.Cloud IAM service account API key](https://cloud.yandex.com/docs/iam/concepts/authorization/api-key).
 * The API key is a private key used for simplified authorization in the Yandex.Cloud API. API keys are only used for [service accounts](https://cloud.yandex.com/docs/iam/concepts/users/service-accounts).
 *
 * API keys do not expire. This means that this authentication method is simpler, but less secure. Use it if you can't automatically request an [IAM token](https://cloud.yandex.com/docs/iam/concepts/authorization/iam-token).
 *
 * ## Example Usage
 *
 * This snippet creates an API key.
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as yandex from "@pulumi/yandex";
 *
 * const sa_api_key = new yandex.IamServiceAccountApiKey("sa-api-key", {
 *     description: "api key for authorization",
 *     pgpKey: "keybase:keybaseusername",
 *     serviceAccountId: "some_sa_id",
 * });
 * ```
 */
export declare class IamServiceAccountApiKey extends pulumi.CustomResource {
    /**
     * Get an existing IamServiceAccountApiKey resource's state with the given name, ID, and optional extra
     * properties used to qualify the lookup.
     *
     * @param name The _unique_ name of the resulting resource.
     * @param id The _unique_ provider ID of the resource to lookup.
     * @param state Any extra arguments used during the lookup.
     * @param opts Optional settings to control the behavior of the CustomResource.
     */
    static get(name: string, id: pulumi.Input<pulumi.ID>, state?: IamServiceAccountApiKeyState, opts?: pulumi.CustomResourceOptions): IamServiceAccountApiKey;
    /**
     * Returns true if the given object is an instance of IamServiceAccountApiKey.  This is designed to work even
     * when multiple copies of the Pulumi SDK have been loaded into the same process.
     */
    static isInstance(obj: any): obj is IamServiceAccountApiKey;
    /**
     * Creation timestamp of the static access key.
     */
    readonly createdAt: pulumi.Output<string>;
    /**
     * The description of the key.
     */
    readonly description: pulumi.Output<string | undefined>;
    /**
     * The encrypted secret key, base64 encoded. This is only populated when `pgpKey` is supplied.
     */
    readonly encryptedSecretKey: pulumi.Output<string>;
    /**
     * The fingerprint of the PGP key used to encrypt the secret key. This is only populated when `pgpKey` is supplied.
     */
    readonly keyFingerprint: pulumi.Output<string>;
    /**
     * An optional PGP key to encrypt the resulting secret key material. May either be a base64-encoded public key or a keybase username in the form `keybase:keybaseusername`.
     */
    readonly pgpKey: pulumi.Output<string | undefined>;
    /**
     * The secret key. This is only populated when no `pgpKey` is provided.
     */
    readonly secretKey: pulumi.Output<string>;
    /**
     * ID of the service account to an API key for.
     */
    readonly serviceAccountId: pulumi.Output<string>;
    /**
     * Create a IamServiceAccountApiKey resource with the given unique name, arguments, and options.
     *
     * @param name The _unique_ name of the resource.
     * @param args The arguments to use to populate this resource's properties.
     * @param opts A bag of options that control this resource's behavior.
     */
    constructor(name: string, args: IamServiceAccountApiKeyArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering IamServiceAccountApiKey resources.
 */
export interface IamServiceAccountApiKeyState {
    /**
     * Creation timestamp of the static access key.
     */
    createdAt?: pulumi.Input<string>;
    /**
     * The description of the key.
     */
    description?: pulumi.Input<string>;
    /**
     * The encrypted secret key, base64 encoded. This is only populated when `pgpKey` is supplied.
     */
    encryptedSecretKey?: pulumi.Input<string>;
    /**
     * The fingerprint of the PGP key used to encrypt the secret key. This is only populated when `pgpKey` is supplied.
     */
    keyFingerprint?: pulumi.Input<string>;
    /**
     * An optional PGP key to encrypt the resulting secret key material. May either be a base64-encoded public key or a keybase username in the form `keybase:keybaseusername`.
     */
    pgpKey?: pulumi.Input<string>;
    /**
     * The secret key. This is only populated when no `pgpKey` is provided.
     */
    secretKey?: pulumi.Input<string>;
    /**
     * ID of the service account to an API key for.
     */
    serviceAccountId?: pulumi.Input<string>;
}
/**
 * The set of arguments for constructing a IamServiceAccountApiKey resource.
 */
export interface IamServiceAccountApiKeyArgs {
    /**
     * The description of the key.
     */
    description?: pulumi.Input<string>;
    /**
     * An optional PGP key to encrypt the resulting secret key material. May either be a base64-encoded public key or a keybase username in the form `keybase:keybaseusername`.
     */
    pgpKey?: pulumi.Input<string>;
    /**
     * ID of the service account to an API key for.
     */
    serviceAccountId: pulumi.Input<string>;
}