Skip to content

ProtocolMountTarget

This class encapsulates and extends the ROS resource type ALIYUN::NAS::ProtocolMountTarget, which is used to create an export directory for a 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: Switch ID exported by the protocol service.
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: Description of the protocol service to export the directory.The console is displayed as the export directory name. limit: The length is 2 to 128 English or Chinese characters. Start with a lowercase letter or Chinese, and you cannot start with http:\/\/ and https: \/\/. It can contain numbers, half-horn colon (:), down line (_) or short lines (-).
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 needs to be exported.

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: Switch ID exported by the protocol service.

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: Description of the protocol service to export the directory.The console is displayed as the export directory name. limit: The length is 2 to 128 English or Chinese characters. Start with a lowercase letter or Chinese, and you cannot start with http:\/\/ and https: \/\/. It can contain numbers, half-horn colon (:), down line (_) or short lines (-).

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 needs to be exported.

limit: This directory must be existing directory on CPFS. The same directory allows only one export. Fileset and Path can only specify one. Format: The length is 1 to 1024 characters. Use UTF-8 encoding. It must start with the positive oblique line (/), and the root directory must be/.

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.

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

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

nodeRequired 

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

The construct tree node associated with this construct.

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 IResolvable getAttrExportId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute ExportId: The protocol service exports directory ID.

attrFileSystemIdRequired 

public IResolvable getAttrFileSystemId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute FileSystemId: File system ID.

attrProtocolMountTargetDomainRequired 

public IResolvable getAttrProtocolMountTargetDomain();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute ProtocolMountTargetDomain: The protocol mount target domain.

attrProtocolServiceIdRequired 

public IResolvable getAttrProtocolServiceId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute ProtocolServiceId: Protocol service ID.