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 ros_cdk_nas
ros_cdk_nas.ProtocolService(
scope: Construct,
id: str,
file_system_id: typing.Union[str, IResolvable],
protocol_spec: typing.Union[str, IResolvable],
protocol_type: typing.Union[str, IResolvable],
vpc_id: typing.Union[str, IResolvable],
v_switch_id: typing.Union[str, IResolvable],
description: typing.Union[str, IResolvable] = None,
throughput: typing.Union[typing.Union[int, float], IResolvable] = None,
enable_resource_property_constraint: bool = None
)
Name | Type | Description |
---|---|---|
scope |
ros_cdk_core.Construct |
No description. |
id |
str |
No description. |
file_system_id |
typing.Union[str, ros_cdk_core.IResolvable] |
Property fileSystemId: File system ID. |
protocol_spec |
typing.Union[str, ros_cdk_core.IResolvable] |
Property protocolSpec: The spec of protocol service. |
protocol_type |
typing.Union[str, ros_cdk_core.IResolvable] |
Property protocolType: The protocol type of agreement service. |
vpc_id |
typing.Union[str, ros_cdk_core.IResolvable] |
Property vpcId: The protocol service VPCID needs to be consistent with the file system VPC. |
v_switch_id |
typing.Union[str, ros_cdk_core.IResolvable] |
Property vSwitchId: Agreement service vswitchid. |
description |
typing.Union[str, 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 |
typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] |
Property throughput: The bandwidth of the agreement service. |
enable_resource_property_constraint |
bool |
No description. |
scope
Required
- Type: ros_cdk_core.Construct
id
Required
- Type: str
file_system_id
Required
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property fileSystemId: File system ID.
protocol_spec
Required
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property protocolSpec: The spec of protocol service.
Default: General. Values: General
protocol_type
Required
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property protocolType: The protocol type of agreement service.
Ranges: NFS: Agreement service supports NFS protocol access. The default value: NFS.
vpc_id
Required
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property vpcId: The protocol service VPCID needs to be consistent with the file system VPC.
v_switch_id
Required
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property vSwitchId: Agreement service vswitchid.
description
Optional
- Type: typing.Union[str, 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: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
Property throughput: The bandwidth of the agreement service.
Unit: MB/S.
enable_resource_property_constraint
Optional
- Type: bool
Methods
Name | Description |
---|---|
to_string |
Returns a string representation of this construct. |
synthesize |
Allows this construct to emit artifacts into the cloud assembly during synthesis. |
add_condition |
No description. |
add_count |
No description. |
add_dependency |
No description. |
add_resource_desc |
No description. |
apply_removal_policy |
No description. |
get_att |
No description. |
set_metadata |
No description. |
to_string
def to_string() -> str
Returns a string representation of this construct.
synthesize
def synthesize(
session: ISynthesisSession
) -> None
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.
- Type: ros_cdk_core.ISynthesisSession
The synthesis session.
add_condition
def add_condition(
condition: RosCondition
) -> None
- Type: ros_cdk_core.RosCondition
add_count
def add_count(
count: typing.Union[typing.Union[int, float], IResolvable]
) -> None
- Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
add_dependency
def add_dependency(
resource: Resource
) -> None
- Type: ros_cdk_core.Resource
add_resource_desc
def add_resource_desc(
desc: str
) -> None
- Type: str
apply_removal_policy
def apply_removal_policy(
policy: RemovalPolicy
) -> None
- Type: ros_cdk_core.RemovalPolicy
get_att
def get_att(
name: str
) -> IResolvable
- Type: str
set_metadata
def set_metadata(
key: str,
value: typing.Any
) -> None
- Type: str
- Type: typing.Any
Static Functions
Name | Description |
---|---|
is_construct |
Return whether the given object is a Construct. |
is_construct
import ros_cdk_nas
ros_cdk_nas.ProtocolService.is_construct(
x: typing.Any
)
Return whether the given object is a Construct.
- Type: typing.Any
Properties
Name | Type | Description |
---|---|---|
node |
ros_cdk_core.ConstructNode |
The construct tree node associated with this construct. |
ref |
str |
No description. |
stack |
ros_cdk_core.Stack |
The stack in which this resource is defined. |
resource |
ros_cdk_core.RosResource |
No description. |
attr_file_system_id |
ros_cdk_core.IResolvable |
Attribute FileSystemId: File system ID. |
attr_protocol_service_id |
ros_cdk_core.IResolvable |
Attribute ProtocolServiceId: Agreement cluster group ID. |
node
Required
node: ConstructNode
- Type: ros_cdk_core.ConstructNode
The construct tree node associated with this construct.
ref
Required
ref: str
- Type: str
stack
Required
stack: Stack
- Type: ros_cdk_core.Stack
The stack in which this resource is defined.
resource
Optional
resource: RosResource
- Type: ros_cdk_core.RosResource
attr_file_system_id
Required
attr_file_system_id: IResolvable
- Type: ros_cdk_core.IResolvable
Attribute FileSystemId: File system ID.
attr_protocol_service_id
Required
attr_protocol_service_id: IResolvable
- Type: ros_cdk_core.IResolvable
Attribute ProtocolServiceId: Agreement cluster group ID.