Skip to content

Fileset

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

Initializers

import com.aliyun.ros.cdk.nas.Fileset;
Fileset.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .fileSystemId(java.lang.String)
    .fileSystemId(IResolvable)
    .fileSystemPath(java.lang.String)
    .fileSystemPath(IResolvable)
//  .description(java.lang.String)
//  .description(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.
fileSystemId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property fileSystemId: The ID of the file system.
fileSystemPath java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property fileSystemPath: The absolute path of the fileset.
description java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property description: The description of the fileset.

scopeRequired

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

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

fileSystemIdRequired

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

fileSystemPathRequired

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

descriptionOptional

  • Type: java.lang.String OR com.aliyun.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 (-).

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.
fetchCondition No description.
fetchDependency No description.
fetchResourceDesc 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.

sessionRequired

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

The synthesis session.


addCondition

public void addCondition(RosCondition condition)

conditionRequired

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

addCount

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

countRequired

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

addDependency

public void addDependency(Resource resource)

resourceRequired

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

addResourceDesc

public void addResourceDesc(java.lang.String desc)

descRequired

  • Type: java.lang.String

applyRemovalPolicy

public void applyRemovalPolicy(RemovalPolicy policy)

policyRequired

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

fetchCondition

public RosCondition fetchCondition()

fetchDependency

public java.util.List<java.lang.String> fetchDependency()

fetchResourceDesc

public java.lang.String fetchResourceDesc()

getAtt

public IResolvable getAtt(java.lang.String name)

nameRequired

  • Type: java.lang.String

setMetadata

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

keyRequired

  • Type: java.lang.String

valueRequired

  • Type: java.lang.Object

Static Functions

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

isConstruct

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

Return whether the given object is a Construct.

xRequired

  • Type: java.lang.Object

Properties

Name Type Description
node com.aliyun.ros.cdk.core.ConstructNode The construct tree node associated with this construct.
env com.aliyun.ros.cdk.core.IResourceEnvironment The environment this resource belongs to.
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 java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute FileSystemId: File system ID.
attrFileSystemPath java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute FileSystemPath: File system path.
attrFsetId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute FsetId: Fileset ID.
props FilesetProps No description.

nodeRequired

public ConstructNode getNode();
  • Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.


envRequired

public IResourceEnvironment getEnv();
  • Type: com.aliyun.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.


refRequired

public java.lang.String getRef();
  • Type: java.lang.String

stackRequired

public Stack getStack();
  • Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.


resourceOptional

public RosResource getResource();
  • Type: com.aliyun.ros.cdk.core.RosResource

attrFileSystemIdRequired

public java.lang.Object getAttrFileSystemId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute FileSystemId: File system ID.


attrFileSystemPathRequired

public java.lang.Object getAttrFileSystemPath();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute FileSystemPath: File system path.


attrFsetIdRequired

public java.lang.Object getAttrFsetId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute FsetId: Fileset ID.


propsRequired

public FilesetProps getProps();