Instance
Provides an ApsaraDB Redis / Memcache instance resource. A DB instance is an isolated database environment in the cloud. It can be associated with IP whitelists and backup configuration which are separate resource providers.
Example Usage
using Pulumi;
using AliCloud = Pulumi.AliCloud;
class MyStack : Stack
{
public MyStack()
{
var config = new Config();
var creation = config.Get("creation") ?? "KVStore";
var name = config.Get("name") ?? "kvstoreinstancevpc";
var defaultZones = Output.Create(AliCloud.GetZones.InvokeAsync(new AliCloud.GetZonesArgs
{
AvailableResourceCreation = creation,
}));
var defaultNetwork = new AliCloud.Vpc.Network("defaultNetwork", new AliCloud.Vpc.NetworkArgs
{
CidrBlock = "172.16.0.0/16",
});
var defaultSwitch = new AliCloud.Vpc.Switch("defaultSwitch", new AliCloud.Vpc.SwitchArgs
{
AvailabilityZone = defaultZones.Apply(defaultZones => defaultZones.Zones[0].Id),
CidrBlock = "172.16.0.0/24",
VpcId = defaultNetwork.Id,
});
var defaultInstance = new AliCloud.KVStore.Instance("defaultInstance", new AliCloud.KVStore.InstanceArgs
{
EngineVersion = "4.0",
InstanceClass = "redis.master.small.default",
InstanceName = name,
InstanceType = "Redis",
PrivateIp = "172.16.0.10",
SecurityIps =
{
"10.0.0.1",
},
VswitchId = defaultSwitch.Id,
});
}
}
Coming soon!
import pulumi
import pulumi_alicloud as alicloud
config = pulumi.Config()
creation = config.get("creation")
if creation is None:
creation = "KVStore"
name = config.get("name")
if name is None:
name = "kvstoreinstancevpc"
default_zones = alicloud.get_zones(available_resource_creation=creation)
default_network = alicloud.vpc.Network("defaultNetwork", cidr_block="172.16.0.0/16")
default_switch = alicloud.vpc.Switch("defaultSwitch",
availability_zone=default_zones.zones[0]["id"],
cidr_block="172.16.0.0/24",
vpc_id=default_network.id)
default_instance = alicloud.kvstore.Instance("defaultInstance",
engine_version="4.0",
instance_class="redis.master.small.default",
instance_name=name,
instance_type="Redis",
private_ip="172.16.0.10",
security_ips=["10.0.0.1"],
vswitch_id=default_switch.id)import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";
const config = new pulumi.Config();
const creation = config.get("creation") || "KVStore";
const name = config.get("name") || "kvstoreinstancevpc";
const defaultZones = pulumi.output(alicloud.getZones({
availableResourceCreation: creation,
}, { async: true }));
const defaultNetwork = new alicloud.vpc.Network("default", {
cidrBlock: "172.16.0.0/16",
});
const defaultSwitch = new alicloud.vpc.Switch("default", {
availabilityZone: defaultZones.zones[0].id,
cidrBlock: "172.16.0.0/24",
vpcId: defaultNetwork.id,
});
const defaultInstance = new alicloud.kvstore.Instance("default", {
engineVersion: "4.0",
instanceClass: "redis.master.small.default",
instanceName: name,
instanceType: "Redis",
privateIp: "172.16.0.10",
securityIps: ["10.0.0.1"],
vswitchId: defaultSwitch.id,
});Create a Instance Resource
new Instance(name: string, args: InstanceArgs, opts?: CustomResourceOptions);def Instance(resource_name, opts=None, auto_renew=None, auto_renew_period=None, availability_zone=None, backup_id=None, engine_version=None, instance_charge_type=None, instance_class=None, instance_name=None, instance_type=None, kms_encrypted_password=None, kms_encryption_context=None, maintain_end_time=None, maintain_start_time=None, parameters=None, password=None, period=None, private_ip=None, resource_group_id=None, security_group_id=None, security_ips=None, tags=None, vpc_auth_mode=None, vswitch_id=None, __props__=None);func NewInstance(ctx *Context, name string, args InstanceArgs, opts ...ResourceOption) (*Instance, error)public Instance(string name, InstanceArgs args, CustomResourceOptions? opts = null)- name string
- The unique name of the resource.
- args InstanceArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- opts ResourceOptions
- A bag of options that control this resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args InstanceArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args InstanceArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
Instance Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.
Inputs
The Instance resource accepts the following input properties:
- Instance
Class string - Auto
Renew bool Whether to renewal a DB instance automatically or not. It is valid when instance_charge_type is
PrePaid. Default tofalse.- Auto
Renew intPeriod Auto-renewal period of an instance, in the unit of the month. It is valid when instance_charge_type is
PrePaid. Valid value:[1~12], Default to 1.- Availability
Zone string The Zone to launch the DB instance.
- Backup
Id string If an instance created based on a backup set generated by another instance is valid, this parameter indicates the ID of the generated backup set.
- Engine
Version string Engine version. Supported values: 2.8, 4.0 and 5.0. Default value: 2.8. Only 2.8 can be supported for Memcache Instance.
- Instance
Charge stringType Valid values are
PrePaid,PostPaid, Default toPostPaid.- Instance
Name string The name of DB instance. It a string of 2 to 256 characters.
- Instance
Type string The engine to use:
RedisorMemcache. Defaults toRedis.- Kms
Encrypted stringPassword An KMS encrypts password used to a instance. If the
passwordis filled in, this field will be ignored.- Kms
Encryption Dictionary<string, object>Context An KMS encryption context used to decrypt
kms_encrypted_passwordbefore creating or updating instance withkms_encrypted_password. See Encryption Context. It is valid whenkms_encrypted_passwordis set.- Maintain
End stringTime The end time of the operation and maintenance time period of the instance, in the format of HH:mmZ (UTC time).
- Maintain
Start stringTime The start time of the operation and maintenance time period of the instance, in the format of HH:mmZ (UTC time).
- Parameters
List<Pulumi.
Ali Cloud. KVStore. Inputs. Instance Parameter Args> Set of parameters needs to be set after instance was launched. Available parameters can refer to the latest docs Instance configurations table .
- Password string
The password of the DB instance. The password is a string of 8 to 30 characters and must contain uppercase letters, lowercase letters, and numbers.
- Period int
The duration that you will buy DB instance (in month). It is valid when instance_charge_type is
PrePaid. Valid values: [1~9], 12, 24, 36. Default to 1.- Private
Ip string Set the instance’s private IP.
- Resource
Group stringId The ID of resource group which the resource belongs.
- Security
Group stringId The Security Group ID of ECS.
- Security
Ips List<string> Set the instance’s IP whitelist of the default security group.
- Dictionary<string, object>
A mapping of tags to assign to the resource.
- Vpc
Auth stringMode Only meaningful if instance_type is
Redisand network type is VPC. Valid values areClose,Open. Defaults toOpen.Closemeans the redis instance can be accessed without authentication.Openmeans authentication is required.- Vswitch
Id string The ID of VSwitch.
- Instance
Class string - Auto
Renew bool Whether to renewal a DB instance automatically or not. It is valid when instance_charge_type is
PrePaid. Default tofalse.- Auto
Renew intPeriod Auto-renewal period of an instance, in the unit of the month. It is valid when instance_charge_type is
PrePaid. Valid value:[1~12], Default to 1.- Availability
Zone string The Zone to launch the DB instance.
- Backup
Id string If an instance created based on a backup set generated by another instance is valid, this parameter indicates the ID of the generated backup set.
- Engine
Version string Engine version. Supported values: 2.8, 4.0 and 5.0. Default value: 2.8. Only 2.8 can be supported for Memcache Instance.
- Instance
Charge stringType Valid values are
PrePaid,PostPaid, Default toPostPaid.- Instance
Name string The name of DB instance. It a string of 2 to 256 characters.
- Instance
Type string The engine to use:
RedisorMemcache. Defaults toRedis.- Kms
Encrypted stringPassword An KMS encrypts password used to a instance. If the
passwordis filled in, this field will be ignored.- Kms
Encryption map[string]interface{}Context An KMS encryption context used to decrypt
kms_encrypted_passwordbefore creating or updating instance withkms_encrypted_password. See Encryption Context. It is valid whenkms_encrypted_passwordis set.- Maintain
End stringTime The end time of the operation and maintenance time period of the instance, in the format of HH:mmZ (UTC time).
- Maintain
Start stringTime The start time of the operation and maintenance time period of the instance, in the format of HH:mmZ (UTC time).
- Parameters
[]Instance
Parameter Set of parameters needs to be set after instance was launched. Available parameters can refer to the latest docs Instance configurations table .
- Password string
The password of the DB instance. The password is a string of 8 to 30 characters and must contain uppercase letters, lowercase letters, and numbers.
- Period int
The duration that you will buy DB instance (in month). It is valid when instance_charge_type is
PrePaid. Valid values: [1~9], 12, 24, 36. Default to 1.- Private
Ip string Set the instance’s private IP.
- Resource
Group stringId The ID of resource group which the resource belongs.
- Security
Group stringId The Security Group ID of ECS.
- Security
Ips []string Set the instance’s IP whitelist of the default security group.
- map[string]interface{}
A mapping of tags to assign to the resource.
- Vpc
Auth stringMode Only meaningful if instance_type is
Redisand network type is VPC. Valid values areClose,Open. Defaults toOpen.Closemeans the redis instance can be accessed without authentication.Openmeans authentication is required.- Vswitch
Id string The ID of VSwitch.
- instance
Class string - auto
Renew boolean Whether to renewal a DB instance automatically or not. It is valid when instance_charge_type is
PrePaid. Default tofalse.- auto
Renew numberPeriod Auto-renewal period of an instance, in the unit of the month. It is valid when instance_charge_type is
PrePaid. Valid value:[1~12], Default to 1.- availability
Zone string The Zone to launch the DB instance.
- backup
Id string If an instance created based on a backup set generated by another instance is valid, this parameter indicates the ID of the generated backup set.
- engine
Version string Engine version. Supported values: 2.8, 4.0 and 5.0. Default value: 2.8. Only 2.8 can be supported for Memcache Instance.
- instance
Charge stringType Valid values are
PrePaid,PostPaid, Default toPostPaid.- instance
Name string The name of DB instance. It a string of 2 to 256 characters.
- instance
Type string The engine to use:
RedisorMemcache. Defaults toRedis.- kms
Encrypted stringPassword An KMS encrypts password used to a instance. If the
passwordis filled in, this field will be ignored.- kms
Encryption {[key: string]: any}Context An KMS encryption context used to decrypt
kms_encrypted_passwordbefore creating or updating instance withkms_encrypted_password. See Encryption Context. It is valid whenkms_encrypted_passwordis set.- maintain
End stringTime The end time of the operation and maintenance time period of the instance, in the format of HH:mmZ (UTC time).
- maintain
Start stringTime The start time of the operation and maintenance time period of the instance, in the format of HH:mmZ (UTC time).
- parameters
Instance
Parameter[] Set of parameters needs to be set after instance was launched. Available parameters can refer to the latest docs Instance configurations table .
- password string
The password of the DB instance. The password is a string of 8 to 30 characters and must contain uppercase letters, lowercase letters, and numbers.
- period number
The duration that you will buy DB instance (in month). It is valid when instance_charge_type is
PrePaid. Valid values: [1~9], 12, 24, 36. Default to 1.- private
Ip string Set the instance’s private IP.
- resource
Group stringId The ID of resource group which the resource belongs.
- security
Group stringId The Security Group ID of ECS.
- security
Ips string[] Set the instance’s IP whitelist of the default security group.
- {[key: string]: any}
A mapping of tags to assign to the resource.
- vpc
Auth stringMode Only meaningful if instance_type is
Redisand network type is VPC. Valid values areClose,Open. Defaults toOpen.Closemeans the redis instance can be accessed without authentication.Openmeans authentication is required.- vswitch
Id string The ID of VSwitch.
- instance_
class str - auto_
renew bool Whether to renewal a DB instance automatically or not. It is valid when instance_charge_type is
PrePaid. Default tofalse.- auto_
renew_ floatperiod Auto-renewal period of an instance, in the unit of the month. It is valid when instance_charge_type is
PrePaid. Valid value:[1~12], Default to 1.- availability_
zone str The Zone to launch the DB instance.
- backup_
id str If an instance created based on a backup set generated by another instance is valid, this parameter indicates the ID of the generated backup set.
- engine_
version str Engine version. Supported values: 2.8, 4.0 and 5.0. Default value: 2.8. Only 2.8 can be supported for Memcache Instance.
- instance_
charge_ strtype Valid values are
PrePaid,PostPaid, Default toPostPaid.- instance_
name str The name of DB instance. It a string of 2 to 256 characters.
- instance_
type str The engine to use:
RedisorMemcache. Defaults toRedis.- kms_
encrypted_ strpassword An KMS encrypts password used to a instance. If the
passwordis filled in, this field will be ignored.- kms_
encryption_ Dict[str, Any]context An KMS encryption context used to decrypt
kms_encrypted_passwordbefore creating or updating instance withkms_encrypted_password. See Encryption Context. It is valid whenkms_encrypted_passwordis set.- maintain_
end_ strtime The end time of the operation and maintenance time period of the instance, in the format of HH:mmZ (UTC time).
- maintain_
start_ strtime The start time of the operation and maintenance time period of the instance, in the format of HH:mmZ (UTC time).
- parameters
List[Instance
Parameter] Set of parameters needs to be set after instance was launched. Available parameters can refer to the latest docs Instance configurations table .
- password str
The password of the DB instance. The password is a string of 8 to 30 characters and must contain uppercase letters, lowercase letters, and numbers.
- period float
The duration that you will buy DB instance (in month). It is valid when instance_charge_type is
PrePaid. Valid values: [1~9], 12, 24, 36. Default to 1.- private_
ip str Set the instance’s private IP.
- resource_
group_ strid The ID of resource group which the resource belongs.
- security_
group_ strid The Security Group ID of ECS.
- security_
ips List[str] Set the instance’s IP whitelist of the default security group.
- Dict[str, Any]
A mapping of tags to assign to the resource.
- vpc_
auth_ strmode Only meaningful if instance_type is
Redisand network type is VPC. Valid values areClose,Open. Defaults toOpen.Closemeans the redis instance can be accessed without authentication.Openmeans authentication is required.- vswitch_
id str The ID of VSwitch.
Outputs
All input properties are implicitly available as output properties. Additionally, the Instance resource produces the following output properties:
- Connection
Domain string Instance connection domain (only Intranet access supported).
- Id string
- The provider-assigned unique ID for this managed resource.
- Connection
Domain string Instance connection domain (only Intranet access supported).
- Id string
- The provider-assigned unique ID for this managed resource.
- connection
Domain string Instance connection domain (only Intranet access supported).
- id string
- The provider-assigned unique ID for this managed resource.
- connection_
domain str Instance connection domain (only Intranet access supported).
- id str
- The provider-assigned unique ID for this managed resource.
Look up an Existing Instance Resource
Get an existing Instance 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?: InstanceState, opts?: CustomResourceOptions): Instancestatic get(resource_name, id, opts=None, auto_renew=None, auto_renew_period=None, availability_zone=None, backup_id=None, connection_domain=None, engine_version=None, instance_charge_type=None, instance_class=None, instance_name=None, instance_type=None, kms_encrypted_password=None, kms_encryption_context=None, maintain_end_time=None, maintain_start_time=None, parameters=None, password=None, period=None, private_ip=None, resource_group_id=None, security_group_id=None, security_ips=None, tags=None, vpc_auth_mode=None, vswitch_id=None, __props__=None);func GetInstance(ctx *Context, name string, id IDInput, state *InstanceState, opts ...ResourceOption) (*Instance, error)public static Instance Get(string name, Input<string> id, InstanceState? state, CustomResourceOptions? opts = null)- 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.
The following state arguments are supported:
- Auto
Renew bool Whether to renewal a DB instance automatically or not. It is valid when instance_charge_type is
PrePaid. Default tofalse.- Auto
Renew intPeriod Auto-renewal period of an instance, in the unit of the month. It is valid when instance_charge_type is
PrePaid. Valid value:[1~12], Default to 1.- Availability
Zone string The Zone to launch the DB instance.
- Backup
Id string If an instance created based on a backup set generated by another instance is valid, this parameter indicates the ID of the generated backup set.
- Connection
Domain string Instance connection domain (only Intranet access supported).
- Engine
Version string Engine version. Supported values: 2.8, 4.0 and 5.0. Default value: 2.8. Only 2.8 can be supported for Memcache Instance.
- Instance
Charge stringType Valid values are
PrePaid,PostPaid, Default toPostPaid.- Instance
Class string - Instance
Name string The name of DB instance. It a string of 2 to 256 characters.
- Instance
Type string The engine to use:
RedisorMemcache. Defaults toRedis.- Kms
Encrypted stringPassword An KMS encrypts password used to a instance. If the
passwordis filled in, this field will be ignored.- Kms
Encryption Dictionary<string, object>Context An KMS encryption context used to decrypt
kms_encrypted_passwordbefore creating or updating instance withkms_encrypted_password. See Encryption Context. It is valid whenkms_encrypted_passwordis set.- Maintain
End stringTime The end time of the operation and maintenance time period of the instance, in the format of HH:mmZ (UTC time).
- Maintain
Start stringTime The start time of the operation and maintenance time period of the instance, in the format of HH:mmZ (UTC time).
- Parameters
List<Pulumi.
Ali Cloud. KVStore. Inputs. Instance Parameter Args> Set of parameters needs to be set after instance was launched. Available parameters can refer to the latest docs Instance configurations table .
- Password string
The password of the DB instance. The password is a string of 8 to 30 characters and must contain uppercase letters, lowercase letters, and numbers.
- Period int
The duration that you will buy DB instance (in month). It is valid when instance_charge_type is
PrePaid. Valid values: [1~9], 12, 24, 36. Default to 1.- Private
Ip string Set the instance’s private IP.
- Resource
Group stringId The ID of resource group which the resource belongs.
- Security
Group stringId The Security Group ID of ECS.
- Security
Ips List<string> Set the instance’s IP whitelist of the default security group.
- Dictionary<string, object>
A mapping of tags to assign to the resource.
- Vpc
Auth stringMode Only meaningful if instance_type is
Redisand network type is VPC. Valid values areClose,Open. Defaults toOpen.Closemeans the redis instance can be accessed without authentication.Openmeans authentication is required.- Vswitch
Id string The ID of VSwitch.
- Auto
Renew bool Whether to renewal a DB instance automatically or not. It is valid when instance_charge_type is
PrePaid. Default tofalse.- Auto
Renew intPeriod Auto-renewal period of an instance, in the unit of the month. It is valid when instance_charge_type is
PrePaid. Valid value:[1~12], Default to 1.- Availability
Zone string The Zone to launch the DB instance.
- Backup
Id string If an instance created based on a backup set generated by another instance is valid, this parameter indicates the ID of the generated backup set.
- Connection
Domain string Instance connection domain (only Intranet access supported).
- Engine
Version string Engine version. Supported values: 2.8, 4.0 and 5.0. Default value: 2.8. Only 2.8 can be supported for Memcache Instance.
- Instance
Charge stringType Valid values are
PrePaid,PostPaid, Default toPostPaid.- Instance
Class string - Instance
Name string The name of DB instance. It a string of 2 to 256 characters.
- Instance
Type string The engine to use:
RedisorMemcache. Defaults toRedis.- Kms
Encrypted stringPassword An KMS encrypts password used to a instance. If the
passwordis filled in, this field will be ignored.- Kms
Encryption map[string]interface{}Context An KMS encryption context used to decrypt
kms_encrypted_passwordbefore creating or updating instance withkms_encrypted_password. See Encryption Context. It is valid whenkms_encrypted_passwordis set.- Maintain
End stringTime The end time of the operation and maintenance time period of the instance, in the format of HH:mmZ (UTC time).
- Maintain
Start stringTime The start time of the operation and maintenance time period of the instance, in the format of HH:mmZ (UTC time).
- Parameters
[]Instance
Parameter Set of parameters needs to be set after instance was launched. Available parameters can refer to the latest docs Instance configurations table .
- Password string
The password of the DB instance. The password is a string of 8 to 30 characters and must contain uppercase letters, lowercase letters, and numbers.
- Period int
The duration that you will buy DB instance (in month). It is valid when instance_charge_type is
PrePaid. Valid values: [1~9], 12, 24, 36. Default to 1.- Private
Ip string Set the instance’s private IP.
- Resource
Group stringId The ID of resource group which the resource belongs.
- Security
Group stringId The Security Group ID of ECS.
- Security
Ips []string Set the instance’s IP whitelist of the default security group.
- map[string]interface{}
A mapping of tags to assign to the resource.
- Vpc
Auth stringMode Only meaningful if instance_type is
Redisand network type is VPC. Valid values areClose,Open. Defaults toOpen.Closemeans the redis instance can be accessed without authentication.Openmeans authentication is required.- Vswitch
Id string The ID of VSwitch.
- auto
Renew boolean Whether to renewal a DB instance automatically or not. It is valid when instance_charge_type is
PrePaid. Default tofalse.- auto
Renew numberPeriod Auto-renewal period of an instance, in the unit of the month. It is valid when instance_charge_type is
PrePaid. Valid value:[1~12], Default to 1.- availability
Zone string The Zone to launch the DB instance.
- backup
Id string If an instance created based on a backup set generated by another instance is valid, this parameter indicates the ID of the generated backup set.
- connection
Domain string Instance connection domain (only Intranet access supported).
- engine
Version string Engine version. Supported values: 2.8, 4.0 and 5.0. Default value: 2.8. Only 2.8 can be supported for Memcache Instance.
- instance
Charge stringType Valid values are
PrePaid,PostPaid, Default toPostPaid.- instance
Class string - instance
Name string The name of DB instance. It a string of 2 to 256 characters.
- instance
Type string The engine to use:
RedisorMemcache. Defaults toRedis.- kms
Encrypted stringPassword An KMS encrypts password used to a instance. If the
passwordis filled in, this field will be ignored.- kms
Encryption {[key: string]: any}Context An KMS encryption context used to decrypt
kms_encrypted_passwordbefore creating or updating instance withkms_encrypted_password. See Encryption Context. It is valid whenkms_encrypted_passwordis set.- maintain
End stringTime The end time of the operation and maintenance time period of the instance, in the format of HH:mmZ (UTC time).
- maintain
Start stringTime The start time of the operation and maintenance time period of the instance, in the format of HH:mmZ (UTC time).
- parameters
Instance
Parameter[] Set of parameters needs to be set after instance was launched. Available parameters can refer to the latest docs Instance configurations table .
- password string
The password of the DB instance. The password is a string of 8 to 30 characters and must contain uppercase letters, lowercase letters, and numbers.
- period number
The duration that you will buy DB instance (in month). It is valid when instance_charge_type is
PrePaid. Valid values: [1~9], 12, 24, 36. Default to 1.- private
Ip string Set the instance’s private IP.
- resource
Group stringId The ID of resource group which the resource belongs.
- security
Group stringId The Security Group ID of ECS.
- security
Ips string[] Set the instance’s IP whitelist of the default security group.
- {[key: string]: any}
A mapping of tags to assign to the resource.
- vpc
Auth stringMode Only meaningful if instance_type is
Redisand network type is VPC. Valid values areClose,Open. Defaults toOpen.Closemeans the redis instance can be accessed without authentication.Openmeans authentication is required.- vswitch
Id string The ID of VSwitch.
- auto_
renew bool Whether to renewal a DB instance automatically or not. It is valid when instance_charge_type is
PrePaid. Default tofalse.- auto_
renew_ floatperiod Auto-renewal period of an instance, in the unit of the month. It is valid when instance_charge_type is
PrePaid. Valid value:[1~12], Default to 1.- availability_
zone str The Zone to launch the DB instance.
- backup_
id str If an instance created based on a backup set generated by another instance is valid, this parameter indicates the ID of the generated backup set.
- connection_
domain str Instance connection domain (only Intranet access supported).
- engine_
version str Engine version. Supported values: 2.8, 4.0 and 5.0. Default value: 2.8. Only 2.8 can be supported for Memcache Instance.
- instance_
charge_ strtype Valid values are
PrePaid,PostPaid, Default toPostPaid.- instance_
class str - instance_
name str The name of DB instance. It a string of 2 to 256 characters.
- instance_
type str The engine to use:
RedisorMemcache. Defaults toRedis.- kms_
encrypted_ strpassword An KMS encrypts password used to a instance. If the
passwordis filled in, this field will be ignored.- kms_
encryption_ Dict[str, Any]context An KMS encryption context used to decrypt
kms_encrypted_passwordbefore creating or updating instance withkms_encrypted_password. See Encryption Context. It is valid whenkms_encrypted_passwordis set.- maintain_
end_ strtime The end time of the operation and maintenance time period of the instance, in the format of HH:mmZ (UTC time).
- maintain_
start_ strtime The start time of the operation and maintenance time period of the instance, in the format of HH:mmZ (UTC time).
- parameters
List[Instance
Parameter] Set of parameters needs to be set after instance was launched. Available parameters can refer to the latest docs Instance configurations table .
- password str
The password of the DB instance. The password is a string of 8 to 30 characters and must contain uppercase letters, lowercase letters, and numbers.
- period float
The duration that you will buy DB instance (in month). It is valid when instance_charge_type is
PrePaid. Valid values: [1~9], 12, 24, 36. Default to 1.- private_
ip str Set the instance’s private IP.
- resource_
group_ strid The ID of resource group which the resource belongs.
- security_
group_ strid The Security Group ID of ECS.
- security_
ips List[str] Set the instance’s IP whitelist of the default security group.
- Dict[str, Any]
A mapping of tags to assign to the resource.
- vpc_
auth_ strmode Only meaningful if instance_type is
Redisand network type is VPC. Valid values areClose,Open. Defaults toOpen.Closemeans the redis instance can be accessed without authentication.Openmeans authentication is required.- vswitch_
id str The ID of VSwitch.
Supporting Types
InstanceParameter
Package Details
- Repository
- https://github.com/pulumi/pulumi-alicloud
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
alicloudTerraform Provider.