Skip to content

ProtocolMountTarget

This class encapsulates and extends the ROS resource type ALIYUN::NAS::ProtocolMountTargetCreates an export directory for a NAS protocol service.

Initializers

import com.aliyun.ros.cdk.nas.ProtocolMountTarget;
ProtocolMountTarget.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .fileSystemId(java.lang.String)
    .fileSystemId(IResolvable)
    .protocolServiceId(java.lang.String)
    .protocolServiceId(IResolvable)
    .vpcId(java.lang.String)
    .vpcId(IResolvable)
    .vSwitchId(java.lang.String)
    .vSwitchId(IResolvable)
//  .accessGroupName(java.lang.String)
//  .accessGroupName(IResolvable)
//  .description(java.lang.String)
//  .description(IResolvable)
//  .fsetId(java.lang.String)
//  .fsetId(IResolvable)
//  .path(java.lang.String)
//  .path(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: File system ID.
protocolServiceId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property protocolServiceId: Agreement service ID.
vpcId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property vpcId: Proper network ID exported by the protocol service.
vSwitchId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property vSwitchId: The vSwitch ID of the export directory.
accessGroupName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property accessGroupName: The name of the permissions group.
description java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property description: The description of the export directory for the protocol service.
fsetId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property fsetId: Fileset ID needs to be exported.
path java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property path: The path of the CPFS directory that you want to export.

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


protocolServiceIdRequired

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

Property protocolServiceId: Agreement service ID.


vpcIdRequired

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

Property vpcId: Proper network ID exported by the protocol service.


vSwitchIdRequired

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

Property vSwitchId: The vSwitch ID of the export directory.

If the storage redundancy type of the file system is not zone-redundant (ZRS) and the VpcId is set, this field is required.


accessGroupNameOptional

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

Property accessGroupName: The name of the permissions group.

Default value: DEFAULT_VPC_GROUP_NAME


descriptionOptional

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

Property description: The description of the export directory for the protocol service.

The name of the export directory appears in the console. Limits:

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

fsetIdOptional

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

Property fsetId: Fileset ID needs to be exported.

limit: The Fileset must exist. A Fileset allows only one export directory. Fileset and Path can only specify one.


pathOptional

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

Property path: The path of the CPFS directory that you want to export.

Limits:

  • The directory already exists in the CPFS file system.
  • You can create only one export directory for a directory.
  • You can specify either a fileset or a path. Format:
  • The path must be 1 to 1,024 characters in length.
  • The path must be encoded in UTF-8.
  • The path must start and end with a forward slash (/). The root directory is \/.

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.ProtocolMountTarget;
ProtocolMountTarget.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.
attrExportId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute ExportId: The protocol service exports directory ID.
attrFileSystemId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute FileSystemId: File system ID.
attrProtocolMountTargetDomain java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute ProtocolMountTargetDomain: The protocol mount target domain.
attrProtocolServiceId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute ProtocolServiceId: Protocol service ID.
props ProtocolMountTargetProps 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

attrExportIdRequired

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

Attribute ExportId: The protocol service exports directory ID.


attrFileSystemIdRequired

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

Attribute FileSystemId: File system ID.


attrProtocolMountTargetDomainRequired

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

Attribute ProtocolMountTargetDomain: The protocol mount target domain.


attrProtocolServiceIdRequired

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

Attribute ProtocolServiceId: Protocol service ID.


propsRequired

public ProtocolMountTargetProps getProps();