ServiceInstance
- Implements: ros_cdk_computenest.datasource.IServiceInstance
This class encapsulates and extends the ROS resource type DATASOURCE::ComputeNest::ServiceInstance, which type is used to query the information about a service instance.
Initializers
from ros_cdk_computenest import datasource
datasource.ServiceInstance(
scope: Construct,
id: str,
service_instance_id: typing.Union[str, IResolvable],
refresh_options: 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_instance_id | typing.Union[str, ros_cdk_core.IResolvable] | Property serviceInstanceId: The ID of the service instance. |
refresh_options | typing.Union[str, ros_cdk_core.IResolvable] | Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated. |
enable_resource_property_constraint | bool | No description. |
scopeRequired
- Type: ros_cdk_core.Construct
idRequired
- Type: str
service_instance_idRequired
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property serviceInstanceId: The ID of the service instance.
refresh_optionsOptional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.
Valid values:
- Never: Never refresh the datasource resource when the stack is updated.
- Always: Always refresh the datasource resource when the stack is updated. Default is Never.
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.
- Type: ros_cdk_core.ISynthesisSession
The synthesis session.
add_condition
def add_condition(
condition: RosCondition
) -> None
- Type: ros_cdk_core.RosCondition
add_count
def add_count(
count: typing.Union[typing.Union[int, float], IResolvable]
) -> None
- Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
add_dependency
def add_dependency(
resource: Resource
) -> None
- Type: ros_cdk_core.Resource
add_resource_desc
def add_resource_desc(
desc: str
) -> None
- Type: str
apply_removal_policy
def apply_removal_policy(
policy: RemovalPolicy
) -> None
- 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
- Type: str
set_metadata
def set_metadata(
key: str,
value: typing.Any
) -> None
- Type: str
- Type: typing.Any
Static Functions
| Name | Description |
|---|---|
is_construct | Return whether the given object is a Construct. |
is_construct
from ros_cdk_computenest import datasource
datasource.ServiceInstance.is_construct(
x: typing.Any
)
Return whether the given object is a Construct.
- 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_components | typing.Union[str, ros_cdk_core.IResolvable] | Attribute Components: Cloud Marketplace additional billing items. |
attr_create_time | typing.Union[str, ros_cdk_core.IResolvable] | Attribute CreateTime: The time when the serviceInstance was created. |
attr_enable_instance_ops | typing.Union[str, ros_cdk_core.IResolvable] | Attribute EnableInstanceOps: Indicates whether the service instance supports the operation feature. |
attr_enable_user_prometheus | typing.Union[str, ros_cdk_core.IResolvable] | Attribute EnableUserPrometheus: Whether to enable Prometheus monitoring. |
attr_is_operated | typing.Union[str, ros_cdk_core.IResolvable] | Attribute IsOperated: Indicates whether the hosted O&M feature is enabled for the service instance. |
attr_license_end_time | typing.Union[str, ros_cdk_core.IResolvable] | Attribute LicenseEndTime: The expiration time of licence. |
attr_market_instance_id | typing.Union[str, ros_cdk_core.IResolvable] | Attribute MarketInstanceId: The ID of the cloud marketplace instance. |
attr_network_config | typing.Union[str, ros_cdk_core.IResolvable] | Attribute NetworkConfig: The network configurations. |
attr_outputs | typing.Union[str, ros_cdk_core.IResolvable] | Attribute Outputs: The outputs returned from creating the service instance. |
attr_parameters | typing.Union[str, ros_cdk_core.IResolvable] | Attribute Parameters: The parameters configured for the service instance. |
attr_predefined_parameter_name | typing.Union[str, ros_cdk_core.IResolvable] | Attribute PredefinedParameterName: The name of the package . |
attr_progress | typing.Union[str, ros_cdk_core.IResolvable] | Attribute Progress: The deployment progress of the service instance. |
attr_resource_group_id | typing.Union[str, ros_cdk_core.IResolvable] | Attribute ResourceGroupId: The resource group ID. |
attr_service | typing.Union[str, ros_cdk_core.IResolvable] | Attribute Service: The information about the service to which the service instance belongs. |
attr_service_instance_id | typing.Union[str, ros_cdk_core.IResolvable] | Attribute ServiceInstanceId: The ID of the service instance. |
attr_service_instance_name | typing.Union[str, ros_cdk_core.IResolvable] | Attribute ServiceInstanceName: The name of the resource. |
attr_service_type | typing.Union[str, ros_cdk_core.IResolvable] | Attribute ServiceType: The type of the service. |
attr_source | typing.Union[str, ros_cdk_core.IResolvable] | Attribute Source: The source of the service instance. |
attr_status_detail | typing.Union[str, ros_cdk_core.IResolvable] | Attribute StatusDetail: The description of the deployment state of the service instance. |
attr_supplier_uid | typing.Union[str, ros_cdk_core.IResolvable] | Attribute SupplierUid: The Alibaba Cloud account ID of the service provider. |
attr_tags | typing.Union[str, ros_cdk_core.IResolvable] | Attribute Tags: The tags of the service instance. |
attr_template_name | typing.Union[str, ros_cdk_core.IResolvable] | Attribute TemplateName: The name of the template. |
attr_update_time | typing.Union[str, ros_cdk_core.IResolvable] | Attribute UpdateTime: The time when the serviceInstance was last updated. |
attr_user_id | typing.Union[str, ros_cdk_core.IResolvable] | Attribute UserId: The AliUid of the user. |
props | ServiceInstanceProps | 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_componentsRequired
attr_components: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute Components: Cloud Marketplace additional billing items.
attr_create_timeRequired
attr_create_time: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute CreateTime: The time when the serviceInstance was created.
attr_enable_instance_opsRequired
attr_enable_instance_ops: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute EnableInstanceOps: Indicates whether the service instance supports the operation feature.
attr_enable_user_prometheusRequired
attr_enable_user_prometheus: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute EnableUserPrometheus: Whether to enable Prometheus monitoring.
attr_is_operatedRequired
attr_is_operated: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute IsOperated: Indicates whether the hosted O&M feature is enabled for the service instance.
attr_license_end_timeRequired
attr_license_end_time: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute LicenseEndTime: The expiration time of licence.
attr_market_instance_idRequired
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_configRequired
attr_network_config: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute NetworkConfig: The network configurations.
attr_outputsRequired
attr_outputs: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute Outputs: The outputs returned from creating the service instance.
attr_parametersRequired
attr_parameters: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute Parameters: The parameters configured for the service instance.
attr_predefined_parameter_nameRequired
attr_predefined_parameter_name: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute PredefinedParameterName: The name of the package .
attr_progressRequired
attr_progress: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute Progress: The deployment progress of the service instance.
Unit: percentage.
attr_resource_group_idRequired
attr_resource_group_id: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute ResourceGroupId: The resource group ID.
attr_serviceRequired
attr_service: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute Service: The information about the service to which the service instance belongs.
attr_service_instance_idRequired
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_nameRequired
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_typeRequired
attr_service_type: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute ServiceType: The type of the service.
attr_sourceRequired
attr_source: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute Source: The source of the service instance.
attr_status_detailRequired
attr_status_detail: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute StatusDetail: The description of the deployment state of the service instance.
attr_supplier_uidRequired
attr_supplier_uid: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute SupplierUid: The Alibaba Cloud account ID of the service provider.
attr_tagsRequired
attr_tags: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute Tags: The tags of the service instance.
attr_template_nameRequired
attr_template_name: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute TemplateName: The name of the template.
attr_update_timeRequired
attr_update_time: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute UpdateTime: The time when the serviceInstance was last updated.
attr_user_idRequired
attr_user_id: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute UserId: The AliUid of the user.
propsRequired
props: ServiceInstanceProps
- Type: ServiceInstanceProps