ServiceInstance
- Implements: com.aliyun.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
import com.aliyun.ros.cdk.computenest.datasource.ServiceInstance;
ServiceInstance.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
.serviceInstanceId(java.lang.String)
.serviceInstanceId(IResolvable)
// .refreshOptions(java.lang.String)
// .refreshOptions(IResolvable)
.build();
| Name | Type | Description |
|---|---|---|
scope | com.aliyun.ros.cdk.core.Construct | No description. |
id | java.lang.String | No description. |
enableResourcePropertyConstraint | java.lang.Boolean | No description. |
serviceInstanceId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property serviceInstanceId: The ID of the service instance. |
refreshOptions | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated. |
scopeRequired
- Type: com.aliyun.ros.cdk.core.Construct
idRequired
- Type: java.lang.String
enableResourcePropertyConstraintOptional
- Type: java.lang.Boolean
serviceInstanceIdRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property serviceInstanceId: The ID of the service instance.
refreshOptionsOptional
- Type: java.lang.String OR com.aliyun.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.
Methods
| Name | Description |
|---|---|
toString | Returns a string representation of this construct. |
synthesize | Allows this construct to emit artifacts into the cloud assembly during synthesis. |
addCondition | No description. |
addCount | No description. |
addDependency | No description. |
addResourceDesc | No description. |
applyRemovalPolicy | No description. |
fetchCondition | No description. |
fetchDependency | No description. |
fetchResourceDesc | No description. |
getAtt | No description. |
setMetadata | No description. |
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.
- Type: com.aliyun.ros.cdk.core.ISynthesisSession
The synthesis session.
addCondition
public void addCondition(RosCondition condition)
- Type: com.aliyun.ros.cdk.core.RosCondition
addCount
public void addCount(java.lang.Number OR IResolvable count)
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
addDependency
public void addDependency(Resource resource)
- Type: com.aliyun.ros.cdk.core.Resource
addResourceDesc
public void addResourceDesc(java.lang.String desc)
- Type: java.lang.String
applyRemovalPolicy
public void applyRemovalPolicy(RemovalPolicy policy)
- Type: com.aliyun.ros.cdk.core.RemovalPolicy
fetchCondition
public RosCondition fetchCondition()
fetchDependency
public java.util.List<java.lang.String> fetchDependency()
fetchResourceDesc
public java.lang.String fetchResourceDesc()
getAtt
public IResolvable getAtt(java.lang.String name)
- Type: java.lang.String
setMetadata
public void setMetadata(java.lang.String key, java.lang.Object value)
- Type: java.lang.String
- Type: java.lang.Object
Static Functions
| Name | Description |
|---|---|
isConstruct | Return whether the given object is a Construct. |
isConstruct
import com.aliyun.ros.cdk.computenest.datasource.ServiceInstance;
ServiceInstance.isConstruct(java.lang.Object x)
Return whether the given object is a Construct.
- Type: java.lang.Object
Properties
| Name | Type | Description |
|---|---|---|
node | com.aliyun.ros.cdk.core.ConstructNode | The construct tree node associated with this construct. |
env | com.aliyun.ros.cdk.core.IResourceEnvironment | The environment this resource belongs to. |
ref | java.lang.String | No description. |
stack | com.aliyun.ros.cdk.core.Stack | The stack in which this resource is defined. |
resource | com.aliyun.ros.cdk.core.RosResource | No description. |
attrComponents | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute Components: Cloud Marketplace additional billing items. |
attrCreateTime | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute CreateTime: The time when the serviceInstance was created. |
attrEnableInstanceOps | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute EnableInstanceOps: Indicates whether the service instance supports the operation feature. |
attrEnableUserPrometheus | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute EnableUserPrometheus: Whether to enable Prometheus monitoring. |
attrIsOperated | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute IsOperated: Indicates whether the hosted O&M feature is enabled for the service instance. |
attrLicenseEndTime | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute LicenseEndTime: The expiration time of licence. |
attrMarketInstanceId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute MarketInstanceId: The ID of the cloud marketplace instance. |
attrNetworkConfig | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute NetworkConfig: The network configurations. |
attrOutputs | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute Outputs: The outputs returned from creating the service instance. |
attrParameters | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute Parameters: The parameters configured for the service instance. |
attrPredefinedParameterName | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute PredefinedParameterName: The name of the package . |
attrProgress | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute Progress: The deployment progress of the service instance. |
attrResourceGroupId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute ResourceGroupId: The resource group ID. |
attrService | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute Service: The information about the service to which the service instance belongs. |
attrServiceInstanceId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute ServiceInstanceId: The ID of the service instance. |
attrServiceInstanceName | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute ServiceInstanceName: The name of the resource. |
attrServiceType | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute ServiceType: The type of the service. |
attrSource | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute Source: The source of the service instance. |
attrStatusDetail | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute StatusDetail: The description of the deployment state of the service instance. |
attrSupplierUid | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute SupplierUid: The Alibaba Cloud account ID of the service provider. |
attrTags | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute Tags: The tags of the service instance. |
attrTemplateName | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute TemplateName: The name of the template. |
attrUpdateTime | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute UpdateTime: The time when the serviceInstance was last updated. |
attrUserId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute UserId: The AliUid of the user. |
props | ServiceInstanceProps | No description. |
nodeRequired
public ConstructNode getNode();
- Type: com.aliyun.ros.cdk.core.ConstructNode
The construct tree node associated with this construct.
envRequired
public IResourceEnvironment getEnv();
- Type: com.aliyun.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
public java.lang.String getRef();
- Type: java.lang.String
stackRequired
public Stack getStack();
- Type: com.aliyun.ros.cdk.core.Stack
The stack in which this resource is defined.
resourceOptional
public RosResource getResource();
- Type: com.aliyun.ros.cdk.core.RosResource
attrComponentsRequired
public java.lang.Object getAttrComponents();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute Components: Cloud Marketplace additional billing items.
attrCreateTimeRequired
public java.lang.Object getAttrCreateTime();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute CreateTime: The time when the serviceInstance was created.
attrEnableInstanceOpsRequired
public java.lang.Object getAttrEnableInstanceOps();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute EnableInstanceOps: Indicates whether the service instance supports the operation feature.
attrEnableUserPrometheusRequired
public java.lang.Object getAttrEnableUserPrometheus();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute EnableUserPrometheus: Whether to enable Prometheus monitoring.
attrIsOperatedRequired
public java.lang.Object getAttrIsOperated();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute IsOperated: Indicates whether the hosted O&M feature is enabled for the service instance.
attrLicenseEndTimeRequired
public java.lang.Object getAttrLicenseEndTime();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute LicenseEndTime: The expiration time of licence.
attrMarketInstanceIdRequired
public java.lang.Object getAttrMarketInstanceId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute MarketInstanceId: The ID of the cloud marketplace instance.
attrNetworkConfigRequired
public java.lang.Object getAttrNetworkConfig();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute NetworkConfig: The network configurations.
attrOutputsRequired
public java.lang.Object getAttrOutputs();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute Outputs: The outputs returned from creating the service instance.
attrParametersRequired
public java.lang.Object getAttrParameters();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute Parameters: The parameters configured for the service instance.
attrPredefinedParameterNameRequired
public java.lang.Object getAttrPredefinedParameterName();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute PredefinedParameterName: The name of the package .
attrProgressRequired
public java.lang.Object getAttrProgress();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute Progress: The deployment progress of the service instance.
Unit: percentage.
attrResourceGroupIdRequired
public java.lang.Object getAttrResourceGroupId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute ResourceGroupId: The resource group ID.
attrServiceRequired
public java.lang.Object getAttrService();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute Service: The information about the service to which the service instance belongs.
attrServiceInstanceIdRequired
public java.lang.Object getAttrServiceInstanceId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute ServiceInstanceId: The ID of the service instance.
attrServiceInstanceNameRequired
public java.lang.Object getAttrServiceInstanceName();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute ServiceInstanceName: The name of the resource.
attrServiceTypeRequired
public java.lang.Object getAttrServiceType();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute ServiceType: The type of the service.
attrSourceRequired
public java.lang.Object getAttrSource();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute Source: The source of the service instance.
attrStatusDetailRequired
public java.lang.Object getAttrStatusDetail();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute StatusDetail: The description of the deployment state of the service instance.
attrSupplierUidRequired
public java.lang.Object getAttrSupplierUid();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute SupplierUid: The Alibaba Cloud account ID of the service provider.
attrTagsRequired
public java.lang.Object getAttrTags();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute Tags: The tags of the service instance.
attrTemplateNameRequired
public java.lang.Object getAttrTemplateName();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute TemplateName: The name of the template.
attrUpdateTimeRequired
public java.lang.Object getAttrUpdateTime();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute UpdateTime: The time when the serviceInstance was last updated.
attrUserIdRequired
public java.lang.Object getAttrUserId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute UserId: The AliUid of the user.
propsRequired
public ServiceInstanceProps getProps();
- Type: ServiceInstanceProps