SynchronizationJob
This class encapsulates and extends the ROS resource type DATASOURCE::DTS::SynchronizationJob.
Initializers
from ros_cdk_dts import datasource
datasource.SynchronizationJob(
  scope: Construct,
  id: str,
  dts_instance_id: typing.Union[str, IResolvable],
  refresh_options: typing.Union[str, IResolvable] = None,
  enable_resource_property_constraint: bool = None
)
| Name | Type | Description | 
|---|---|---|
| scope | ros_cdk_core.Construct | No description. | 
| id | str | No description. | 
| dts_instance_id | typing.Union[str, ros_cdk_core.IResolvable] | Property dtsInstanceId: Synchronization instance ID. | 
| refresh_options | typing.Union[str, ros_cdk_core.IResolvable] | Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated. | 
| enable_resource_property_constraint | bool | No description. | 
scopeRequired 
- Type: ros_cdk_core.Construct
idRequired 
- Type: str
dts_instance_idRequired 
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property dtsInstanceId: Synchronization instance ID.
refresh_optionsOptional 
- Type: typing.Union[str, 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.
enable_resource_property_constraintOptional 
- Type: bool
Methods
| Name | Description | 
|---|---|
| to_string | Returns a string representation of this construct. | 
| synthesize | Allows this construct to emit artifacts into the cloud assembly during synthesis. | 
| add_condition | No description. | 
| add_count | No description. | 
| add_dependency | No description. | 
| add_resource_desc | No description. | 
| apply_removal_policy | No description. | 
| get_att | No description. | 
| set_metadata | No description. | 
to_string 
def to_string() -> str
Returns a string representation of this construct.
synthesize 
def synthesize(
  session: ISynthesisSession
) -> None
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: ros_cdk_core.ISynthesisSession
The synthesis session.
add_condition 
def add_condition(
  condition: RosCondition
) -> None
- Type: ros_cdk_core.RosCondition
add_count 
def add_count(
  count: typing.Union[typing.Union[int, float], IResolvable]
) -> None
- Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
add_dependency 
def add_dependency(
  resource: Resource
) -> None
- Type: ros_cdk_core.Resource
add_resource_desc 
def add_resource_desc(
  desc: str
) -> None
- Type: str
apply_removal_policy 
def apply_removal_policy(
  policy: RemovalPolicy
) -> None
- Type: ros_cdk_core.RemovalPolicy
get_att 
def get_att(
  name: str
) -> IResolvable
- Type: str
set_metadata 
def set_metadata(
  key: str,
  value: typing.Any
) -> None
- Type: str
- Type: typing.Any
Static Functions
| Name | Description | 
|---|---|
| is_construct | Return whether the given object is a Construct. | 
is_construct 
from ros_cdk_dts import datasource
datasource.SynchronizationJob.is_construct(
  x: typing.Any
)
Return whether the given object is a Construct.
- Type: typing.Any
Properties
| Name | Type | Description | 
|---|---|---|
| node | ros_cdk_core.ConstructNode | The construct tree node associated with this construct. | 
| ref | str | No description. | 
| stack | ros_cdk_core.Stack | The stack in which this resource is defined. | 
| resource | ros_cdk_core.RosResource | No description. | 
| attr_create_time | ros_cdk_core.IResolvable | Attribute CreateTime: The task creation time, which follows the yyyy-MM-ddTHH:mm:ssZ(UTC time). | 
| attr_destination_endpoint_engine_name | ros_cdk_core.IResolvable | Attribute DestinationEndpointEngineName: The target database engine type. | 
| attr_destination_endpoint_region | ros_cdk_core.IResolvable | Attribute DestinationEndpointRegion: Region of source instance. | 
| attr_dts_instance_id | ros_cdk_core.IResolvable | Attribute DtsInstanceId: Synchronization instance ID. | 
| attr_instance_class | ros_cdk_core.IResolvable | Attribute InstanceClass: The specification of the migration or synchronization instance. | 
| attr_payment_type | ros_cdk_core.IResolvable | Attribute PaymentType: The payment type of the resource. | 
| attr_source_endpoint_engine_name | ros_cdk_core.IResolvable | Attribute SourceEndpointEngineName: Source instance database engine type. | 
| attr_source_endpoint_region | ros_cdk_core.IResolvable | Attribute SourceEndpointRegion: Region of source instance. | 
nodeRequired 
node: ConstructNode
- Type: ros_cdk_core.ConstructNode
The construct tree node associated with this construct.
refRequired 
ref: str
- Type: str
stackRequired 
stack: Stack
- Type: ros_cdk_core.Stack
The stack in which this resource is defined.
resourceOptional 
resource: RosResource
- Type: ros_cdk_core.RosResource
attr_create_timeRequired 
attr_create_time: IResolvable
- Type: ros_cdk_core.IResolvable
Attribute CreateTime: The task creation time, which follows the yyyy-MM-ddTHH:mm:ssZ(UTC time).
attr_destination_endpoint_engine_nameRequired 
attr_destination_endpoint_engine_name: IResolvable
- Type: ros_cdk_core.IResolvable
Attribute DestinationEndpointEngineName: The target database engine type.
attr_destination_endpoint_regionRequired 
attr_destination_endpoint_region: IResolvable
- Type: ros_cdk_core.IResolvable
Attribute DestinationEndpointRegion: Region of source instance.
attr_dts_instance_idRequired 
attr_dts_instance_id: IResolvable
- Type: ros_cdk_core.IResolvable
Attribute DtsInstanceId: Synchronization instance ID.
attr_instance_classRequired 
attr_instance_class: IResolvable
- Type: ros_cdk_core.IResolvable
Attribute InstanceClass: The specification of the migration or synchronization instance.
attr_payment_typeRequired 
attr_payment_type: IResolvable
- Type: ros_cdk_core.IResolvable
Attribute PaymentType: The payment type of the resource.
attr_source_endpoint_engine_nameRequired 
attr_source_endpoint_engine_name: IResolvable
- Type: ros_cdk_core.IResolvable
Attribute SourceEndpointEngineName: Source instance database engine type.
attr_source_endpoint_regionRequired 
attr_source_endpoint_region: IResolvable
- Type: ros_cdk_core.IResolvable
Attribute SourceEndpointRegion: Region of source instance.