Skip to content

ReadOnlyDBInstanceProps

Properties for defining a ReadOnlyDBInstance.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-rds-readonlydbinstance

Initializer 

import com.aliyun.ros.cdk.rds.ReadOnlyDBInstanceProps;
ReadOnlyDBInstanceProps.builder()
    .dbInstanceClass(java.lang.String)
    .dbInstanceClass(IResolvable)
    .dbInstanceId(java.lang.String)
    .dbInstanceId(IResolvable)
    .dbInstanceStorage(java.lang.Number)
    .dbInstanceStorage(IResolvable)
    .engineVersion(java.lang.String)
    .engineVersion(IResolvable)
    .zoneId(java.lang.String)
    .zoneId(IResolvable)
//  .autoRenew(java.lang.Boolean)
//  .autoRenew(IResolvable)
//  .category(java.lang.String)
//  .category(IResolvable)
//  .dbInstanceDescription(java.lang.String)
//  .dbInstanceDescription(IResolvable)
//  .dbInstanceStorageType(java.lang.String)
//  .dbInstanceStorageType(IResolvable)
//  .dedicatedHostGroupId(java.lang.String)
//  .dedicatedHostGroupId(IResolvable)
//  .deletionProtection(java.lang.Boolean)
//  .deletionProtection(IResolvable)
//  .payType(java.lang.String)
//  .payType(IResolvable)
//  .period(java.lang.Number)
//  .period(IResolvable)
//  .periodType(java.lang.String)
//  .periodType(IResolvable)
//  .privateIpAddress(java.lang.String)
//  .privateIpAddress(IResolvable)
//  .resourceGroupId(java.lang.String)
//  .resourceGroupId(IResolvable)
//  .tags(java.util.Map<java.lang.String, java.lang.Object>)
//  .targetDedicatedHostIdForMaster(java.lang.String)
//  .targetDedicatedHostIdForMaster(IResolvable)
//  .vpcId(java.lang.String)
//  .vpcId(IResolvable)
//  .vSwitchId(java.lang.String)
//  .vSwitchId(IResolvable)
    .build();

Properties

Name Type Description
dbInstanceClass java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property dbInstanceClass: The type of the instance.
dbInstanceId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property dbInstanceId: The ID of the master instance.
dbInstanceStorage java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property dbInstanceStorage: The storage space of the instance.
engineVersion java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property engineVersion: The version of the database.
zoneId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property zoneId: The ID of the zone.
autoRenew java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property autoRenew: Specifies whether to enable auto-renewal.
category java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property category: The RDS edition of the read-only instance.
dbInstanceDescription java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property dbInstanceDescription: Description of created database instance.
dbInstanceStorageType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property dbInstanceStorageType: The type of storage media that is used by the instance.
dedicatedHostGroupId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property dedicatedHostGroupId: The ID of the dedicated cluster to which the read-only instance belongs.
deletionProtection java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property deletionProtection: Specifies whether to enable the release protection feature for the read-only instance.
payType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property payType: The billing method.
period java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property period: The subscription duration.
periodType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property periodType: Charge period for created instances.
privateIpAddress java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property privateIpAddress: The private IP address of the read-only instance.
resourceGroupId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property resourceGroupId: Resource group id.
tags java.util.Map Property tags: The tags of an instance.
targetDedicatedHostIdForMaster java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property targetDedicatedHostIdForMaster: The ID of the host on which the primary instance resides.
vpcId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property vpcId: The ID of the VPC.
vSwitchId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property vSwitchId: The ID of the VSwitch.

dbInstanceClassRequired 

public java.lang.Object getDbInstanceClass();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property dbInstanceClass: The type of the instance.

For more information, see Instance type list. The type of the read-only instance must be no less than that of the master instance. Otherwise, the read-only instance incurs high latency and high load.

dbInstanceIdRequired 

public java.lang.Object getDbInstanceId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property dbInstanceId: The ID of the master instance.

dbInstanceStorageRequired 

public java.lang.Object getDbInstanceStorage();
  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property dbInstanceStorage: The storage space of the instance.

Value range: 5 to 3000. The value must be a multiple of 5. Unit: GB.

engineVersionRequired 

public java.lang.Object getEngineVersion();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property engineVersion: The version of the database.

The database and the master instance must have the same database version. Valid values: 5.6, 5.7, 8.0, 2017_ent, 2019_ent

zoneIdRequired 

public java.lang.Object getZoneId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property zoneId: The ID of the zone.

You can call the DescribeRegions API operation to view the latest zones.

autoRenewOptional 

public java.lang.Object getAutoRenew();
  • Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

Property autoRenew: Specifies whether to enable auto-renewal.

Valid values: true and false. Note :Monthly subscription: The auto-renewal cycle is one month. Annual subscription: The auto-renewal cycle is one year.

categoryOptional 

public java.lang.Object getCategory();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property category: The RDS edition of the read-only instance.

Valid values: Basic: Basic Edition. HighAvailability: High-availability Edition. This is the default value. AlwaysOn: Cluster Edition. Finance: Enterprise Edition. This edition is available only on the China site (aliyun.com).

dbInstanceDescriptionOptional 

public java.lang.Object getDbInstanceDescription();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property dbInstanceDescription: Description of created database instance.

dbInstanceStorageTypeOptional 

public java.lang.Object getDbInstanceStorageType();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property dbInstanceStorageType: The type of storage media that is used by the instance.

Valid values: local_ssd: local SSDs cloud_ssd: standard SSDs cloud_essd: ESSDs of performance level 1 (PL1) cloud_essd2: ESSDs of PL2 cloud_essd3: ESSDs of PL3

dedicatedHostGroupIdOptional 

public java.lang.Object getDedicatedHostGroupId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property dedicatedHostGroupId: The ID of the dedicated cluster to which the read-only instance belongs.

This parameter is valid when you create the read-only instance in a dedicated cluster.

deletionProtectionOptional 

public java.lang.Object getDeletionProtection();
  • Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

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

Valid values:- true: enables the feature.- false (default): disables the feature.

payTypeOptional 

public java.lang.Object getPayType();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property payType: The billing method.

periodOptional 

public java.lang.Object getPeriod();
  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property period: The subscription duration.

Valid values: When PeriodType is Month, it could be from 1 to 12, 24, 36, 48, 60. When PeriodType is Year, it could be from 1 to 5.

periodTypeOptional 

public java.lang.Object getPeriodType();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property periodType: Charge period for created instances.

privateIpAddressOptional 

public java.lang.Object getPrivateIpAddress();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property privateIpAddress: The private IP address of the read-only instance.

It must be within the IP address range provided by the switch. The system automatically assigns an IP address based on the VPCId and VSwitchId by default.

resourceGroupIdOptional 

public java.lang.Object getResourceGroupId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property resourceGroupId: Resource group id.

tagsOptional 

public java.util.Map<java.lang.String, java.lang.Object> getTags();
  • Type: java.util.Map

Property tags: The tags of an instance.

You should input the information of the tag with the format of the Key-Value, such as {"key1":"value1","key2":"value2", ... "key5":"value5"}. At most 5 tags can be specified. Key It can be up to 64 characters in length. Cannot begin with aliyun. Cannot begin with http:// or https://. Cannot be a null string. Value It can be up to 128 characters in length. Cannot begin with aliyun. Cannot begin with http:// or https://. Can be a null string.

targetDedicatedHostIdForMasterOptional 

public java.lang.Object getTargetDedicatedHostIdForMaster();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property targetDedicatedHostIdForMaster: The ID of the host on which the primary instance resides.

This parameter is valid when you create the read-only instance in a dedicated cluster.

vpcIdOptional 

public java.lang.Object getVpcId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property vpcId: The ID of the VPC.

vSwitchIdOptional 

public java.lang.Object getVSwitchId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property vSwitchId: The ID of the VSwitch.