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 com.aliyun.ros.cdk.nas.DataFlow;
DataFlow.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .fileSystemId(java.lang.String)
    .fileSystemId(IResolvable)
    .fsetId(java.lang.String)
    .fsetId(IResolvable)
    .sourceStorage(java.lang.String)
    .sourceStorage(IResolvable)
    .throughput(java.lang.Number)
    .throughput(IResolvable)
//  .autoRefreshInterval(java.lang.Number)
//  .autoRefreshInterval(IResolvable)
//  .autoRefreshPolicy(java.lang.String)
//  .autoRefreshPolicy(IResolvable)
//  .autoRefreshs(IResolvable)
//  .autoRefreshs(java.util.List<IResolvable)
//  .autoRefreshs(AutoRefreshsProperty>)
//  .description(java.lang.String)
//  .description(IResolvable)
//  .sourceSecurityType(java.lang.String)
//  .sourceSecurityType(IResolvable)
    .build();

scope^Required

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

id^Required

• Type: java.lang.String

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

fileSystemId^Required

• Type: java.lang.String OR com.aliyun.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****.

fsetId^Required

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

Property fsetId: The fileset ID.

This parameter is required for CPFS file systems.

sourceStorage^Required

• Type: java.lang.String OR com.aliyun.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: java.lang.Number OR com.aliyun.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.

autoRefreshInterval^Optional

• Type: java.lang.Number OR com.aliyun.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.

autoRefreshPolicy^Optional

• Type: java.lang.String OR com.aliyun.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.

autoRefreshs^Optional

• Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.ListAutoRefreshsProperty>

Property autoRefreshs:.

description^Optional

• Type: java.lang.String OR com.aliyun.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 (-).

sourceSecurityType^Optional

• Type: java.lang.String OR com.aliyun.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.

Methods

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.

session^Required

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

The synthesis session.

addCondition

public void addCondition(RosCondition condition)

condition^Required

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

addCount

public void addCount(java.lang.Number OR IResolvable count)

count^Required

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

addDependency

public void addDependency(Resource resource)

resource^Required

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

addResourceDesc

public void addResourceDesc(java.lang.String desc)

desc^Required

• Type: java.lang.String

applyRemovalPolicy

public void applyRemovalPolicy(RemovalPolicy policy)

policy^Required

• 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)

name^Required

• Type: java.lang.String

setMetadata

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

key^Required

• Type: java.lang.String

value^Required

• Type: java.lang.Object

Static Functions

isConstruct

import com.aliyun.ros.cdk.nas.DataFlow;
DataFlow.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

x^Required

• Type: java.lang.Object

Properties

node^Required

public ConstructNode getNode();

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

The construct tree node associated with this construct.

env^Required

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.

ref^Required

public java.lang.String getRef();

• Type: java.lang.String

stack^Required

public Stack getStack();

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

The stack in which this resource is defined.

resource^Optional

public RosResource getResource();

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

attrDataFlowId^Required

public java.lang.Object getAttrDataFlowId();

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

Attribute DataFlowId: Data flow ID.

attrFileSystemId^Required

public java.lang.Object getAttrFileSystemId();

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

Attribute FileSystemId: File system ID.

props^Required

public DataFlowProps getProps();

• Type: DataFlowProps