Instance
- Implements: com.aliyun.ros.cdk.apigateway.datasource.IInstance
This class encapsulates and extends the ROS resource type DATASOURCE::ApiGateway::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. |
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.apigateway.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. |
attrAclId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute AclId: Access control ID. |
attrAclName | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute AclName: Access control name. |
attrAclStatus | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute AclStatus: Access control type. |
attrAclType | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute AclType: Access control type. |
attrClassicEgressAddress | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute ClassicEgressAddress: Classic network exit address. |
attrCreateTime | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute CreateTime: Creation time. |
attrEgressIpv6Enable | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute EgressIpv6Enable: Does IPV6 Capability Support. |
attrExpiredTime | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute ExpiredTime: Instance expiration time. |
attrHttpsPolicy | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute HttpsPolicy: Https policy. |
attrInstanceId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute InstanceId: Instance id. |
attrInstanceName | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute InstanceName: Instance name. |
attrInstanceRpsLimit | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute InstanceRpsLimit: Instance rps limits. |
attrInstanceSpec | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute InstanceSpec: Instance type. |
attrInstanceSpecAttributes | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute InstanceSpecAttributes: Instance type. |
attrInstanceType | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute InstanceType: Instance type. |
attrInternetEgressAddress | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute InternetEgressAddress: Public network exit address. |
attrPaymentType | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute PaymentType: The payment type of the resource. |
attrSupportIpv6 | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute SupportIpv6: Does ipv6 support. |
attrUserVpcId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute UserVpcId: User's VpcID. |
attrUserVswitchId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute UserVswitchId: DescribeInstances. |
attrVipTypeList | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute VipTypeList: Vip type. |
attrVpcEgressAddress | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute VpcEgressAddress: Intranet VPC exit network segment. |
attrVpcIntranetEnable | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute VpcIntranetEnable: Whether Vpc allows authorization. |
attrVpcOwnerId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute VpcOwnerId: Vpc licensor ID. |
attrVpcSlbIntranetEnable | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute VpcSlbIntranetEnable: Whether the slb of the Vpc supports. |
attrZoneId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute ZoneId: Zone. |
attrZoneLocalName | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute ZoneLocalName: Available area. |
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
attrAclIdRequired
public java.lang.Object getAttrAclId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute AclId: Access control ID.
attrAclNameRequired
public java.lang.Object getAttrAclName();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute AclName: Access control name.
attrAclStatusRequired
public java.lang.Object getAttrAclStatus();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute AclStatus: Access control type.
attrAclTypeRequired
public java.lang.Object getAttrAclType();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute AclType: Access control type.
attrClassicEgressAddressRequired
public java.lang.Object getAttrClassicEgressAddress();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute ClassicEgressAddress: Classic network exit address.
attrCreateTimeRequired
public java.lang.Object getAttrCreateTime();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute CreateTime: Creation time.
attrEgressIpv6EnableRequired
public java.lang.Object getAttrEgressIpv6Enable();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute EgressIpv6Enable: Does IPV6 Capability Support.
attrExpiredTimeRequired
public java.lang.Object getAttrExpiredTime();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute ExpiredTime: Instance expiration time.
attrHttpsPolicyRequired
public java.lang.Object getAttrHttpsPolicy();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute HttpsPolicy: Https policy.
attrInstanceIdRequired
public java.lang.Object getAttrInstanceId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute InstanceId: Instance id.
attrInstanceNameRequired
public java.lang.Object getAttrInstanceName();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute InstanceName: Instance name.
attrInstanceRpsLimitRequired
public java.lang.Object getAttrInstanceRpsLimit();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute InstanceRpsLimit: Instance rps limits.
attrInstanceSpecRequired
public java.lang.Object getAttrInstanceSpec();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute InstanceSpec: Instance type.
attrInstanceSpecAttributesRequired
public java.lang.Object getAttrInstanceSpecAttributes();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute InstanceSpecAttributes: Instance type.
attrInstanceTypeRequired
public java.lang.Object getAttrInstanceType();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute InstanceType: Instance type.
attrInternetEgressAddressRequired
public java.lang.Object getAttrInternetEgressAddress();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute InternetEgressAddress: Public network exit address.
attrPaymentTypeRequired
public java.lang.Object getAttrPaymentType();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute PaymentType: The payment type of the resource.
attrSupportIpv6Required
public java.lang.Object getAttrSupportIpv6();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute SupportIpv6: Does ipv6 support.
attrUserVpcIdRequired
public java.lang.Object getAttrUserVpcId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute UserVpcId: User's VpcID.
attrUserVswitchIdRequired
public java.lang.Object getAttrUserVswitchId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute UserVswitchId: DescribeInstances.
attrVipTypeListRequired
public java.lang.Object getAttrVipTypeList();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute VipTypeList: Vip type.
attrVpcEgressAddressRequired
public java.lang.Object getAttrVpcEgressAddress();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute VpcEgressAddress: Intranet VPC exit network segment.
attrVpcIntranetEnableRequired
public java.lang.Object getAttrVpcIntranetEnable();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute VpcIntranetEnable: Whether Vpc allows authorization.
attrVpcOwnerIdRequired
public java.lang.Object getAttrVpcOwnerId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute VpcOwnerId: Vpc licensor ID.
attrVpcSlbIntranetEnableRequired
public java.lang.Object getAttrVpcSlbIntranetEnable();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute VpcSlbIntranetEnable: Whether the slb of the Vpc supports.
attrZoneIdRequired
public java.lang.Object getAttrZoneId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute ZoneId: Zone.
attrZoneLocalNameRequired
public java.lang.Object getAttrZoneLocalName();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute ZoneLocalName: Available area.
propsRequired
public InstanceProps getProps();
- Type: InstanceProps