ProtocolService

This class encapsulates and extends the ROS resource type ALIYUN::NAS::ProtocolService, which is used to create a protocol service for a Cloud Paralleled File System (CPFS) file system.

Initializers

import com.aliyun.ros.cdk.nas.ProtocolService;
ProtocolService.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .fileSystemId(java.lang.String)
    .fileSystemId(IResolvable)
    .protocolSpec(java.lang.String)
    .protocolSpec(IResolvable)
    .protocolType(java.lang.String)
    .protocolType(IResolvable)
    .vpcId(java.lang.String)
    .vpcId(IResolvable)
    .vSwitchId(java.lang.String)
    .vSwitchId(IResolvable)
//  .description(java.lang.String)
//  .description(IResolvable)
//  .throughput(java.lang.Number)
//  .throughput(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.
protocolSpec	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property protocolSpec: The spec of protocol service.
protocolType	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property protocolType: The protocol type of agreement service.
vpcId	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property vpcId: The protocol service VPCID needs to be consistent with the file system VPC.
vSwitchId	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property vSwitchId: Agreement service vswitchid.
description	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property description: Description of protocol service.The console shows the "protocol service 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 (-).
throughput	java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable	Property throughput: The bandwidth of the agreement service.

---

scope^Required

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

---

id^Required

• Type: java.lang.String

---

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

---

fileSystemId^Required

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

Property fileSystemId: File system ID.

---

protocolSpec^Required

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

Property protocolSpec: The spec of protocol service.

Default: General. Values: General

---

protocolType^Required

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

Property protocolType: The protocol type of agreement service.

Ranges: NFS: Agreement service supports NFS protocol access. The default value: NFS.

---

vpcId^Required

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

Property vpcId: The protocol service VPCID needs to be consistent with the file system VPC.

---

vSwitchId^Required

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

Property vSwitchId: Agreement service vswitchid.

---

description^Optional

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

Property description: Description of protocol service.The console shows the "protocol service 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 (-).

---

throughput^Optional

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

Property throughput: The bandwidth of the agreement service.

Unit: MB/S.

---

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.ProtocolService;
ProtocolService.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: File system ID.
attrProtocolServiceId	com.aliyun.ros.cdk.core.IResolvable	Attribute ProtocolServiceId: Agreement cluster group ID.

---

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

---

attrProtocolServiceId^Required

public IResolvable getAttrProtocolServiceId();

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

Attribute ProtocolServiceId: Agreement cluster group ID.

---