Skip to content

SynchronizationJob

  • Implements: com.aliyun.ros.cdk.dts.datasource.ISynchronizationJob

This class encapsulates and extends the ROS resource type DATASOURCE::DTS::SynchronizationJob.

Initializers

import com.aliyun.ros.cdk.dts.datasource.SynchronizationJob;
SynchronizationJob.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .dtsInstanceId(java.lang.String)
    .dtsInstanceId(IResolvable)
//  .refreshOptions(java.lang.String)
//  .refreshOptions(IResolvable)
    .build();
Name Type Description
scope com.aliyun.ros.cdk.core.Construct No description.
id java.lang.String No description.
enableResourcePropertyConstraint java.lang.Boolean No description.
dtsInstanceId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property dtsInstanceId: Synchronization instance ID.
refreshOptions java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.

scopeRequired

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

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

dtsInstanceIdRequired

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

Property dtsInstanceId: Synchronization instance ID.


refreshOptionsOptional

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

Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.

Valid values:

  • Never: Never refresh the datasource resource when the stack is updated.
  • Always: Always refresh the datasource resource when the stack is updated. Default is Never.

Methods

Name Description
toString Returns a string representation of this construct.
synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
addCondition No description.
addCount No description.
addDependency No description.
addResourceDesc No description.
applyRemovalPolicy No description.
fetchCondition No description.
fetchDependency No description.
fetchResourceDesc No description.
getAtt No description.
setMetadata No description.

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.


addCondition

public void addCondition(RosCondition condition)

conditionRequired

  • 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

addDependency

public void addDependency(Resource resource)

resourceRequired

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

addResourceDesc

public void addResourceDesc(java.lang.String desc)

descRequired

  • Type: java.lang.String

applyRemovalPolicy

public void applyRemovalPolicy(RemovalPolicy policy)

policyRequired

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

fetchCondition

public RosCondition fetchCondition()

fetchDependency

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

fetchResourceDesc

public java.lang.String fetchResourceDesc()

getAtt

public IResolvable getAtt(java.lang.String name)

nameRequired

  • Type: java.lang.String

setMetadata

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

keyRequired

  • Type: java.lang.String

valueRequired

  • Type: java.lang.Object

Static Functions

Name Description
isConstruct Return whether the given object is a Construct.

isConstruct

import com.aliyun.ros.cdk.dts.datasource.SynchronizationJob;
SynchronizationJob.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

xRequired

  • Type: java.lang.Object

Properties

Name Type Description
node com.aliyun.ros.cdk.core.ConstructNode The construct tree node associated with this construct.
env com.aliyun.ros.cdk.core.IResourceEnvironment The environment this resource belongs to.
ref java.lang.String No description.
stack com.aliyun.ros.cdk.core.Stack The stack in which this resource is defined.
resource com.aliyun.ros.cdk.core.RosResource No description.
attrCreateTime java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute CreateTime: The task creation time, which follows the yyyy-MM-ddTHH:mm:ssZ(UTC time).
attrDestinationEndpointEngineName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute DestinationEndpointEngineName: The target database engine type.
attrDestinationEndpointRegion java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute DestinationEndpointRegion: Region of source instance.
attrDtsInstanceId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute DtsInstanceId: Synchronization instance ID.
attrInstanceClass java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute InstanceClass: The specification of the migration or synchronization instance.
attrPaymentType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute PaymentType: The payment type of the resource.
attrSourceEndpointEngineName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute SourceEndpointEngineName: Source instance database engine type.
attrSourceEndpointRegion java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute SourceEndpointRegion: Region of source instance.
props SynchronizationJobProps No description.

nodeRequired

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

The construct tree node associated with this construct.


envRequired

public IResourceEnvironment getEnv();
  • Type: com.aliyun.ros.cdk.core.IResourceEnvironment

The environment this resource belongs to.

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


refRequired

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

stackRequired

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

The stack in which this resource is defined.


resourceOptional

public RosResource getResource();
  • Type: com.aliyun.ros.cdk.core.RosResource

attrCreateTimeRequired

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

Attribute CreateTime: The task creation time, which follows the yyyy-MM-ddTHH:mm:ssZ(UTC time).


attrDestinationEndpointEngineNameRequired

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

Attribute DestinationEndpointEngineName: The target database engine type.


attrDestinationEndpointRegionRequired

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

Attribute DestinationEndpointRegion: Region of source instance.


attrDtsInstanceIdRequired

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

Attribute DtsInstanceId: Synchronization instance ID.


attrInstanceClassRequired

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

Attribute InstanceClass: The specification of the migration or synchronization instance.


attrPaymentTypeRequired

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

Attribute PaymentType: The payment type of the resource.


attrSourceEndpointEngineNameRequired

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

Attribute SourceEndpointEngineName: Source instance database engine type.


attrSourceEndpointRegionRequired

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

Attribute SourceEndpointRegion: Region of source instance.


propsRequired

public SynchronizationJobProps getProps();