PrepayInstance

• Implements: IPrepayInstance

This class encapsulates and extends the ROS resource type ALIYUN::REDIS::PrepayInstance.

Initializers

import com.aliyun.ros.cdk.redis.PrepayInstance;
PrepayInstance.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
//  .autoPay(java.lang.Boolean)
//  .autoPay(IResolvable)
//  .autoRenewDuration(java.lang.Number)
//  .autoRenewDuration(IResolvable)
//  .backupPolicy(IResolvable)
//  .backupPolicy(BackupPolicyProperty)
//  .connections(IResolvable)
//  .connections(ConnectionsProperty)
//  .deletionForce(java.lang.Boolean)
//  .deletionForce(IResolvable)
//  .deletionProtection(java.lang.Boolean)
//  .deletionProtection(IResolvable)
//  .engineVersion(java.lang.String)
//  .engineVersion(IResolvable)
//  .evictionPolicy(java.lang.String)
//  .evictionPolicy(IResolvable)
//  .instanceClass(java.lang.String)
//  .instanceClass(IResolvable)
//  .instanceMaintainTime(IResolvable)
//  .instanceMaintainTime(InstanceMaintainTimeProperty)
//  .instanceName(java.lang.String)
//  .instanceName(IResolvable)
//  .nodeType(java.lang.String)
//  .nodeType(IResolvable)
//  .password(java.lang.String)
//  .password(IResolvable)
//  .period(java.lang.Number)
//  .period(IResolvable)
//  .periodUnit(java.lang.String)
//  .periodUnit(IResolvable)
//  .productType(java.lang.String)
//  .productType(IResolvable)
//  .readOnlyCount(java.lang.Number)
//  .readOnlyCount(IResolvable)
//  .resourceGroupId(java.lang.String)
//  .resourceGroupId(IResolvable)
//  .secondaryZoneId(java.lang.String)
//  .secondaryZoneId(IResolvable)
//  .securityGroupId(java.lang.String)
//  .securityGroupId(IResolvable)
//  .shardCount(java.lang.Number)
//  .shardCount(IResolvable)
//  .sslEnabled(java.lang.String)
//  .sslEnabled(IResolvable)
//  .subscriptionDeletionForce(java.lang.Boolean)
//  .subscriptionDeletionForce(IResolvable)
//  .tags(java.util.List<TagsProperty>)
//  .tairConfig(IResolvable)
//  .tairConfig(TairConfigProperty)
//  .tlsProtocol(java.lang.String)
//  .tlsProtocol(IResolvable)
//  .vpcId(java.lang.String)
//  .vpcId(IResolvable)
//  .vpcPasswordFree(java.lang.Boolean)
//  .vpcPasswordFree(IResolvable)
//  .vSwitchId(java.lang.String)
//  .vSwitchId(IResolvable)
//  .zoneId(java.lang.String)
//  .zoneId(IResolvable)
    .build();

scope^Required

• Type: com.aliyun.ros.cdk.core.Construct

id^Required

• Type: java.lang.String

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

autoPay^Optional

• Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

Property autoPay: Indicates whether automatic payment is enabled.

Valid values: false: Automatic payment is disabled. You need to go to Orders to make the payment once an order is generated. true: Automatic payment is enabled. The payment is automatically made. Default is False

autoRenewDuration^Optional

• Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

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.

backupPolicy^Optional

• Type: com.aliyun.ros.cdk.core.IResolvable OR BackupPolicyProperty

Property backupPolicy: Backup policy.

connections^Optional

• Type: com.aliyun.ros.cdk.core.IResolvable OR ConnectionsProperty

Property connections: Connection address.

deletionForce^Optional

• Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

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

Default is false

deletionProtection^Optional

• Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

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

Default is false.

engineVersion^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property engineVersion: Engine version.

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

evictionPolicy^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property evictionPolicy: The eviction policy of cache data storage.

instanceClass^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

instanceMaintainTime^Optional

• Type: com.aliyun.ros.cdk.core.IResolvable OR InstanceMaintainTimeProperty

Property instanceMaintainTime: Instance maintain time.

instanceName^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property nodeType: The type of node.

Valid value:

• STAND_ALONE
• MASTER_SLAVE
• double
• single

password^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

period^Optional

• Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

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

periodUnit^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property periodUnit: The unit of the subscription duration.

Valid values: Month Year Default value: Month.

productType^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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)

readOnlyCount^Optional

• Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property readOnlyCount: The number of read replicas in the primary zone.

Valid values: 1 to 9.

resourceGroupId^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property resourceGroupId: Resource group id.

secondaryZoneId^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property secondaryZoneId: The secondary zone ID of the instance.

securityGroupId^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property securityGroupId: The IDs of security groups.

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

shardCount^Optional

• Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

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.

sslEnabled^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property sslEnabled: Modifies the SSL status.

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

subscriptionDeletionForce^Optional

• Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

Property subscriptionDeletionForce: This option is only applicable to subscription instances.

For subscription instances, if this option is true, the instance will be converted to a postpaid instance before being deleted. If false, the forced deletion will not be performed. This operation will incur additional fees, so choose carefully.

tags^Optional

• Type: java.util.List<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.

tairConfig^Optional

• Type: com.aliyun.ros.cdk.core.IResolvable OR TairConfigProperty

Property tairConfig: Tair config.

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

tlsProtocol^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property tlsProtocol: The TLS version of the instance.

vpcId^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property vpcId: The VPC id to create ecs instance.

vpcPasswordFree^Optional

• Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

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

If set to:

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

vSwitchId^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property vSwitchId: The vSwitch Id to create ecs instance.

zoneId^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property zoneId: The zone id of input region.

Methods

toString

public java.lang.String toString()

Returns a string representation of this construct.

synthesize

public void synthesize(ISynthesisSession session)

Allows this construct to emit artifacts into the cloud assembly during synthesis.

This method is usually implemented by framework-level constructs such as Stack and Asset as they participate in synthesizing the cloud assembly.

session^Required

• Type: com.aliyun.ros.cdk.core.ISynthesisSession

The synthesis session.

addCondition

public void addCondition(RosCondition condition)

condition^Required

• Type: com.aliyun.ros.cdk.core.RosCondition

addCount

public void addCount(java.lang.Number OR IResolvable count)

count^Required

• Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

addDependency

public void addDependency(Resource resource)

resource^Required

• Type: com.aliyun.ros.cdk.core.Resource

addResourceDesc

public void addResourceDesc(java.lang.String desc)

desc^Required

• Type: java.lang.String

applyRemovalPolicy

public void applyRemovalPolicy(RemovalPolicy policy)

policy^Required

• Type: com.aliyun.ros.cdk.core.RemovalPolicy

fetchCondition

public RosCondition fetchCondition()

fetchDependency

public java.util.List<java.lang.String> fetchDependency()

fetchResourceDesc

public java.lang.String fetchResourceDesc()

getAtt

public IResolvable getAtt(java.lang.String name)

name^Required

• Type: java.lang.String

setMetadata

public void setMetadata(java.lang.String key, java.lang.Object value)

key^Required

• Type: java.lang.String

value^Required

• Type: java.lang.Object

Static Functions

isConstruct

import com.aliyun.ros.cdk.redis.PrepayInstance;
PrepayInstance.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

x^Required

• Type: java.lang.Object

Properties

node^Required

public ConstructNode getNode();

• Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.

env^Required

public IResourceEnvironment getEnv();

• Type: com.aliyun.ros.cdk.core.IResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

ref^Required

public java.lang.String getRef();

• Type: java.lang.String

stack^Required

public Stack getStack();

• Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.

resource^Optional

public RosResource getResource();

• Type: com.aliyun.ros.cdk.core.RosResource

attrArchitectureType^Required

public java.lang.Object getAttrArchitectureType();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute ArchitectureType: The architecture.

attrBandwidth^Required

public java.lang.Object getAttrBandwidth();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute Bandwidth: The bandwidth of the instance.

Unit: Mbit/s.

attrCapacity^Required

public java.lang.Object getAttrCapacity();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute Capacity: The storage capacity of the instance.

Unit: MB.

attrChargeType^Required

public java.lang.Object getAttrChargeType();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute ChargeType: The billing method of the instance.

attrClassicInnerConnectionPort^Required

public java.lang.Object getAttrClassicInnerConnectionPort();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute ClassicInnerConnectionPort: The classic inner connection port of the instance.

attrClassicInnerConnectionString^Required

public java.lang.Object getAttrClassicInnerConnectionString();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute ClassicInnerConnectionString: The classic inner connection string of the instance.

attrConnectionDomain^Required

public java.lang.Object getAttrConnectionDomain();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute ConnectionDomain: Connection domain of created instance.

attrConnections^Required

public java.lang.Object getAttrConnections();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute Connections: The maximum number of connections supported by the instance.

attrDirectConnectionPort^Required

public java.lang.Object getAttrDirectConnectionPort();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute DirectConnectionPort: The direct connection port of the instance.

attrDirectConnectionString^Required

public java.lang.Object getAttrDirectConnectionString();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute DirectConnectionString: The direct connection string of the instance.

attrEngineVersion^Required

public java.lang.Object getAttrEngineVersion();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute EngineVersion: The engine version of the instance.

attrHasRenewChangeOrder^Required

public java.lang.Object getAttrHasRenewChangeOrder();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute HasRenewChangeOrder: Indicates whether the Alibaba Cloud account has pending renewal or scaling orders.

attrInstanceClass^Required

public java.lang.Object getAttrInstanceClass();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute InstanceClass: Redis instance type.

attrInstanceId^Required

public java.lang.Object getAttrInstanceId();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute InstanceId: Instance id of created redis instance.

attrInstanceName^Required

public java.lang.Object getAttrInstanceName();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute InstanceName: Name of created redis instance.

attrInstanceType^Required

public java.lang.Object getAttrInstanceType();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute InstanceType: The engine type of the instance.

attrNetworkType^Required

public java.lang.Object getAttrNetworkType();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute NetworkType: The network type.

attrNodeType^Required

public java.lang.Object getAttrNodeType();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute NodeType: The type of node.

attrOrderId^Required

public java.lang.Object getAttrOrderId();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute OrderId: Order Id of created instance.

attrPackageType^Required

public java.lang.Object getAttrPackageType();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute PackageType: The plan type.

attrPort^Required

public java.lang.Object getAttrPort();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute Port: Port of created instance.

attrPrivateIp^Required

public java.lang.Object getAttrPrivateIp();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute PrivateIp: The internal IP address of the instance.

attrPublicConnectionPort^Required

public java.lang.Object getAttrPublicConnectionPort();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute PublicConnectionPort: The public connection port of the instance.

attrPublicConnectionString^Required

public java.lang.Object getAttrPublicConnectionString();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute PublicConnectionString: The public connection string of the instance.

attrQps^Required

public java.lang.Object getAttrQps();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute QPS: The queries per second (QPS) supported by the instance.

attrResourceGroupId^Required

public java.lang.Object getAttrResourceGroupId();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute ResourceGroupId: The ID of the resource group to which the instance belongs.

attrVpcId^Required

public java.lang.Object getAttrVpcId();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute VpcId: The ID of the VPC.

attrVpcPrivateConnectionPort^Required

public java.lang.Object getAttrVpcPrivateConnectionPort();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute VpcPrivateConnectionPort: The vpc private connection port of the instance.

attrVpcPrivateConnectionString^Required

public java.lang.Object getAttrVpcPrivateConnectionString();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute VpcPrivateConnectionString: The vpc private connection string of the instance.

attrVSwitchId^Required

public java.lang.Object getAttrVSwitchId();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute VSwitchId: The ID of the vSwitch.

attrZoneId^Required

public java.lang.Object getAttrZoneId();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute ZoneId: The ID of the zone.

props^Required

public PrepayInstanceProps getProps();

• Type: PrepayInstanceProps