@volcengine/pulumi/redis/account.d.ts

A Pulumi package for creating and managing volcengine cloud resources.

import * as pulumi from "@pulumi/pulumi";
/**
 * Provides a resource to manage redis account
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as volcengine from "@pulumi/volcengine";
 * import * as volcengine from "@volcengine/pulumi";
 *
 * const fooZones = volcengine.ecs.getZones({});
 * const fooVpc = new volcengine.vpc.Vpc("fooVpc", {
 *     vpcName: "acc-test-vpc",
 *     cidrBlock: "172.16.0.0/16",
 * });
 * const fooSubnet = new volcengine.vpc.Subnet("fooSubnet", {
 *     subnetName: "acc-test-subnet",
 *     cidrBlock: "172.16.0.0/24",
 *     zoneId: fooZones.then(fooZones => fooZones.zones?.[0]?.id),
 *     vpcId: fooVpc.id,
 * });
 * const fooInstance = new volcengine.redis.Instance("fooInstance", {
 *     zoneIds: [fooZones.then(fooZones => fooZones.zones?.[0]?.id)],
 *     instanceName: "acc-test-tf-redis",
 *     shardedCluster: 1,
 *     password: "1qaz!QAZ12",
 *     nodeNumber: 2,
 *     shardCapacity: 1024,
 *     shardNumber: 2,
 *     engineVersion: "5.0",
 *     subnetId: fooSubnet.id,
 *     deletionProtection: "disabled",
 *     vpcAuthMode: "close",
 *     chargeType: "PostPaid",
 *     port: 6381,
 *     projectName: "default",
 * });
 * const fooAccount = new volcengine.redis.Account("fooAccount", {
 *     accountName: "acc_test_account",
 *     instanceId: fooInstance.id,
 *     password: "Password@@",
 *     roleName: "ReadOnly",
 * });
 * ```
 *
 * ## Import
 *
 * Redis account can be imported using the instanceId:accountName, e.g.
 *
 * ```sh
 * $ pulumi import volcengine:redis/account:Account default redis-42b38c769c4b:test
 * ```
 */
export declare class Account extends pulumi.CustomResource {
    /**
     * Get an existing Account 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?: AccountState, opts?: pulumi.CustomResourceOptions): Account;
    /**
     * Returns true if the given object is an instance of Account.  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 Account;
    /**
     * Redis account name.
     */
    readonly accountName: pulumi.Output<string>;
    /**
     * The description of the redis account.
     */
    readonly description: pulumi.Output<string | undefined>;
    /**
     * The ID of the Redis instance.
     */
    readonly instanceId: pulumi.Output<string>;
    /**
     * The password of the redis account. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignoreChanges ignore changes in fields.
     */
    readonly password: pulumi.Output<string>;
    /**
     * Role type, the valid value can be `Administrator`, `ReadWrite`, `ReadOnly`, `NotDangerous`.
     */
    readonly roleName: pulumi.Output<string>;
    /**
     * Create a Account 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: AccountArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering Account resources.
 */
export interface AccountState {
    /**
     * Redis account name.
     */
    accountName?: pulumi.Input<string>;
    /**
     * The description of the redis account.
     */
    description?: pulumi.Input<string>;
    /**
     * The ID of the Redis instance.
     */
    instanceId?: pulumi.Input<string>;
    /**
     * The password of the redis account. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignoreChanges ignore changes in fields.
     */
    password?: pulumi.Input<string>;
    /**
     * Role type, the valid value can be `Administrator`, `ReadWrite`, `ReadOnly`, `NotDangerous`.
     */
    roleName?: pulumi.Input<string>;
}
/**
 * The set of arguments for constructing a Account resource.
 */
export interface AccountArgs {
    /**
     * Redis account name.
     */
    accountName: pulumi.Input<string>;
    /**
     * The description of the redis account.
     */
    description?: pulumi.Input<string>;
    /**
     * The ID of the Redis instance.
     */
    instanceId: pulumi.Input<string>;
    /**
     * The password of the redis account. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignoreChanges ignore changes in fields.
     */
    password: pulumi.Input<string>;
    /**
     * Role type, the valid value can be `Administrator`, `ReadWrite`, `ReadOnly`, `NotDangerous`.
     */
    roleName: pulumi.Input<string>;
}