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 com.aliyun.ros.cdk.nas.FileSystem;
FileSystem.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .protocolType(java.lang.String)
    .protocolType(IResolvable)
    .storageType(java.lang.String)
    .storageType(IResolvable)
//  .bandwidth(java.lang.Number)
//  .bandwidth(IResolvable)
//  .capacity(java.lang.Number)
//  .capacity(IResolvable)
//  .chargeType(java.lang.String)
//  .chargeType(IResolvable)
//  .deletionForce(java.lang.Boolean)
//  .deletionForce(IResolvable)
//  .description(java.lang.String)
//  .description(IResolvable)
//  .duration(java.lang.Number)
//  .duration(IResolvable)
//  .encryptType(java.lang.Number)
//  .encryptType(IResolvable)
//  .fileSystemType(java.lang.String)
//  .fileSystemType(IResolvable)
//  .snapshotId(java.lang.String)
//  .snapshotId(IResolvable)
//  .tags(java.util.List<TagsProperty>)
//  .vpcId(java.lang.String)
//  .vpcId(IResolvable)
//  .vSwitchId(java.lang.String)
//  .vSwitchId(IResolvable)
//  .zoneId(java.lang.String)
//  .zoneId(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: Type of protocol used.
`storageType`	`java.lang.String OR com.aliyun.ros.cdk.core.IResolvable`	Property storageType: The storage type of the file System.
`bandwidth`	`java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable`	Property bandwidth: Maximum file system throughput, unit is MB\/s.
`capacity`	`java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable`	Property capacity: File system capacity, the unit is GB.
`chargeType`	`java.lang.String OR com.aliyun.ros.cdk.core.IResolvable`	Property chargeType: Type of payment: PayAsYouGo (pay as you go) Subscription.
`deletionForce`	`java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable`	Property deletionForce: Whether delete all mount targets on the file system and then delete file system.
`description`	`java.lang.String OR com.aliyun.ros.cdk.core.IResolvable`	Property description: File system description (space characters are not allowed).
`duration`	`java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable`	Property duration: The period of subscription in months.
`encryptType`	`java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable`	Property encryptType: Specifies whether to encrypt data.
`fileSystemType`	`java.lang.String OR com.aliyun.ros.cdk.core.IResolvable`	Property fileSystemType: File system type.
`snapshotId`	`java.lang.String OR com.aliyun.ros.cdk.core.IResolvable`	Property snapshotId: Snapshot ID.
`tags`	`java.util.List<TagsProperty>`	Property tags: Tags to attach to filesystem.
`vpcId`	`java.lang.String OR com.aliyun.ros.cdk.core.IResolvable`	Property vpcId: Vpc ID.
`vSwitchId`	`java.lang.String OR com.aliyun.ros.cdk.core.IResolvable`	Property vSwitchId: VSwitch ID.
`zoneId`	`java.lang.String OR com.aliyun.ros.cdk.core.IResolvable`	Property zoneId: Zone ID.

`scope`^Required

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

`id`^Required

Type: java.lang.String

`enableResourcePropertyConstraint`^Optional

Type: java.lang.Boolean

`protocolType`^Required

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

Property protocolType: Type of protocol used.

Valid values: NFS, SMB, cpfs.

`storageType`^Required

Type: java.lang.String OR com.aliyun.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: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

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

Required and valid only when FileSystemType=cpfs.

`capacity`^Optional

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

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

Required and valid when FileSystemType=extreme or cpfs.

`chargeType`^Optional

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

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

`deletionForce`^Optional

Type: java.lang.Boolean OR com.aliyun.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: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

`duration`^Optional

Type: java.lang.Number OR com.aliyun.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.

`encryptType`^Optional

Type: java.lang.Number OR com.aliyun.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.

`fileSystemType`^Optional

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

Property fileSystemType: File system type.

Allowed values: standard(default), extreme, cpfs

`snapshotId`^Optional

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

Property snapshotId: Snapshot ID.

`tags`^Optional

Type: java.util.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.

`vpcId`^Optional

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

Property vpcId: Vpc ID.

`vSwitchId`^Optional

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

Property vSwitchId: VSwitch ID.

`zoneId`^Optional

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

Property zoneId: Zone ID.

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.

session^Required

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

The synthesis session.

`addCondition`

public void addCondition(RosCondition condition)

condition^Required

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

`addCount`

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

count^Required

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

`addDependency`

public void addDependency(Resource resource)

resource^Required

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

`addResourceDesc`

public void addResourceDesc(java.lang.String desc)

desc^Required

Type: java.lang.String

`applyRemovalPolicy`

public void applyRemovalPolicy(RemovalPolicy policy)

policy^Required

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

`getAtt`

public IResolvable getAtt(java.lang.String name)

name^Required

Type: java.lang.String

`setMetadata`

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

key^Required

Type: java.lang.String

value^Required

Type: java.lang.Object

Static Functions

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

`isConstruct`

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

Return whether the given object is a Construct.

x^Required

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

`node`^Required

public ConstructNode getNode();

Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.

`ref`^Required

public java.lang.String getRef();

Type: java.lang.String

`stack`^Required

public Stack getStack();

Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.

`resource`^Optional

public RosResource getResource();

Type: com.aliyun.ros.cdk.core.RosResource

`attrFileSystemId`^Required

public IResolvable getAttrFileSystemId();

Type: com.aliyun.ros.cdk.core.IResolvable

Attribute FileSystemId: ID of the file system created.

FileSystem

Initializers

scopeRequired

idRequired

enableResourcePropertyConstraintOptional

protocolTypeRequired

storageTypeRequired

bandwidthOptional

capacityOptional

chargeTypeOptional

deletionForceOptional

descriptionOptional

durationOptional

encryptTypeOptional

fileSystemTypeOptional

snapshotIdOptional

tagsOptional

vpcIdOptional

vSwitchIdOptional

zoneIdOptional