Skip to content

RosDBInstance

This class is a base encapsulation around the ROS resource type ALIYUN::RDS::DBInstance, which is used to create an ApsaraDB RDS instance.

Initializers

import com.aliyun.ros.cdk.rds.RosDBInstance;
RosDBInstance.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .dbInstanceClass(java.lang.String)
    .dbInstanceClass(IResolvable)
    .dbInstanceStorage(java.lang.Number)
    .dbInstanceStorage(IResolvable)
    .engine(java.lang.String)
    .engine(IResolvable)
    .engineVersion(java.lang.String)
    .engineVersion(IResolvable)
    .securityIpList(java.lang.String)
    .securityIpList(IResolvable)
//  .allocatePublicConnection(java.lang.Boolean)
//  .allocatePublicConnection(IResolvable)
//  .archiveBackupKeepCount(java.lang.Number)
//  .archiveBackupKeepCount(IResolvable)
//  .archiveBackupKeepPolicy(java.lang.String)
//  .archiveBackupKeepPolicy(IResolvable)
//  .archiveBackupRetentionPeriod(java.lang.Number)
//  .archiveBackupRetentionPeriod(IResolvable)
//  .autoRenew(java.lang.Boolean)
//  .autoRenew(IResolvable)
//  .backUpCategory(java.lang.String)
//  .backUpCategory(IResolvable)
//  .backupPolicyMode(java.lang.String)
//  .backupPolicyMode(IResolvable)
//  .backupRetentionPeriod(java.lang.Number)
//  .backupRetentionPeriod(IResolvable)
//  .burstingEnabled(java.lang.Boolean)
//  .burstingEnabled(IResolvable)
//  .category(java.lang.String)
//  .category(IResolvable)
//  .coldDataEnabled(java.lang.Boolean)
//  .coldDataEnabled(IResolvable)
//  .compressType(java.lang.Number)
//  .compressType(IResolvable)
//  .connectionMode(java.lang.String)
//  .connectionMode(IResolvable)
//  .connectionStringPrefix(java.lang.String)
//  .connectionStringPrefix(IResolvable)
//  .connectionStringType(java.lang.String)
//  .connectionStringType(IResolvable)
//  .dbInstanceDescription(java.lang.String)
//  .dbInstanceDescription(IResolvable)
//  .dbInstanceNetType(java.lang.String)
//  .dbInstanceNetType(IResolvable)
//  .dbInstanceStorageType(java.lang.String)
//  .dbInstanceStorageType(IResolvable)
//  .dbIsIgnoreCase(java.lang.Number)
//  .dbIsIgnoreCase(IResolvable)
//  .dbMappings(IResolvable)
//  .dbMappings(java.util.List<IResolvable)
//  .dbMappings(DBMappingsProperty>)
//  .dbParamGroupId(java.lang.String)
//  .dbParamGroupId(IResolvable)
//  .dbTimeZone(java.lang.String)
//  .dbTimeZone(IResolvable)
//  .dedicatedHostGroupId(java.lang.String)
//  .dedicatedHostGroupId(IResolvable)
//  .enableBackupLog(java.lang.Boolean)
//  .enableBackupLog(IResolvable)
//  .encryptionKey(java.lang.String)
//  .encryptionKey(IResolvable)
//  .highSpaceUsageProtection(java.lang.String)
//  .highSpaceUsageProtection(IResolvable)
//  .instanceNetworkType(java.lang.String)
//  .instanceNetworkType(IResolvable)
//  .ioAccelerationEnabled(java.lang.String)
//  .ioAccelerationEnabled(IResolvable)
//  .localLogRetentionHours(java.lang.Number)
//  .localLogRetentionHours(IResolvable)
//  .localLogRetentionSpace(java.lang.Number)
//  .localLogRetentionSpace(IResolvable)
//  .logBackupFrequency(java.lang.String)
//  .logBackupFrequency(IResolvable)
//  .logBackupLocalRetentionNumber(java.lang.Number)
//  .logBackupLocalRetentionNumber(IResolvable)
//  .logBackupRetentionPeriod(java.lang.Number)
//  .logBackupRetentionPeriod(IResolvable)
//  .maintainTime(java.lang.String)
//  .maintainTime(IResolvable)
//  .masterUsername(java.lang.String)
//  .masterUsername(IResolvable)
//  .masterUserPassword(java.lang.String)
//  .masterUserPassword(IResolvable)
//  .masterUserType(java.lang.String)
//  .masterUserType(IResolvable)
//  .multiAz(java.lang.Boolean)
//  .multiAz(IResolvable)
//  .payType(java.lang.String)
//  .payType(IResolvable)
//  .period(java.lang.Number)
//  .period(IResolvable)
//  .periodType(java.lang.String)
//  .periodType(IResolvable)
//  .port(java.lang.Number)
//  .port(IResolvable)
//  .preferredBackupPeriod(IResolvable)
//  .preferredBackupPeriod(java.util.List<java.lang.String)
//  .preferredBackupPeriod(IResolvable>)
//  .preferredBackupTime(java.lang.String)
//  .preferredBackupTime(IResolvable)
//  .privateIpAddress(java.lang.String)
//  .privateIpAddress(IResolvable)
//  .releasedKeepPolicy(java.lang.String)
//  .releasedKeepPolicy(IResolvable)
//  .resourceGroupId(java.lang.String)
//  .resourceGroupId(IResolvable)
//  .roleArn(java.lang.String)
//  .roleArn(IResolvable)
//  .securityGroupId(java.lang.String)
//  .securityGroupId(IResolvable)
//  .serverlessConfig(IResolvable)
//  .serverlessConfig(ServerlessConfigProperty)
//  .slaveZoneIds(IResolvable)
//  .slaveZoneIds(java.util.List<java.lang.String)
//  .slaveZoneIds(IResolvable>)
//  .sqlCollectorStatus(java.lang.String)
//  .sqlCollectorStatus(IResolvable)
//  .sslSetting(java.lang.String)
//  .sslSetting(IResolvable)
//  .storageAutoScale(java.lang.String)
//  .storageAutoScale(IResolvable)
//  .storageThreshold(java.lang.Number)
//  .storageThreshold(IResolvable)
//  .storageUpperBound(java.lang.Number)
//  .storageUpperBound(IResolvable)
//  .tags(java.util.Map<java.lang.String, java.lang.Object>)
//  .targetDedicatedHostIdForLog(java.lang.String)
//  .targetDedicatedHostIdForLog(IResolvable)
//  .targetDedicatedHostIdForMaster(java.lang.String)
//  .targetDedicatedHostIdForMaster(IResolvable)
//  .targetDedicatedHostIdForSlave(java.lang.String)
//  .targetDedicatedHostIdForSlave(IResolvable)
//  .vpcId(java.lang.String)
//  .vpcId(IResolvable)
//  .vSwitchId(java.lang.String)
//  .vSwitchId(IResolvable)
//  .zoneId(java.lang.String)
//  .zoneId(IResolvable)
    .build();
Name Type Description
scope com.aliyun.ros.cdk.core.Construct - scope in which this resource is defined.
id java.lang.String - scoped id of the resource.
enableResourcePropertyConstraint java.lang.Boolean No description.
dbInstanceClass java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
dbInstanceStorage java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable No description.
engine java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
engineVersion java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
securityIpList java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
allocatePublicConnection java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable No description.
archiveBackupKeepCount java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable No description.
archiveBackupKeepPolicy java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
archiveBackupRetentionPeriod java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable No description.
autoRenew java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable No description.
backUpCategory java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
backupPolicyMode java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
backupRetentionPeriod java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable No description.
burstingEnabled java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable No description.
category java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
coldDataEnabled java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable No description.
compressType java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable No description.
connectionMode java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
connectionStringPrefix java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
connectionStringType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
dbInstanceDescription java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
dbInstanceNetType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
dbInstanceStorageType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
dbIsIgnoreCase java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable No description.
dbMappings com.aliyun.ros.cdk.core.IResolvable OR java.util.ListDBMappingsProperty> No description.
dbParamGroupId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
dbTimeZone java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
dedicatedHostGroupId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
enableBackupLog java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable No description.
encryptionKey java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
highSpaceUsageProtection java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
instanceNetworkType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
ioAccelerationEnabled java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
localLogRetentionHours java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable No description.
localLogRetentionSpace java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable No description.
logBackupFrequency java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
logBackupLocalRetentionNumber java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable No description.
logBackupRetentionPeriod java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable No description.
maintainTime java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
masterUsername java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
masterUserPassword java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
masterUserType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
multiAz java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable No description.
payType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
period java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable No description.
periodType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
port java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable No description.
preferredBackupPeriod com.aliyun.ros.cdk.core.IResolvable OR java.util.List No description.
preferredBackupTime java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
privateIpAddress java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
releasedKeepPolicy java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
resourceGroupId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
roleArn java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
securityGroupId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
serverlessConfig com.aliyun.ros.cdk.core.IResolvable OR ServerlessConfigProperty No description.
slaveZoneIds com.aliyun.ros.cdk.core.IResolvable OR java.util.List No description.
sqlCollectorStatus java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
sslSetting java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
storageAutoScale java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
storageThreshold java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable No description.
storageUpperBound java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable No description.
tags java.util.Map No description.
targetDedicatedHostIdForLog java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
targetDedicatedHostIdForMaster java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
targetDedicatedHostIdForSlave java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
vpcId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
vSwitchId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
zoneId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.

scopeRequired

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

scope in which this resource is defined.


idRequired

  • Type: java.lang.String

scoped id of the resource.


enableResourcePropertyConstraintRequired

  • Type: java.lang.Boolean

dbInstanceClassRequired

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

dbInstanceStorageRequired

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

engineRequired

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

engineVersionRequired

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

securityIpListRequired

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

allocatePublicConnectionOptional

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

archiveBackupKeepCountOptional

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

archiveBackupKeepPolicyOptional

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

archiveBackupRetentionPeriodOptional

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

autoRenewOptional

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

backUpCategoryOptional

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

backupPolicyModeOptional

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

backupRetentionPeriodOptional

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

burstingEnabledOptional

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

categoryOptional

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

coldDataEnabledOptional

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

compressTypeOptional

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

connectionModeOptional

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

connectionStringPrefixOptional

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

connectionStringTypeOptional

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

dbInstanceDescriptionOptional

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

dbInstanceNetTypeOptional

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

dbInstanceStorageTypeOptional

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

dbIsIgnoreCaseOptional

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

dbMappingsOptional

  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.ListDBMappingsProperty>

dbParamGroupIdOptional

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

dbTimeZoneOptional

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

dedicatedHostGroupIdOptional

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

enableBackupLogOptional

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

encryptionKeyOptional

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

highSpaceUsageProtectionOptional

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

instanceNetworkTypeOptional

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

ioAccelerationEnabledOptional

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

localLogRetentionHoursOptional

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

localLogRetentionSpaceOptional

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

logBackupFrequencyOptional

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

logBackupLocalRetentionNumberOptional

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

logBackupRetentionPeriodOptional

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

maintainTimeOptional

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

masterUsernameOptional

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

masterUserPasswordOptional

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

masterUserTypeOptional

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

multiAzOptional

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

payTypeOptional

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

periodOptional

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

periodTypeOptional

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

portOptional

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

preferredBackupPeriodOptional

  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List

preferredBackupTimeOptional

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

privateIpAddressOptional

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

releasedKeepPolicyOptional

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

resourceGroupIdOptional

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

roleArnOptional

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

securityGroupIdOptional

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

serverlessConfigOptional


slaveZoneIdsOptional

  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List

sqlCollectorStatusOptional

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

sslSettingOptional

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

storageAutoScaleOptional

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

storageThresholdOptional

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

storageUpperBoundOptional

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

tagsOptional

  • Type: java.util.Map

targetDedicatedHostIdForLogOptional

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

targetDedicatedHostIdForMasterOptional

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

targetDedicatedHostIdForSlaveOptional

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

vpcIdOptional

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

vSwitchIdOptional

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

zoneIdOptional

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

Methods

Name Description
toString Returns a string representation of this construct.
synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
overrideLogicalId Overrides the auto-generated logical ID with a specific ID.
addCondition No description.
addCount No description.
addDeletionOverride Syntactic sugar for addOverride(path, undefined).
addDependsOn Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addDesc No description.
addMetaData No description.
addOverride Adds an override to the synthesized ROS resource.
addPropertyDeletionOverride Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride Adds an override to a resource property.
addRosDependency No description.
applyRemovalPolicy Sets the deletion policy of the resource based on the removal policy specified.
getAtt Returns a token for an runtime attribute of this resource.

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.

sessionRequired

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

The synthesis session.


overrideLogicalId

public void overrideLogicalId(java.lang.String newLogicalId)

Overrides the auto-generated logical ID with a specific ID.

newLogicalIdRequired

  • Type: java.lang.String

The new logical ID to use for this stack element.


addCondition

public void addCondition(RosCondition con)

conRequired

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

addCount

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

countRequired

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

addDeletionOverride

public void addDeletionOverride(java.lang.String path)

Syntactic sugar for addOverride(path, undefined).

pathRequired

  • Type: java.lang.String

The path of the value to delete.


addDependsOn

public void addDependsOn(RosResource target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

targetRequired

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

addDesc

public void addDesc(java.lang.String desc)

descRequired

  • Type: java.lang.String

addMetaData

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

keyRequired

  • Type: java.lang.String

valueRequired

  • Type: java.lang.Object

addOverride

public void addOverride(java.lang.String path, java.lang.Object value)

Adds an override to the synthesized ROS resource.

To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

For example,

addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute'])
addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE')

would add the overrides

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}

pathRequired

  • Type: java.lang.String

The path of the property, you can use dot notation to override values in complex types.

Any intermdediate keys will be created as needed.


valueRequired

  • Type: java.lang.Object

The value.

Could be primitive or complex.


addPropertyDeletionOverride

public void addPropertyDeletionOverride(java.lang.String propertyPath)

Adds an override that deletes the value of a property from the resource definition.

propertyPathRequired

  • Type: java.lang.String

The path to the property.


addPropertyOverride

public void addPropertyOverride(java.lang.String propertyPath, java.lang.Object value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

propertyPathRequired

  • Type: java.lang.String

The path of the property.


valueRequired

  • Type: java.lang.Object

The value.


addRosDependency

public void addRosDependency(java.lang.String target)

targetRequired

  • Type: java.lang.String

applyRemovalPolicy

public void applyRemovalPolicy()
public void applyRemovalPolicy(RemovalPolicy policy)
public void applyRemovalPolicy(RemovalPolicy policy, RemovalPolicyOptions options)

Sets the deletion policy of the resource based on the removal policy specified.

policyOptional

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

optionsOptional

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

getAtt

public Reference getAtt(java.lang.String attributeName)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

attributeNameRequired

  • Type: java.lang.String

The name of the attribute.


Static Functions

Name Description
isConstruct Return whether the given object is a Construct.
isRosElement Returns true if a construct is a stack element (i.e. part of the synthesized template).
isRosResource Check whether the given construct is a RosResource.

isConstruct

import com.aliyun.ros.cdk.rds.RosDBInstance;
RosDBInstance.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

xRequired

  • Type: java.lang.Object

isRosElement

import com.aliyun.ros.cdk.rds.RosDBInstance;
RosDBInstance.isRosElement(java.lang.Object x)

Returns true if a construct is a stack element (i.e. part of the synthesized template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

xRequired

  • Type: java.lang.Object

isRosResource

import com.aliyun.ros.cdk.rds.RosDBInstance;
RosDBInstance.isRosResource(IConstruct construct)

Check whether the given construct is a RosResource.

constructRequired

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

Properties

Name Type Description
node com.aliyun.ros.cdk.core.ConstructNode The construct tree node associated with this construct.
creationStack java.util.List No description.
logicalId java.lang.String The logical ID for this stack element.
stack com.aliyun.ros.cdk.core.Stack The stack in which this element is defined.
ref java.lang.String Return a string that will be resolved to a RosTemplate { Ref } for this element.
rosOptions com.aliyun.ros.cdk.core.IRosResourceOptions Options for this resource, such as condition, update policy etc.
rosResourceType java.lang.String ROS resource type.
attrDbInstanceId com.aliyun.ros.cdk.core.IResolvable No description.
attrInnerConnectionString com.aliyun.ros.cdk.core.IResolvable No description.
attrInnerIpAddress com.aliyun.ros.cdk.core.IResolvable No description.
attrInnerPort com.aliyun.ros.cdk.core.IResolvable No description.
attrPublicConnectionString com.aliyun.ros.cdk.core.IResolvable No description.
attrPublicIpAddress com.aliyun.ros.cdk.core.IResolvable No description.
attrPublicPort com.aliyun.ros.cdk.core.IResolvable No description.
dbInstanceClass java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
dbInstanceStorage java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable No description.
enableResourcePropertyConstraint java.lang.Boolean No description.
engine java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
engineVersion java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
securityIpList java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
allocatePublicConnection java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable No description.
archiveBackupKeepCount java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable No description.
archiveBackupKeepPolicy java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
archiveBackupRetentionPeriod java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable No description.
autoRenew java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable No description.
backUpCategory java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
backupPolicyMode java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
backupRetentionPeriod java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable No description.
burstingEnabled java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable No description.
category java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
coldDataEnabled java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable No description.
compressType java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable No description.
connectionMode java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
connectionStringPrefix java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
connectionStringType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
dbInstanceDescription java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
dbInstanceNetType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
dbInstanceStorageType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
dbIsIgnoreCase java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable No description.
dbMappings com.aliyun.ros.cdk.core.IResolvable OR java.util.ListDBMappingsProperty> No description.
dbParamGroupId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
dbTimeZone java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
dedicatedHostGroupId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
enableBackupLog java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable No description.
encryptionKey java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
highSpaceUsageProtection java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
instanceNetworkType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
ioAccelerationEnabled java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
localLogRetentionHours java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable No description.
localLogRetentionSpace java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable No description.
logBackupFrequency java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
logBackupLocalRetentionNumber java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable No description.
logBackupRetentionPeriod java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable No description.
maintainTime java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
masterUsername java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
masterUserPassword java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
masterUserType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
multiAz java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable No description.
payType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
period java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable No description.
periodType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
port java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable No description.
preferredBackupPeriod com.aliyun.ros.cdk.core.IResolvable OR java.util.List No description.
preferredBackupTime java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
privateIpAddress java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
releasedKeepPolicy java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
resourceGroupId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
roleArn java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
securityGroupId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
serverlessConfig com.aliyun.ros.cdk.core.IResolvable OR ServerlessConfigProperty No description.
slaveZoneIds com.aliyun.ros.cdk.core.IResolvable OR java.util.List No description.
sqlCollectorStatus java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
sslSetting java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
storageAutoScale java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
storageThreshold java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable No description.
storageUpperBound java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable No description.
tags java.util.Map No description.
targetDedicatedHostIdForLog java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
targetDedicatedHostIdForMaster java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
targetDedicatedHostIdForSlave java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
vpcId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
vSwitchId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
zoneId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.

nodeRequired

public ConstructNode getNode();
  • Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.


creationStackRequired

public java.util.List<java.lang.String> getCreationStack();
  • Type: java.util.List

logicalIdRequired

public java.lang.String getLogicalId();
  • Type: java.lang.String

The logical ID for this stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).


stackRequired

public Stack getStack();
  • Type: com.aliyun.ros.cdk.core.Stack

The stack in which this element is defined.

RosElements must be defined within a stack scope (directly or indirectly).


refRequired

public java.lang.String getRef();
  • Type: java.lang.String

Return a string that will be resolved to a RosTemplate { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).


rosOptionsRequired

public IRosResourceOptions getRosOptions();
  • Type: com.aliyun.ros.cdk.core.IRosResourceOptions

Options for this resource, such as condition, update policy etc.


rosResourceTypeRequired

public java.lang.String getRosResourceType();
  • Type: java.lang.String

ROS resource type.


attrDbInstanceIdRequired

public IResolvable getAttrDbInstanceId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

attrInnerConnectionStringRequired

public IResolvable getAttrInnerConnectionString();
  • Type: com.aliyun.ros.cdk.core.IResolvable

attrInnerIpAddressRequired

public IResolvable getAttrInnerIpAddress();
  • Type: com.aliyun.ros.cdk.core.IResolvable

attrInnerPortRequired

public IResolvable getAttrInnerPort();
  • Type: com.aliyun.ros.cdk.core.IResolvable

attrPublicConnectionStringRequired

public IResolvable getAttrPublicConnectionString();
  • Type: com.aliyun.ros.cdk.core.IResolvable

attrPublicIpAddressRequired

public IResolvable getAttrPublicIpAddress();
  • Type: com.aliyun.ros.cdk.core.IResolvable

attrPublicPortRequired

public IResolvable getAttrPublicPort();
  • Type: com.aliyun.ros.cdk.core.IResolvable

dbInstanceClassRequired

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

dbInstanceStorageRequired

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

enableResourcePropertyConstraintRequired

public java.lang.Boolean getEnableResourcePropertyConstraint();
  • Type: java.lang.Boolean

engineRequired

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

engineVersionRequired

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

securityIpListRequired

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

allocatePublicConnectionOptional

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

archiveBackupKeepCountOptional

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

archiveBackupKeepPolicyOptional

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

archiveBackupRetentionPeriodOptional

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

autoRenewOptional

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

backUpCategoryOptional

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

backupPolicyModeOptional

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

backupRetentionPeriodOptional

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

burstingEnabledOptional

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

categoryOptional

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

coldDataEnabledOptional

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

compressTypeOptional

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

connectionModeOptional

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

connectionStringPrefixOptional

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

connectionStringTypeOptional

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

dbInstanceDescriptionOptional

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

dbInstanceNetTypeOptional

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

dbInstanceStorageTypeOptional

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

dbIsIgnoreCaseOptional

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

dbMappingsOptional

public java.lang.Object getDbMappings();
  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.ListDBMappingsProperty>

dbParamGroupIdOptional

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

dbTimeZoneOptional

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

dedicatedHostGroupIdOptional

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

enableBackupLogOptional

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

encryptionKeyOptional

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

highSpaceUsageProtectionOptional

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

instanceNetworkTypeOptional

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

ioAccelerationEnabledOptional

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

localLogRetentionHoursOptional

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

localLogRetentionSpaceOptional

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

logBackupFrequencyOptional

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

logBackupLocalRetentionNumberOptional

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

logBackupRetentionPeriodOptional

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

maintainTimeOptional

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

masterUsernameOptional

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

masterUserPasswordOptional

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

masterUserTypeOptional

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

multiAzOptional

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

payTypeOptional

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

periodOptional

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

periodTypeOptional

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

portOptional

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

preferredBackupPeriodOptional

public java.lang.Object getPreferredBackupPeriod();
  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List

preferredBackupTimeOptional

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

privateIpAddressOptional

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

releasedKeepPolicyOptional

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

resourceGroupIdOptional

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

roleArnOptional

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

securityGroupIdOptional

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

serverlessConfigOptional

public java.lang.Object getServerlessConfig();

slaveZoneIdsOptional

public java.lang.Object getSlaveZoneIds();
  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List

sqlCollectorStatusOptional

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

sslSettingOptional

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

storageAutoScaleOptional

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

storageThresholdOptional

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

storageUpperBoundOptional

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

tagsOptional

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

targetDedicatedHostIdForLogOptional

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

targetDedicatedHostIdForMasterOptional

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

targetDedicatedHostIdForSlaveOptional

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

vpcIdOptional

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

vSwitchIdOptional

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

zoneIdOptional

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

Constants

Name Type Description
ROS_RESOURCE_TYPE_NAME java.lang.String The resource type name for this resource class.

ROS_RESOURCE_TYPE_NAMERequired

public java.lang.String getRosResourceTypeName();
  • Type: java.lang.String

The resource type name for this resource class.