App

• Implements: IApp

This class encapsulates and extends the ROS resource type ALIYUN::SAG::App, which is used to create a Smart Access Gateway (SAG) app instance.

Initializers

import ros_cdk_sag
ros_cdk_sag.App(
  scope: Construct,
  id: str,
  auto_pay: typing.Union[bool, IResolvable],
  data_plan: typing.Union[typing.Union[int, float], IResolvable],
  period: typing.Union[typing.Union[int, float], IResolvable],
  user_count: typing.Union[typing.Union[int, float], IResolvable],
  charge_type: typing.Union[str, IResolvable] = None,
  enable_resource_property_constraint: bool = None
)

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

auto_pay^Required

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

Property autoPay: Specifies whether to automatically pay the bills of SAG APP instances.

Default value: false. Valid values: true: automatically pays the bills of SAG APP instances. false: does not automatically pay the bills of SAG APP instances. If you set the parameter to false, after you call this operation, go to Billing Management of the SAG console to complete the payment, the instance can be created.

data_plan^Required

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

Property dataPlan: The quota of the traffic plan that the system allows each client account to use for free each month.

Unit: GB. Set the value to 5. Note The system allows each client account to use 5 GB traffic plan for free.

period^Required

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

Property period: The subscription period of the SAG APP instance.

Unit: months. Valid values: 1~9, 12, 24, and 36.

user_count^Required

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

Property userCount: The quota of client accounts for the SAG APP instance.

Note The quota must be a positive multiple of 5, for example, 5, 10, and 15.

charge_type^Optional

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

Property chargeType: The billing method of the SAG APP instance.

Set the value to PREPAY. This value indicates that the SAG APP instance is a subscription resource.

enable_resource_property_constraint^Optional

• Type: bool

Methods

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.

session^Required

• Type: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition

def add_condition(
  condition: RosCondition
) -> None

condition^Required

• Type: ros_cdk_core.RosCondition

add_count

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

count^Required

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

add_dependency

def add_dependency(
  resource: Resource
) -> None

resource^Required

• Type: ros_cdk_core.Resource

add_resource_desc

def add_resource_desc(
  desc: str
) -> None

desc^Required

• Type: str

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policy^Required

• 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

name^Required

• Type: str

set_metadata

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

key^Required

• Type: str

value^Required

• Type: typing.Any

Static Functions

is_construct

import ros_cdk_sag
ros_cdk_sag.App.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

x^Required

• Type: typing.Any

Properties

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

env^Required

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.

ref^Required

ref: str

• Type: str

stack^Required

stack: Stack

• Type: ros_cdk_core.Stack

The stack in which this resource is defined.

resource^Optional

resource: RosResource

• Type: ros_cdk_core.RosResource

attr_order_id^Required

attr_order_id: typing.Union[str, IResolvable]

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

Attribute OrderId: The ID of the order that you placed to subscribe to the SAG APP instance.

attr_smart_ag_id^Required

attr_smart_ag_id: typing.Union[str, IResolvable]

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

Attribute SmartAGId: The ID of the SAG APP instance.

props^Required

props: AppProps

• Type: AppProps