FileSystem

This class encapsulates and extends the ROS resource type ALIYUN::NAS::FileSystem, which is used to create a file system of File Storage NAS (NAS).

Initializers

import ros_cdk_nas
ros_cdk_nas.FileSystem(
  scope: Construct,
  id: str,
  protocol_type: typing.Union[str, IResolvable],
  storage_type: typing.Union[str, IResolvable],
  bandwidth: typing.Union[typing.Union[int, float], IResolvable] = None,
  capacity: typing.Union[typing.Union[int, float], IResolvable] = None,
  charge_type: typing.Union[str, IResolvable] = None,
  deletion_force: typing.Union[bool, IResolvable] = None,
  description: typing.Union[str, IResolvable] = None,
  duration: typing.Union[typing.Union[int, float], IResolvable] = None,
  encrypt_type: typing.Union[typing.Union[int, float], IResolvable] = None,
  file_system_type: typing.Union[str, IResolvable] = None,
  snapshot_id: typing.Union[str, IResolvable] = None,
  tags: typing.List[TagsProperty] = None,
  vpc_id: typing.Union[str, IResolvable] = None,
  v_switch_id: typing.Union[str, IResolvable] = None,
  zone_id: 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: Type of protocol used.
`storage_type`	`typing.Union[str, ros_cdk_core.IResolvable]`	Property storageType: The storage type of the file System.
`bandwidth`	`typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]`	Property bandwidth: Maximum file system throughput, unit is MB\/s.
`capacity`	`typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]`	Property capacity: File system capacity, the unit is GB.
`charge_type`	`typing.Union[str, ros_cdk_core.IResolvable]`	Property chargeType: Type of payment: PayAsYouGo (pay as you go) Subscription.
`deletion_force`	`typing.Union[bool, ros_cdk_core.IResolvable]`	Property deletionForce: Whether delete all mount targets on the file system and then delete file system.
`description`	`typing.Union[str, ros_cdk_core.IResolvable]`	Property description: File system description (space characters are not allowed).
`duration`	`typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]`	Property duration: The period of subscription in months.
`encrypt_type`	`typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]`	Property encryptType: Specifies whether to encrypt data.
`file_system_type`	`typing.Union[str, ros_cdk_core.IResolvable]`	Property fileSystemType: File system type.
`snapshot_id`	`typing.Union[str, ros_cdk_core.IResolvable]`	Property snapshotId: Snapshot ID.
`tags`	`typing.List[TagsProperty]`	Property tags: Tags to attach to filesystem.
`vpc_id`	`typing.Union[str, ros_cdk_core.IResolvable]`	Property vpcId: Vpc ID.
`v_switch_id`	`typing.Union[str, ros_cdk_core.IResolvable]`	Property vSwitchId: VSwitch ID.
`zone_id`	`typing.Union[str, ros_cdk_core.IResolvable]`	Property zoneId: Zone ID.
`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: Type of protocol used.

Valid values: NFS, SMB, cpfs.

`storage_type`^Required

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

Property storageType: The storage type of the file System.

Valid values: Performance、Capacity(Available when the file_system_type is standard) standard、advance(Available when the file_system_type is extreme) advance_100、advance_200(Available when the file_system_type is cpfs)

`bandwidth`^Optional

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

Property bandwidth: Maximum file system throughput, unit is MB\/s.

Required and valid only when FileSystemType=cpfs.

`capacity`^Optional

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

Property capacity: File system capacity, the unit is GB.

Required and valid when FileSystemType=extreme or cpfs.

`charge_type`^Optional

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

Property chargeType: Type of payment: PayAsYouGo (pay as you go) Subscription.

`deletion_force`^Optional

Type: typing.Union[bool, ros_cdk_core.IResolvable]

Property deletionForce: Whether delete all mount targets on the file system and then delete file system.

Default is false

`description`^Optional

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

Property description: File system description (space characters are not allowed).

`duration`^Optional

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

Property duration: The period of subscription in months.

Required and valid when ChargeType is Subscription. When the annual and monthly subscription instance expires without renewal, the instance will automatically expire and be released.

`encrypt_type`^Optional

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

Property encryptType: Specifies whether to encrypt data.

You can use keys that are hosted by Key Management Service (KMS) to encrypt data stored on a file system. Data is automatically decrypted when you access encrypted data. Valid values: 0: specifies that no encryption is applied to data on the file system. 1: specifies that encryption is applied to data on the file system.

`file_system_type`^Optional

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

Property fileSystemType: File system type.

Allowed values: standard(default), extreme, cpfs

`snapshot_id`^Optional

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

Property snapshotId: Snapshot ID.

`tags`^Optional

Type: typing.List[TagsProperty]

Property tags: Tags to attach to filesystem.

Max support 20 tags to add during create filesystem. Each tag with two properties Key and Value, and Key is required.

`vpc_id`^Optional

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

Property vpcId: Vpc ID.

`v_switch_id`^Optional

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

Property vSwitchId: VSwitch ID.

`zone_id`^Optional

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

Property zoneId: Zone ID.

`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_nas
ros_cdk_nas.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: ID of the file system created.

`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: ID of the file system created.

FileSystem

Initializers

scopeRequired

idRequired

protocol_typeRequired

storage_typeRequired

bandwidthOptional

capacityOptional

charge_typeOptional

deletion_forceOptional

descriptionOptional

durationOptional

encrypt_typeOptional

file_system_typeOptional

snapshot_idOptional

tagsOptional

vpc_idOptional

v_switch_idOptional

zone_idOptional

enable_resource_property_constraintOptional