Skip to content

RosService

This class is a base encapsulation around the ROS resource type DATASOURCE::PAI::Service.

Initializers 

import com.aliyun.ros.cdk.pai.datasource.RosService;
RosService.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .serviceName(java.lang.String)
    .serviceName(IResolvable)
//  .refreshOptions(java.lang.String)
//  .refreshOptions(IResolvable)
    .build();
Name Type Description
scope com.aliyun.ros.cdk.core.Construct - scope in which this resource is defined.
id java.lang.String - scoped id of the resource.
enableResourcePropertyConstraint java.lang.Boolean No description.
serviceName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
refreshOptions java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.

scopeRequired

  • Type: com.aliyun.ros.cdk.core.Construct

scope in which this resource is defined.

idRequired

  • Type: java.lang.String

scoped id of the resource.

enableResourcePropertyConstraintRequired

  • Type: java.lang.Boolean

serviceNameRequired

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

refreshOptionsOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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.
getAtt Returns a token for an runtime attribute of this resource.

toString 

public java.lang.String toString()

Returns a string representation of this construct.

synthesize 

public 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: com.aliyun.ros.cdk.core.ISynthesisSession

The synthesis session.

overrideLogicalId 

public void overrideLogicalId(java.lang.String newLogicalId)

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

newLogicalIdRequired

  • Type: java.lang.String

The new logical ID to use for this stack element.

addCondition 

public void addCondition(RosCondition con)

conRequired

  • Type: com.aliyun.ros.cdk.core.RosCondition

addCount 

public void addCount(java.lang.Number OR IResolvable count)

countRequired

  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

addDeletionOverride 

public void addDeletionOverride(java.lang.String path)

Syntactic sugar for addOverride(path, undefined).

pathRequired

  • Type: java.lang.String

The path of the value to delete.

addDependsOn 

public 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: com.aliyun.ros.cdk.core.RosResource

addDesc 

public void addDesc(java.lang.String desc)

descRequired

  • Type: java.lang.String

addMetaData 

public void addMetaData(java.lang.String key, java.lang.Object value)

keyRequired

  • Type: java.lang.String

valueRequired

  • Type: java.lang.Object

addOverride 

public void addOverride(java.lang.String path, java.lang.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: java.lang.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: java.lang.Object

The value.

Could be primitive or complex.

addPropertyDeletionOverride 

public void addPropertyDeletionOverride(java.lang.String propertyPath)

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

propertyPathRequired

  • Type: java.lang.String

The path to the property.

addPropertyOverride 

public void addPropertyOverride(java.lang.String propertyPath, java.lang.Object value)

Adds an override to a resource property.

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

propertyPathRequired

  • Type: java.lang.String

The path of the property.

valueRequired

  • Type: java.lang.Object

The value.

addRosDependency 

public void addRosDependency(java.lang.String target)

targetRequired

  • Type: java.lang.String

applyRemovalPolicy 

public void applyRemovalPolicy()
public void applyRemovalPolicy(RemovalPolicy policy)
public void applyRemovalPolicy(RemovalPolicy policy, RemovalPolicyOptions options)

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

policyOptional

  • Type: com.aliyun.ros.cdk.core.RemovalPolicy

optionsOptional

  • Type: com.aliyun.ros.cdk.core.RemovalPolicyOptions

getAtt 

public Reference getAtt(java.lang.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: java.lang.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 

import com.aliyun.ros.cdk.pai.datasource.RosService;
RosService.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

xRequired

  • Type: java.lang.Object

isRosElement 

import com.aliyun.ros.cdk.pai.datasource.RosService;
RosService.isRosElement(java.lang.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: java.lang.Object

isRosResource 

import com.aliyun.ros.cdk.pai.datasource.RosService;
RosService.isRosResource(IConstruct construct)

Check whether the given construct is a RosResource.

constructRequired

  • Type: com.aliyun.ros.cdk.core.IConstruct

Properties

Name Type Description
node com.aliyun.ros.cdk.core.ConstructNode The construct tree node associated with this construct.
creationStack java.util.List No description.
logicalId java.lang.String The logical ID for this stack element.
stack com.aliyun.ros.cdk.core.Stack The stack in which this element is defined.
ref java.lang.String Return a string that will be resolved to a RosTemplate { Ref } for this element.
rosOptions com.aliyun.ros.cdk.core.IRosResourceOptions Options for this resource, such as condition, update policy etc.
rosResourceType java.lang.String ROS resource type.
attrAccessToken com.aliyun.ros.cdk.core.IResolvable No description.
attrCallerUid com.aliyun.ros.cdk.core.IResolvable No description.
attrCpu com.aliyun.ros.cdk.core.IResolvable No description.
attrCreateTime com.aliyun.ros.cdk.core.IResolvable No description.
attrCurrentVersion com.aliyun.ros.cdk.core.IResolvable No description.
attrExtraData com.aliyun.ros.cdk.core.IResolvable No description.
attrGpu com.aliyun.ros.cdk.core.IResolvable No description.
attrImage com.aliyun.ros.cdk.core.IResolvable No description.
attrInternetEndpoint com.aliyun.ros.cdk.core.IResolvable No description.
attrIntranetEndpoint com.aliyun.ros.cdk.core.IResolvable No description.
attrLabels com.aliyun.ros.cdk.core.IResolvable No description.
attrLatestVersion com.aliyun.ros.cdk.core.IResolvable No description.
attrMemory com.aliyun.ros.cdk.core.IResolvable No description.
attrMessage com.aliyun.ros.cdk.core.IResolvable No description.
attrNamespace com.aliyun.ros.cdk.core.IResolvable No description.
attrParentUid com.aliyun.ros.cdk.core.IResolvable No description.
attrPendingInstance com.aliyun.ros.cdk.core.IResolvable No description.
attrReason com.aliyun.ros.cdk.core.IResolvable No description.
attrResource com.aliyun.ros.cdk.core.IResolvable No description.
attrResourceAlias com.aliyun.ros.cdk.core.IResolvable No description.
attrRole com.aliyun.ros.cdk.core.IResolvable No description.
attrRoleAttrs com.aliyun.ros.cdk.core.IResolvable No description.
attrRunningInstance com.aliyun.ros.cdk.core.IResolvable No description.
attrSafetyLock com.aliyun.ros.cdk.core.IResolvable No description.
attrServiceConfig com.aliyun.ros.cdk.core.IResolvable No description.
attrServiceGroup com.aliyun.ros.cdk.core.IResolvable No description.
attrServiceName com.aliyun.ros.cdk.core.IResolvable No description.
attrServiceUid com.aliyun.ros.cdk.core.IResolvable No description.
attrTotalInstance com.aliyun.ros.cdk.core.IResolvable No description.
attrUpdateTime com.aliyun.ros.cdk.core.IResolvable No description.
attrWeight com.aliyun.ros.cdk.core.IResolvable No description.
enableResourcePropertyConstraint java.lang.Boolean No description.
serviceName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
refreshOptions java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.

nodeRequired 

public ConstructNode getNode();
  • Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.

creationStackRequired 

public java.util.List<java.lang.String> getCreationStack();
  • Type: java.util.List

logicalIdRequired 

public java.lang.String getLogicalId();
  • Type: java.lang.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 getStack();
  • Type: com.aliyun.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 java.lang.String getRef();
  • Type: java.lang.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 getRosOptions();
  • Type: com.aliyun.ros.cdk.core.IRosResourceOptions

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

rosResourceTypeRequired 

public java.lang.String getRosResourceType();
  • Type: java.lang.String

ROS resource type.

attrAccessTokenRequired 

public IResolvable getAttrAccessToken();
  • Type: com.aliyun.ros.cdk.core.IResolvable

attrCallerUidRequired 

public IResolvable getAttrCallerUid();
  • Type: com.aliyun.ros.cdk.core.IResolvable

attrCpuRequired 

public IResolvable getAttrCpu();
  • Type: com.aliyun.ros.cdk.core.IResolvable

attrCreateTimeRequired 

public IResolvable getAttrCreateTime();
  • Type: com.aliyun.ros.cdk.core.IResolvable

attrCurrentVersionRequired 

public IResolvable getAttrCurrentVersion();
  • Type: com.aliyun.ros.cdk.core.IResolvable

attrExtraDataRequired 

public IResolvable getAttrExtraData();
  • Type: com.aliyun.ros.cdk.core.IResolvable

attrGpuRequired 

public IResolvable getAttrGpu();
  • Type: com.aliyun.ros.cdk.core.IResolvable

attrImageRequired 

public IResolvable getAttrImage();
  • Type: com.aliyun.ros.cdk.core.IResolvable

attrInternetEndpointRequired 

public IResolvable getAttrInternetEndpoint();
  • Type: com.aliyun.ros.cdk.core.IResolvable

attrIntranetEndpointRequired 

public IResolvable getAttrIntranetEndpoint();
  • Type: com.aliyun.ros.cdk.core.IResolvable

attrLabelsRequired 

public IResolvable getAttrLabels();
  • Type: com.aliyun.ros.cdk.core.IResolvable

attrLatestVersionRequired 

public IResolvable getAttrLatestVersion();
  • Type: com.aliyun.ros.cdk.core.IResolvable

attrMemoryRequired 

public IResolvable getAttrMemory();
  • Type: com.aliyun.ros.cdk.core.IResolvable

attrMessageRequired 

public IResolvable getAttrMessage();
  • Type: com.aliyun.ros.cdk.core.IResolvable

attrNamespaceRequired 

public IResolvable getAttrNamespace();
  • Type: com.aliyun.ros.cdk.core.IResolvable

attrParentUidRequired 

public IResolvable getAttrParentUid();
  • Type: com.aliyun.ros.cdk.core.IResolvable

attrPendingInstanceRequired 

public IResolvable getAttrPendingInstance();
  • Type: com.aliyun.ros.cdk.core.IResolvable

attrReasonRequired 

public IResolvable getAttrReason();
  • Type: com.aliyun.ros.cdk.core.IResolvable

attrResourceRequired 

public IResolvable getAttrResource();
  • Type: com.aliyun.ros.cdk.core.IResolvable

attrResourceAliasRequired 

public IResolvable getAttrResourceAlias();
  • Type: com.aliyun.ros.cdk.core.IResolvable

attrRoleRequired 

public IResolvable getAttrRole();
  • Type: com.aliyun.ros.cdk.core.IResolvable

attrRoleAttrsRequired 

public IResolvable getAttrRoleAttrs();
  • Type: com.aliyun.ros.cdk.core.IResolvable

attrRunningInstanceRequired 

public IResolvable getAttrRunningInstance();
  • Type: com.aliyun.ros.cdk.core.IResolvable

attrSafetyLockRequired 

public IResolvable getAttrSafetyLock();
  • Type: com.aliyun.ros.cdk.core.IResolvable

attrServiceConfigRequired 

public IResolvable getAttrServiceConfig();
  • Type: com.aliyun.ros.cdk.core.IResolvable

attrServiceGroupRequired 

public IResolvable getAttrServiceGroup();
  • Type: com.aliyun.ros.cdk.core.IResolvable

attrServiceNameRequired 

public IResolvable getAttrServiceName();
  • Type: com.aliyun.ros.cdk.core.IResolvable

attrServiceUidRequired 

public IResolvable getAttrServiceUid();
  • Type: com.aliyun.ros.cdk.core.IResolvable

attrTotalInstanceRequired 

public IResolvable getAttrTotalInstance();
  • Type: com.aliyun.ros.cdk.core.IResolvable

attrUpdateTimeRequired 

public IResolvable getAttrUpdateTime();
  • Type: com.aliyun.ros.cdk.core.IResolvable

attrWeightRequired 

public IResolvable getAttrWeight();
  • Type: com.aliyun.ros.cdk.core.IResolvable

enableResourcePropertyConstraintRequired 

public java.lang.Boolean getEnableResourcePropertyConstraint();
  • Type: java.lang.Boolean

serviceNameRequired 

public java.lang.Object getServiceName();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

refreshOptionsOptional 

public java.lang.Object getRefreshOptions();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Constants

Name Type Description
ROS_RESOURCE_TYPE_NAME java.lang.String The resource type name for this resource class.

ROS_RESOURCE_TYPE_NAMERequired 

public java.lang.String getRosResourceTypeName();
  • Type: java.lang.String

The resource type name for this resource class.