ServiceInstance

• Implements: IServiceInstance

This class encapsulates and extends the ROS resource type ALIYUN::ComputeNest::ServiceInstanceThe , which type is used to create and deploy a service instance.

Initializers

import ros_cdk_computenest
ros_cdk_computenest.ServiceInstance(
  scope: Construct,
  id: str,
  service: typing.Union[IResolvable, ServiceProperty],
  commodity: typing.Union[IResolvable, CommodityProperty] = None,
  contact_group: typing.Union[str, IResolvable] = None,
  dry_run: typing.Union[bool, IResolvable] = None,
  enable_instance_ops: typing.Union[bool, IResolvable] = None,
  enable_user_prometheus: typing.Union[bool, IResolvable] = None,
  operation_name: typing.Union[str, IResolvable] = None,
  parameters: typing.Union[IResolvable, typing.Mapping[typing.Any]] = None,
  predefined_parameter_name: typing.Union[str, IResolvable] = None,
  resource_auto_pay: typing.Union[bool, IResolvable] = None,
  resource_group_id: typing.Union[str, IResolvable] = None,
  service_instance_name: typing.Union[str, IResolvable] = None,
  specification_code: typing.Union[str, IResolvable] = None,
  tags: typing.List[TagsProperty] = None,
  template_name: typing.Union[str, IResolvable] = None,
  enable_resource_property_constraint: bool = None
)

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

service^Required

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

Property service: Service details.

commodity^Optional

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

Property commodity: The purchase order information of the cloud market does not need to be transmitted if the service is not on the cloud market or charged by volume.

contact_group^Optional

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

Property contactGroup: Alarm Contact Group.

dry_run^Optional

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

Property dryRun: Whether to perform PreCheck on the creation request, including permissions and instance status verification.

Possible values:

• true: The request is sent without creating a service instance.
• false: Sends the request and creates a service instance after the check is passed.

enable_instance_ops^Optional

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

Property enableInstanceOps: Whether the service instance has the O & M function.

Possible values:

• true: The service instance has a generation O & M function.
• false: The service instance does not have the O & M function.

enable_user_prometheus^Optional

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

Property enableUserPrometheus: Whether Prometheus monitoring is enabled.

Possible values:

• true: enabled.
• false: not enabled.

operation_name^Optional

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

Property operationName: Change operation name.

parameters^Optional

• Type: typing.Union[ros_cdk_core.IResolvable, typing.Mapping[typing.Any]]

Property parameters: The parameters entered by the deployment service instance.

predefined_parameter_name^Optional

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

Property predefinedParameterName: Package name.

resource_auto_pay^Optional

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

Property resourceAutoPay: Whether the resource is automatically deducted from the balance.

Value:

• true: automatic payment.
• false: Do not pay automatically.

resource_group_id^Optional

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

Property resourceGroupId: The ID of the resource group.

service_instance_name^Optional

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

Property serviceInstanceName: The name of the service instance.

specification_code^Optional

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

Property specificationCode: Commodity specification Code.

tags^Optional

• Type: typing.List[TagsProperty]

Property tags: Tags of service instance.

template_name^Optional

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

Property templateName: Template name.

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_computenest
ros_cdk_computenest.ServiceInstance.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_components^Required

attr_components: typing.Union[str, IResolvable]

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

Attribute Components: Additional billing items.

attr_create_time^Required

attr_create_time: typing.Union[str, IResolvable]

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

Attribute CreateTime: Creation time.

attr_enable_instance_ops^Required

attr_enable_instance_ops: typing.Union[str, IResolvable]

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

Attribute EnableInstanceOps: Whether the service instance has the O & M function.

attr_enable_user_prometheus^Required

attr_enable_user_prometheus: typing.Union[str, IResolvable]

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

Attribute EnableUserPrometheus: Whether Prometheus monitoring is enabled.

attr_is_operated^Required

attr_is_operated: typing.Union[str, IResolvable]

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

Attribute IsOperated: Whether the generation O & M function of the service instance is enabled.

attr_license_end_time^Required

attr_license_end_time: typing.Union[str, IResolvable]

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

Attribute LicenseEndTime: License expiration time.

attr_market_instance_id^Required

attr_market_instance_id: typing.Union[str, IResolvable]

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

Attribute MarketInstanceId: The ID of the cloud marketplace instance.

attr_network_config^Required

attr_network_config: typing.Union[str, IResolvable]

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

Attribute NetworkConfig: Network configuration information.

attr_output^Required

attr_output: typing.Union[str, IResolvable]

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

Attribute Output: Create the output Field returned by the service instance.

attr_outputs^Required

attr_outputs: typing.Union[str, IResolvable]

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

Attribute Outputs: Create the output Field returned by the service instance.

attr_parameters^Required

attr_parameters: typing.Union[str, IResolvable]

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

Attribute Parameters: The parameters entered by the deployment service instance.

attr_predefined_parameter_name^Required

attr_predefined_parameter_name: typing.Union[str, IResolvable]

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

Attribute PredefinedParameterName: Package name.

attr_progress^Required

attr_progress: typing.Union[str, IResolvable]

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

Attribute Progress: The deployment progress of the service instance.

Unit:%.

attr_resource_group_id^Required

attr_resource_group_id: typing.Union[str, IResolvable]

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

Attribute ResourceGroupId: The ID of the resource group.

attr_service^Required

attr_service: typing.Union[str, IResolvable]

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

Attribute Service: Service details.

attr_service_instance_id^Required

attr_service_instance_id: typing.Union[str, IResolvable]

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

Attribute ServiceInstanceId: The ID of the service instance.

attr_service_instance_name^Required

attr_service_instance_name: typing.Union[str, IResolvable]

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

Attribute ServiceInstanceName: The name of the resource.

attr_service_type^Required

attr_service_type: typing.Union[str, IResolvable]

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

Attribute ServiceType: Service type.

attr_source^Required

attr_source: typing.Union[str, IResolvable]

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

Attribute Source: The source of the service instance.

attr_status_detail^Required

attr_status_detail: typing.Union[str, IResolvable]

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

Attribute StatusDetail: The status description of the deployment instance.

attr_supplier_uid^Required

attr_supplier_uid: typing.Union[str, IResolvable]

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

Attribute SupplierUid: Service provider AliUid.

attr_tags^Required

attr_tags: typing.Union[str, IResolvable]

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

Attribute Tags: User-defined labels.

attr_template_name^Required

attr_template_name: typing.Union[str, IResolvable]

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

Attribute TemplateName: Template name.

attr_update_time^Required

attr_update_time: typing.Union[str, IResolvable]

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

Attribute UpdateTime: Update time.

attr_user_id^Required

attr_user_id: typing.Union[str, IResolvable]

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

Attribute UserId: AliUid of the user.

props^Required

props: ServiceInstanceProps

• Type: ServiceInstanceProps