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 com.aliyun.ros.cdk.ecd.SimpleOfficeSite;
SimpleOfficeSite.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
//  .bandwidth(java.lang.Number)
//  .bandwidth(IResolvable)
//  .cenId(java.lang.String)
//  .cenId(IResolvable)
//  .cenOwnerId(java.lang.Number)
//  .cenOwnerId(IResolvable)
//  .cidrBlock(java.lang.String)
//  .cidrBlock(IResolvable)
//  .cloudBoxOfficeSite(java.lang.Boolean)
//  .cloudBoxOfficeSite(IResolvable)
//  .desktopAccessType(java.lang.String)
//  .desktopAccessType(IResolvable)
//  .enableAdminAccess(java.lang.Boolean)
//  .enableAdminAccess(IResolvable)
//  .enableInternetAccess(java.lang.Boolean)
//  .enableInternetAccess(IResolvable)
//  .needVerifyZeroDevice(java.lang.Boolean)
//  .needVerifyZeroDevice(IResolvable)
//  .officeSiteName(java.lang.String)
//  .officeSiteName(IResolvable)
//  .verifyCode(java.lang.String)
//  .verifyCode(IResolvable)
//  .vSwitchId(java.lang.String)
//  .vSwitchId(IResolvable)
    .build();
Name Type Description
scope com.aliyun.ros.cdk.core.Construct No description.
id java.lang.String No description.
enableResourcePropertyConstraint java.lang.Boolean No description.
bandwidth java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property bandwidth: The maximum public bandwidth.
cenId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property cenId: The ID of the Cloud Enterprise Network (CEN) instance.
cenOwnerId java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property cenOwnerId: The ID of the Alibaba Cloud account to which the Cloud Enterprise Network (CEN) instance belongs.
cidrBlock java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property cidrBlock: The IPv4 CIDR block in the secure office network of the workspace.
cloudBoxOfficeSite java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property cloudBoxOfficeSite: Specifies whether the workspace is a CloudBox-based workspace.
desktopAccessType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property desktopAccessType: The method that is used to connect the client to cloud desktops.
enableAdminAccess java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property enableAdminAccess: Specifies whether to grant the permissions of the local administrator to the regular user of the cloud desktop.
enableInternetAccess java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property enableInternetAccess: Specifies whether to enable Internet access.
needVerifyZeroDevice java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property needVerifyZeroDevice: Specifies whether to enable trusted device verification.
officeSiteName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property officeSiteName: The name of the workspace.
verifyCode java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property verifyCode: The verification code.
vSwitchId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property vSwitchId: The IDs of the vSwitches in the VPC.

scopeRequired

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

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

bandwidthOptional

  • Type: java.lang.Number OR com.aliyun.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.

cenIdOptional

  • Type: java.lang.String OR com.aliyun.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.

cenOwnerIdOptional

  • Type: java.lang.Number OR com.aliyun.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.

cidrBlockOptional

  • Type: java.lang.String OR com.aliyun.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.

cloudBoxOfficeSiteOptional

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

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

Enumeration Value: true false

desktopAccessTypeOptional

  • Type: java.lang.String OR com.aliyun.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.

enableAdminAccessOptional

  • Type: java.lang.Boolean OR com.aliyun.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

enableInternetAccessOptional

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

Property enableInternetAccess: Specifies whether to enable Internet access.

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

needVerifyZeroDeviceOptional

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

Property needVerifyZeroDevice: Specifies whether to enable trusted device verification.

Enumeration Value: true false

officeSiteNameOptional

  • Type: java.lang.String OR com.aliyun.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 (-).

verifyCodeOptional

  • Type: java.lang.String OR com.aliyun.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.

vSwitchIdOptional

  • Type: java.lang.String OR com.aliyun.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.

Methods

Name Description
toString Returns a string representation of this construct.
synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
addCondition No description.
addCount No description.
addDependency No description.
addResourceDesc No description.
applyRemovalPolicy No description.
getAtt No description.
setMetadata No description.

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.

sessionRequired

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

The synthesis session.

addCondition 

public void addCondition(RosCondition condition)

conditionRequired

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

addCount 

public void addCount(java.lang.Number OR IResolvable count)

countRequired

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

addDependency 

public void addDependency(Resource resource)

resourceRequired

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

addResourceDesc 

public void addResourceDesc(java.lang.String desc)

descRequired

  • Type: java.lang.String

applyRemovalPolicy 

public void applyRemovalPolicy(RemovalPolicy policy)

policyRequired

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

getAtt 

public IResolvable getAtt(java.lang.String name)

nameRequired

  • Type: java.lang.String

setMetadata 

public void setMetadata(java.lang.String key, java.lang.Object value)

keyRequired

  • Type: java.lang.String

valueRequired

  • Type: java.lang.Object

Static Functions

Name Description
isConstruct Return whether the given object is a Construct.

isConstruct 

import com.aliyun.ros.cdk.ecd.SimpleOfficeSite;
SimpleOfficeSite.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

xRequired

  • Type: java.lang.Object

Properties

Name Type Description
node com.aliyun.ros.cdk.core.ConstructNode The construct tree node associated with this construct.
ref java.lang.String No description.
stack com.aliyun.ros.cdk.core.Stack The stack in which this resource is defined.
resource com.aliyun.ros.cdk.core.RosResource No description.
attrOfficeSiteId com.aliyun.ros.cdk.core.IResolvable Attribute OfficeSiteId: The ID of the workspace.

nodeRequired 

public ConstructNode getNode();
  • Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.

refRequired 

public java.lang.String getRef();
  • Type: java.lang.String

stackRequired 

public Stack getStack();
  • Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.

resourceOptional 

public RosResource getResource();
  • Type: com.aliyun.ros.cdk.core.RosResource

attrOfficeSiteIdRequired 

public IResolvable getAttrOfficeSiteId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute OfficeSiteId: The ID of the workspace.

Structs