Skip to content

ServiceInstance

This class encapsulates and extends the ROS resource type ALIYUN::ComputeNest::ServiceInstance, which 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,
  enable_instance_ops: typing.Union[bool, IResolvable] = None,
  enable_user_prometheus: typing.Union[bool, IResolvable] = None,
  market_instance_id: typing.Union[str, IResolvable] = None,
  name: typing.Union[str, 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_group_id: 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
)
Name Type Description
scope ros_cdk_core.Construct No description.
id str No description.
service typing.Union[ros_cdk_core.IResolvable, ServiceProperty] Property service: Service details.
commodity typing.Union[ros_cdk_core.IResolvable, CommodityProperty] Property commodity: Cloud market commodity purchase parameters.
contact_group typing.Union[str, ros_cdk_core.IResolvable] Property contactGroup: Alarm Contact Group.
enable_instance_ops typing.Union[bool, ros_cdk_core.IResolvable] Property enableInstanceOps: Whether the service instance has the O & M function.
enable_user_prometheus typing.Union[bool, ros_cdk_core.IResolvable] Property enableUserPrometheus: Whether Prometheus monitoring is enabled.
market_instance_id typing.Union[str, ros_cdk_core.IResolvable] Property marketInstanceId: The ID of the cloud marketplace instance.
name typing.Union[str, ros_cdk_core.IResolvable] Property name: The name of the service instance.
operation_name typing.Union[str, ros_cdk_core.IResolvable] Property operationName: Change operation name.
parameters typing.Union[ros_cdk_core.IResolvable, typing.Mapping[typing.Any]] Property parameters: The parameters entered by the deployment service instance.
predefined_parameter_name typing.Union[str, ros_cdk_core.IResolvable] Property predefinedParameterName: Package name.
resource_group_id typing.Union[str, ros_cdk_core.IResolvable] Property resourceGroupId: The ID of the resource group.
specification_code typing.Union[str, ros_cdk_core.IResolvable] Property specificationCode: Commodity specification Code.
tags typing.List[TagsProperty] Property tags: Tags of service instance.
template_name typing.Union[str, ros_cdk_core.IResolvable] Property templateName: Template name.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

serviceRequired

Property service: Service details.


commodityOptional

Property commodity: Cloud market commodity purchase parameters.


contact_groupOptional

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

Property contactGroup: Alarm Contact Group.


enable_instance_opsOptional

  • 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_prometheusOptional

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

Property enableUserPrometheus: Whether Prometheus monitoring is enabled.

Possible values:

  • true: enabled.
  • false: not enabled.

market_instance_idOptional

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

Property marketInstanceId: The ID of the cloud marketplace instance.


nameOptional

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

Property name: The name of the service instance.


operation_nameOptional

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

Property operationName: Change operation name.


parametersOptional

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

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


predefined_parameter_nameOptional

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

Property predefinedParameterName: Package name.


resource_group_idOptional

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

Property resourceGroupId: The ID of the resource group.


specification_codeOptional

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

Property specificationCode: Commodity specification Code.


tagsOptional

Property tags: Tags of service instance.


template_nameOptional

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

Property templateName: Template name.


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_computenest
ros_cdk_computenest.ServiceInstance.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_components ros_cdk_core.IResolvable Attribute Components: Additional billing items.
attr_create_time ros_cdk_core.IResolvable Attribute CreateTime: Creation time.
attr_enable_instance_ops ros_cdk_core.IResolvable Attribute EnableInstanceOps: Whether the service instance has the O & M function.
attr_enable_user_prometheus ros_cdk_core.IResolvable Attribute EnableUserPrometheus: Whether Prometheus monitoring is enabled.
attr_is_operated ros_cdk_core.IResolvable Attribute IsOperated: Whether the generation O & M function of the service instance is enabled.
attr_license_end_time ros_cdk_core.IResolvable Attribute LicenseEndTime: License expiration time.
attr_name ros_cdk_core.IResolvable Attribute Name: The name of the service instance.
attr_network_config ros_cdk_core.IResolvable Attribute NetworkConfig: Network configuration information.
attr_outputs ros_cdk_core.IResolvable Attribute Outputs: Create the output Field returned by the service instance.
attr_parameters ros_cdk_core.IResolvable Attribute Parameters: The parameters entered by the deployment service instance.
attr_predefined_parameter_name ros_cdk_core.IResolvable Attribute PredefinedParameterName: Package name.
attr_progress ros_cdk_core.IResolvable Attribute Progress: The deployment progress of the service instance.
attr_resource_group_id ros_cdk_core.IResolvable Attribute ResourceGroupId: The ID of the resource group.
attr_service ros_cdk_core.IResolvable Attribute Service: Service details.
attr_service_instance_id ros_cdk_core.IResolvable Attribute ServiceInstanceId: The ID of the service instance.
attr_service_type ros_cdk_core.IResolvable Attribute ServiceType: Service type.
attr_source ros_cdk_core.IResolvable Attribute Source: The source of the service instance.
attr_status_detail ros_cdk_core.IResolvable Attribute StatusDetail: The status description of the deployment instance.
attr_supplier_uid ros_cdk_core.IResolvable Attribute SupplierUid: Service provider AliUid.
attr_tags ros_cdk_core.IResolvable Attribute Tags: User-defined labels.
attr_template_name ros_cdk_core.IResolvable Attribute TemplateName: Template name.
attr_update_time ros_cdk_core.IResolvable Attribute UpdateTime: Update time.
attr_user_id ros_cdk_core.IResolvable Attribute UserId: AliUid of the user.

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_componentsRequired

attr_components: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute Components: Additional billing items.


attr_create_timeRequired

attr_create_time: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute CreateTime: Creation time.


attr_enable_instance_opsRequired

attr_enable_instance_ops: IResolvable
  • Type: ros_cdk_core.IResolvable

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


attr_enable_user_prometheusRequired

attr_enable_user_prometheus: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute EnableUserPrometheus: Whether Prometheus monitoring is enabled.


attr_is_operatedRequired

attr_is_operated: IResolvable
  • Type: ros_cdk_core.IResolvable

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


attr_license_end_timeRequired

attr_license_end_time: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute LicenseEndTime: License expiration time.


attr_nameRequired

attr_name: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute Name: The name of the service instance.


attr_network_configRequired

attr_network_config: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute NetworkConfig: Network configuration information.


attr_outputsRequired

attr_outputs: IResolvable
  • Type: ros_cdk_core.IResolvable

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


attr_parametersRequired

attr_parameters: IResolvable
  • Type: ros_cdk_core.IResolvable

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


attr_predefined_parameter_nameRequired

attr_predefined_parameter_name: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute PredefinedParameterName: Package name.


attr_progressRequired

attr_progress: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute Progress: The deployment progress of the service instance.

Unit:%.


attr_resource_group_idRequired

attr_resource_group_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ResourceGroupId: The ID of the resource group.


attr_serviceRequired

attr_service: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute Service: Service details.


attr_service_instance_idRequired

attr_service_instance_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ServiceInstanceId: The ID of the service instance.


attr_service_typeRequired

attr_service_type: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ServiceType: Service type.


attr_sourceRequired

attr_source: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute Source: The source of the service instance.


attr_status_detailRequired

attr_status_detail: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute StatusDetail: The status description of the deployment instance.


attr_supplier_uidRequired

attr_supplier_uid: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute SupplierUid: Service provider AliUid.


attr_tagsRequired

attr_tags: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute Tags: User-defined labels.


attr_template_nameRequired

attr_template_name: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute TemplateName: Template name.


attr_update_timeRequired

attr_update_time: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute UpdateTime: Update time.


attr_user_idRequired

attr_user_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute UserId: AliUid of the user.