Skip to content

RosServiceInstance

This class is a base encapsulation around the ROS resource type ALIYUN::ComputeNest::ServiceInstance, which is used to create and deploy a service instance.

Initializers 

import com.aliyun.ros.cdk.computenest.RosServiceInstance;
RosServiceInstance.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .service(IResolvable)
    .service(ServiceProperty)
//  .commodity(IResolvable)
//  .commodity(CommodityProperty)
//  .contactGroup(java.lang.String)
//  .contactGroup(IResolvable)
//  .enableInstanceOps(java.lang.Boolean)
//  .enableInstanceOps(IResolvable)
//  .enableUserPrometheus(java.lang.Boolean)
//  .enableUserPrometheus(IResolvable)
//  .marketInstanceId(java.lang.String)
//  .marketInstanceId(IResolvable)
//  .name(java.lang.String)
//  .name(IResolvable)
//  .operationName(java.lang.String)
//  .operationName(IResolvable)
//  .parameters(IResolvable)
//  .parameters(java.util.Map<java.lang.String, java.lang.Object>)
//  .predefinedParameterName(java.lang.String)
//  .predefinedParameterName(IResolvable)
//  .resourceGroupId(java.lang.String)
//  .resourceGroupId(IResolvable)
//  .specificationCode(java.lang.String)
//  .specificationCode(IResolvable)
//  .tags(java.util.List<TagsProperty>)
//  .templateName(java.lang.String)
//  .templateName(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.
service com.aliyun.ros.cdk.core.IResolvable OR ServiceProperty No description.
commodity com.aliyun.ros.cdk.core.IResolvable OR CommodityProperty No description.
contactGroup java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
enableInstanceOps java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable No description.
enableUserPrometheus java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable No description.
marketInstanceId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
name java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
operationName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
parameters com.aliyun.ros.cdk.core.IResolvable OR java.util.Map No description.
predefinedParameterName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
resourceGroupId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
specificationCode java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
tags java.util.List<TagsProperty> No description.
templateName 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

serviceRequired

commodityOptional

contactGroupOptional

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

enableInstanceOpsOptional

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

enableUserPrometheusOptional

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

marketInstanceIdOptional

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

nameOptional

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

operationNameOptional

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

parametersOptional

  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.Map

predefinedParameterNameOptional

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

resourceGroupIdOptional

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

specificationCodeOptional

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

tagsOptional

templateNameOptional

  • 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.computenest.RosServiceInstance;
RosServiceInstance.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

xRequired

  • Type: java.lang.Object

isRosElement 

import com.aliyun.ros.cdk.computenest.RosServiceInstance;
RosServiceInstance.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.computenest.RosServiceInstance;
RosServiceInstance.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.
attrComponents com.aliyun.ros.cdk.core.IResolvable No description.
attrCreateTime com.aliyun.ros.cdk.core.IResolvable No description.
attrEnableInstanceOps com.aliyun.ros.cdk.core.IResolvable No description.
attrEnableUserPrometheus com.aliyun.ros.cdk.core.IResolvable No description.
attrIsOperated com.aliyun.ros.cdk.core.IResolvable No description.
attrLicenseEndTime com.aliyun.ros.cdk.core.IResolvable No description.
attrName com.aliyun.ros.cdk.core.IResolvable No description.
attrNetworkConfig com.aliyun.ros.cdk.core.IResolvable No description.
attrOutputs com.aliyun.ros.cdk.core.IResolvable No description.
attrParameters com.aliyun.ros.cdk.core.IResolvable No description.
attrPredefinedParameterName com.aliyun.ros.cdk.core.IResolvable No description.
attrProgress com.aliyun.ros.cdk.core.IResolvable No description.
attrResourceGroupId com.aliyun.ros.cdk.core.IResolvable No description.
attrService com.aliyun.ros.cdk.core.IResolvable No description.
attrServiceInstanceId com.aliyun.ros.cdk.core.IResolvable No description.
attrServiceType com.aliyun.ros.cdk.core.IResolvable No description.
attrSource com.aliyun.ros.cdk.core.IResolvable No description.
attrStatusDetail com.aliyun.ros.cdk.core.IResolvable No description.
attrSupplierUid com.aliyun.ros.cdk.core.IResolvable No description.
attrTags com.aliyun.ros.cdk.core.IResolvable No description.
attrTemplateName com.aliyun.ros.cdk.core.IResolvable No description.
attrUpdateTime com.aliyun.ros.cdk.core.IResolvable No description.
attrUserId com.aliyun.ros.cdk.core.IResolvable No description.
enableResourcePropertyConstraint java.lang.Boolean No description.
service com.aliyun.ros.cdk.core.IResolvable OR ServiceProperty No description.
commodity com.aliyun.ros.cdk.core.IResolvable OR CommodityProperty No description.
contactGroup java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
enableInstanceOps java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable No description.
enableUserPrometheus java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable No description.
marketInstanceId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
name java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
operationName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
parameters com.aliyun.ros.cdk.core.IResolvable OR java.util.Map No description.
predefinedParameterName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
resourceGroupId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
specificationCode java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
tags java.util.List<TagsProperty> No description.
templateName 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.

attrComponentsRequired 

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

attrCreateTimeRequired 

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

attrEnableInstanceOpsRequired 

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

attrEnableUserPrometheusRequired 

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

attrIsOperatedRequired 

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

attrLicenseEndTimeRequired 

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

attrNameRequired 

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

attrNetworkConfigRequired 

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

attrOutputsRequired 

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

attrParametersRequired 

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

attrPredefinedParameterNameRequired 

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

attrProgressRequired 

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

attrResourceGroupIdRequired 

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

attrServiceRequired 

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

attrServiceInstanceIdRequired 

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

attrServiceTypeRequired 

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

attrSourceRequired 

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

attrStatusDetailRequired 

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

attrSupplierUidRequired 

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

attrTagsRequired 

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

attrTemplateNameRequired 

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

attrUpdateTimeRequired 

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

attrUserIdRequired 

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

enableResourcePropertyConstraintRequired 

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

serviceRequired 

public java.lang.Object getService();

commodityOptional 

public java.lang.Object getCommodity();

contactGroupOptional 

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

enableInstanceOpsOptional 

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

enableUserPrometheusOptional 

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

marketInstanceIdOptional 

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

nameOptional 

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

operationNameOptional 

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

parametersOptional 

public java.lang.Object getParameters();
  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.Map

predefinedParameterNameOptional 

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

resourceGroupIdOptional 

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

specificationCodeOptional 

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

tagsOptional 

public java.util.List<TagsProperty> getTags();

templateNameOptional 

public java.lang.Object getTemplateName();
  • 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.