Skip to content

App

This class encapsulates and extends the ROS resource type ALIYUN::MOBI::App.

Initializers

import ros_cdk_mobi
ros_cdk_mobi.App(
  scope: Construct,
  id: str,
  app_icon: typing.Union[str, IResolvable],
  app_name: typing.Union[str, IResolvable],
  app_workspace_id: typing.Union[str, IResolvable],
  template: typing.Union[IResolvable, TemplateProperty],
  app_description: typing.Union[str, IResolvable] = None,
  app_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.
app_icon typing.Union[str, ros_cdk_core.IResolvable] Property appIcon: Application icon label, The system provides an icon by default, which is given in the form of a label.
app_name typing.Union[str, ros_cdk_core.IResolvable] Property appName: The application name.
app_workspace_id typing.Union[str, ros_cdk_core.IResolvable] Property appWorkspaceId: Workspace ID of application, The application belongs to the workspace.
template typing.Union[ros_cdk_core.IResolvable, TemplateProperty] Property template: Application Template.
app_description typing.Union[str, ros_cdk_core.IResolvable] Property appDescription: Description of application.
app_type typing.Union[str, ros_cdk_core.IResolvable] Property appType: The application type.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

app_iconRequired

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

Property appIcon: Application icon label, The system provides an icon by default, which is given in the form of a label.

The default value is -1.


app_nameRequired

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

Property appName: The application name.


app_workspace_idRequired

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

Property appWorkspaceId: Workspace ID of application, The application belongs to the workspace.


templateRequired

Property template: Application Template.


app_descriptionOptional

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

Property appDescription: Description of application.


app_typeOptional

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

Property appType: The application type.

Web applications and Copilot applications are supported.

  • Web:Web application.
  • Copilot:Copilot application.

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_mobi
ros_cdk_mobi.App.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_app_description ros_cdk_core.IResolvable Attribute AppDescription: Description of application.
attr_app_icon ros_cdk_core.IResolvable Attribute AppIcon: Application icon label, The system provides an icon by default, which is given in the form of a label.
attr_app_id ros_cdk_core.IResolvable Attribute AppId: Application ID.
attr_app_name ros_cdk_core.IResolvable Attribute AppName: The application name.
attr_app_type ros_cdk_core.IResolvable Attribute AppType: The application type.
attr_app_workspace_id ros_cdk_core.IResolvable Attribute AppWorkspaceId: Workspace ID of application, The application belongs to the workspace.
attr_create_time ros_cdk_core.IResolvable Attribute CreateTime: Create time of application.
attr_modified_time ros_cdk_core.IResolvable Attribute ModifiedTime: Modified time of application.

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_app_descriptionRequired

attr_app_description: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute AppDescription: Description of application.


attr_app_iconRequired

attr_app_icon: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute AppIcon: Application icon label, The system provides an icon by default, which is given in the form of a label.

The default value is -1.


attr_app_idRequired

attr_app_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute AppId: Application ID.


attr_app_nameRequired

attr_app_name: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute AppName: The application name.


attr_app_typeRequired

attr_app_type: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute AppType: The application type.

Web applications and Copilot applications are supported.


attr_app_workspace_idRequired

attr_app_workspace_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute AppWorkspaceId: Workspace ID of application, The application belongs to the workspace.


attr_create_timeRequired

attr_create_time: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute CreateTime: Create time of application.


attr_modified_timeRequired

attr_modified_time: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ModifiedTime: Modified time of application.