DataFlow

• Implements: IDataFlow

This class encapsulates and extends the ROS resource type ALIYUN::NAS::DataFlowCreates 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
)

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: The ID of the file system.

• The IDs of CPFS file systems must start with cpfs-. Example: cpfs-125487****.
• The IDs of CPFS for Lingjun file systems must start with bmcpfs-. Example: bmcpfs-0015****.

fset_id^Required

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

Property fsetId: The fileset ID.

This parameter is required for CPFS file systems.

source_storage^Required

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

Property sourceStorage: The access path of the source storage.

Format: <storage type>:\/\/[<account id>:]<path>. Parameters:

• storage type: Only OSS is supported.
• account id (optional): the UID of the account of the source storage. This parameter is required when you use OSS buckets across accounts.
• path: the name of the OSS bucket. Limits:
• The name can contain only lowercase letters, digits, and hyphens (-). The name must start and end with a lowercase letter or digit.
• The name can be up to 128 characters in length.
• The name must be encoded in UTF-8.

• The OSS bucket must be an existing bucket in the region.
• Only CPFS for LINGJUN V2.6.0 and later support the account id parameter.

throughput^Required

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

Property throughput: The maximum data flow throughput.

Unit: MB/s. Valid values:

• 600
• 1200
• 1500

The data flow throughput must be less than the I/O throughput of the file system. This parameter is required for CPFS file systems.

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: The automatic update policy.

The updated data in the source storage is imported into the CPFS file system based on the policy.

• None (default): Updated data in the source storage is not automatically imported into the CPFS file system. You can run a data flow task to import the updated data from the source storage.
• ImportChanged: Updated data in the source storage is automatically imported into the CPFS file system.

This parameter takes effect only for CPFS file systems.

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: The description of the dataflow.

Limits:

• The description must be 2 to 128 characters in length.
• The description must start with a letter but cannot start with http:\/\/ or https:\/\/.
• The description can contain letters, digits, colons (:), underscores (_), and hyphens (-).

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

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

fetch_condition

def fetch_condition() -> RosCondition

fetch_dependency

def fetch_dependency() -> typing.List[str]

fetch_resource_desc

def fetch_resource_desc() -> str

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

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

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

env^Required

env: IResourceEnvironment

• Type: 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.

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: typing.Union[str, IResolvable]

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

Attribute DataFlowId: Data flow ID.

attr_file_system_id^Required

attr_file_system_id: typing.Union[str, IResolvable]

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

Attribute FileSystemId: File system ID.

props^Required

props: DataFlowProps

• Type: DataFlowProps