@volcengine/pulumi
Version:
A Pulumi package for creating and managing volcengine cloud resources.
142 lines (141 loc) • 4.96 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Provides a resource to manage iam access key
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as volcengine from "@volcengine/pulumi";
*
* const fooUser = new volcengine.iam.User("fooUser", {
* userName: "acc-test-user",
* description: "acc-test",
* displayName: "name",
* });
* const fooAccessKey = new volcengine.iam.AccessKey("fooAccessKey", {
* userName: fooUser.userName,
* secretFile: "./sk",
* status: "active",
* });
* // pgp_key = "keybase:some_person_that_exists"
* ```
*
* ## Import
*
* Iam access key don't support import
*/
export declare class AccessKey extends pulumi.CustomResource {
/**
* Get an existing AccessKey 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?: AccessKeyState, opts?: pulumi.CustomResourceOptions): AccessKey;
/**
* Returns true if the given object is an instance of AccessKey. 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 AccessKey;
/**
* The create date of the access key.
*/
readonly createDate: pulumi.Output<string>;
/**
* The encrypted secret of the access key by pgp key, base64 encoded.
*/
readonly encryptedSecret: pulumi.Output<string>;
/**
* The key fingerprint of the encrypted secret.
*/
readonly keyFingerprint: pulumi.Output<string>;
/**
* Either a base-64 encoded PGP public key, or a keybase username in the form `keybase:some_person_that_exists`.
*/
readonly pgpKey: pulumi.Output<string | undefined>;
/**
* The secret of the access key.
*/
readonly secret: pulumi.Output<string>;
/**
* The file to save the access id and secret. Strongly suggest you to specified it when you creating access key, otherwise, you wouldn't get its secret ever.
*/
readonly secretFile: pulumi.Output<string | undefined>;
/**
* The status of the access key, Optional choice contains `active` or `inactive`.
*/
readonly status: pulumi.Output<string | undefined>;
/**
* The user name.
*/
readonly userName: pulumi.Output<string>;
/**
* Create a AccessKey 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?: AccessKeyArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering AccessKey resources.
*/
export interface AccessKeyState {
/**
* The create date of the access key.
*/
createDate?: pulumi.Input<string>;
/**
* The encrypted secret of the access key by pgp key, base64 encoded.
*/
encryptedSecret?: pulumi.Input<string>;
/**
* The key fingerprint of the encrypted secret.
*/
keyFingerprint?: pulumi.Input<string>;
/**
* Either a base-64 encoded PGP public key, or a keybase username in the form `keybase:some_person_that_exists`.
*/
pgpKey?: pulumi.Input<string>;
/**
* The secret of the access key.
*/
secret?: pulumi.Input<string>;
/**
* The file to save the access id and secret. Strongly suggest you to specified it when you creating access key, otherwise, you wouldn't get its secret ever.
*/
secretFile?: pulumi.Input<string>;
/**
* The status of the access key, Optional choice contains `active` or `inactive`.
*/
status?: pulumi.Input<string>;
/**
* The user name.
*/
userName?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a AccessKey resource.
*/
export interface AccessKeyArgs {
/**
* Either a base-64 encoded PGP public key, or a keybase username in the form `keybase:some_person_that_exists`.
*/
pgpKey?: pulumi.Input<string>;
/**
* The file to save the access id and secret. Strongly suggest you to specified it when you creating access key, otherwise, you wouldn't get its secret ever.
*/
secretFile?: pulumi.Input<string>;
/**
* The status of the access key, Optional choice contains `active` or `inactive`.
*/
status?: pulumi.Input<string>;
/**
* The user name.
*/
userName?: pulumi.Input<string>;
}