volcengine.redis.Backup
Explore with Pulumi AI
Provides a resource to manage redis backup
Example Usage
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Volcengine = Pulumi.Volcengine;
using Volcengine = 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 fooBackup = new Volcengine.Redis.Backup("fooBackup", new()
{
InstanceId = fooInstance.Id,
});
});
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.NewBackup(ctx, "fooBackup", &redis.BackupArgs{
InstanceId: fooInstance.ID(),
})
if err != nil {
return err
}
return nil
})
}
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.Backup;
import com.pulumi.volcengine.redis.BackupArgs;
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 fooBackup = new Backup("fooBackup", BackupArgs.builder()
.instanceId(fooInstance.id())
.build());
}
}
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_backup = volcengine.redis.Backup("fooBackup", instance_id=foo_instance.id)
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 fooBackup = new volcengine.redis.Backup("fooBackup", {instanceId: fooInstance.id});
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
fooBackup:
type: volcengine:redis:Backup
properties:
instanceId: ${fooInstance.id}
variables:
fooZones:
fn::invoke:
Function: volcengine:ecs:Zones
Arguments: {}
Create Backup Resource
new Backup(name: string, args: BackupArgs, opts?: CustomResourceOptions);
@overload
def Backup(resource_name: str,
opts: Optional[ResourceOptions] = None,
instance_id: Optional[str] = None)
@overload
def Backup(resource_name: str,
args: BackupArgs,
opts: Optional[ResourceOptions] = None)
func NewBackup(ctx *Context, name string, args BackupArgs, opts ...ResourceOption) (*Backup, error)
public Backup(string name, BackupArgs args, CustomResourceOptions? opts = null)
public Backup(String name, BackupArgs args)
public Backup(String name, BackupArgs args, CustomResourceOptions options)
type: volcengine:redis:Backup
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args BackupArgs
- 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 BackupArgs
- 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 BackupArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args BackupArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args BackupArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Backup Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The Backup resource accepts the following input properties:
- Instance
Id string Id of instance to create backup.
- Instance
Id string Id of instance to create backup.
- instance
Id String Id of instance to create backup.
- instance
Id string Id of instance to create backup.
- instance_
id str Id of instance to create backup.
- instance
Id String Id of instance to create backup.
Outputs
All input properties are implicitly available as output properties. Additionally, the Backup resource produces the following output properties:
- Backup
Point stringId The id of backup point.
- Backup
Strategy string Backup strategy.
- Backup
Type string Backup type.
- End
Time string End time of backup.
- Id string
The provider-assigned unique ID for this managed resource.
- Instance
Details List<Volcengine.Backup Instance Detail> Information of instance.
- Size int
Size in MiB.
- Start
Time string Start time of backup.
- Status string
Status of backup (Creating/Available/Unavailable/Deleting).
- Backup
Point stringId The id of backup point.
- Backup
Strategy string Backup strategy.
- Backup
Type string Backup type.
- End
Time string End time of backup.
- Id string
The provider-assigned unique ID for this managed resource.
- Instance
Details []BackupInstance Detail Information of instance.
- Size int
Size in MiB.
- Start
Time string Start time of backup.
- Status string
Status of backup (Creating/Available/Unavailable/Deleting).
- backup
Point StringId The id of backup point.
- backup
Strategy String Backup strategy.
- backup
Type String Backup type.
- end
Time String End time of backup.
- id String
The provider-assigned unique ID for this managed resource.
- instance
Details List<BackupInstance Detail> Information of instance.
- size Integer
Size in MiB.
- start
Time String Start time of backup.
- status String
Status of backup (Creating/Available/Unavailable/Deleting).
- backup
Point stringId The id of backup point.
- backup
Strategy string Backup strategy.
- backup
Type string Backup type.
- end
Time string End time of backup.
- id string
The provider-assigned unique ID for this managed resource.
- instance
Details BackupInstance Detail[] Information of instance.
- size number
Size in MiB.
- start
Time string Start time of backup.
- status string
Status of backup (Creating/Available/Unavailable/Deleting).
- backup_
point_ strid The id of backup point.
- backup_
strategy str Backup strategy.
- backup_
type str Backup type.
- end_
time str End time of backup.
- id str
The provider-assigned unique ID for this managed resource.
- instance_
details Sequence[BackupInstance Detail] Information of instance.
- size int
Size in MiB.
- start_
time str Start time of backup.
- status str
Status of backup (Creating/Available/Unavailable/Deleting).
- backup
Point StringId The id of backup point.
- backup
Strategy String Backup strategy.
- backup
Type String Backup type.
- end
Time String End time of backup.
- id String
The provider-assigned unique ID for this managed resource.
- instance
Details List<Property Map> Information of instance.
- size Number
Size in MiB.
- start
Time String Start time of backup.
- status String
Status of backup (Creating/Available/Unavailable/Deleting).
Look up Existing Backup Resource
Get an existing Backup 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?: BackupState, opts?: CustomResourceOptions): Backup
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
backup_point_id: Optional[str] = None,
backup_strategy: Optional[str] = None,
backup_type: Optional[str] = None,
end_time: Optional[str] = None,
instance_details: Optional[Sequence[BackupInstanceDetailArgs]] = None,
instance_id: Optional[str] = None,
size: Optional[int] = None,
start_time: Optional[str] = None,
status: Optional[str] = None) -> Backup
func GetBackup(ctx *Context, name string, id IDInput, state *BackupState, opts ...ResourceOption) (*Backup, error)
public static Backup Get(string name, Input<string> id, BackupState? state, CustomResourceOptions? opts = null)
public static Backup get(String name, Output<String> id, BackupState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- 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.
- Backup
Point stringId The id of backup point.
- Backup
Strategy string Backup strategy.
- Backup
Type string Backup type.
- End
Time string End time of backup.
- Instance
Details List<Volcengine.Backup Instance Detail> Information of instance.
- Instance
Id string Id of instance to create backup.
- Size int
Size in MiB.
- Start
Time string Start time of backup.
- Status string
Status of backup (Creating/Available/Unavailable/Deleting).
- Backup
Point stringId The id of backup point.
- Backup
Strategy string Backup strategy.
- Backup
Type string Backup type.
- End
Time string End time of backup.
- Instance
Details []BackupInstance Detail Args Information of instance.
- Instance
Id string Id of instance to create backup.
- Size int
Size in MiB.
- Start
Time string Start time of backup.
- Status string
Status of backup (Creating/Available/Unavailable/Deleting).
- backup
Point StringId The id of backup point.
- backup
Strategy String Backup strategy.
- backup
Type String Backup type.
- end
Time String End time of backup.
- instance
Details List<BackupInstance Detail> Information of instance.
- instance
Id String Id of instance to create backup.
- size Integer
Size in MiB.
- start
Time String Start time of backup.
- status String
Status of backup (Creating/Available/Unavailable/Deleting).
- backup
Point stringId The id of backup point.
- backup
Strategy string Backup strategy.
- backup
Type string Backup type.
- end
Time string End time of backup.
- instance
Details BackupInstance Detail[] Information of instance.
- instance
Id string Id of instance to create backup.
- size number
Size in MiB.
- start
Time string Start time of backup.
- status string
Status of backup (Creating/Available/Unavailable/Deleting).
- backup_
point_ strid The id of backup point.
- backup_
strategy str Backup strategy.
- backup_
type str Backup type.
- end_
time str End time of backup.
- instance_
details Sequence[BackupInstance Detail Args] Information of instance.
- instance_
id str Id of instance to create backup.
- size int
Size in MiB.
- start_
time str Start time of backup.
- status str
Status of backup (Creating/Available/Unavailable/Deleting).
- backup
Point StringId The id of backup point.
- backup
Strategy String Backup strategy.
- backup
Type String Backup type.
- end
Time String End time of backup.
- instance
Details List<Property Map> Information of instance.
- instance
Id String Id of instance to create backup.
- size Number
Size in MiB.
- start
Time String Start time of backup.
- status String
Status of backup (Creating/Available/Unavailable/Deleting).
Supporting Types
BackupInstanceDetail, BackupInstanceDetailArgs
- Account
Id int Id of account.
- Arch
Type string Arch type of instance(Standard/Cluster).
- Charge
Type string Charge type of instance(Postpaid/Prepaid).
- Engine
Version string Engine version of instance.
- Expired
Time string Expired time of instance.
- Instance
Id string Id of instance to create backup.
- Instance
Name string Name of instance.
- Maintenance
Time string The maintainable period (in UTC) of the instance.
- Network
Type string Network type of instance.
- Project
Name string Project name of instance.
- Region
Id string Id of region.
- Replicas int
Count of replica in which shard.
- Server
Cpu int Count of cpu cores of instance.
- int
Capacity of shard.
- int
Count of shard.
- Total
Capacity int Total capacity of instance.
- Used
Capacity int Capacity used of this instance.
- Vpc
Infos List<Volcengine.Backup Instance Detail Vpc Info> Information of vpc.
- Zone
Ids List<string> List of id of zone.
- Account
Id int Id of account.
- Arch
Type string Arch type of instance(Standard/Cluster).
- Charge
Type string Charge type of instance(Postpaid/Prepaid).
- Engine
Version string Engine version of instance.
- Expired
Time string Expired time of instance.
- Instance
Id string Id of instance to create backup.
- Instance
Name string Name of instance.
- Maintenance
Time string The maintainable period (in UTC) of the instance.
- Network
Type string Network type of instance.
- Project
Name string Project name of instance.
- Region
Id string Id of region.
- Replicas int
Count of replica in which shard.
- Server
Cpu int Count of cpu cores of instance.
- int
Capacity of shard.
- int
Count of shard.
- Total
Capacity int Total capacity of instance.
- Used
Capacity int Capacity used of this instance.
- Vpc
Infos []BackupInstance Detail Vpc Info Information of vpc.
- Zone
Ids []string List of id of zone.
- account
Id Integer Id of account.
- arch
Type String Arch type of instance(Standard/Cluster).
- charge
Type String Charge type of instance(Postpaid/Prepaid).
- engine
Version String Engine version of instance.
- expired
Time String Expired time of instance.
- instance
Id String Id of instance to create backup.
- instance
Name String Name of instance.
- maintenance
Time String The maintainable period (in UTC) of the instance.
- network
Type String Network type of instance.
- project
Name String Project name of instance.
- region
Id String Id of region.
- replicas Integer
Count of replica in which shard.
- server
Cpu Integer Count of cpu cores of instance.
- Integer
Capacity of shard.
- Integer
Count of shard.
- total
Capacity Integer Total capacity of instance.
- used
Capacity Integer Capacity used of this instance.
- vpc
Infos List<BackupInstance Detail Vpc Info> Information of vpc.
- zone
Ids List<String> List of id of zone.
- account
Id number Id of account.
- arch
Type string Arch type of instance(Standard/Cluster).
- charge
Type string Charge type of instance(Postpaid/Prepaid).
- engine
Version string Engine version of instance.
- expired
Time string Expired time of instance.
- instance
Id string Id of instance to create backup.
- instance
Name string Name of instance.
- maintenance
Time string The maintainable period (in UTC) of the instance.
- network
Type string Network type of instance.
- project
Name string Project name of instance.
- region
Id string Id of region.
- replicas number
Count of replica in which shard.
- server
Cpu number Count of cpu cores of instance.
- number
Capacity of shard.
- number
Count of shard.
- total
Capacity number Total capacity of instance.
- used
Capacity number Capacity used of this instance.
- vpc
Infos BackupInstance Detail Vpc Info[] Information of vpc.
- zone
Ids string[] List of id of zone.
- account_
id int Id of account.
- arch_
type str Arch type of instance(Standard/Cluster).
- charge_
type str Charge type of instance(Postpaid/Prepaid).
- engine_
version str Engine version of instance.
- expired_
time str Expired time of instance.
- instance_
id str Id of instance to create backup.
- instance_
name str Name of instance.
- maintenance_
time str The maintainable period (in UTC) of the instance.
- network_
type str Network type of instance.
- project_
name str Project name of instance.
- region_
id str Id of region.
- replicas int
Count of replica in which shard.
- server_
cpu int Count of cpu cores of instance.
- int
Capacity of shard.
- int
Count of shard.
- total_
capacity int Total capacity of instance.
- used_
capacity int Capacity used of this instance.
- vpc_
infos Sequence[BackupInstance Detail Vpc Info] Information of vpc.
- zone_
ids Sequence[str] List of id of zone.
- account
Id Number Id of account.
- arch
Type String Arch type of instance(Standard/Cluster).
- charge
Type String Charge type of instance(Postpaid/Prepaid).
- engine
Version String Engine version of instance.
- expired
Time String Expired time of instance.
- instance
Id String Id of instance to create backup.
- instance
Name String Name of instance.
- maintenance
Time String The maintainable period (in UTC) of the instance.
- network
Type String Network type of instance.
- project
Name String Project name of instance.
- region
Id String Id of region.
- replicas Number
Count of replica in which shard.
- server
Cpu Number Count of cpu cores of instance.
- Number
Capacity of shard.
- Number
Count of shard.
- total
Capacity Number Total capacity of instance.
- used
Capacity Number Capacity used of this instance.
- vpc
Infos List<Property Map> Information of vpc.
- zone
Ids List<String> List of id of zone.
BackupInstanceDetailVpcInfo, BackupInstanceDetailVpcInfoArgs
Import
Redis Backup can be imported using the instanceId:backupId, e.g.
$ pulumi import volcengine:redis/backup:Backup default redis-cn02aqusft7ws****:b-cn02xmmrp751i9cdzcphjmk4****
Package Details
- Repository
- volcengine volcengine/pulumi-volcengine
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
volcengine
Terraform Provider.