Skip to content

FileSystem

This class encapsulates and extends the ROS resource type DATASOURCE::NAS::FileSystem, which is used to query the information about a file system.

Initializers 

import { datasource } from '@alicloud/ros-cdk-nas'
new datasource.FileSystem(scope: Construct, id: string, props: FileSystemProps, enableResourcePropertyConstraint?: boolean)
Name Type Description
scope @alicloud/ros-cdk-core.Construct No description.
id string No description.
props FileSystemProps No description.
enableResourcePropertyConstraint boolean No description.

scopeRequired

  • Type: @alicloud/ros-cdk-core.Construct

idRequired

  • Type: string

propsRequired

enableResourcePropertyConstraintOptional

  • Type: boolean

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 toString(): string

Returns a string representation of this construct.

synthesize 

public synthesize(session: ISynthesisSession): void

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.

sessionRequired

  • Type: @alicloud/ros-cdk-core.ISynthesisSession

The synthesis session.

addCondition 

public addCondition(condition: RosCondition): void

conditionRequired

  • Type: @alicloud/ros-cdk-core.RosCondition

addCount 

public addCount(count: number | IResolvable): void

countRequired

  • Type: number | @alicloud/ros-cdk-core.IResolvable

addDependency 

public addDependency(resource: Resource): void

resourceRequired

  • Type: @alicloud/ros-cdk-core.Resource

addResourceDesc 

public addResourceDesc(desc: string): void

descRequired

  • Type: string

applyRemovalPolicy 

public applyRemovalPolicy(policy: RemovalPolicy): void

policyRequired

  • Type: @alicloud/ros-cdk-core.RemovalPolicy

getAtt 

public getAtt(name: string): IResolvable

nameRequired

  • Type: string

setMetadata 

public setMetadata(key: string, value: any): void

keyRequired

  • Type: string

valueRequired

  • Type: any

Static Functions

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

isConstruct 

import { datasource } from '@alicloud/ros-cdk-nas'
datasource.FileSystem.isConstruct(x: any)

Return whether the given object is a Construct.

xRequired

  • Type: any

Properties

Name Type Description
node @alicloud/ros-cdk-core.ConstructNode The construct tree node associated with this construct.
ref string No description.
stack @alicloud/ros-cdk-core.Stack The stack in which this resource is defined.
resource @alicloud/ros-cdk-core.RosResource No description.
attrBandwidth @alicloud/ros-cdk-core.IResolvable Attribute Bandwidth: Maximum file system throughput.
attrCapacity @alicloud/ros-cdk-core.IResolvable Attribute Capacity: File system capacity.
attrCreateTime @alicloud/ros-cdk-core.IResolvable Attribute CreateTime: CreateTime.
attrDescription @alicloud/ros-cdk-core.IResolvable Attribute Description: File system description.
attrEncryptType @alicloud/ros-cdk-core.IResolvable Attribute EncryptType: Whether the file system is encrypted.
attrExpiredTime @alicloud/ros-cdk-core.IResolvable Attribute ExpiredTime: ExpiredTime.
attrFileSystemId @alicloud/ros-cdk-core.IResolvable Attribute FileSystemId: The ID of the file system to be created.
attrFileSystemType @alicloud/ros-cdk-core.IResolvable Attribute FileSystemType: File system type.
attrKmsKeyId @alicloud/ros-cdk-core.IResolvable Attribute KmsKeyId: The ID of the KMS key.
attrLdap @alicloud/ros-cdk-core.IResolvable Attribute Ldap: Ldap.
attrMeteredSize @alicloud/ros-cdk-core.IResolvable Attribute MeteredSize: MeteredSize.
attrPaymentType @alicloud/ros-cdk-core.IResolvable Attribute PaymentType: ChargeType.
attrProtocolType @alicloud/ros-cdk-core.IResolvable Attribute ProtocolType: File transfer protocol type.
attrStorageType @alicloud/ros-cdk-core.IResolvable Attribute StorageType: Storage type.
attrTags @alicloud/ros-cdk-core.IResolvable Attribute Tags: Tags.
attrZoneId @alicloud/ros-cdk-core.IResolvable Attribute ZoneId: The zone ID.

nodeRequired 

public readonly node: ConstructNode;
  • Type: @alicloud/ros-cdk-core.ConstructNode

The construct tree node associated with this construct.

refRequired 

public readonly ref: string;
  • Type: string

stackRequired 

public readonly stack: Stack;
  • Type: @alicloud/ros-cdk-core.Stack

The stack in which this resource is defined.

resourceOptional 

public readonly resource: RosResource;
  • Type: @alicloud/ros-cdk-core.RosResource

attrBandwidthRequired 

public readonly attrBandwidth: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute Bandwidth: Maximum file system throughput.

attrCapacityRequired 

public readonly attrCapacity: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute Capacity: File system capacity.

attrCreateTimeRequired 

public readonly attrCreateTime: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute CreateTime: CreateTime.

attrDescriptionRequired 

public readonly attrDescription: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute Description: File system description.

attrEncryptTypeRequired 

public readonly attrEncryptType: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute EncryptType: Whether the file system is encrypted.

attrExpiredTimeRequired 

public readonly attrExpiredTime: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute ExpiredTime: ExpiredTime.

attrFileSystemIdRequired 

public readonly attrFileSystemId: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute FileSystemId: The ID of the file system to be created.

attrFileSystemTypeRequired 

public readonly attrFileSystemType: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute FileSystemType: File system type.

attrKmsKeyIdRequired 

public readonly attrKmsKeyId: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute KmsKeyId: The ID of the KMS key.

attrLdapRequired 

public readonly attrLdap: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute Ldap: Ldap.

attrMeteredSizeRequired 

public readonly attrMeteredSize: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute MeteredSize: MeteredSize.

attrPaymentTypeRequired 

public readonly attrPaymentType: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute PaymentType: ChargeType.

attrProtocolTypeRequired 

public readonly attrProtocolType: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute ProtocolType: File transfer protocol type.

attrStorageTypeRequired 

public readonly attrStorageType: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute StorageType: Storage type.

attrTagsRequired 

public readonly attrTags: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute Tags: Tags.

attrZoneIdRequired 

public readonly attrZoneId: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute ZoneId: The zone ID.