@pulumi/yandex/iamServiceAccountStaticAccessKey.d.ts

A Pulumi package for creating and managing yandex cloud resources.

import * as pulumi from "@pulumi/pulumi";
/**
 * Allows management of [Yandex.Cloud IAM service account static access keys](https://cloud.yandex.com/docs/iam/operations/sa/create-access-key).
 * Generated pair of keys is used to access [Yandex Object Storage](https://cloud.yandex.com/docs/storage) on behalf of service account.
 *
 * Before using keys do not forget to [assign a proper role](https://cloud.yandex.com/docs/iam/operations/sa/assign-role-for-sa) to the service account.
 *
 * ## Example Usage
 *
 * This snippet creates a service account static access key.
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as yandex from "@pulumi/yandex";
 *
 * const sa_static_key = new yandex.IamServiceAccountStaticAccessKey("sa-static-key", {
 *     description: "static access key for object storage",
 *     pgpKey: "keybase:keybaseusername",
 *     serviceAccountId: "some_sa_id",
 * });
 * ```
 */
export declare class IamServiceAccountStaticAccessKey extends pulumi.CustomResource {
    /**
     * Get an existing IamServiceAccountStaticAccessKey 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?: IamServiceAccountStaticAccessKeyState, opts?: pulumi.CustomResourceOptions): IamServiceAccountStaticAccessKey;
    /**
     * Returns true if the given object is an instance of IamServiceAccountStaticAccessKey.  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 IamServiceAccountStaticAccessKey;
    /**
     * ID of the static access key.
     */
    readonly accessKey: pulumi.Output<string>;
    /**
     * Creation timestamp of the static access key.
     */
    readonly createdAt: pulumi.Output<string>;
    /**
     * The description of the service account static key.
     */
    readonly description: pulumi.Output<string | undefined>;
    /**
     * The encrypted secret, 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>;
    /**
     * Private part of generated static access key. This is only populated when no `pgpKey` is provided.
     */
    readonly secretKey: pulumi.Output<string>;
    /**
     * ID of the service account which is used to get a static key.
     */
    readonly serviceAccountId: pulumi.Output<string>;
    /**
     * Create a IamServiceAccountStaticAccessKey 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: IamServiceAccountStaticAccessKeyArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering IamServiceAccountStaticAccessKey resources.
 */
export interface IamServiceAccountStaticAccessKeyState {
    /**
     * ID of the static access key.
     */
    accessKey?: pulumi.Input<string>;
    /**
     * Creation timestamp of the static access key.
     */
    createdAt?: pulumi.Input<string>;
    /**
     * The description of the service account static key.
     */
    description?: pulumi.Input<string>;
    /**
     * The encrypted secret, 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>;
    /**
     * Private part of generated static access key. This is only populated when no `pgpKey` is provided.
     */
    secretKey?: pulumi.Input<string>;
    /**
     * ID of the service account which is used to get a static key.
     */
    serviceAccountId?: pulumi.Input<string>;
}
/**
 * The set of arguments for constructing a IamServiceAccountStaticAccessKey resource.
 */
export interface IamServiceAccountStaticAccessKeyArgs {
    /**
     * The description of the service account static 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 which is used to get a static key.
     */
    serviceAccountId: pulumi.Input<string>;
}