Skip to content

InstanceProps

Properties for defining a Instance.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-redis-instance

Initializer

import "github.com/alibabacloud-go/ros-cdk/alicloudroscdkredis"
&alicloudroscdkredis.InstanceProps {
    AutoRenewDuration: interface{},
    BackupPolicy: interface{},
    ChargeType: interface{},
    Connections: interface{},
    DeletionForce: interface{},
    DeletionProtection: interface{},
    EngineVersion: interface{},
    EvictionPolicy: interface{},
    InstanceClass: interface{},
    InstanceMaintainTime: interface{},
    InstanceName: interface{},
    NodeType: interface{},
    Password: interface{},
    Period: interface{},
    PeriodUnit: interface{},
    ProductType: interface{},
    ResourceGroupId: interface{},
    SecondaryZoneId: interface{},
    SecurityGroupId: interface{},
    ShardCount: interface{},
    SslEnabled: interface{},
    Tags: *[]github.com/alibabacloud-go/ros-cdk/alicloudroscdkredis.RosInstance.TagsProperty,
    TairConfig: interface{},
    VpcId: interface{},
    VpcPasswordFree: interface{},
    VSwitchId: interface{},
    ZoneId: interface{},
}

Properties

Name Type Description
AutoRenewDuration interface{} Property autoRenewDuration: The auto-renewal period.
BackupPolicy interface{} Property backupPolicy: Backup policy.
ChargeType interface{} Property chargeType: The billing method of the ApsaraDB for Redis instance.
Connections interface{} Property connections: Connection address.
DeletionForce interface{} Property deletionForce: Whether destroy instance when it is in recycle.
DeletionProtection interface{} Property deletionProtection: Specifies whether to enable the release protection feature for the instance.
EngineVersion interface{} Property engineVersion: Engine version.
EvictionPolicy interface{} Property evictionPolicy: The eviction policy of cache data storage.
InstanceClass interface{} Property instanceClass: Redis instance type.
InstanceMaintainTime interface{} Property instanceMaintainTime: Instance maintain time.
InstanceName interface{} Property instanceName: Display name of the instance, [2, 128] English or Chinese characters, must start with a letter or Chinese in size, can contain numbers, '_' or '.', '-'.
NodeType interface{} Property nodeType: The type of node.
Password interface{} Property password: The password of redis instance.length 8 to 30 characters, need to contain both uppercase and lowercase letters and numbers.
Period interface{} Property period: The period of order, when choose Prepaid required.optional value 1-9, 12, 24, 36, 60 Unit in month.
PeriodUnit interface{} Property periodUnit: The unit of the subscription duration.
ProductType interface{} Property productType: Product type.
ResourceGroupId interface{} Property resourceGroupId: Resource group id.
SecondaryZoneId interface{} Property secondaryZoneId: The secondary zone ID of the instance.
SecurityGroupId interface{} Property securityGroupId: The IDs of security groups.
ShardCount interface{} Property shardCount: The number of data nodes in the instance.
SslEnabled interface{} Property sslEnabled: Modifies the SSL status.
Tags *[]TagsProperty Property tags: Tags to attach to redis.
TairConfig interface{} Property tairConfig: Tair config.
VpcId interface{} Property vpcId: The VPC id to create ecs instance.
VpcPasswordFree interface{} Property vpcPasswordFree: Specifies whether to enable password free for access within the VPC.
VSwitchId interface{} Property vSwitchId: The vSwitch Id to create ecs instance.
ZoneId interface{} Property zoneId: The zone id of input region.

AutoRenewDurationOptional

AutoRenewDuration interface{}
  • Type: interface{}

Property autoRenewDuration: The auto-renewal period.

Valid values: 1 to 12. When the instance is about to expire, the instance is automatically renewed based on the number of months specified by this parameter. Note This parameter is valid only when ChargeType is set to PrePaid.


BackupPolicyOptional

BackupPolicy interface{}
  • Type: interface{}

Property backupPolicy: Backup policy.


ChargeTypeOptional

ChargeType interface{}
  • Type: interface{}

Property chargeType: The billing method of the ApsaraDB for Redis instance.


ConnectionsOptional

Connections interface{}
  • Type: interface{}

Property connections: Connection address.


DeletionForceOptional

DeletionForce interface{}
  • Type: interface{}

Property deletionForce: Whether destroy instance when it is in recycle.

Default is false


DeletionProtectionOptional

DeletionProtection interface{}
  • Type: interface{}

Property deletionProtection: Specifies whether to enable the release protection feature for the instance.

Default is false.


EngineVersionOptional

EngineVersion interface{}
  • Type: interface{}

Property engineVersion: Engine version.

Supported values: 2.8, 4.0, 5.0, 6.0 and 7.0


EvictionPolicyOptional

EvictionPolicy interface{}
  • Type: interface{}

Property evictionPolicy: The eviction policy of cache data storage.


InstanceClassOptional

InstanceClass interface{}
  • Type: interface{}

Property instanceClass: Redis instance type.

Refer the Redis instance type reference, such as 'redis.master.small.default', 'redis.master.4xlarge.default', 'redis.sharding.mid.default' etc


InstanceMaintainTimeOptional

InstanceMaintainTime interface{}
  • Type: interface{}

Property instanceMaintainTime: Instance maintain time.


InstanceNameOptional

InstanceName interface{}
  • Type: interface{}

Property instanceName: Display name of the instance, [2, 128] English or Chinese characters, must start with a letter or Chinese in size, can contain numbers, '_' or '.', '-'.


NodeTypeOptional

NodeType interface{}
  • Type: interface{}

Property nodeType: The type of node.

Valid value:

  • STAND_ALONE
  • MASTER_SLAVE
  • double
  • single

PasswordOptional

Password interface{}
  • Type: interface{}

Property password: The password of redis instance.length 8 to 30 characters, need to contain both uppercase and lowercase letters and numbers.


PeriodOptional

Period interface{}
  • Type: interface{}

Property period: The period of order, when choose Prepaid required.optional value 1-9, 12, 24, 36, 60 Unit in month.


PeriodUnitOptional

PeriodUnit interface{}
  • Type: interface{}

Property periodUnit: The unit of the subscription duration.

Valid values: Month Year Default value: Month.


ProductTypeOptional

ProductType interface{}
  • Type: interface{}

Property productType: Product type.

Valid values:Local: Community Edition(Local) or Enhanced Edition(Local)Tair_rdb: Performance Enhanced(Cloud Disk)Tair_scm: Persistent Memory(Cloud Disk)Tair_essd: Capacity Storage(Cloud Disk)OnECS: Community Edition(Cloud Disk)


ResourceGroupIdOptional

ResourceGroupId interface{}
  • Type: interface{}

Property resourceGroupId: Resource group id.


SecondaryZoneIdOptional

SecondaryZoneId interface{}
  • Type: interface{}

Property secondaryZoneId: The secondary zone ID of the instance.


SecurityGroupIdOptional

SecurityGroupId interface{}
  • Type: interface{}

Property securityGroupId: The IDs of security groups.

Separate multiple security group IDs with commas (,) and up to 10 can be set.


ShardCountOptional

ShardCount interface{}
  • Type: interface{}

Property shardCount: The number of data nodes in the instance.

Default value: 1. Valid values: 1: You can create an instance in the standard architecture that contains only a single data node. For more information about the standard architecture, see Cluster master-replica instances. 2 to 32: You can create an instance in the cluster architecturethat contains the specified number of data nodes. For more information about the cluster architecture, see Cluster master-replica instances.


SslEnabledOptional

SslEnabled interface{}
  • Type: interface{}

Property sslEnabled: Modifies the SSL status.

Valid values: Disable: disables SSL encryption. Enable: enables SSL encryption. Update: updates the SSL certificate.


TagsOptional

Tags *[]TagsProperty

Property tags: Tags to attach to redis.

Max support 20 tags to add during create redis. Each tag with two properties Key and Value, and Key is required.


TairConfigOptional

TairConfig interface{}
  • Type: interface{}

Property tairConfig: Tair config.

This parameter is available only if the InstanceClass parameter is start with tair.


VpcIdOptional

VpcId interface{}
  • Type: interface{}

Property vpcId: The VPC id to create ecs instance.


VpcPasswordFreeOptional

VpcPasswordFree interface{}
  • Type: interface{}

Property vpcPasswordFree: Specifies whether to enable password free for access within the VPC.

If set to:

  • true: enables password free.
  • false: disables password free.

VSwitchIdOptional

VSwitchId interface{}
  • Type: interface{}

Property vSwitchId: The vSwitch Id to create ecs instance.


ZoneIdOptional

ZoneId interface{}
  • Type: interface{}

Property zoneId: The zone id of input region.