Skip to content

AccessRule

This class encapsulates and extends the ROS resource type ALIYUN::NAS::AccessRule, which is used to create a rule for a permission group.

Initializers 

import ros_cdk_nas
ros_cdk_nas.AccessRule(
  scope: Construct,
  id: str,
  access_group_name: typing.Union[str, IResolvable],
  file_system_type: typing.Union[str, IResolvable] = None,
  ipv6_source_cidr_ip: typing.Union[str, IResolvable] = None,
  priority: typing.Union[typing.Union[int, float], IResolvable] = None,
  rw_access_type: typing.Union[str, IResolvable] = None,
  source_cidr_ip: typing.Union[str, IResolvable] = None,
  user_access_type: 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.
access_group_name typing.Union[str, ros_cdk_core.IResolvable] Property accessGroupName: Permission group name.
file_system_type typing.Union[str, ros_cdk_core.IResolvable] Property fileSystemType: The type of file system.
ipv6_source_cidr_ip typing.Union[str, ros_cdk_core.IResolvable] Property ipv6SourceCidrIp: Source IPv6 CIDR address segment.
priority typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property priority: Priority level.
rw_access_type typing.Union[str, ros_cdk_core.IResolvable] Property rwAccessType: Read-write permission type: RDWR (default), RDONLY.
source_cidr_ip typing.Union[str, ros_cdk_core.IResolvable] Property sourceCidrIp: Address or address segment.
user_access_type typing.Union[str, ros_cdk_core.IResolvable] Property userAccessType: User permission type: no_squash (default), root_squash, all_squash.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

access_group_nameRequired

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property accessGroupName: Permission group name.

file_system_typeOptional

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property fileSystemType: The type of file system.

Values: standard: the general NAS extreme: the extreme NAS

ipv6_source_cidr_ipOptional

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property ipv6SourceCidrIp: Source IPv6 CIDR address segment.

IP addresses in CIDR format and IPv6 format are supported. Currently, only the ultra-fast NAS in mainland China supports the IPv6 function, and the file system needs to enable the IPv6 function. Only VPC private network is supported. IPv4 and IPv6 are mutually exclusive, and the types cannot be converted.

priorityOptional

  • Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

Property priority: Priority level.

Range: 1-100. Default value: 1

rw_access_typeOptional

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property rwAccessType: Read-write permission type: RDWR (default), RDONLY.

source_cidr_ipOptional

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property sourceCidrIp: Address or address segment.

user_access_typeOptional

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property userAccessType: User permission type: no_squash (default), root_squash, all_squash.

enable_resource_property_constraintOptional

  • 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.

sessionRequired

  • Type: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition 

def add_condition(
  condition: RosCondition
) -> None

conditionRequired

  • Type: ros_cdk_core.RosCondition

add_count 

def add_count(
  count: typing.Union[typing.Union[int, float], IResolvable]
) -> None

countRequired

  • Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

add_dependency 

def add_dependency(
  resource: Resource
) -> None

resourceRequired

  • Type: ros_cdk_core.Resource

add_resource_desc 

def add_resource_desc(
  desc: str
) -> None

descRequired

  • Type: str

apply_removal_policy 

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policyRequired

  • Type: ros_cdk_core.RemovalPolicy

get_att 

def get_att(
  name: str
) -> IResolvable

nameRequired

  • Type: str

set_metadata 

def set_metadata(
  key: str,
  value: typing.Any
) -> None

keyRequired

  • Type: str

valueRequired

  • 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.AccessRule.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

xRequired

  • 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_access_rule_id ros_cdk_core.IResolvable Attribute AccessRuleId: Rule serial number.

nodeRequired 

node: ConstructNode
  • Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

refRequired 

ref: str
  • Type: str

stackRequired 

stack: Stack
  • Type: ros_cdk_core.Stack

The stack in which this resource is defined.

resourceOptional 

resource: RosResource
  • Type: ros_cdk_core.RosResource

attr_access_rule_idRequired 

attr_access_rule_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute AccessRuleId: Rule serial number.