BizType

• Implements: IBizType

This class encapsulates and extends the ROS resource type ALIYUN::Aligreen::BizType, which is used to create a business scenario.

Initializers

import ros_cdk_aligreen
ros_cdk_aligreen.BizType(
  scope: Construct,
  id: str,
  biz_type_name: typing.Union[str, IResolvable],
  cite_template: typing.Union[bool, IResolvable],
  biz_type_import: typing.Union[str, IResolvable] = None,
  description: typing.Union[str, IResolvable] = None,
  industry_info: typing.Union[str, IResolvable] = None,
  enable_resource_property_constraint: bool = None
)

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

biz_type_name^Required

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

Property bizTypeName: The name of the business scenario defined by the customer.

It can contain no more than 32 characters in English, numbers, and underscores.

cite_template^Required

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

Property citeTemplate: Specifies whether to import the configuration of an industry template.

Default value: false. Valid values: true: imports the configuration of an industry template. false: does not import the configuration of an industry template. If the value is true, you must specify the industryInfo parameter.

biz_type_import^Optional

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

Property bizTypeImport: The name of the existing business scenario that was imported from when the business scenario was created.

description^Optional

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

Property description: The description of the business scenario defined by the customer, which is a combination of Chinese and English, numbers, and underscores, and cannot exceed 32 characters.

industry_info^Optional

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

Property industryInfo: The industry classification.

For specific types see CreateBizType.

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_aligreen
ros_cdk_aligreen.BizType.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_biz_type_name^Required

attr_biz_type_name: typing.Union[str, IResolvable]

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

Attribute BizTypeName: The name of the business scenario defined by the customer.

attr_cite_template^Required

attr_cite_template: typing.Union[str, IResolvable]

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

Attribute CiteTemplate: Specifies whether to import the configuration of an industry template.

Default value: false.

attr_description^Required

attr_description: typing.Union[str, IResolvable]

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

Attribute Description: The description of the business scenario defined by the customer.

attr_industry_info^Required

attr_industry_info: typing.Union[str, IResolvable]

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

Attribute IndustryInfo: The industry classification.

props^Required

props: BizTypeProps

• Type: BizTypeProps