DataFlow

This class encapsulates and extends the ROS resource type ALIYUN::NAS::DataFlow, which is used to create a data flow between a Cloud Parallel File Storage (CPFS) file system and an Object Storage Service (OSS) bucket.

Initializers

import ros_cdk_nas
ros_cdk_nas.DataFlow(
  scope: Construct,
  id: str,
  file_system_id: typing.Union[str, IResolvable],
  fset_id: typing.Union[str, IResolvable],
  source_storage: typing.Union[str, IResolvable],
  throughput: typing.Union[typing.Union[int, float], IResolvable],
  auto_refresh_interval: typing.Union[typing.Union[int, float], IResolvable] = None,
  auto_refresh_policy: typing.Union[str, IResolvable] = None,
  auto_refreshs: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, AutoRefreshsProperty]]] = None,
  description: typing.Union[str, IResolvable] = None,
  source_security_type: 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.
`file_system_id`	`typing.Union[str, ros_cdk_core.IResolvable]`	Property fileSystemId: File system ID.
`fset_id`	`typing.Union[str, ros_cdk_core.IResolvable]`	Property fsetId: Fileset ID.
`source_storage`	`typing.Union[str, ros_cdk_core.IResolvable]`	Property sourceStorage: Access path stored at the source.Format: : \/\/ . in: Storage Type: Currently only supports OSS. PATH: OSS's bucket name.Limit the following. Only support the lowercase letters, numbers and short strokes (-) and must start with a lowercase letter or number. The length is 8 ~ 128 English characters. Use UTF-8 encoding. Can't start with http: \/\/ and https: \/\/. Explain that the OSS BUCKET must be the bucket that exists in the region.
`throughput`	`typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]`	Property throughput: The upper limit of transmission bandwidth for data flow, unit: MB\/s. Value: 600 1200 1500.
`auto_refresh_interval`	`typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]`	Property autoRefreshInterval: The automatic update interval time, every time the interval, the CPFS checks whether there is a data update in the directory.
`auto_refresh_policy`	`typing.Union[str, ros_cdk_core.IResolvable]`	Property autoRefreshPolicy: Automatic update strategy, after the source data is updated, the data update is introduced to the CPFS strategy.
`auto_refreshs`	`typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, AutoRefreshsProperty]]]`	Property autoRefreshs:.
`description`	`typing.Union[str, ros_cdk_core.IResolvable]`	Property description: Description of data flow.
`source_security_type`	`typing.Union[str, ros_cdk_core.IResolvable]`	Property sourceSecurityType: The type of safety protection types of the source storage.
`enable_resource_property_constraint`	`bool`	No description.

`scope`^Required

Type: ros_cdk_core.Construct

`id`^Required

Type: str

`file_system_id`^Required

Type: typing.Union[str, ros_cdk_core.IResolvable]

Property fileSystemId: File system ID.

`fset_id`^Required

Type: typing.Union[str, ros_cdk_core.IResolvable]

Property fsetId: Fileset ID.

`source_storage`^Required

Type: typing.Union[str, ros_cdk_core.IResolvable]

Property sourceStorage: Access path stored at the source.Format: : \/\/ . in: Storage Type: Currently only supports OSS. PATH: OSS's bucket name.Limit the following. Only support the lowercase letters, numbers and short strokes (-) and must start with a lowercase letter or number. The length is 8 ~ 128 English characters. Use UTF-8 encoding. Can't start with http: \/\/ and https: \/\/. Explain that the OSS BUCKET must be the bucket that exists in the region.

`throughput`^Required

Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

Property throughput: The upper limit of transmission bandwidth for data flow, unit: MB\/s. Value: 600 1200 1500.

Explanation The transmission bandwidth of the data flow must be smaller than the IO bandwidth of the file system.

`auto_refresh_interval`^Optional

Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

Property autoRefreshInterval: The automatic update interval time, every time the interval, the CPFS checks whether there is a data update in the directory.

If there is data update, start the automatic update task, unit: minute. Scope of value: 5 ~ 525600, default value: 10.

`auto_refresh_policy`^Optional

Type: typing.Union[str, ros_cdk_core.IResolvable]

Property autoRefreshPolicy: Automatic update strategy, after the source data is updated, the data update is introduced to the CPFS strategy.

None (default): The data update of the source is not automatically imported into CPFS. Users can import data update at the source end of the source through data flow tasks. Importchanged: The data update at the source automatically imports CPFS.

`auto_refreshs`^Optional

Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, AutoRefreshsProperty]]]

Property autoRefreshs:.

`description`^Optional

Type: typing.Union[str, ros_cdk_core.IResolvable]

Property description: Description of data flow.

limit: The length is 2 to 128 English or Chinese characters. Start with a lowercase letter or Chinese, and you cannot start with http:// and https: //. It can contain numbers, half-horn colon (:), down line (_) or short lines (-).

`source_security_type`^Optional

Type: typing.Union[str, ros_cdk_core.IResolvable]

Property sourceSecurityType: The type of safety protection types of the source storage.

If the source storage must be protected through safety protection, please specify the type of safety protection type storage.Value: No (default value): It means that the source storage does not need to be accessed by safe protection. SSL: Protective access through SSL certificates.

`enable_resource_property_constraint`^Optional

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.

session^Required

Type: ros_cdk_core.ISynthesisSession

The synthesis session.

`add_condition`

def add_condition(
  condition: RosCondition
) -> None

condition^Required

Type: ros_cdk_core.RosCondition

`add_count`

def add_count(
  count: typing.Union[typing.Union[int, float], IResolvable]
) -> None

count^Required

Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

`add_dependency`

def add_dependency(
  resource: Resource
) -> None

resource^Required

Type: ros_cdk_core.Resource

`add_resource_desc`

def add_resource_desc(
  desc: str
) -> None

desc^Required

Type: str

`apply_removal_policy`

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policy^Required

Type: ros_cdk_core.RemovalPolicy

`get_att`

def get_att(
  name: str
) -> IResolvable

name^Required

Type: str

`set_metadata`

def set_metadata(
  key: str,
  value: typing.Any
) -> None

key^Required

Type: str

value^Required

Type: typing.Any

Static Functions

Name	Description
`is_construct`	Return whether the given object is a Construct.

`is_construct`

import ros_cdk_nas
ros_cdk_nas.DataFlow.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

x^Required

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_data_flow_id`	`ros_cdk_core.IResolvable`	Attribute DataFlowId: Data flow ID.
`attr_file_system_id`	`ros_cdk_core.IResolvable`	Attribute FileSystemId: File system ID.

`node`^Required

node: ConstructNode

Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

`ref`^Required

ref: str

Type: str

`stack`^Required

stack: Stack

Type: ros_cdk_core.Stack

The stack in which this resource is defined.

`resource`^Optional

resource: RosResource

Type: ros_cdk_core.RosResource

`attr_data_flow_id`^Required

attr_data_flow_id: IResolvable

Type: ros_cdk_core.IResolvable

Attribute DataFlowId: Data flow ID.

`attr_file_system_id`^Required

attr_file_system_id: IResolvable

Type: ros_cdk_core.IResolvable

Attribute FileSystemId: File system ID.

DataFlow

Initializers

scopeRequired

idRequired

file_system_idRequired

fset_idRequired

source_storageRequired

throughputRequired

auto_refresh_intervalOptional

auto_refresh_policyOptional

auto_refreshsOptional

descriptionOptional

source_security_typeOptional

enable_resource_property_constraintOptional

Methods

to_string

synthesize

add_condition

add_count

add_dependency

add_resource_desc

apply_removal_policy

get_att

set_metadata