RosDBInstanceClone
This class is a base encapsulation around the ROS resource type ALIYUN::RDS::DBInstanceClone
, which is used to restore historical data of an instance to a new instance.
The new instance is the clone of the instance.
Initializers
import com.aliyun.ros.cdk.rds.RosDBInstanceClone;
RosDBInstanceClone.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
.dbInstanceId(java.lang.String)
.dbInstanceId(IResolvable)
.payType(java.lang.String)
.payType(IResolvable)
// .allocatePublicConnection(java.lang.Boolean)
// .allocatePublicConnection(IResolvable)
// .backupId(java.lang.String)
// .backupId(IResolvable)
// .backupRetentionPeriod(java.lang.Number)
// .backupRetentionPeriod(IResolvable)
// .backupType(java.lang.String)
// .backupType(IResolvable)
// .category(java.lang.String)
// .category(IResolvable)
// .connectionStringPrefix(java.lang.String)
// .connectionStringPrefix(IResolvable)
// .connectionStringType(java.lang.String)
// .connectionStringType(IResolvable)
// .dbInstanceClass(java.lang.String)
// .dbInstanceClass(IResolvable)
// .dbInstanceDescription(java.lang.String)
// .dbInstanceDescription(IResolvable)
// .dbInstanceStorage(java.lang.Number)
// .dbInstanceStorage(IResolvable)
// .dbInstanceStorageType(java.lang.String)
// .dbInstanceStorageType(IResolvable)
// .dbMappings(IResolvable)
// .dbMappings(java.util.List<IResolvable)
// .dbMappings(DBMappingsProperty>)
// .dbNames(java.lang.String)
// .dbNames(IResolvable)
// .dedicatedHostGroupId(java.lang.String)
// .dedicatedHostGroupId(IResolvable)
// .instanceNetworkType(java.lang.String)
// .instanceNetworkType(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)
// .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)
// .restoreTable(java.lang.String)
// .restoreTable(IResolvable)
// .restoreTime(java.lang.String)
// .restoreTime(IResolvable)
// .securityGroupId(java.lang.String)
// .securityGroupId(IResolvable)
// .securityIpList(java.lang.String)
// .securityIpList(IResolvable)
// .slaveZoneIds(IResolvable)
// .slaveZoneIds(java.util.List<java.lang.String)
// .slaveZoneIds(IResolvable>)
// .sqlCollectorStatus(java.lang.String)
// .sqlCollectorStatus(IResolvable)
// .sslSetting(java.lang.String)
// .sslSetting(IResolvable)
// .tableMeta(IResolvable)
// .tableMeta(java.util.List<IResolvable)
// .tableMeta(TableMetaProperty>)
// .tags(java.util.Map<java.lang.String, java.lang.Object>)
// .timeoutInMinutes(java.lang.Number)
// .timeoutInMinutes(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. |
dbInstanceId |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
No description. |
payType |
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. |
backupId |
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. |
backupType |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
No description. |
category |
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. |
dbInstanceClass |
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. |
dbInstanceStorage |
java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable |
No description. |
dbInstanceStorageType |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
No description. |
dbMappings |
com.aliyun.ros.cdk.core.IResolvable OR java.util.List |
No description. |
dbNames |
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. |
instanceNetworkType |
java.lang.String 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. |
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. |
restoreTable |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
No description. |
restoreTime |
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. |
securityIpList |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
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. |
tableMeta |
com.aliyun.ros.cdk.core.IResolvable OR java.util.List |
No description. |
tags |
java.util.Map |
No description. |
timeoutInMinutes |
java.lang.Number 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. |
scope
Required
- Type: com.aliyun.ros.cdk.core.Construct
scope in which this resource is defined.
id
Required
- Type: java.lang.String
scoped id of the resource.
enableResourcePropertyConstraint
Required
- Type: java.lang.Boolean
dbInstanceId
Required
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
payType
Required
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
allocatePublicConnection
Optional
- Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable
backupId
Optional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
backupRetentionPeriod
Optional
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
backupType
Optional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
category
Optional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
connectionStringPrefix
Optional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
connectionStringType
Optional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
dbInstanceClass
Optional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
dbInstanceDescription
Optional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
dbInstanceStorage
Optional
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
dbInstanceStorageType
Optional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
dbMappings
Optional
- Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List
DBMappingsProperty>
dbNames
Optional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
dedicatedHostGroupId
Optional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
instanceNetworkType
Optional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
maintainTime
Optional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
masterUsername
Optional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
masterUserPassword
Optional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
masterUserType
Optional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
period
Optional
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
periodType
Optional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
port
Optional
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
preferredBackupPeriod
Optional
- Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List
preferredBackupTime
Optional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
privateIpAddress
Optional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
restoreTable
Optional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
restoreTime
Optional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
securityGroupId
Optional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
securityIpList
Optional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
slaveZoneIds
Optional
- Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List
sqlCollectorStatus
Optional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
sslSetting
Optional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
tableMeta
Optional
- Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List
TableMetaProperty>
tags
Optional
- Type: java.util.Map
timeoutInMinutes
Optional
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
vpcId
Optional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
vSwitchId
Optional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
zoneId
Optional
- 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.
- 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.
- Type: java.lang.String
The new logical ID to use for this stack element.
addCondition
public void addCondition(RosCondition con)
- Type: com.aliyun.ros.cdk.core.RosCondition
addCount
public void addCount(java.lang.Number OR IResolvable count)
- 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)
.
- 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.
- Type: com.aliyun.ros.cdk.core.RosResource
addDesc
public void addDesc(java.lang.String desc)
- Type: java.lang.String
addMetaData
public void addMetaData(java.lang.String key, java.lang.Object value)
- Type: java.lang.String
- 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"
...
},
]
...
}
- 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.
- 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.
- 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)
.
- Type: java.lang.String
The path of the property.
- Type: java.lang.Object
The value.
addRosDependency
public void addRosDependency(java.lang.String target)
- 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.
- Type: com.aliyun.ros.cdk.core.RemovalPolicy
- 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.
- 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.RosDBInstanceClone;
RosDBInstanceClone.isConstruct(java.lang.Object x)
Return whether the given object is a Construct.
- Type: java.lang.Object
isRosElement
import com.aliyun.ros.cdk.rds.RosDBInstanceClone;
RosDBInstanceClone.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.
- Type: java.lang.Object
isRosResource
import com.aliyun.ros.cdk.rds.RosDBInstanceClone;
RosDBInstanceClone.isRosResource(IConstruct construct)
Check whether the given construct is a RosResource.
- 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. |
dbInstanceId |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
No description. |
enableResourcePropertyConstraint |
java.lang.Boolean |
No description. |
payType |
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. |
backupId |
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. |
backupType |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
No description. |
category |
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. |
dbInstanceClass |
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. |
dbInstanceStorage |
java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable |
No description. |
dbInstanceStorageType |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
No description. |
dbMappings |
com.aliyun.ros.cdk.core.IResolvable OR java.util.List |
No description. |
dbNames |
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. |
instanceNetworkType |
java.lang.String 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. |
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. |
restoreTable |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
No description. |
restoreTime |
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. |
securityIpList |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
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. |
tableMeta |
com.aliyun.ros.cdk.core.IResolvable OR java.util.List |
No description. |
tags |
java.util.Map |
No description. |
timeoutInMinutes |
java.lang.Number 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. |
node
Required
public ConstructNode getNode();
- Type: com.aliyun.ros.cdk.core.ConstructNode
The construct tree node associated with this construct.
creationStack
Required
public java.util.List<java.lang.String> getCreationStack();
- Type: java.util.List
logicalId
Required
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)
.
stack
Required
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).
ref
Required
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 })
.
rosOptions
Required
public IRosResourceOptions getRosOptions();
- Type: com.aliyun.ros.cdk.core.IRosResourceOptions
Options for this resource, such as condition, update policy etc.
rosResourceType
Required
public java.lang.String getRosResourceType();
- Type: java.lang.String
ROS resource type.
attrDbInstanceId
Required
public IResolvable getAttrDbInstanceId();
- Type: com.aliyun.ros.cdk.core.IResolvable
attrInnerConnectionString
Required
public IResolvable getAttrInnerConnectionString();
- Type: com.aliyun.ros.cdk.core.IResolvable
attrInnerIpAddress
Required
public IResolvable getAttrInnerIpAddress();
- Type: com.aliyun.ros.cdk.core.IResolvable
attrInnerPort
Required
public IResolvable getAttrInnerPort();
- Type: com.aliyun.ros.cdk.core.IResolvable
attrPublicConnectionString
Required
public IResolvable getAttrPublicConnectionString();
- Type: com.aliyun.ros.cdk.core.IResolvable
attrPublicIpAddress
Required
public IResolvable getAttrPublicIpAddress();
- Type: com.aliyun.ros.cdk.core.IResolvable
attrPublicPort
Required
public IResolvable getAttrPublicPort();
- Type: com.aliyun.ros.cdk.core.IResolvable
dbInstanceId
Required
public java.lang.Object getDbInstanceId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
enableResourcePropertyConstraint
Required
public java.lang.Boolean getEnableResourcePropertyConstraint();
- Type: java.lang.Boolean
payType
Required
public java.lang.Object getPayType();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
allocatePublicConnection
Optional
public java.lang.Object getAllocatePublicConnection();
- Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable
backupId
Optional
public java.lang.Object getBackupId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
backupRetentionPeriod
Optional
public java.lang.Object getBackupRetentionPeriod();
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
backupType
Optional
public java.lang.Object getBackupType();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
category
Optional
public java.lang.Object getCategory();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
connectionStringPrefix
Optional
public java.lang.Object getConnectionStringPrefix();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
connectionStringType
Optional
public java.lang.Object getConnectionStringType();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
dbInstanceClass
Optional
public java.lang.Object getDbInstanceClass();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
dbInstanceDescription
Optional
public java.lang.Object getDbInstanceDescription();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
dbInstanceStorage
Optional
public java.lang.Object getDbInstanceStorage();
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
dbInstanceStorageType
Optional
public java.lang.Object getDbInstanceStorageType();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
dbMappings
Optional
public java.lang.Object getDbMappings();
- Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List
DBMappingsProperty>
dbNames
Optional
public java.lang.Object getDbNames();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
dedicatedHostGroupId
Optional
public java.lang.Object getDedicatedHostGroupId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
instanceNetworkType
Optional
public java.lang.Object getInstanceNetworkType();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
maintainTime
Optional
public java.lang.Object getMaintainTime();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
masterUsername
Optional
public java.lang.Object getMasterUsername();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
masterUserPassword
Optional
public java.lang.Object getMasterUserPassword();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
masterUserType
Optional
public java.lang.Object getMasterUserType();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
period
Optional
public java.lang.Object getPeriod();
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
periodType
Optional
public java.lang.Object getPeriodType();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
port
Optional
public java.lang.Object getPort();
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
preferredBackupPeriod
Optional
public java.lang.Object getPreferredBackupPeriod();
- Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List
preferredBackupTime
Optional
public java.lang.Object getPreferredBackupTime();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
privateIpAddress
Optional
public java.lang.Object getPrivateIpAddress();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
restoreTable
Optional
public java.lang.Object getRestoreTable();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
restoreTime
Optional
public java.lang.Object getRestoreTime();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
securityGroupId
Optional
public java.lang.Object getSecurityGroupId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
securityIpList
Optional
public java.lang.Object getSecurityIpList();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
slaveZoneIds
Optional
public java.lang.Object getSlaveZoneIds();
- Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List
sqlCollectorStatus
Optional
public java.lang.Object getSqlCollectorStatus();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
sslSetting
Optional
public java.lang.Object getSslSetting();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
tableMeta
Optional
public java.lang.Object getTableMeta();
- Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List
TableMetaProperty>
tags
Optional
public java.util.Map<java.lang.String, java.lang.Object> getTags();
- Type: java.util.Map
timeoutInMinutes
Optional
public java.lang.Object getTimeoutInMinutes();
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
vpcId
Optional
public java.lang.Object getVpcId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
vSwitchId
Optional
public java.lang.Object getVSwitchId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
zoneId
Optional
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_NAME
Required
public java.lang.String getRosResourceTypeName();
- Type: java.lang.String
The resource type name for this resource class.