InstanceArgs

data class InstanceArgs(val autoRenew: Output<Boolean>? = null, val autoRenewPeriod: Output<Int>? = null, val autoUseCoupon: Output<Boolean>? = null, val availabilityZone: Output<String>? = null, val backupId: Output<String>? = null, val backupPeriods: Output<List<String>>? = null, val backupTime: Output<String>? = null, val bandwidth: Output<Int>? = null, val businessInfo: Output<String>? = null, val capacity: Output<Int>? = null, val config: Output<Map<String, String>>? = null, val connectionStringPrefix: Output<String>? = null, val couponNo: Output<String>? = null, val dbInstanceName: Output<String>? = null, val dedicatedHostGroupId: Output<String>? = null, val dryRun: Output<Boolean>? = null, val effectiveTime: Output<String>? = null, val enableBackupLog: Output<Int>? = null, val enablePublic: Output<Boolean>? = null, val encryptionKey: Output<String>? = null, val encryptionName: Output<String>? = null, val engineVersion: Output<String>? = null, val forceUpgrade: Output<Boolean>? = null, val globalInstance: Output<Boolean>? = null, val globalInstanceId: Output<String>? = null, val instanceChargeType: Output<String>? = null, val instanceClass: Output<String>? = null, val instanceName: Output<String>? = null, val instanceReleaseProtection: Output<Boolean>? = null, val instanceType: Output<String>? = null, val isAutoUpgradeOpen: Output<String>? = null, val kmsEncryptedPassword: Output<String>? = null, val kmsEncryptionContext: Output<Map<String, String>>? = null, val maintainEndTime: Output<String>? = null, val maintainStartTime: Output<String>? = null, val nodeType: Output<String>? = null, val orderType: Output<String>? = null, val parameters: Output<List<InstanceParameterArgs>>? = null, val password: Output<String>? = null, val paymentType: Output<String>? = null, val period: Output<String>? = null, val port: Output<Int>? = null, val privateConnectionPort: Output<String>? = null, val privateConnectionPrefix: Output<String>? = null, val privateIp: Output<String>? = null, val readOnlyCount: Output<Int>? = null, val resourceGroupId: Output<String>? = null, val restoreTime: Output<String>? = null, val roleArn: Output<String>? = null, val secondaryZoneId: Output<String>? = null, val securityGroupId: Output<String>? = null, val securityIpGroupAttribute: Output<String>? = null, val securityIpGroupName: Output<String>? = null, val securityIps: Output<List<String>>? = null, val shardCount: Output<Int>? = null, val slaveReadOnlyCount: Output<Int>? = null, val srcdbInstanceId: Output<String>? = null, val sslEnable: Output<String>? = null, val tags: Output<Map<String, String>>? = null, val tdeStatus: Output<String>? = null, val vpcAuthMode: Output<String>? = null, val vswitchId: Output<String>? = null, val zoneId: Output<String>? = null) : ConvertibleToJava<InstanceArgs>

Import

KVStore instance can be imported using the id, e.g.

$ pulumi import alicloud:kvstore/instance:Instance example r-abc12345678

Constructors

Link copied to clipboard
constructor(autoRenew: Output<Boolean>? = null, autoRenewPeriod: Output<Int>? = null, autoUseCoupon: Output<Boolean>? = null, availabilityZone: Output<String>? = null, backupId: Output<String>? = null, backupPeriods: Output<List<String>>? = null, backupTime: Output<String>? = null, bandwidth: Output<Int>? = null, businessInfo: Output<String>? = null, capacity: Output<Int>? = null, config: Output<Map<String, String>>? = null, connectionStringPrefix: Output<String>? = null, couponNo: Output<String>? = null, dbInstanceName: Output<String>? = null, dedicatedHostGroupId: Output<String>? = null, dryRun: Output<Boolean>? = null, effectiveTime: Output<String>? = null, enableBackupLog: Output<Int>? = null, enablePublic: Output<Boolean>? = null, encryptionKey: Output<String>? = null, encryptionName: Output<String>? = null, engineVersion: Output<String>? = null, forceUpgrade: Output<Boolean>? = null, globalInstance: Output<Boolean>? = null, globalInstanceId: Output<String>? = null, instanceChargeType: Output<String>? = null, instanceClass: Output<String>? = null, instanceName: Output<String>? = null, instanceReleaseProtection: Output<Boolean>? = null, instanceType: Output<String>? = null, isAutoUpgradeOpen: Output<String>? = null, kmsEncryptedPassword: Output<String>? = null, kmsEncryptionContext: Output<Map<String, String>>? = null, maintainEndTime: Output<String>? = null, maintainStartTime: Output<String>? = null, nodeType: Output<String>? = null, orderType: Output<String>? = null, parameters: Output<List<InstanceParameterArgs>>? = null, password: Output<String>? = null, paymentType: Output<String>? = null, period: Output<String>? = null, port: Output<Int>? = null, privateConnectionPort: Output<String>? = null, privateConnectionPrefix: Output<String>? = null, privateIp: Output<String>? = null, readOnlyCount: Output<Int>? = null, resourceGroupId: Output<String>? = null, restoreTime: Output<String>? = null, roleArn: Output<String>? = null, secondaryZoneId: Output<String>? = null, securityGroupId: Output<String>? = null, securityIpGroupAttribute: Output<String>? = null, securityIpGroupName: Output<String>? = null, securityIps: Output<List<String>>? = null, shardCount: Output<Int>? = null, slaveReadOnlyCount: Output<Int>? = null, srcdbInstanceId: Output<String>? = null, sslEnable: Output<String>? = null, tags: Output<Map<String, String>>? = null, tdeStatus: Output<String>? = null, vpcAuthMode: Output<String>? = null, vswitchId: Output<String>? = null, zoneId: Output<String>? = null)

Properties

Link copied to clipboard
val autoRenew: Output<Boolean>? = null

Whether to renewal a KVStore DBInstance automatically or not. It is valid when payment_type is PrePaid. Default value: false.

Link copied to clipboard
val autoRenewPeriod: Output<Int>? = null

Auto-renewal period of an KVStore DBInstance, in the unit of the month. It is valid when payment_type is PrePaid. Valid values: 1~12. Default value: 1.

Link copied to clipboard
val autoUseCoupon: Output<Boolean>? = null

Specifies whether to use a coupon. Default value: false.

Link copied to clipboard
val availabilityZone: Output<String>? = null

It has been deprecated from provider version 1.101.0 and zone_id instead.

Link copied to clipboard
val backupId: Output<String>? = null

The ID of the backup file of the source instance.

Link copied to clipboard
val backupPeriods: Output<List<String>>? = null

Backup period.

Link copied to clipboard
val backupTime: Output<String>? = null

Backup time, the format is HH:mmZ-HH:mmZ (UTC time).

Link copied to clipboard
val bandwidth: Output<Int>? = null

The total bandwidth of the instance. NOTE: From version 1.232.0, bandwidth can be set. If the instance is a cluster instance, bandwidth must be divisible by the number of shard_count in the instance, and if the instance is a read/write splitting instance, bandwidth cannot be set.

Link copied to clipboard
val businessInfo: Output<String>? = null

The ID of the event or the business information.

Link copied to clipboard
val capacity: Output<Int>? = null

The storage capacity of the KVStore DBInstance. Unit: MB.

Link copied to clipboard
val config: Output<Map<String, String>>? = null

The configuration of the KVStore DBInstance. Available parameters can refer to the latest docs Instance configurations table.

Link copied to clipboard
val connectionStringPrefix: Output<String>? = null

It has been deprecated from provider version 1.101.0 and resource alicloud.kvstore.Connection instead.

Link copied to clipboard
val couponNo: Output<String>? = null

The coupon code. NOTE: The default value youhuiquan_promotion_option_id_for_blank removed since v1.216.0, this can cause your status file to change even if it has not been modified, so please review your change plan before apply change plan.

Link copied to clipboard
val dbInstanceName: Output<String>? = null

The name of KVStore DBInstance. It is a string of 2 to 256 characters.

Link copied to clipboard
val dedicatedHostGroupId: Output<String>? = null

The ID of the dedicated cluster. This parameter is required when you create a Tair (Redis OSS-Compatible) And Memcache (KVStore) Classic Instance in a dedicated cluster.

Link copied to clipboard
val dryRun: Output<Boolean>? = null

Specifies whether to precheck the request. Valid values:

Link copied to clipboard
val effectiveTime: Output<String>? = null

The time when the database is switched after the instance is migrated, or when the major version is upgraded, or when the instance class is upgraded. Valid values:

Link copied to clipboard
val enableBackupLog: Output<Int>? = null

Turn on or off incremental backup. Valid values: 1, 0. Default value: 0

Link copied to clipboard
val enablePublic: Output<Boolean>? = null

It has been deprecated from provider version 1.101.0 and resource alicloud.kvstore.Connection instead.

Link copied to clipboard
val encryptionKey: Output<String>? = null

The Custom key ID, which you can get by calling DescribeEncryptionKeyList.If this parameter is not passed, the key is automatically generated by the key management service. To create a custom key, you can call the CreateKey interface of the key management service.

Link copied to clipboard
val encryptionName: Output<String>? = null

The Encryption algorithm, default AES-CTR-256.Note that this parameter is only available when the TDEStatus parameter is Enabled.

Link copied to clipboard
val engineVersion: Output<String>? = null

The engine version of the KVStore DBInstance. Valid values: "2.8", "4.0", "5.0", "6.0", "7.0". Default value: 5.0. NOTE: When instance_type = Memcache, the engine_version only supports "4.0".

Link copied to clipboard
val forceUpgrade: Output<Boolean>? = null

Specifies whether to forcibly change the type. Default value: true.

Link copied to clipboard
val globalInstance: Output<Boolean>? = null

Whether to create a distributed cache. Default value: false.

Link copied to clipboard
val globalInstanceId: Output<String>? = null

The ID of distributed cache.

Link copied to clipboard
val instanceChargeType: Output<String>? = null

It has been deprecated from provider version 1.101.0 and payment_type instead.

Link copied to clipboard
val instanceClass: Output<String>? = null

Type of the applied Tair (Redis OSS-Compatible) And Memcache (KVStore) Classic Instance. It can be retrieved by data source alicloud.kvstore.getInstanceClasses or referring to help-docs Instance type table.

Link copied to clipboard
val instanceName: Output<String>? = null

It has been deprecated from provider version 1.101.0 and db_instance_name instead.

Link copied to clipboard
val instanceReleaseProtection: Output<Boolean>? = null

Whether to open the release protection.

Link copied to clipboard
val instanceType: Output<String>? = null

The engine type of the KVStore DBInstance. Valid values: Redis or Memcache. Default value: Redis.

Link copied to clipboard
val isAutoUpgradeOpen: Output<String>? = null

Specifies whether to enable automatic minor version update. Valid values:

Link copied to clipboard
val kmsEncryptedPassword: Output<String>? = null

An KMS encrypts password used to an instance. If the password is filled in, this field will be ignored.

Link copied to clipboard
val kmsEncryptionContext: Output<Map<String, String>>? = null

An KMS encryption context used to decrypt kms_encrypted_password before creating or updating instance with kms_encrypted_password. See Encryption Context. It is valid when kms_encrypted_password is set.

Link copied to clipboard
val maintainEndTime: Output<String>? = null

The end time of the operation and maintenance time period of the KVStore DBInstance, in the format of HH:mmZ (UTC time).

Link copied to clipboard
val maintainStartTime: Output<String>? = null

The start time of the operation and maintenance time period of the KVStore DBInstance, in the format of HH:mmZ (UTC time).

Link copied to clipboard
val nodeType: Output<String>? = null

"Field node_type has been deprecated from version 1.120.1". This parameter is determined by the instance_class.

Link copied to clipboard
val orderType: Output<String>? = null

Specifies a change type when you change the configuration of a subscription instance. Valid values: UPGRADE, DOWNGRADE. Default value: UPGRADE. UPGRADE means upgrades the configuration of a subscription instance. DOWNGRADE means downgrades the configuration of a subscription instance.

Link copied to clipboard
val parameters: Output<List<InstanceParameterArgs>>? = null

It has been deprecated from provider version 1.101.0 and config instead. See parameters below.

Link copied to clipboard
val password: Output<String>? = null

The password of the KVStore DBInstance. The password that is used to connect to the instance. The password must be 8 to 32 characters in length and must contain at least three of the following character types: uppercase letters, lowercase letters, special characters, and digits. Special characters include: ! @ # $ % ^ & * ( ) _ + - =

Link copied to clipboard
val paymentType: Output<String>? = null

The billing method of the KVStore DBInstance. Valid values: PrePaid, PostPaid. Default value: PostPaid.

Link copied to clipboard
val period: Output<String>? = null

The duration that you will buy KVStore DBInstance (in month). It is valid when payment_type is PrePaid. Valid values: [1~9], 12, 24, 36.

Link copied to clipboard
val port: Output<Int>? = null

It has been deprecated from provider version 1.101.0 and resource alicloud.kvstore.Connection instead.

Link copied to clipboard
val privateConnectionPort: Output<String>? = null

Private network connection port, used to modify the private network connection port.

Link copied to clipboard
val privateConnectionPrefix: Output<String>? = null

Private network connection prefix, used to modify the private network connection address. Only supports updating private network connections for existing instance.

Link copied to clipboard
val privateIp: Output<String>? = null

The internal IP address of the instance.

Link copied to clipboard
val readOnlyCount: Output<Int>? = null

The number of read replicas in the primary zone. Valid values: 1 to 9.

Link copied to clipboard
val resourceGroupId: Output<String>? = null

The ID of resource group which the resource belongs.

Link copied to clipboard
val restoreTime: Output<String>? = null

The point in time of a backup file.

Link copied to clipboard
val roleArn: Output<String>? = null

The Specify the global resource descriptor ARN (Alibaba Cloud Resource Name) information of the role to be authorized, and use the related key management services after the authorization is completed, in the format: acs:ram::$accountID:role/$roleName.

Link copied to clipboard
val secondaryZoneId: Output<String>? = null

The ID of the secondary zone to which you want to migrate the Tair (Redis OSS-Compatible) And Memcache (KVStore) Classic Instance.

Link copied to clipboard
val securityGroupId: Output<String>? = null

The ID of security groups. Separate multiple security group IDs with commas (,), such as sg-***,sg-***,sg-***.

Link copied to clipboard
val securityIpGroupAttribute: Output<String>? = null

The value of this parameter is empty by default. The attribute of the whitelist group. The console does not display the whitelist group whose value of this parameter is hidden.

Link copied to clipboard
val securityIpGroupName: Output<String>? = null

The name of the whitelist group.

Link copied to clipboard
val securityIps: Output<List<String>>? = null

The IP addresses in the whitelist group. The maximum number of IP addresses in the whitelist group is 1000.

Link copied to clipboard
val shardCount: Output<Int>? = null

The number of data shards. This parameter is available only if you create a cluster instance that uses cloud disks. You can use this parameter to specify a custom number of data shards. NOTE: From version 1.216.0, shard_count can be modified.

Link copied to clipboard
val slaveReadOnlyCount: Output<Int>? = null

The number of read replicas in the secondary zone. NOTE:: When you create a multi-zone read/write splitting instance, you must specify both secondary_zone_id and slave_read_only_count.

Link copied to clipboard
val srcdbInstanceId: Output<String>? = null

The ID of the source instance.

Link copied to clipboard
val sslEnable: Output<String>? = null

Modifies the SSL status. Valid values: Disable, Enable and Update. NOTE: This functionality is supported by Cluster mode (Redis 2.8, 4.0, 5.0) and Standard mode( Redis 2.8 only).

Link copied to clipboard
val tags: Output<Map<String, String>>? = null

A mapping of tags to assign to the resource.

Link copied to clipboard
val tdeStatus: Output<String>? = null

Specifies whether to enable TDE. Valid values: Enabled. NOTE:: TDE cannot be disabled after it is enabled. Before you enable it, evaluate whether this feature affects. your business. For more information, see Enable TDE.

Link copied to clipboard
val vpcAuthMode: Output<String>? = null

Only meaningful if instance_type is Redis and network type is VPC. Valid values: Close, Open. Default value: Open. Close means the redis instance can be accessed without authentication. Open means authentication is required.

Link copied to clipboard
val vswitchId: Output<String>? = null

The ID of VSwitch.

Link copied to clipboard
val zoneId: Output<String>? = null

The ID of the zone.

Functions

Link copied to clipboard
open override fun toJava(): InstanceArgs