Skip to content

Service

This class encapsulates and extends the ROS resource type ALIYUN::PAI::Service, which is used to create an Elastic Algorithm Service (EAS) service in Machine Learning Platform for AI (PAI).

Initializers

import ros_cdk_pai
ros_cdk_pai.Service(
  scope: Construct,
  id: str,
  service_config: typing.Union[IResolvable, typing.Mapping[typing.Any]],
  develop: typing.Union[str, IResolvable] = None,
  labels: typing.Union[IResolvable, typing.Mapping[typing.Any]] = None,
  enable_resource_property_constraint: bool = None
)
Name Type Description
scope ros_cdk_core.Construct No description.
id str No description.
service_config typing.Union[ros_cdk_core.IResolvable, typing.Mapping[typing.Any]] Property serviceConfig: Service configuration information.
develop typing.Union[str, ros_cdk_core.IResolvable] Property develop: Whether to enter the development mode.
labels typing.Union[ros_cdk_core.IResolvable, typing.Mapping[typing.Any]] Property labels: Service Tag.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

service_configRequired

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

Property serviceConfig: Service configuration information.


developOptional

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

Property develop: Whether to enter the development mode.


labelsOptional

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

Property labels: Service Tag.


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.

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

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

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_pai
ros_cdk_pai.Service.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.
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_access_token typing.Union[str, ros_cdk_core.IResolvable] Attribute AccessToken: Service Request authentication token.
attr_caller_uid typing.Union[str, ros_cdk_core.IResolvable] Attribute CallerUid: The ID of the service creator, which can be the ID of the RAM account.
attr_cpu typing.Union[str, ros_cdk_core.IResolvable] Attribute Cpu: Number of service CPU cores.
attr_create_time typing.Union[str, ros_cdk_core.IResolvable] Attribute CreateTime: Creation time of the service.
attr_current_version typing.Union[str, ros_cdk_core.IResolvable] Attribute CurrentVersion: Current running version of the service.
attr_extra_data typing.Union[str, ros_cdk_core.IResolvable] Attribute ExtraData: Service Extra Information.
attr_gpu typing.Union[str, ros_cdk_core.IResolvable] Attribute Gpu: Number of service GPU cards.
attr_image typing.Union[str, ros_cdk_core.IResolvable] Attribute Image: Service Deployment Mirroring.
attr_internet_endpoint typing.Union[str, ros_cdk_core.IResolvable] Attribute InternetEndpoint: Public network Endpoint of the service.
attr_intranet_endpoint typing.Union[str, ros_cdk_core.IResolvable] Attribute IntranetEndpoint: The intranet Endpoint of the service.
attr_labels typing.Union[str, ros_cdk_core.IResolvable] Attribute Labels: Service Tag.
attr_latest_version typing.Union[str, ros_cdk_core.IResolvable] Attribute LatestVersion: The latest version of the service.
attr_memory typing.Union[str, ros_cdk_core.IResolvable] Attribute Memory: Memory of service (MB).
attr_message typing.Union[str, ros_cdk_core.IResolvable] Attribute Message: Latest information on services.
attr_namespace typing.Union[str, ros_cdk_core.IResolvable] Attribute Namespace: The namespace to which the service belongs.
attr_parent_uid typing.Union[str, ros_cdk_core.IResolvable] Attribute ParentUid: Primary account ID of the creator.
attr_pending_instance typing.Union[str, ros_cdk_core.IResolvable] Attribute PendingInstance: Number of instances where the service is not currently ready.
attr_reason typing.Union[str, ros_cdk_core.IResolvable] Attribute Reason: Service deployment failure reason.
attr_resource typing.Union[str, ros_cdk_core.IResolvable] Attribute Resource: The ID of the resource group to which the service belongs.
attr_resource_alias typing.Union[str, ros_cdk_core.IResolvable] Attribute ResourceAlias: Name of the resource group where the service resides.
attr_role typing.Union[str, ros_cdk_core.IResolvable] Attribute Role: Grouping Service Role.
attr_role_attrs typing.Union[str, ros_cdk_core.IResolvable] Attribute RoleAttrs: Grouping Service Role Properties.
attr_running_instance typing.Union[str, ros_cdk_core.IResolvable] Attribute RunningInstance: Number of instances in service running.
attr_safety_lock typing.Union[str, ros_cdk_core.IResolvable] Attribute SafetyLock: Service Security Lock Status.
attr_service_config typing.Union[str, ros_cdk_core.IResolvable] Attribute ServiceConfig: Service configuration information.
attr_service_group typing.Union[str, ros_cdk_core.IResolvable] Attribute ServiceGroup: Group to which the service belongs.
attr_service_name typing.Union[str, ros_cdk_core.IResolvable] Attribute ServiceName: Service Name.
attr_service_uid typing.Union[str, ros_cdk_core.IResolvable] Attribute ServiceUid: Unique Service ID.
attr_total_instance typing.Union[str, ros_cdk_core.IResolvable] Attribute TotalInstance: Total number of instances required by the service.
attr_update_time typing.Union[str, ros_cdk_core.IResolvable] Attribute UpdateTime: Service Last Updated.
attr_weight typing.Union[str, ros_cdk_core.IResolvable] Attribute Weight: Packet Service Traffic Weight.
props ServiceProps 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_access_tokenRequired

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

Attribute AccessToken: Service Request authentication token.


attr_caller_uidRequired

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

Attribute CallerUid: The ID of the service creator, which can be the ID of the RAM account.


attr_cpuRequired

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

Attribute Cpu: Number of service CPU cores.


attr_create_timeRequired

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

Attribute CreateTime: Creation time of the service.


attr_current_versionRequired

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

Attribute CurrentVersion: Current running version of the service.


attr_extra_dataRequired

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

Attribute ExtraData: Service Extra Information.


attr_gpuRequired

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

Attribute Gpu: Number of service GPU cards.


attr_imageRequired

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

Attribute Image: Service Deployment Mirroring.


attr_internet_endpointRequired

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

Attribute InternetEndpoint: Public network Endpoint of the service.


attr_intranet_endpointRequired

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

Attribute IntranetEndpoint: The intranet Endpoint of the service.


attr_labelsRequired

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

Attribute Labels: Service Tag.


attr_latest_versionRequired

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

Attribute LatestVersion: The latest version of the service.


attr_memoryRequired

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

Attribute Memory: Memory of service (MB).


attr_messageRequired

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

Attribute Message: Latest information on services.


attr_namespaceRequired

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

Attribute Namespace: The namespace to which the service belongs.


attr_parent_uidRequired

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

Attribute ParentUid: Primary account ID of the creator.


attr_pending_instanceRequired

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

Attribute PendingInstance: Number of instances where the service is not currently ready.


attr_reasonRequired

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

Attribute Reason: Service deployment failure reason.


attr_resourceRequired

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

Attribute Resource: The ID of the resource group to which the service belongs.


attr_resource_aliasRequired

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

Attribute ResourceAlias: Name of the resource group where the service resides.


attr_roleRequired

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

Attribute Role: Grouping Service Role.


attr_role_attrsRequired

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

Attribute RoleAttrs: Grouping Service Role Properties.


attr_running_instanceRequired

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

Attribute RunningInstance: Number of instances in service running.


attr_safety_lockRequired

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

Attribute SafetyLock: Service Security Lock Status.


attr_service_configRequired

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

Attribute ServiceConfig: Service configuration information.


attr_service_groupRequired

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

Attribute ServiceGroup: Group to which the service belongs.


attr_service_nameRequired

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

Attribute ServiceName: Service Name.


attr_service_uidRequired

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

Attribute ServiceUid: Unique Service ID.


attr_total_instanceRequired

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

Attribute TotalInstance: Total number of instances required by the service.


attr_update_timeRequired

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

Attribute UpdateTime: Service Last Updated.


attr_weightRequired

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

Attribute Weight: Packet Service Traffic Weight.


propsRequired

props: ServiceProps