Skip to content

SimpleOfficeSite

This class encapsulates and extends the ROS resource type ALIYUN::ECD::SimpleOfficeSite, which is used to create a workspace of the convenience account type.

Initializers 

import ros_cdk_ecd
ros_cdk_ecd.SimpleOfficeSite(
  scope: Construct,
  id: str,
  bandwidth: typing.Union[typing.Union[int, float], IResolvable] = None,
  cen_id: typing.Union[str, IResolvable] = None,
  cen_owner_id: typing.Union[typing.Union[int, float], IResolvable] = None,
  cidr_block: typing.Union[str, IResolvable] = None,
  cloud_box_office_site: typing.Union[bool, IResolvable] = None,
  desktop_access_type: typing.Union[str, IResolvable] = None,
  enable_admin_access: typing.Union[bool, IResolvable] = None,
  enable_internet_access: typing.Union[bool, IResolvable] = None,
  need_verify_zero_device: typing.Union[bool, IResolvable] = None,
  office_site_name: typing.Union[str, IResolvable] = None,
  verify_code: typing.Union[str, IResolvable] = None,
  vpc_type: typing.Union[str, IResolvable] = None,
  v_switch_id: 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.
bandwidth typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property bandwidth: The maximum public bandwidth.
cen_id typing.Union[str, ros_cdk_core.IResolvable] Property cenId: The ID of the Cloud Enterprise Network (CEN) instance.
cen_owner_id typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property cenOwnerId: The ID of the Alibaba Cloud account to which the Cloud Enterprise Network (CEN) instance belongs.
cidr_block typing.Union[str, ros_cdk_core.IResolvable] Property cidrBlock: The IPv4 CIDR block in the secure office network of the workspace.
cloud_box_office_site typing.Union[bool, ros_cdk_core.IResolvable] Property cloudBoxOfficeSite: Specifies whether the workspace is a CloudBox-based workspace.
desktop_access_type typing.Union[str, ros_cdk_core.IResolvable] Property desktopAccessType: The method that is used to connect the client to cloud desktops.
enable_admin_access typing.Union[bool, ros_cdk_core.IResolvable] Property enableAdminAccess: Specifies whether to grant the permissions of the local administrator to the regular user of the cloud desktop.
enable_internet_access typing.Union[bool, ros_cdk_core.IResolvable] Property enableInternetAccess: Specifies whether to enable Internet access.
need_verify_zero_device typing.Union[bool, ros_cdk_core.IResolvable] Property needVerifyZeroDevice: Specifies whether to enable trusted device verification.
office_site_name typing.Union[str, ros_cdk_core.IResolvable] Property officeSiteName: The name of the workspace.
verify_code typing.Union[str, ros_cdk_core.IResolvable] Property verifyCode: The verification code.
vpc_type typing.Union[str, ros_cdk_core.IResolvable] Property vpcType: The type of office network.
v_switch_id typing.Union[str, ros_cdk_core.IResolvable] Property vSwitchId: The IDs of the vSwitches in the VPC.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

bandwidthOptional

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

Property bandwidth: The maximum public bandwidth.

Value range: 10 to 200. Unit: Mbit/s. This parameter is available if you set EnableInternetAccess to true.

cen_idOptional

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

Property cenId: The ID of the Cloud Enterprise Network (CEN) instance.

NoteIf you want to connect to your cloud desktops over a VPC, you can attach the network of the workspace to the CEN instance. The CEN instance is connected to the on-premises network over VPN Gateway or Express Connect.

cen_owner_idOptional

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

Property cenOwnerId: The ID of the Alibaba Cloud account to which the Cloud Enterprise Network (CEN) instance belongs.

If you do not specify the CenId parameter, or the CEN instance that is specified by the CenId parameter belongs to the current Alibaba Cloud account, skip this parameter. If you specify the CenId parameter and the CEN instance that you specify for the CenId parameter belongs to another Alibaba Cloud account, enter the ID of the Alibaba Cloud account.

cidr_blockOptional

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

Property cidrBlock: The IPv4 CIDR block in the secure office network of the workspace.

The IPv4 CIDR block that the system uses to create a virtual private cloud (VPC) for the workspace. We recommend that you set the IPv4 CIDR block to 10.0.0.0/12, 172.16.0.0/12, 192.168.0.0/16, or a subnet of these CIDR blocks. If you set the IPv4 CIDR block to 10.0.0.0/12 or 172.16.0.0/12, the mask is 1224 bits in length. If you set the IPv4 CIDR block to 192.168.0.0/16, the mask is 1624 bits in length.

cloud_box_office_siteOptional

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

Property cloudBoxOfficeSite: Specifies whether the workspace is a CloudBox-based workspace.

Enumeration Value: true false

desktop_access_typeOptional

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

Property desktopAccessType: The method that is used to connect the client to cloud desktops.

NoteVPC connections are established by using Alibaba Cloud PrivateLink. You can use PrivateLink for free. When you set this parameter to VPC or Any, PrivateLink is automatically activated.

enable_admin_accessOptional

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

Property enableAdminAccess: Specifies whether to grant the permissions of the local administrator to the regular user of the cloud desktop.

Enumeration Value: true false

enable_internet_accessOptional

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

Property enableInternetAccess: Specifies whether to enable Internet access.

By default, Internet access is not enabled. Enumeration Value: true false

need_verify_zero_deviceOptional

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

Property needVerifyZeroDevice: Specifies whether to enable trusted device verification.

Enumeration Value: true false

office_site_nameOptional

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

Property officeSiteName: The name of the workspace.

The name must be 2 to 255 characters in length. It must start with a letter and cannot start with http:// or https://. The name can contain letters, digits, colons (:), underscores (_), and hyphens (-).

verify_codeOptional

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

Property verifyCode: The verification code.

If the CEN instance that you specify for the CenId parameter belongs to another Alibaba Cloud account, you must call the SendVerifyCode operation to obtain the verification code.

vpc_typeOptional

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

Property vpcType: The type of office network.

Enumeration value: standard: Advanced office network. basic: Basic office network.

v_switch_idOptional

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

Property vSwitchId: The IDs of the vSwitches in the VPC.

This parameter is required when you create a CloudBox-based workspace.

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_ecd
ros_cdk_ecd.SimpleOfficeSite.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_office_site_id ros_cdk_core.IResolvable Attribute OfficeSiteId: The ID of the workspace.

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_office_site_idRequired 

attr_office_site_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute OfficeSiteId: The ID of the workspace.

Structs