FileSystem

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

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
)

Name	Type	Description
scope	ros_cdk_core.Construct	No description.
id	str	No description.
protocol_type	typing.Union[str, ros_cdk_core.IResolvable]	Property protocolType: Protocol type, only support HDFS（HadoopFileSystem）.
space_capacity	typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]	Property spaceCapacity: Capacity of the file system.
storage_type	typing.Union[str, ros_cdk_core.IResolvable]	Property storageType: Type of storage media.
zone_id	typing.Union[str, ros_cdk_core.IResolvable]	Property zoneId: zone id.
data_redundancy_type	typing.Union[str, ros_cdk_core.IResolvable]	Property dataRedundancyType: Redundancy mode of the file system.
description	typing.Union[str, ros_cdk_core.IResolvable]	Property description: The description of the file system.
file_system_name	typing.Union[str, ros_cdk_core.IResolvable]	Property fileSystemName: Name of the file system.
partition_number	typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]	Property partitionNumber: The reserved parameters.
provisioned_throughput_in_mi_bps	typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]	Property provisionedThroughputInMiBps: Preset handling capacity.
storage_set_name	typing.Union[str, ros_cdk_core.IResolvable]	Property storageSetName: The reserved parameters.
throughput_mode	typing.Union[str, ros_cdk_core.IResolvable]	Property throughputMode: Throughput mode Values: Standard（default）: standard throughputProvisioned: preset throughput.
enable_resource_property_constraint	bool	No description.

---

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 data volume reaches the file system capacity, data cannot be written. Unit: GB

---

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: Redundancy mode of the file system.

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

---

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: 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 (_).

---

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 handling capacity.

Unit: MB/sdata range: 1-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

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

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

---

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

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

---

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

Name	Type	Description
node	ros_cdk_core.ConstructNode	The construct tree node associated with this construct.
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_file_system_id	ros_cdk_core.IResolvable	Attribute FileSystemId: The ID of the file system.

---

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

---

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: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute FileSystemId: The ID of the file system.

---