FileSystem

• Implements: IFileSystem

This class encapsulates and extends the ROS resource type ALIYUN::DFS::FileSystem.

Initializers

import com.aliyun.ros.cdk.dfs.FileSystem;
FileSystem.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .protocolType(java.lang.String)
    .protocolType(IResolvable)
    .spaceCapacity(java.lang.Number)
    .spaceCapacity(IResolvable)
    .storageType(java.lang.String)
    .storageType(IResolvable)
    .zoneId(java.lang.String)
    .zoneId(IResolvable)
//  .dataRedundancyType(java.lang.String)
//  .dataRedundancyType(IResolvable)
//  .description(java.lang.String)
//  .description(IResolvable)
//  .fileSystemName(java.lang.String)
//  .fileSystemName(IResolvable)
//  .partitionNumber(java.lang.Number)
//  .partitionNumber(IResolvable)
//  .provisionedThroughputInMiBps(java.lang.Number)
//  .provisionedThroughputInMiBps(IResolvable)
//  .storageSetName(java.lang.String)
//  .storageSetName(IResolvable)
//  .throughputMode(java.lang.String)
//  .throughputMode(IResolvable)
    .build();

scope^Required

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

id^Required

• Type: java.lang.String

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

protocolType^Required

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

Property protocolType: Protocol type, only support HDFS（HadoopFileSystem）.

spaceCapacity^Required

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

Property spaceCapacity: Capacity of the file system.

When the actual storage data size reaches the file system capacity, no further data can be written. Unit: GiB

storageType^Required

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

Property storageType: Type of storage media.

Values: STANDARD (default) : standard type. PERFORMANCE: performance type.

zoneId^Required

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

Property zoneId: zone id.

dataRedundancyType^Optional

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

Property dataRedundancyType: Data redundancy mode of the file system.

Valid values:

• LRS (default): locally redundant storage
• ZRS: zone-redundant storage. When ZRS is selected, the zoneId parameter must be a string containing a list of multiple zone IDs for zone-redundant deployment, for example, zoneId1,zoneId2.

description^Optional

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

Property description: The description of the file system.

fileSystemName^Optional

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

Property fileSystemName: File system name.

The naming convention is as follows:

• Length must be 6 to 64 characters.
• Must be globally unique and cannot be an empty string.
• Supports English letters and can contain digits, underscores (_), and hyphens (-).

partitionNumber^Optional

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

Property partitionNumber: The reserved parameters.

provisionedThroughputInMiBps^Optional

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

Property provisionedThroughputInMiBps: Preset throughput.

This parameter is required when the ThroughputMode parameter is set to Provisioned. Unit: MB/s Valid values: 1 to 5120

storageSetName^Optional

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

Property storageSetName: The reserved parameters.

throughputMode^Optional

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

Property throughputMode: Throughput mode Values: Standard（default）: standard throughputProvisioned: preset throughput.

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.dfs.FileSystem;
FileSystem.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

attrFileSystemId^Required

public java.lang.Object getAttrFileSystemId();

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

Attribute FileSystemId: The ID of the file system.

props^Required

public FileSystemProps getProps();

• Type: FileSystemProps