Skip to content

Rum

This class encapsulates and extends the ROS resource type ALIYUN::ARMS::Rum.

Initializers

import ros_cdk_arms
ros_cdk_arms.Rum(
  scope: Construct,
  id: str,
  app_name: typing.Union[str, IResolvable],
  site_type: typing.Union[str, IResolvable],
  app_group: typing.Union[str, IResolvable] = None,
  description: typing.Union[str, IResolvable] = None,
  language: typing.Union[str, IResolvable] = None,
  nick_name: typing.Union[str, IResolvable] = None,
  package_name: typing.Union[str, IResolvable] = None,
  real_region_id: typing.Union[str, IResolvable] = None,
  resource_group_id: typing.Union[str, IResolvable] = None,
  source: typing.Union[str, IResolvable] = None,
  tags: typing.List[TagsProperty] = None,
  enable_resource_property_constraint: bool = None
)
Name Type Description
scope ros_cdk_core.Construct No description.
id str No description.
app_name typing.Union[str, ros_cdk_core.IResolvable] Property appName: The name of the RUM application.
site_type typing.Union[str, ros_cdk_core.IResolvable] Property siteType: The application type.
app_group typing.Union[str, ros_cdk_core.IResolvable] Property appGroup: The group to which the RUM application belongs.
description typing.Union[str, ros_cdk_core.IResolvable] Property description: The description of the RUM application.
language typing.Union[str, ros_cdk_core.IResolvable] Property language: The programming language of the RUM application.
nick_name typing.Union[str, ros_cdk_core.IResolvable] Property nickName: The nickname of the RUM application.
package_name typing.Union[str, ros_cdk_core.IResolvable] Property packageName: The name of the Android application package.
real_region_id typing.Union[str, ros_cdk_core.IResolvable] Property realRegionId: The region where the application resides.
resource_group_id typing.Union[str, ros_cdk_core.IResolvable] Property resourceGroupId: The ID of the resource group to which the RUM application belongs.
source typing.Union[str, ros_cdk_core.IResolvable] Property source: The source.
tags typing.List[TagsProperty] Property tags: A list of tags to attach to the RUM application.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

app_nameRequired

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

Property appName: The name of the RUM application.

The value can be up to 64 characters in length.


site_typeRequired

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

Property siteType: The application type.

Valid values: web, miniapp, ios, and android.


app_groupOptional

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

Property appGroup: The group to which the RUM application belongs.


descriptionOptional

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

Property description: The description of the RUM application.


languageOptional

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

Property language: The programming language of the RUM application.


nick_nameOptional

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

Property nickName: The nickname of the RUM application.


package_nameOptional

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

Property packageName: The name of the Android application package.

This parameter is required if you create an Android application.


real_region_idOptional

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

Property realRegionId: The region where the application resides.

You can leave this parameter empty or set it to China East 2 Finance.


resource_group_idOptional

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

Property resourceGroupId: The ID of the resource group to which the RUM application belongs.


sourceOptional

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

Property source: The source.

This is a reserved parameter.


tagsOptional

Property tags: A list of tags to attach to the RUM application.

Each tag is a key-value pair.


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.
fetch_condition No description.
fetch_dependency No description.
fetch_resource_desc 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

fetch_condition

def fetch_condition() -> RosCondition

fetch_dependency

def fetch_dependency() -> typing.List[str]

fetch_resource_desc

def fetch_resource_desc() -> str

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_arms
ros_cdk_arms.Rum.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.
env ros_cdk_core.IResourceEnvironment The environment this resource belongs to.
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_cdn_domain typing.Union[str, ros_cdk_core.IResolvable] Attribute CdnDomain: The CDN domain of the RUM application.
attr_endpoint typing.Union[str, ros_cdk_core.IResolvable] Attribute Endpoint: The endpoint of the RUM application.
attr_pid typing.Union[str, ros_cdk_core.IResolvable] Attribute Pid: The PID of the RUM application.
props RumProps No description.

nodeRequired

node: ConstructNode
  • Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.


envRequired

env: IResourceEnvironment
  • Type: ros_cdk_core.IResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.


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_cdn_domainRequired

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

Attribute CdnDomain: The CDN domain of the RUM application.


attr_endpointRequired

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

Attribute Endpoint: The endpoint of the RUM application.


attr_pidRequired

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

Attribute Pid: The PID of the RUM application.


propsRequired

props: RumProps