Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Volcengine
  3. API Docs
  4. redis
  5. Account
Volcengine v0.0.27 published on Tuesday, Dec 10, 2024 by Volcengine
volcengine/pulumi-volcengine

volcengine.redis.Account

Explore with Pulumi AI

volcengine logo
Volcengine v0.0.27 published on Tuesday, Dec 10, 2024 by Volcengine
volcengine/pulumi-volcengine

    Provides a resource to manage redis account

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as volcengine from "@pulumi/volcengine";
import * as volcengine from "@volcengine/pulumi";

const fooZones = volcengine.ecs.Zones({});
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 pulumi
import pulumi_volcengine as volcengine

foo_zones = volcengine.ecs.zones()
foo_vpc = volcengine.vpc.Vpc("fooVpc",
    vpc_name="acc-test-vpc",
    cidr_block="172.16.0.0/16")
foo_subnet = volcengine.vpc.Subnet("fooSubnet",
    subnet_name="acc-test-subnet",
    cidr_block="172.16.0.0/24",
    zone_id=foo_zones.zones[0].id,
    vpc_id=foo_vpc.id)
foo_instance = volcengine.redis.Instance("fooInstance",
    zone_ids=[foo_zones.zones[0].id],
    instance_name="acc-test-tf-redis",
    sharded_cluster=1,
    password="1qaz!QAZ12",
    node_number=2,
    shard_capacity=1024,
    shard_number=2,
    engine_version="5.0",
    subnet_id=foo_subnet.id,
    deletion_protection="disabled",
    vpc_auth_mode="close",
    charge_type="PostPaid",
    port=6381,
    project_name="default")
foo_account = volcengine.redis.Account("fooAccount",
    account_name="acc_test_account",
    instance_id=foo_instance.id,
    password="Password@@",
    role_name="ReadOnly")

    package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/ecs"
	"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/redis"
	"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/vpc"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		fooZones, err := ecs.Zones(ctx, nil, nil)
		if err != nil {
			return err
		}
		fooVpc, err := vpc.NewVpc(ctx, "fooVpc", &vpc.VpcArgs{
			VpcName:   pulumi.String("acc-test-vpc"),
			CidrBlock: pulumi.String("172.16.0.0/16"),
		})
		if err != nil {
			return err
		}
		fooSubnet, err := vpc.NewSubnet(ctx, "fooSubnet", &vpc.SubnetArgs{
			SubnetName: pulumi.String("acc-test-subnet"),
			CidrBlock:  pulumi.String("172.16.0.0/24"),
			ZoneId:     pulumi.String(fooZones.Zones[0].Id),
			VpcId:      fooVpc.ID(),
		})
		if err != nil {
			return err
		}
		fooInstance, err := redis.NewInstance(ctx, "fooInstance", &redis.InstanceArgs{
			ZoneIds: pulumi.StringArray{
				pulumi.String(fooZones.Zones[0].Id),
			},
			InstanceName:       pulumi.String("acc-test-tf-redis"),
			ShardedCluster:     pulumi.Int(1),
			Password:           pulumi.String("1qaz!QAZ12"),
			NodeNumber:         pulumi.Int(2),
			ShardCapacity:      pulumi.Int(1024),
			ShardNumber:        pulumi.Int(2),
			EngineVersion:      pulumi.String("5.0"),
			SubnetId:           fooSubnet.ID(),
			DeletionProtection: pulumi.String("disabled"),
			VpcAuthMode:        pulumi.String("close"),
			ChargeType:         pulumi.String("PostPaid"),
			Port:               pulumi.Int(6381),
			ProjectName:        pulumi.String("default"),
		})
		if err != nil {
			return err
		}
		_, err = redis.NewAccount(ctx, "fooAccount", &redis.AccountArgs{
			AccountName: pulumi.String("acc_test_account"),
			InstanceId:  fooInstance.ID(),
			Password:    pulumi.String("Password@@"),
			RoleName:    pulumi.String("ReadOnly"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Volcengine = Pulumi.Volcengine;

return await Deployment.RunAsync(() => 
{
    var fooZones = Volcengine.Ecs.Zones.Invoke();

    var fooVpc = new Volcengine.Vpc.Vpc("fooVpc", new()
    {
        VpcName = "acc-test-vpc",
        CidrBlock = "172.16.0.0/16",
    });

    var fooSubnet = new Volcengine.Vpc.Subnet("fooSubnet", new()
    {
        SubnetName = "acc-test-subnet",
        CidrBlock = "172.16.0.0/24",
        ZoneId = fooZones.Apply(zonesResult => zonesResult.Zones[0]?.Id),
        VpcId = fooVpc.Id,
    });

    var fooInstance = new Volcengine.Redis.Instance("fooInstance", new()
    {
        ZoneIds = new[]
        {
            fooZones.Apply(zonesResult => zonesResult.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",
    });

    var fooAccount = new Volcengine.Redis.Account("fooAccount", new()
    {
        AccountName = "acc_test_account",
        InstanceId = fooInstance.Id,
        Password = "Password@@",
        RoleName = "ReadOnly",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.volcengine.ecs.EcsFunctions;
import com.pulumi.volcengine.ecs.inputs.ZonesArgs;
import com.pulumi.volcengine.vpc.Vpc;
import com.pulumi.volcengine.vpc.VpcArgs;
import com.pulumi.volcengine.vpc.Subnet;
import com.pulumi.volcengine.vpc.SubnetArgs;
import com.pulumi.volcengine.redis.Instance;
import com.pulumi.volcengine.redis.InstanceArgs;
import com.pulumi.volcengine.redis.Account;
import com.pulumi.volcengine.redis.AccountArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var fooZones = EcsFunctions.Zones();

        var fooVpc = new Vpc("fooVpc", VpcArgs.builder()        
            .vpcName("acc-test-vpc")
            .cidrBlock("172.16.0.0/16")
            .build());

        var fooSubnet = new Subnet("fooSubnet", SubnetArgs.builder()        
            .subnetName("acc-test-subnet")
            .cidrBlock("172.16.0.0/24")
            .zoneId(fooZones.applyValue(zonesResult -> zonesResult.zones()[0].id()))
            .vpcId(fooVpc.id())
            .build());

        var fooInstance = new Instance("fooInstance", InstanceArgs.builder()        
            .zoneIds(fooZones.applyValue(zonesResult -> zonesResult.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")
            .build());

        var fooAccount = new Account("fooAccount", AccountArgs.builder()        
            .accountName("acc_test_account")
            .instanceId(fooInstance.id())
            .password("Password@@")
            .roleName("ReadOnly")
            .build());

    }
}

    resources:
  fooVpc:
    type: volcengine:vpc:Vpc
    properties:
      vpcName: acc-test-vpc
      cidrBlock: 172.16.0.0/16
  fooSubnet:
    type: volcengine:vpc:Subnet
    properties:
      subnetName: acc-test-subnet
      cidrBlock: 172.16.0.0/24
      zoneId: ${fooZones.zones[0].id}
      vpcId: ${fooVpc.id}
  fooInstance:
    type: volcengine:redis:Instance
    properties:
      zoneIds:
        - ${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
  fooAccount:
    type: volcengine:redis:Account
    properties:
      accountName: acc_test_account
      instanceId: ${fooInstance.id}
      password: Password@@
      roleName: ReadOnly
variables:
  fooZones:
    fn::invoke:
      Function: volcengine:ecs:Zones
      Arguments: {}

    Create Account Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Account(name: string, args: AccountArgs, opts?: CustomResourceOptions);
    @overload
def Account(resource_name: str,
            args: AccountArgs,
            opts: Optional[ResourceOptions] = None)

@overload
def Account(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            account_name: Optional[str] = None,
            instance_id: Optional[str] = None,
            password: Optional[str] = None,
            role_name: Optional[str] = None,
            description: Optional[str] = None)
    func NewAccount(ctx *Context, name string, args AccountArgs, opts ...ResourceOption) (*Account, error)
    public Account(string name, AccountArgs args, CustomResourceOptions? opts = null)
    public Account(String name, AccountArgs args)
public Account(String name, AccountArgs args, CustomResourceOptions options)

    type: volcengine:redis:Account
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args AccountArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args AccountArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args AccountArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AccountArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AccountArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var exampleaccountResourceResourceFromRedisaccount = new Volcengine.Redis.Account("exampleaccountResourceResourceFromRedisaccount", new()
{
    AccountName = "string",
    InstanceId = "string",
    Password = "string",
    RoleName = "string",
    Description = "string",
});

    example, err := redis.NewAccount(ctx, "exampleaccountResourceResourceFromRedisaccount", &redis.AccountArgs{
	AccountName: pulumi.String("string"),
	InstanceId:  pulumi.String("string"),
	Password:    pulumi.String("string"),
	RoleName:    pulumi.String("string"),
	Description: pulumi.String("string"),
})

    var exampleaccountResourceResourceFromRedisaccount = new Account("exampleaccountResourceResourceFromRedisaccount", AccountArgs.builder()
    .accountName("string")
    .instanceId("string")
    .password("string")
    .roleName("string")
    .description("string")
    .build());

    exampleaccount_resource_resource_from_redisaccount = volcengine.redis.Account("exampleaccountResourceResourceFromRedisaccount",
    account_name="string",
    instance_id="string",
    password="string",
    role_name="string",
    description="string")

    const exampleaccountResourceResourceFromRedisaccount = new volcengine.redis.Account("exampleaccountResourceResourceFromRedisaccount", {
    accountName: "string",
    instanceId: "string",
    password: "string",
    roleName: "string",
    description: "string",
});

    type: volcengine:redis:Account
properties:
    accountName: string
    description: string
    instanceId: string
    password: string
    roleName: string

    Account Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Account resource accepts the following input properties:

    AccountName string
    Redis account name.
    InstanceId string
    The ID of the Redis instance.
    Password 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 ignore_changes ignore changes in fields.
    RoleName string
    Role type, the valid value can be Administrator, ReadWrite, ReadOnly, NotDangerous.
    Description string
    The description of the redis account.
    AccountName string
    Redis account name.
    InstanceId string
    The ID of the Redis instance.
    Password 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 ignore_changes ignore changes in fields.
    RoleName string
    Role type, the valid value can be Administrator, ReadWrite, ReadOnly, NotDangerous.
    Description string
    The description of the redis account.
    accountName String
    Redis account name.
    instanceId String
    The ID of the Redis instance.
    password 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 ignore_changes ignore changes in fields.
    roleName String
    Role type, the valid value can be Administrator, ReadWrite, ReadOnly, NotDangerous.
    description String
    The description of the redis account.
    accountName string
    Redis account name.
    instanceId string
    The ID of the Redis instance.
    password 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 ignore_changes ignore changes in fields.
    roleName string
    Role type, the valid value can be Administrator, ReadWrite, ReadOnly, NotDangerous.
    description string
    The description of the redis account.
    account_name str
    Redis account name.
    instance_id str
    The ID of the Redis instance.
    password str
    The password of the redis account. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
    role_name str
    Role type, the valid value can be Administrator, ReadWrite, ReadOnly, NotDangerous.
    description str
    The description of the redis account.
    accountName String
    Redis account name.
    instanceId String
    The ID of the Redis instance.
    password 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 ignore_changes ignore changes in fields.
    roleName String
    Role type, the valid value can be Administrator, ReadWrite, ReadOnly, NotDangerous.
    description String
    The description of the redis account.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Account resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing Account Resource

    Get an existing Account resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: AccountState, opts?: CustomResourceOptions): Account
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        account_name: Optional[str] = None,
        description: Optional[str] = None,
        instance_id: Optional[str] = None,
        password: Optional[str] = None,
        role_name: Optional[str] = None) -> Account
    func GetAccount(ctx *Context, name string, id IDInput, state *AccountState, opts ...ResourceOption) (*Account, error)
    public static Account Get(string name, Input<string> id, AccountState? state, CustomResourceOptions? opts = null)
    public static Account get(String name, Output<String> id, AccountState state, CustomResourceOptions options)
    resources:  _:    type: volcengine:redis:Account    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AccountName string
    Redis account name.
    Description string
    The description of the redis account.
    InstanceId string
    The ID of the Redis instance.
    Password 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 ignore_changes ignore changes in fields.
    RoleName string
    Role type, the valid value can be Administrator, ReadWrite, ReadOnly, NotDangerous.
    AccountName string
    Redis account name.
    Description string
    The description of the redis account.
    InstanceId string
    The ID of the Redis instance.
    Password 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 ignore_changes ignore changes in fields.
    RoleName string
    Role type, the valid value can be Administrator, ReadWrite, ReadOnly, NotDangerous.
    accountName String
    Redis account name.
    description String
    The description of the redis account.
    instanceId String
    The ID of the Redis instance.
    password 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 ignore_changes ignore changes in fields.
    roleName String
    Role type, the valid value can be Administrator, ReadWrite, ReadOnly, NotDangerous.
    accountName string
    Redis account name.
    description string
    The description of the redis account.
    instanceId string
    The ID of the Redis instance.
    password 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 ignore_changes ignore changes in fields.
    roleName string
    Role type, the valid value can be Administrator, ReadWrite, ReadOnly, NotDangerous.
    account_name str
    Redis account name.
    description str
    The description of the redis account.
    instance_id str
    The ID of the Redis instance.
    password str
    The password of the redis account. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
    role_name str
    Role type, the valid value can be Administrator, ReadWrite, ReadOnly, NotDangerous.
    accountName String
    Redis account name.
    description String
    The description of the redis account.
    instanceId String
    The ID of the Redis instance.
    password 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 ignore_changes ignore changes in fields.
    roleName String
    Role type, the valid value can be Administrator, ReadWrite, ReadOnly, NotDangerous.

    Import

    Redis account can be imported using the instanceId:accountName, e.g.

    $ pulumi import volcengine:redis/account:Account default redis-42b38c769c4b:test

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    volcengine volcengine/pulumi-volcengine
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the volcengine Terraform Provider.
    volcengine logo
    Volcengine v0.0.27 published on Tuesday, Dec 10, 2024 by Volcengine
    volcengine/pulumi-volcengine