FileSystem

• Implements: IFileSystem

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

Initializers

import ros_cdk_dfs
ros_cdk_dfs.FileSystem(
  scope: Construct,
  id: str,
  protocol_type: typing.Union[str, IResolvable],
  space_capacity: typing.Union[typing.Union[int, float], IResolvable],
  storage_type: typing.Union[str, IResolvable],
  zone_id: typing.Union[str, IResolvable],
  data_redundancy_type: typing.Union[str, IResolvable] = None,
  description: typing.Union[str, IResolvable] = None,
  file_system_name: typing.Union[str, IResolvable] = None,
  partition_number: typing.Union[typing.Union[int, float], IResolvable] = None,
  provisioned_throughput_in_mi_bps: typing.Union[typing.Union[int, float], IResolvable] = None,
  storage_set_name: typing.Union[str, IResolvable] = None,
  throughput_mode: typing.Union[str, IResolvable] = None,
  enable_resource_property_constraint: bool = None
)

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

protocol_type^Required

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

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

space_capacity^Required

• Type: typing.Union[typing.Union[int, float], 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

storage_type^Required

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

Property storageType: Type of storage media.

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

zone_id^Required

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

Property zoneId: zone id.

data_redundancy_type^Optional

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

Property description: The description of the file system.

file_system_name^Optional

• Type: typing.Union[str, 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 (-).

partition_number^Optional

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

Property partitionNumber: The reserved parameters.

provisioned_throughput_in_mi_bps^Optional

• Type: typing.Union[typing.Union[int, float], 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

storage_set_name^Optional

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

Property storageSetName: The reserved parameters.

throughput_mode^Optional

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

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

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_dfs
ros_cdk_dfs.FileSystem.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_file_system_id^Required

attr_file_system_id: typing.Union[str, IResolvable]

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

Attribute FileSystemId: The ID of the file system.

props^Required

props: FileSystemProps

• Type: FileSystemProps