Skip to content

RosModelVersion

This class is a base encapsulation around the ROS resource type ALIYUN::PAI::ModelVersion.

Initializers

using AlibabaCloud.SDK.ROS.CDK.Pai;
new RosModelVersion(Construct Scope, string Id, RosModelVersionProps Props, bool EnableResourcePropertyConstraint);
Name Type Description
Scope AlibabaCloud.SDK.ROS.CDK.Core.Construct - scope in which this resource is defined.
Id string - scoped id of the resource.
Props RosModelVersionProps - resource properties.
EnableResourcePropertyConstraint bool No description.

ScopeRequired

  • Type: AlibabaCloud.SDK.ROS.CDK.Core.Construct

scope in which this resource is defined.


IdRequired

  • Type: string

scoped id of the resource.


PropsRequired

resource properties.


EnableResourcePropertyConstraintRequired

  • Type: bool

Methods

Name Description
ToString Returns a string representation of this construct.
Synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
OverrideLogicalId Overrides the auto-generated logical ID with a specific ID.
AddCondition No description.
AddCount No description.
AddDeletionOverride Syntactic sugar for addOverride(path, undefined).
AddDependsOn Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
AddDesc No description.
AddMetaData No description.
AddOverride Adds an override to the synthesized ROS resource.
AddPropertyDeletionOverride Adds an override that deletes the value of a property from the resource definition.
AddPropertyOverride Adds an override to a resource property.
AddRosDependency No description.
ApplyRemovalPolicy Sets the deletion policy of the resource based on the removal policy specified.
FetchCondition No description.
FetchDesc No description.
FetchRosDependency No description.
GetAtt Returns a token for an runtime attribute of this resource.

ToString

private string ToString()

Returns a string representation of this construct.

Synthesize

private void Synthesize(ISynthesisSession Session)

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: AlibabaCloud.SDK.ROS.CDK.Core.ISynthesisSession

The synthesis session.


OverrideLogicalId

private void OverrideLogicalId(string NewLogicalId)

Overrides the auto-generated logical ID with a specific ID.

NewLogicalIdRequired

  • Type: string

The new logical ID to use for this stack element.


AddCondition

private void AddCondition(RosCondition Con)

ConRequired

  • Type: AlibabaCloud.SDK.ROS.CDK.Core.RosCondition

AddCount

private void AddCount(object Count)

CountRequired

  • Type: object

AddDeletionOverride

private void AddDeletionOverride(string Path)

Syntactic sugar for addOverride(path, undefined).

PathRequired

  • Type: string

The path of the value to delete.


AddDependsOn

private void AddDependsOn(RosResource Target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

TargetRequired

  • Type: AlibabaCloud.SDK.ROS.CDK.Core.RosResource

AddDesc

private void AddDesc(string Desc)

DescRequired

  • Type: string

AddMetaData

private void AddMetaData(string Key, object Value)

KeyRequired

  • Type: string

ValueRequired

  • Type: object

AddOverride

private void AddOverride(string Path, object Value)

Adds an override to the synthesized ROS resource.

To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

For example,

addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute'])
addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE')

would add the overrides

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}

PathRequired

  • Type: string

The path of the property, you can use dot notation to override values in complex types.

Any intermdediate keys will be created as needed.


ValueRequired

  • Type: object

The value.

Could be primitive or complex.


AddPropertyDeletionOverride

private void AddPropertyDeletionOverride(string PropertyPath)

Adds an override that deletes the value of a property from the resource definition.

PropertyPathRequired

  • Type: string

The path to the property.


AddPropertyOverride

private void AddPropertyOverride(string PropertyPath, object Value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

PropertyPathRequired

  • Type: string

The path of the property.


ValueRequired

  • Type: object

The value.


AddRosDependency

private void AddRosDependency(string Target)

TargetRequired

  • Type: string

ApplyRemovalPolicy

private void ApplyRemovalPolicy(RemovalPolicy Policy = null, RemovalPolicyOptions Options = null)

Sets the deletion policy of the resource based on the removal policy specified.

PolicyOptional

  • Type: AlibabaCloud.SDK.ROS.CDK.Core.RemovalPolicy

OptionsOptional

  • Type: AlibabaCloud.SDK.ROS.CDK.Core.RemovalPolicyOptions

FetchCondition

private RosCondition FetchCondition()

FetchDesc

private string FetchDesc()

FetchRosDependency

private string[] FetchRosDependency()

GetAtt

private Reference GetAtt(string AttributeName)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

AttributeNameRequired

  • Type: string

The name of the attribute.


Static Functions

Name Description
IsConstruct Return whether the given object is a Construct.
IsRosElement Returns true if a construct is a stack element (i.e. part of the synthesized template).
IsRosResource Check whether the given construct is a RosResource.

IsConstruct

using AlibabaCloud.SDK.ROS.CDK.Pai;
RosModelVersion.IsConstruct(object X);

Return whether the given object is a Construct.

XRequired

  • Type: object

IsRosElement

using AlibabaCloud.SDK.ROS.CDK.Pai;
RosModelVersion.IsRosElement(object X);

Returns true if a construct is a stack element (i.e. part of the synthesized template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

XRequired

  • Type: object

IsRosResource

using AlibabaCloud.SDK.ROS.CDK.Pai;
RosModelVersion.IsRosResource(IConstruct Construct);

Check whether the given construct is a RosResource.

ConstructRequired

  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IConstruct

Properties

Name Type Description
Node AlibabaCloud.SDK.ROS.CDK.Core.ConstructNode The construct tree node associated with this construct.
CreationStack string[] No description.
LogicalId string The logical ID for this stack element.
Stack AlibabaCloud.SDK.ROS.CDK.Core.Stack The stack in which this element is defined.
Ref string Return a string that will be resolved to a RosTemplate { Ref } for this element.
RosOptions AlibabaCloud.SDK.ROS.CDK.Core.IRosResourceOptions Options for this resource, such as condition, update policy etc.
RosResourceType string ROS resource type.
AttrApprovalStatus AlibabaCloud.SDK.ROS.CDK.Core.IResolvable No description.
AttrExtraInfo AlibabaCloud.SDK.ROS.CDK.Core.IResolvable No description.
AttrFormatType AlibabaCloud.SDK.ROS.CDK.Core.IResolvable No description.
AttrFrameworkType AlibabaCloud.SDK.ROS.CDK.Core.IResolvable No description.
AttrGmtCreateTime AlibabaCloud.SDK.ROS.CDK.Core.IResolvable No description.
AttrGmtModifiedTime AlibabaCloud.SDK.ROS.CDK.Core.IResolvable No description.
AttrInferenceSpec AlibabaCloud.SDK.ROS.CDK.Core.IResolvable No description.
AttrLabels AlibabaCloud.SDK.ROS.CDK.Core.IResolvable No description.
AttrMetrics AlibabaCloud.SDK.ROS.CDK.Core.IResolvable No description.
AttrOptions AlibabaCloud.SDK.ROS.CDK.Core.IResolvable No description.
AttrOwnerId AlibabaCloud.SDK.ROS.CDK.Core.IResolvable No description.
AttrSourceId AlibabaCloud.SDK.ROS.CDK.Core.IResolvable No description.
AttrSourceType AlibabaCloud.SDK.ROS.CDK.Core.IResolvable No description.
AttrTrainingSpec AlibabaCloud.SDK.ROS.CDK.Core.IResolvable No description.
AttrUri AlibabaCloud.SDK.ROS.CDK.Core.IResolvable No description.
AttrUserId AlibabaCloud.SDK.ROS.CDK.Core.IResolvable No description.
AttrVersionDescription AlibabaCloud.SDK.ROS.CDK.Core.IResolvable No description.
AttrVersionName AlibabaCloud.SDK.ROS.CDK.Core.IResolvable No description.
EnableResourcePropertyConstraint bool No description.
ModelId object No description.
Uri object No description.
ApprovalStatus object No description.
ExtraInfo object No description.
FormatType object No description.
FrameworkType object No description.
InferenceSpec object No description.
Labels object No description.
Metrics object No description.
Options object No description.
SourceId object No description.
SourceType object No description.
TrainingSpec object No description.
VersionDescription object No description.
VersionName object No description.

NodeRequired

public ConstructNode Node { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.ConstructNode

The construct tree node associated with this construct.


CreationStackRequired

public string[] CreationStack { get; }
  • Type: string[]

LogicalIdRequired

public string LogicalId { get; }
  • Type: string

The logical ID for this stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).


StackRequired

public Stack Stack { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.Stack

The stack in which this element is defined.

RosElements must be defined within a stack scope (directly or indirectly).


RefRequired

public string Ref { get; }
  • Type: string

Return a string that will be resolved to a RosTemplate { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).


RosOptionsRequired

public IRosResourceOptions RosOptions { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IRosResourceOptions

Options for this resource, such as condition, update policy etc.


RosResourceTypeRequired

public string RosResourceType { get; }
  • Type: string

ROS resource type.


AttrApprovalStatusRequired

public IResolvable AttrApprovalStatus { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

AttrExtraInfoRequired

public IResolvable AttrExtraInfo { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

AttrFormatTypeRequired

public IResolvable AttrFormatType { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

AttrFrameworkTypeRequired

public IResolvable AttrFrameworkType { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

AttrGmtCreateTimeRequired

public IResolvable AttrGmtCreateTime { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

AttrGmtModifiedTimeRequired

public IResolvable AttrGmtModifiedTime { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

AttrInferenceSpecRequired

public IResolvable AttrInferenceSpec { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

AttrLabelsRequired

public IResolvable AttrLabels { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

AttrMetricsRequired

public IResolvable AttrMetrics { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

AttrOptionsRequired

public IResolvable AttrOptions { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

AttrOwnerIdRequired

public IResolvable AttrOwnerId { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

AttrSourceIdRequired

public IResolvable AttrSourceId { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

AttrSourceTypeRequired

public IResolvable AttrSourceType { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

AttrTrainingSpecRequired

public IResolvable AttrTrainingSpec { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

AttrUriRequired

public IResolvable AttrUri { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

AttrUserIdRequired

public IResolvable AttrUserId { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

AttrVersionDescriptionRequired

public IResolvable AttrVersionDescription { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

AttrVersionNameRequired

public IResolvable AttrVersionName { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

EnableResourcePropertyConstraintRequired

public bool EnableResourcePropertyConstraint { get; }
  • Type: bool

ModelIdRequired

public object ModelId { get; }
  • Type: object

UriRequired

public object Uri { get; }
  • Type: object

ApprovalStatusOptional

public object ApprovalStatus { get; }
  • Type: object

ExtraInfoOptional

public object ExtraInfo { get; }
  • Type: object

FormatTypeOptional

public object FormatType { get; }
  • Type: object

FrameworkTypeOptional

public object FrameworkType { get; }
  • Type: object

InferenceSpecOptional

public object InferenceSpec { get; }
  • Type: object

LabelsOptional

public object Labels { get; }
  • Type: object

MetricsOptional

public object Metrics { get; }
  • Type: object

OptionsOptional

public object Options { get; }
  • Type: object

SourceIdOptional

public object SourceId { get; }
  • Type: object

SourceTypeOptional

public object SourceType { get; }
  • Type: object

TrainingSpecOptional

public object TrainingSpec { get; }
  • Type: object

VersionDescriptionOptional

public object VersionDescription { get; }
  • Type: object

VersionNameOptional

public object VersionName { get; }
  • Type: object

Constants

Name Type Description
RosResourceTypeName string The resource type name for this resource class.

RosResourceTypeNameRequired

public string RosResourceTypeName { get; }
  • Type: string

The resource type name for this resource class.