Fileset

• Implements: IFileset

This class encapsulates and extends the ROS resource type ALIYUN::NAS::Fileset.

Initializers

import ros_cdk_nas
ros_cdk_nas.Fileset(
  scope: Construct,
  id: str,
  file_system_id: typing.Union[str, IResolvable],
  file_system_path: typing.Union[str, IResolvable],
  description: typing.Union[str, IResolvable] = None,
  enable_resource_property_constraint: bool = None
)

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

file_system_id^Required

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

Property fileSystemId: The ID of the file system.

• The IDs of CPFS file systems must start with cpfs-. Example: cpfs-099394bd928c****.
• The IDs of CPFS for Lingjun file systems must start with bmcpfs-. Example: bmcpfs-290w65p03ok64ya****.

file_system_path^Required

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

Property fileSystemPath: The absolute path of the fileset.

• CPFS path limits.
• The parent directory of the path that you specify must be an existing directory in the file system.
• The path must be 2 to 1024 characters in length.
• The path must start and end with a forward slash (/).
• Path limit of CPFS for Lingjun
• The path must be 2 to 1024 characters in length.
• The path must start and end with a forward slash (/).
• The fileset path must be a new path and cannot be an existing path. Fileset paths cannot be renamed and cannot be symbolic links.
• The maximum depth supported by a fileset path is eight levels. The depth of the root directory / is 0 levels. For example, the fileset path /test/aaa/ccc/ has three levels.
• If the fileset path is a multi-level path, the parent directory must be an existing directory.
• Nested filesets are not supported. If a fileset is specified as a parent directory, its subdirectory cannot be a fileset. A fileset path supports only one quota.
• The path cannot exceed 990 characters in length.

description^Optional

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

Property description: The description of the fileset.

• The description must be 2 to 128 characters in length.
• The name must start with a letter and cannot start with http:// or https://.
• The description can contain letters, digits, colons (:), underscores (_), periods (.), and hyphens (-).

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_nas
ros_cdk_nas.Fileset.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: File system ID.

attr_file_system_path^Required

attr_file_system_path: typing.Union[str, IResolvable]

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

Attribute FileSystemPath: File system path.

attr_fset_id^Required

attr_fset_id: typing.Union[str, IResolvable]

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

Attribute FsetId: Fileset ID.

props^Required

props: FilesetProps

• Type: FilesetProps