@pulumi/yandex
Version:
A Pulumi package for creating and managing yandex cloud resources.
160 lines (159 loc) • 6.46 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Allows management of [Yandex.Cloud IAM service account authorized keys](https://cloud.yandex.com/docs/iam/concepts/authorization/key).
* Generated pair of keys is used to create a [JSON Web Token](https://tools.ietf.org/html/rfc7519) which is necessary for requesting an [IAM Token](https://cloud.yandex.com/docs/iam/concepts/authorization/iam-token) for a [service account](https://cloud.yandex.com/docs/iam/concepts/users/service-accounts).
*
* ## Example Usage
*
* This snippet creates an authorized keys pair.
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as yandex from "@pulumi/yandex";
*
* const sa_auth_key = new yandex.IamServiceAccountKey("sa-auth-key", {
* description: "key for service account",
* keyAlgorithm: "RSA_4096",
* pgpKey: "keybase:keybaseusername",
* serviceAccountId: "some_sa_id",
* });
* ```
*/
export declare class IamServiceAccountKey extends pulumi.CustomResource {
/**
* Get an existing IamServiceAccountKey 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?: IamServiceAccountKeyState, opts?: pulumi.CustomResourceOptions): IamServiceAccountKey;
/**
* Returns true if the given object is an instance of IamServiceAccountKey. 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 IamServiceAccountKey;
/**
* Creation timestamp of the static access key.
*/
readonly createdAt: pulumi.Output<string>;
/**
* The description of the key pair.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* The encrypted private key, base64 encoded. This is only populated when `pgpKey` is supplied.
*/
readonly encryptedPrivateKey: pulumi.Output<string>;
/**
* The output format of the keys. `PEM_FILE` is the default format.
*/
readonly format: pulumi.Output<string | undefined>;
/**
* The algorithm used to generate the key. `RSA_2048` is the default algorithm.
* Valid values are listed in the [API reference](https://cloud.yandex.com/docs/iam/api-ref/Key).
*/
readonly keyAlgorithm: pulumi.Output<string | undefined>;
/**
* The fingerprint of the PGP key used to encrypt the private key. This is only populated when `pgpKey` is supplied.
*/
readonly keyFingerprint: pulumi.Output<string>;
/**
* An optional PGP key to encrypt the resulting private 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 private key. This is only populated when no `pgpKey` is provided.
*/
readonly privateKey: pulumi.Output<string>;
/**
* The public key.
*/
readonly publicKey: pulumi.Output<string>;
/**
* ID of the service account to create a pair for.
*/
readonly serviceAccountId: pulumi.Output<string>;
/**
* Create a IamServiceAccountKey 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: IamServiceAccountKeyArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering IamServiceAccountKey resources.
*/
export interface IamServiceAccountKeyState {
/**
* Creation timestamp of the static access key.
*/
createdAt?: pulumi.Input<string>;
/**
* The description of the key pair.
*/
description?: pulumi.Input<string>;
/**
* The encrypted private key, base64 encoded. This is only populated when `pgpKey` is supplied.
*/
encryptedPrivateKey?: pulumi.Input<string>;
/**
* The output format of the keys. `PEM_FILE` is the default format.
*/
format?: pulumi.Input<string>;
/**
* The algorithm used to generate the key. `RSA_2048` is the default algorithm.
* Valid values are listed in the [API reference](https://cloud.yandex.com/docs/iam/api-ref/Key).
*/
keyAlgorithm?: pulumi.Input<string>;
/**
* The fingerprint of the PGP key used to encrypt the private key. This is only populated when `pgpKey` is supplied.
*/
keyFingerprint?: pulumi.Input<string>;
/**
* An optional PGP key to encrypt the resulting private key material. May either be a base64-encoded public key or a keybase username in the form `keybase:keybaseusername`.
*/
pgpKey?: pulumi.Input<string>;
/**
* The private key. This is only populated when no `pgpKey` is provided.
*/
privateKey?: pulumi.Input<string>;
/**
* The public key.
*/
publicKey?: pulumi.Input<string>;
/**
* ID of the service account to create a pair for.
*/
serviceAccountId?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a IamServiceAccountKey resource.
*/
export interface IamServiceAccountKeyArgs {
/**
* The description of the key pair.
*/
description?: pulumi.Input<string>;
/**
* The output format of the keys. `PEM_FILE` is the default format.
*/
format?: pulumi.Input<string>;
/**
* The algorithm used to generate the key. `RSA_2048` is the default algorithm.
* Valid values are listed in the [API reference](https://cloud.yandex.com/docs/iam/api-ref/Key).
*/
keyAlgorithm?: pulumi.Input<string>;
/**
* An optional PGP key to encrypt the resulting private 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 create a pair for.
*/
serviceAccountId: pulumi.Input<string>;
}