ProtocolService

• Implements: IProtocolService

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

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();

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 the protocol service.

Valid value: NFS (default). Only NFSv3 is supported.

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: The description of the protocol service.

The name of the protocol service 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 (-).

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

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

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)

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

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

node^Required

public ConstructNode getNode();

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

The construct tree node associated with this construct.

env^Required

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.

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 java.lang.Object getAttrFileSystemId();

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

Attribute FileSystemId: File system ID.

attrProtocolServiceId^Required

public java.lang.Object getAttrProtocolServiceId();

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

Attribute ProtocolServiceId: Agreement cluster group ID.

props^Required

public ProtocolServiceProps getProps();

• Type: ProtocolServiceProps