Skip to content

RosInstance2

This class is a base encapsulation around the ROS resource type ALIYUN::DMS::Instance2.

Initializers

import com.aliyun.ros.cdk.dms.RosInstance2;
RosInstance2.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .databasePassword(java.lang.String)
    .databasePassword(IResolvable)
    .databaseUser(java.lang.String)
    .databaseUser(IResolvable)
    .dbaId(java.lang.Number)
    .dbaId(IResolvable)
    .enableSellTrust(java.lang.String)
    .enableSellTrust(IResolvable)
    .envType(java.lang.String)
    .envType(IResolvable)
    .exportTimeout(java.lang.Number)
    .exportTimeout(IResolvable)
    .host(java.lang.String)
    .host(IResolvable)
    .instanceAlias(java.lang.String)
    .instanceAlias(IResolvable)
    .instanceSource(java.lang.String)
    .instanceSource(IResolvable)
    .instanceType(java.lang.String)
    .instanceType(IResolvable)
    .networkType(java.lang.String)
    .networkType(IResolvable)
    .port(java.lang.Number)
    .port(IResolvable)
    .queryTimeout(java.lang.Number)
    .queryTimeout(IResolvable)
    .safeRule(java.lang.String)
    .safeRule(IResolvable)
//  .dataLinkName(java.lang.String)
//  .dataLinkName(IResolvable)
//  .ddlOnline(java.lang.Number)
//  .ddlOnline(IResolvable)
//  .ecsInstanceId(java.lang.String)
//  .ecsInstanceId(IResolvable)
//  .ecsRegion(java.lang.String)
//  .ecsRegion(IResolvable)
//  .enableSellCommon(java.lang.String)
//  .enableSellCommon(IResolvable)
//  .enableSellSitd(java.lang.String)
//  .enableSellSitd(IResolvable)
//  .enableSellStable(java.lang.String)
//  .enableSellStable(IResolvable)
//  .sid(java.lang.String)
//  .sid(IResolvable)
//  .skipTest(java.lang.Boolean)
//  .skipTest(IResolvable)
//  .templateId(java.lang.Number)
//  .templateId(IResolvable)
//  .templateType(java.lang.String)
//  .templateType(IResolvable)
//  .tid(java.lang.Number)
//  .tid(IResolvable)
//  .useDsql(java.lang.Number)
//  .useDsql(IResolvable)
//  .useSsl(java.lang.Number)
//  .useSsl(IResolvable)
//  .vpcId(java.lang.String)
//  .vpcId(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.
databasePassword java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
databaseUser java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
dbaId java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable No description.
enableSellTrust java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
envType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
exportTimeout java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable No description.
host java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
instanceAlias java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
instanceSource java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
instanceType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
networkType 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.
queryTimeout java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable No description.
safeRule java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
dataLinkName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
ddlOnline java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable No description.
ecsInstanceId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
ecsRegion java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
enableSellCommon java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
enableSellSitd java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
enableSellStable java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
sid java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
skipTest java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable No description.
templateId java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable No description.
templateType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
tid java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable No description.
useDsql java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable No description.
useSsl 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.

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

databasePasswordRequired

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

databaseUserRequired

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

dbaIdRequired

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

enableSellTrustRequired

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

envTypeRequired

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

exportTimeoutRequired

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

hostRequired

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

instanceAliasRequired

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

instanceSourceRequired

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

instanceTypeRequired

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

networkTypeRequired

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

portRequired

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

queryTimeoutRequired

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

safeRuleRequired

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

dataLinkNameOptional

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

ddlOnlineOptional

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

ecsInstanceIdOptional

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

ecsRegionOptional

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

enableSellCommonOptional

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

enableSellSitdOptional

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

enableSellStableOptional

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

sidOptional

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

skipTestOptional

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

templateIdOptional

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

templateTypeOptional

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

tidOptional

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

useDsqlOptional

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

useSslOptional

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

vpcIdOptional

  • 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.dms.RosInstance2;
RosInstance2.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

xRequired

  • Type: java.lang.Object

isRosElement

import com.aliyun.ros.cdk.dms.RosInstance2;
RosInstance2.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.dms.RosInstance2;
RosInstance2.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.
attrHost com.aliyun.ros.cdk.core.IResolvable No description.
attrInstanceId com.aliyun.ros.cdk.core.IResolvable No description.
attrPort com.aliyun.ros.cdk.core.IResolvable No description.
databasePassword java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
databaseUser java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
dbaId java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable No description.
enableResourcePropertyConstraint java.lang.Boolean No description.
enableSellTrust java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
envType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
exportTimeout java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable No description.
host java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
instanceAlias java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
instanceSource java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
instanceType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
networkType 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.
queryTimeout java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable No description.
safeRule java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
dataLinkName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
ddlOnline java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable No description.
ecsInstanceId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
ecsRegion java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
enableSellCommon java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
enableSellSitd java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
enableSellStable java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
sid java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
skipTest java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable No description.
templateId java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable No description.
templateType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
tid java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable No description.
useDsql java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable No description.
useSsl 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.

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.


attrHostRequired

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

attrInstanceIdRequired

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

attrPortRequired

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

databasePasswordRequired

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

databaseUserRequired

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

dbaIdRequired

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

enableResourcePropertyConstraintRequired

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

enableSellTrustRequired

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

envTypeRequired

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

exportTimeoutRequired

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

hostRequired

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

instanceAliasRequired

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

instanceSourceRequired

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

instanceTypeRequired

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

networkTypeRequired

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

portRequired

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

queryTimeoutRequired

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

safeRuleRequired

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

dataLinkNameOptional

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

ddlOnlineOptional

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

ecsInstanceIdOptional

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

ecsRegionOptional

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

enableSellCommonOptional

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

enableSellSitdOptional

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

enableSellStableOptional

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

sidOptional

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

skipTestOptional

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

templateIdOptional

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

templateTypeOptional

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

tidOptional

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

useDsqlOptional

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

useSslOptional

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

vpcIdOptional

public java.lang.Object getVpcId();
  • 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.