Skip to content

FileSystem

This class encapsulates and extends the ROS resource type ALIYUN::DFS::FileSystem, which is used to create a file system.

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();
Name Type Description
scope com.aliyun.ros.cdk.core.Construct No description.
id java.lang.String No description.
enableResourcePropertyConstraint java.lang.Boolean No description.
protocolType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property protocolType: Protocol type, only support HDFS（HadoopFileSystem）.
spaceCapacity java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property spaceCapacity: Capacity of the file system.
storageType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property storageType: Type of storage media.
zoneId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property zoneId: zone id.
dataRedundancyType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property dataRedundancyType: Redundancy mode of the file system.
description java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property description: The description of the file system.
fileSystemName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property fileSystemName: Name of the file system.
partitionNumber java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property partitionNumber: The reserved parameters.
provisionedThroughputInMiBps java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property provisionedThroughputInMiBps: Preset handling capacity.
storageSetName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property storageSetName: The reserved parameters.
throughputMode java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property throughputMode: Throughput mode Values: Standard（default）: standard throughputProvisioned: preset throughput.

scopeRequired

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

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

protocolTypeRequired

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

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

spaceCapacityRequired

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

Property spaceCapacity: Capacity of the file system.

When the actual data volume reaches the file system capacity, data cannot be written. Unit: GB

storageTypeRequired

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

zoneIdRequired

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

Property zoneId: zone id.

dataRedundancyTypeOptional

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

Property dataRedundancyType: Redundancy mode of the file system.

Values: LRS (default) : local redundancy. ZRS: in-city redundancy.

descriptionOptional

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

Property description: The description of the file system.

fileSystemNameOptional

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

Property fileSystemName: Name of the file system.

The naming rules are as follows: The value contains 6 to 100 characters. Globally unique and cannot be an empty string. The value can contain letters and digits and underscores (_).

partitionNumberOptional

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

Property partitionNumber: The reserved parameters.

provisionedThroughputInMiBpsOptional

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

Property provisionedThroughputInMiBps: Preset handling capacity.

Unit: MB/sdata range: 1-5120

storageSetNameOptional

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

Property storageSetName: The reserved parameters.

throughputModeOptional

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

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

Methods

Name Description
toString Returns a string representation of this construct.
synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
addCondition No description.
addCount No description.
addDependency No description.
addResourceDesc No description.
applyRemovalPolicy No description.
getAtt No description.
setMetadata No description.

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.

sessionRequired

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

The synthesis session.

addCondition 

public void addCondition(RosCondition condition)

conditionRequired

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

addCount 

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

countRequired

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

addDependency 

public void addDependency(Resource resource)

resourceRequired

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

addResourceDesc 

public void addResourceDesc(java.lang.String desc)

descRequired

  • Type: java.lang.String

applyRemovalPolicy 

public void applyRemovalPolicy(RemovalPolicy policy)

policyRequired

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

getAtt 

public IResolvable getAtt(java.lang.String name)

nameRequired

  • Type: java.lang.String

setMetadata 

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

keyRequired

  • Type: java.lang.String

valueRequired

  • Type: java.lang.Object

Static Functions

Name Description
isConstruct Return whether the given object is a Construct.

isConstruct 

import com.aliyun.ros.cdk.dfs.FileSystem;
FileSystem.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

xRequired

  • Type: java.lang.Object

Properties

Name Type Description
node com.aliyun.ros.cdk.core.ConstructNode The construct tree node associated with this construct.
ref java.lang.String No description.
stack com.aliyun.ros.cdk.core.Stack The stack in which this resource is defined.
resource com.aliyun.ros.cdk.core.RosResource No description.
attrFileSystemId com.aliyun.ros.cdk.core.IResolvable Attribute FileSystemId: The ID of the file system.

nodeRequired 

public ConstructNode getNode();
  • Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.

refRequired 

public java.lang.String getRef();
  • Type: java.lang.String

stackRequired 

public Stack getStack();
  • Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.

resourceOptional 

public RosResource getResource();
  • Type: com.aliyun.ros.cdk.core.RosResource

attrFileSystemIdRequired 

public IResolvable getAttrFileSystemId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute FileSystemId: The ID of the file system.