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 ros_cdk_nas
ros_cdk_nas.ProtocolMountTarget(
scope: Construct,
id: str,
file_system_id: typing.Union[str, IResolvable],
protocol_service_id: typing.Union[str, IResolvable],
vpc_id: typing.Union[str, IResolvable],
v_switch_id: typing.Union[str, IResolvable],
access_group_name: typing.Union[str, IResolvable] = None,
description: typing.Union[str, IResolvable] = None,
fset_id: typing.Union[str, IResolvable] = None,
path: typing.Union[str, 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_service_id |
typing.Union[str, ros_cdk_core.IResolvable] |
Property protocolServiceId: Agreement service ID. |
vpc_id |
typing.Union[str, ros_cdk_core.IResolvable] |
Property vpcId: Proper network ID exported by the protocol service. |
v_switch_id |
typing.Union[str, ros_cdk_core.IResolvable] |
Property vSwitchId: Switch ID exported by the protocol service. |
access_group_name |
typing.Union[str, ros_cdk_core.IResolvable] |
Property accessGroupName: The name of the permissions group. |
description |
typing.Union[str, 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 (-). |
fset_id |
typing.Union[str, ros_cdk_core.IResolvable] |
Property fsetId: Fileset ID needs to be exported. |
path |
typing.Union[str, ros_cdk_core.IResolvable] |
Property path: The path of the CPFS directory that needs to be exported. |
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_service_id
Required
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property protocolServiceId: Agreement service ID.
vpc_id
Required
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property vpcId: Proper network ID exported by the protocol service.
v_switch_id
Required
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property vSwitchId: Switch ID exported by the protocol service.
access_group_name
Optional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property accessGroupName: The name of the permissions group.
Default value: DEFAULT_VPC_GROUP_NAME
description
Optional
- Type: typing.Union[str, 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 (-).
fset_id
Optional
- Type: typing.Union[str, 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.
path
Optional
- Type: typing.Union[str, 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/.
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.ProtocolMountTarget.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_export_id |
ros_cdk_core.IResolvable |
Attribute ExportId: The protocol service exports directory ID. |
attr_file_system_id |
ros_cdk_core.IResolvable |
Attribute FileSystemId: File system ID. |
attr_protocol_mount_target_domain |
ros_cdk_core.IResolvable |
Attribute ProtocolMountTargetDomain: The protocol mount target domain. |
attr_protocol_service_id |
ros_cdk_core.IResolvable |
Attribute ProtocolServiceId: Protocol service 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_export_id
Required
attr_export_id: IResolvable
- Type: ros_cdk_core.IResolvable
Attribute ExportId: The protocol service exports directory ID.
attr_file_system_id
Required
attr_file_system_id: IResolvable
- Type: ros_cdk_core.IResolvable
Attribute FileSystemId: File system ID.
attr_protocol_mount_target_domain
Required
attr_protocol_mount_target_domain: IResolvable
- Type: ros_cdk_core.IResolvable
Attribute ProtocolMountTargetDomain: The protocol mount target domain.
attr_protocol_service_id
Required
attr_protocol_service_id: IResolvable
- Type: ros_cdk_core.IResolvable
Attribute ProtocolServiceId: Protocol service ID.