Skip to content

Instance

This class encapsulates and extends 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.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: Instance id.
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: Instance id.

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

sessionRequired

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

The synthesis session.

addCondition 

public void addCondition(RosCondition condition)

conditionRequired

  • 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

addDependency 

public void addDependency(Resource resource)

resourceRequired

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

addResourceDesc 

public void addResourceDesc(java.lang.String desc)

descRequired

  • Type: java.lang.String

applyRemovalPolicy 

public void applyRemovalPolicy(RemovalPolicy policy)

policyRequired

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

getAtt 

public IResolvable getAtt(java.lang.String name)

nameRequired

  • Type: java.lang.String

setMetadata 

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

keyRequired

  • Type: java.lang.String

valueRequired

  • Type: java.lang.Object

Static Functions

Name Description
isConstruct Return whether the given object is a Construct.

isConstruct 

import com.aliyun.ros.cdk.apigateway.datasource.Instance;
Instance.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

xRequired

  • Type: java.lang.Object

Properties

Name Type Description
node com.aliyun.ros.cdk.core.ConstructNode The construct tree node associated with this construct.
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.
attrAclId com.aliyun.ros.cdk.core.IResolvable Attribute AclId: Access control ID.
attrAclName com.aliyun.ros.cdk.core.IResolvable Attribute AclName: Access control name.
attrAclStatus com.aliyun.ros.cdk.core.IResolvable Attribute AclStatus: Access control type.
attrAclType com.aliyun.ros.cdk.core.IResolvable Attribute AclType: Access control type.
attrClassicEgressAddress com.aliyun.ros.cdk.core.IResolvable Attribute ClassicEgressAddress: Classic network exit address.
attrCreateTime com.aliyun.ros.cdk.core.IResolvable Attribute CreateTime: Creation time.
attrEgressIpv6Enable com.aliyun.ros.cdk.core.IResolvable Attribute EgressIpv6Enable: Does IPV6 Capability Support.
attrExpiredTime com.aliyun.ros.cdk.core.IResolvable Attribute ExpiredTime: Instance expiration time.
attrHttpsPolicy com.aliyun.ros.cdk.core.IResolvable Attribute HttpsPolicy: Https policy.
attrInstanceId com.aliyun.ros.cdk.core.IResolvable Attribute InstanceId: Instance id.
attrInstanceName com.aliyun.ros.cdk.core.IResolvable Attribute InstanceName: Instance name.
attrInstanceRpsLimit com.aliyun.ros.cdk.core.IResolvable Attribute InstanceRpsLimit: Instance rps limits.
attrInstanceSpec com.aliyun.ros.cdk.core.IResolvable Attribute InstanceSpec: Instance type.
attrInstanceSpecAttributes com.aliyun.ros.cdk.core.IResolvable Attribute InstanceSpecAttributes: Instance type.
attrInstanceType com.aliyun.ros.cdk.core.IResolvable Attribute InstanceType: Instance type.
attrInternetEgressAddress com.aliyun.ros.cdk.core.IResolvable Attribute InternetEgressAddress: Public network exit address.
attrPaymentType com.aliyun.ros.cdk.core.IResolvable Attribute PaymentType: The payment type of the resource.
attrSupportIpv6 com.aliyun.ros.cdk.core.IResolvable Attribute SupportIpv6: Does ipv6 support.
attrUserVpcId com.aliyun.ros.cdk.core.IResolvable Attribute UserVpcId: User's VpcID.
attrUserVswitchId com.aliyun.ros.cdk.core.IResolvable Attribute UserVswitchId: DescribeInstances.
attrVipTypeList com.aliyun.ros.cdk.core.IResolvable Attribute VipTypeList: Vip type.
attrVpcEgressAddress com.aliyun.ros.cdk.core.IResolvable Attribute VpcEgressAddress: Intranet VPC exit network segment.
attrVpcIntranetEnable com.aliyun.ros.cdk.core.IResolvable Attribute VpcIntranetEnable: Whether Vpc allows authorization.
attrVpcOwnerId com.aliyun.ros.cdk.core.IResolvable Attribute VpcOwnerId: Vpc licensor ID.
attrVpcSlbIntranetEnable com.aliyun.ros.cdk.core.IResolvable Attribute VpcSlbIntranetEnable: Whether the slb of the Vpc supports.
attrZoneId com.aliyun.ros.cdk.core.IResolvable Attribute ZoneId: Zone.
attrZoneLocalName com.aliyun.ros.cdk.core.IResolvable Attribute ZoneLocalName: Available area.

nodeRequired 

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

The construct tree node associated with this construct.

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

attrAclIdRequired 

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

Attribute AclId: Access control ID.

attrAclNameRequired 

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

Attribute AclName: Access control name.

attrAclStatusRequired 

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

Attribute AclStatus: Access control type.

attrAclTypeRequired 

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

Attribute AclType: Access control type.

attrClassicEgressAddressRequired 

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

Attribute ClassicEgressAddress: Classic network exit address.

attrCreateTimeRequired 

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

Attribute CreateTime: Creation time.

attrEgressIpv6EnableRequired 

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

Attribute EgressIpv6Enable: Does IPV6 Capability Support.

attrExpiredTimeRequired 

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

Attribute ExpiredTime: Instance expiration time.

attrHttpsPolicyRequired 

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

Attribute HttpsPolicy: Https policy.

attrInstanceIdRequired 

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

Attribute InstanceId: Instance id.

attrInstanceNameRequired 

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

Attribute InstanceName: Instance name.

attrInstanceRpsLimitRequired 

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

Attribute InstanceRpsLimit: Instance rps limits.

attrInstanceSpecRequired 

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

Attribute InstanceSpec: Instance type.

attrInstanceSpecAttributesRequired 

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

Attribute InstanceSpecAttributes: Instance type.

attrInstanceTypeRequired 

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

Attribute InstanceType: Instance type.

attrInternetEgressAddressRequired 

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

Attribute InternetEgressAddress: Public network exit address.

attrPaymentTypeRequired 

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

Attribute PaymentType: The payment type of the resource.

attrSupportIpv6Required 

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

Attribute SupportIpv6: Does ipv6 support.

attrUserVpcIdRequired 

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

Attribute UserVpcId: User's VpcID.

attrUserVswitchIdRequired 

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

Attribute UserVswitchId: DescribeInstances.

attrVipTypeListRequired 

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

Attribute VipTypeList: Vip type.

attrVpcEgressAddressRequired 

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

Attribute VpcEgressAddress: Intranet VPC exit network segment.

attrVpcIntranetEnableRequired 

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

Attribute VpcIntranetEnable: Whether Vpc allows authorization.

attrVpcOwnerIdRequired 

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

Attribute VpcOwnerId: Vpc licensor ID.

attrVpcSlbIntranetEnableRequired 

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

Attribute VpcSlbIntranetEnable: Whether the slb of the Vpc supports.

attrZoneIdRequired 

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

Attribute ZoneId: Zone.

attrZoneLocalNameRequired 

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

Attribute ZoneLocalName: Available area.