DataFlow
- Implements: IDataFlow
This class encapsulates and extends the ROS resource type ALIYUN::NAS::DataFlow.
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: |
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. |
scopeRequired
- Type: ros_cdk_core.Construct
idRequired
- Type: str
file_system_idRequired
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property fileSystemId: File system ID.
fset_idRequired
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property fsetId: Fileset ID.
source_storageRequired
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property sourceStorage: Access path stored at the source.Format:
throughputRequired
- 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_intervalOptional
- 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_policyOptional
- 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_refreshsOptional
- Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, AutoRefreshsProperty]]]
Property autoRefreshs:.
descriptionOptional
- 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_typeOptional
- 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_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. |
fetch_condition | No description. |
fetch_dependency | No description. |
fetch_resource_desc | 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
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
- 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
import ros_cdk_nas
ros_cdk_nas.DataFlow.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. |
env | ros_cdk_core.IResourceEnvironment | The environment this resource belongs to. |
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 | typing.Union[str, ros_cdk_core.IResolvable] | Attribute DataFlowId: Data flow ID. |
attr_file_system_id | typing.Union[str, ros_cdk_core.IResolvable] | Attribute FileSystemId: File system ID. |
props | DataFlowProps | No description. |
nodeRequired
node: ConstructNode
- Type: ros_cdk_core.ConstructNode
The construct tree node associated with this construct.
envRequired
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.
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_data_flow_idRequired
attr_data_flow_id: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute DataFlowId: Data flow ID.
attr_file_system_idRequired
attr_file_system_id: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute FileSystemId: File system ID.
propsRequired
props: DataFlowProps
- Type: DataFlowProps