RosInstance

This class is a base encapsulation around the ROS resource type DATASOURCE::ApiGateway::Instance, which is used to query the information about an instance.

Initializers

import com.aliyun.ros.cdk.apigateway.datasource.RosInstance;
RosInstance.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	- scope in which this resource is defined.
id	java.lang.String	- scoped id of the resource.
enableResourcePropertyConstraint	java.lang.Boolean	No description.
instanceId	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.

---

scope^Required

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

scope in which this resource is defined.

---

id^Required

• Type: java.lang.String

scoped id of the resource.

---

enableResourcePropertyConstraint^Required

• Type: java.lang.Boolean

---

instanceId^Required

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

---

refreshOptions^Optional

• 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.

session^Required

• 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.

newLogicalId^Required

• Type: java.lang.String

The new logical ID to use for this stack element.

---

addCondition

public void addCondition(RosCondition con)

con^Required

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

---

addCount

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

count^Required

• 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).

path^Required

• 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.

target^Required

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

---

addDesc

public void addDesc(java.lang.String desc)

desc^Required

• Type: java.lang.String

---

addMetaData

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

key^Required

• Type: java.lang.String

---

value^Required

• 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"
       ...
     },
   ]
   ...
}

path^Required

• 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.

---

value^Required

• 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.

propertyPath^Required

• 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).

propertyPath^Required

• Type: java.lang.String

The path of the property.

---

value^Required

• Type: java.lang.Object

The value.

---

addRosDependency

public void addRosDependency(java.lang.String target)

target^Required

• 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.

policy^Optional

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

---

options^Optional

• 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.

attributeName^Required

• 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.apigateway.datasource.RosInstance;
RosInstance.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

x^Required

• Type: java.lang.Object

---

isRosElement

import com.aliyun.ros.cdk.apigateway.datasource.RosInstance;
RosInstance.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.

x^Required

• Type: java.lang.Object

---

isRosResource

import com.aliyun.ros.cdk.apigateway.datasource.RosInstance;
RosInstance.isRosResource(IConstruct construct)

Check whether the given construct is a RosResource.

construct^Required

• 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.
attrAclId	com.aliyun.ros.cdk.core.IResolvable	No description.
attrAclName	com.aliyun.ros.cdk.core.IResolvable	No description.
attrAclStatus	com.aliyun.ros.cdk.core.IResolvable	No description.
attrAclType	com.aliyun.ros.cdk.core.IResolvable	No description.
attrClassicEgressAddress	com.aliyun.ros.cdk.core.IResolvable	No description.
attrCreateTime	com.aliyun.ros.cdk.core.IResolvable	No description.
attrEgressIpv6Enable	com.aliyun.ros.cdk.core.IResolvable	No description.
attrExpiredTime	com.aliyun.ros.cdk.core.IResolvable	No description.
attrHttpsPolicy	com.aliyun.ros.cdk.core.IResolvable	No description.
attrInstanceId	com.aliyun.ros.cdk.core.IResolvable	No description.
attrInstanceName	com.aliyun.ros.cdk.core.IResolvable	No description.
attrInstanceRpsLimit	com.aliyun.ros.cdk.core.IResolvable	No description.
attrInstanceSpec	com.aliyun.ros.cdk.core.IResolvable	No description.
attrInstanceSpecAttributes	com.aliyun.ros.cdk.core.IResolvable	No description.
attrInstanceType	com.aliyun.ros.cdk.core.IResolvable	No description.
attrInternetEgressAddress	com.aliyun.ros.cdk.core.IResolvable	No description.
attrPaymentType	com.aliyun.ros.cdk.core.IResolvable	No description.
attrSupportIpv6	com.aliyun.ros.cdk.core.IResolvable	No description.
attrUserVpcId	com.aliyun.ros.cdk.core.IResolvable	No description.
attrUserVswitchId	com.aliyun.ros.cdk.core.IResolvable	No description.
attrVipTypeList	com.aliyun.ros.cdk.core.IResolvable	No description.
attrVpcEgressAddress	com.aliyun.ros.cdk.core.IResolvable	No description.
attrVpcIntranetEnable	com.aliyun.ros.cdk.core.IResolvable	No description.
attrVpcOwnerId	com.aliyun.ros.cdk.core.IResolvable	No description.
attrVpcSlbIntranetEnable	com.aliyun.ros.cdk.core.IResolvable	No description.
attrZoneId	com.aliyun.ros.cdk.core.IResolvable	No description.
attrZoneLocalName	com.aliyun.ros.cdk.core.IResolvable	No description.
enableResourcePropertyConstraint	java.lang.Boolean	No description.
instanceId	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.

---

node^Required

public ConstructNode getNode();

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

The construct tree node associated with this construct.

---

creationStack^Required

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

• Type: java.util.List

---

logicalId^Required

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).

---

stack^Required

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).

---

ref^Required

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 }).

---

rosOptions^Required

public IRosResourceOptions getRosOptions();

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

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

---

rosResourceType^Required

public java.lang.String getRosResourceType();

• Type: java.lang.String

ROS resource type.

---

attrAclId^Required

public IResolvable getAttrAclId();

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

---

attrAclName^Required

public IResolvable getAttrAclName();

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

---

attrAclStatus^Required

public IResolvable getAttrAclStatus();

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

---

attrAclType^Required

public IResolvable getAttrAclType();

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

---

attrClassicEgressAddress^Required

public IResolvable getAttrClassicEgressAddress();

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

---

attrCreateTime^Required

public IResolvable getAttrCreateTime();

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

---

attrEgressIpv6Enable^Required

public IResolvable getAttrEgressIpv6Enable();

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

---

attrExpiredTime^Required

public IResolvable getAttrExpiredTime();

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

---

attrHttpsPolicy^Required

public IResolvable getAttrHttpsPolicy();

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

---

attrInstanceId^Required

public IResolvable getAttrInstanceId();

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

---

attrInstanceName^Required

public IResolvable getAttrInstanceName();

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

---

attrInstanceRpsLimit^Required

public IResolvable getAttrInstanceRpsLimit();

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

---

attrInstanceSpec^Required

public IResolvable getAttrInstanceSpec();

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

---

attrInstanceSpecAttributes^Required

public IResolvable getAttrInstanceSpecAttributes();

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

---

attrInstanceType^Required

public IResolvable getAttrInstanceType();

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

---

attrInternetEgressAddress^Required

public IResolvable getAttrInternetEgressAddress();

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

---

attrPaymentType^Required

public IResolvable getAttrPaymentType();

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

---

attrSupportIpv6^Required

public IResolvable getAttrSupportIpv6();

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

---

attrUserVpcId^Required

public IResolvable getAttrUserVpcId();

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

---

attrUserVswitchId^Required

public IResolvable getAttrUserVswitchId();

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

---

attrVipTypeList^Required

public IResolvable getAttrVipTypeList();

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

---

attrVpcEgressAddress^Required

public IResolvable getAttrVpcEgressAddress();

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

---

attrVpcIntranetEnable^Required

public IResolvable getAttrVpcIntranetEnable();

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

---

attrVpcOwnerId^Required

public IResolvable getAttrVpcOwnerId();

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

---

attrVpcSlbIntranetEnable^Required

public IResolvable getAttrVpcSlbIntranetEnable();

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

---

attrZoneId^Required

public IResolvable getAttrZoneId();

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

---

attrZoneLocalName^Required

public IResolvable getAttrZoneLocalName();

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

---

enableResourcePropertyConstraint^Required

public java.lang.Boolean getEnableResourcePropertyConstraint();

• Type: java.lang.Boolean

---

instanceId^Required

public java.lang.Object getInstanceId();

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

---

refreshOptions^Optional

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_NAME^Required

public java.lang.String getRosResourceTypeName();

• Type: java.lang.String

The resource type name for this resource class.

---