Instance
- Implements: com.aliyun.ros.cdk.swas.datasource.IInstance
This class encapsulates and extends the ROS resource type DATASOURCE::SWAS::Instance.
Initializers
import com.aliyun.ros.cdk.swas.datasource.Instance;
Instance.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
.instanceId(java.lang.String)
.instanceId(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. |
instanceId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property instanceId: The ID of the 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
instanceIdRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property instanceId: The ID of the 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.swas.datasource.Instance;
Instance.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. |
attrBusinessStatus | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute BusinessStatus: The business status of the instance. |
attrChargeType | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute ChargeType: The billing method of the instance. |
attrCombination | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute Combination: Indicates whether the instance is a combination instance. |
attrCreationTime | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute CreationTime: The creation time of the instance. |
attrDdosStatus | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute DdosStatus: The anti-DDoS status of the instance. |
attrDisableReason | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute DisableReason: The reason why the instance is disabled. |
attrDisks | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute Disks: The disks of the instance. |
attrExpiredTime | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute ExpiredTime: The expiration time of the instance. |
attrImage | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute Image: The image information of the instance. |
attrImageId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute ImageId: The ID of the image used by the instance. |
attrInnerIpAddress | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute InnerIpAddress: The private IP address of the instance. |
attrInstanceId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute InstanceId: The ID of the instance. |
attrInstanceName | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute InstanceName: The name of the instance. |
attrNetworkAttributes | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute NetworkAttributes: The network attributes of the instance. |
attrPlanId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute PlanId: The plan ID of the instance. |
attrPlanType | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute PlanType: The plan type of the instance. |
attrPublicIpAddress | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute PublicIpAddress: The public IP address of the instance. |
attrRegionId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute RegionId: The ID of the region where the instance is deployed. |
attrResourceGroupId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute ResourceGroupId: The ID of the resource group to which the instance belongs. |
attrResourceSpec | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute ResourceSpec: The resource specification of the instance. |
attrStatus | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute Status: The status of the instance. |
attrTags | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute Tags: The tags of the instance. |
attrUuid | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute Uuid: The unique identifier of the instance. |
props | InstanceProps | 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
attrBusinessStatusRequired
public java.lang.Object getAttrBusinessStatus();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute BusinessStatus: The business status of the instance.
attrChargeTypeRequired
public java.lang.Object getAttrChargeType();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute ChargeType: The billing method of the instance.
attrCombinationRequired
public java.lang.Object getAttrCombination();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute Combination: Indicates whether the instance is a combination instance.
attrCreationTimeRequired
public java.lang.Object getAttrCreationTime();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute CreationTime: The creation time of the instance.
attrDdosStatusRequired
public java.lang.Object getAttrDdosStatus();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute DdosStatus: The anti-DDoS status of the instance.
attrDisableReasonRequired
public java.lang.Object getAttrDisableReason();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute DisableReason: The reason why the instance is disabled.
attrDisksRequired
public java.lang.Object getAttrDisks();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute Disks: The disks of the instance.
attrExpiredTimeRequired
public java.lang.Object getAttrExpiredTime();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute ExpiredTime: The expiration time of the instance.
attrImageRequired
public java.lang.Object getAttrImage();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute Image: The image information of the instance.
attrImageIdRequired
public java.lang.Object getAttrImageId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute ImageId: The ID of the image used by the instance.
attrInnerIpAddressRequired
public java.lang.Object getAttrInnerIpAddress();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute InnerIpAddress: The private IP address of the instance.
attrInstanceIdRequired
public java.lang.Object getAttrInstanceId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute InstanceId: The ID of the instance.
attrInstanceNameRequired
public java.lang.Object getAttrInstanceName();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute InstanceName: The name of the instance.
attrNetworkAttributesRequired
public java.lang.Object getAttrNetworkAttributes();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute NetworkAttributes: The network attributes of the instance.
attrPlanIdRequired
public java.lang.Object getAttrPlanId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute PlanId: The plan ID of the instance.
attrPlanTypeRequired
public java.lang.Object getAttrPlanType();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute PlanType: The plan type of the instance.
attrPublicIpAddressRequired
public java.lang.Object getAttrPublicIpAddress();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute PublicIpAddress: The public IP address of the instance.
attrRegionIdRequired
public java.lang.Object getAttrRegionId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute RegionId: The ID of the region where the instance is deployed.
attrResourceGroupIdRequired
public java.lang.Object getAttrResourceGroupId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute ResourceGroupId: The ID of the resource group to which the instance belongs.
attrResourceSpecRequired
public java.lang.Object getAttrResourceSpec();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute ResourceSpec: The resource specification of the instance.
attrStatusRequired
public java.lang.Object getAttrStatus();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute Status: The status of the instance.
attrTagsRequired
public java.lang.Object getAttrTags();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute Tags: The tags of the instance.
attrUuidRequired
public java.lang.Object getAttrUuid();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute Uuid: The unique identifier of the instance.
propsRequired
public InstanceProps getProps();
- Type: InstanceProps