HaVip
- Implements: com.aliyun.ros.cdk.vpc.datasource.IHaVip
This class encapsulates and extends the ROS resource type DATASOURCE::VPC::HaVip, which is used to query a high-availability virtual IP address (HAVIP).
Initializers
import com.aliyun.ros.cdk.vpc.datasource.HaVip;
HaVip.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
.haVipId(java.lang.String)
.haVipId(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. |
haVipId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property haVipId: The ID of the resource. |
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
haVipIdRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property haVipId: The ID of the resource.
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.vpc.datasource.HaVip;
HaVip.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. |
attrAssociatedEipAddresses | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute AssociatedEipAddresses: EIP bound to HaVip. |
attrAssociatedInstances | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute AssociatedInstances: An ECS instance that is bound to HaVip. |
attrAssociatedInstanceType | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute AssociatedInstanceType: The type of the instance that is bound to the VIIP. |
attrCreateTime | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute CreateTime: The creation time of the resource. |
attrDescription | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute Description: Dependence of a HaVip instance. |
attrHaVipId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute HaVipId: The ID of the resource. |
attrHaVipName | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute HaVipName: The name of the HaVip instance. |
attrIpAddress | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute IpAddress: IP address of private network. |
attrMasterInstanceId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute MasterInstanceId: The primary instance ID bound to HaVip. |
attrVpcId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute VpcId: The VPC ID to which the HaVip instance belongs. |
attrVSwitchId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute VSwitchId: The switch ID to which the HaVip instance belongs. |
props | HaVipProps | 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
attrAssociatedEipAddressesRequired
public java.lang.Object getAttrAssociatedEipAddresses();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute AssociatedEipAddresses: EIP bound to HaVip.
attrAssociatedInstancesRequired
public java.lang.Object getAttrAssociatedInstances();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute AssociatedInstances: An ECS instance that is bound to HaVip.
attrAssociatedInstanceTypeRequired
public java.lang.Object getAttrAssociatedInstanceType();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute AssociatedInstanceType: The type of the instance that is bound to the VIIP.
attrCreateTimeRequired
public java.lang.Object getAttrCreateTime();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute CreateTime: The creation time of the resource.
attrDescriptionRequired
public java.lang.Object getAttrDescription();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute Description: Dependence of a HaVip instance.
attrHaVipIdRequired
public java.lang.Object getAttrHaVipId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute HaVipId: The ID of the resource.
attrHaVipNameRequired
public java.lang.Object getAttrHaVipName();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute HaVipName: The name of the HaVip instance.
attrIpAddressRequired
public java.lang.Object getAttrIpAddress();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute IpAddress: IP address of private network.
attrMasterInstanceIdRequired
public java.lang.Object getAttrMasterInstanceId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute MasterInstanceId: The primary instance ID bound to HaVip.
attrVpcIdRequired
public java.lang.Object getAttrVpcId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute VpcId: The VPC ID to which the HaVip instance belongs.
attrVSwitchIdRequired
public java.lang.Object getAttrVSwitchId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute VSwitchId: The switch ID to which the HaVip instance belongs.
propsRequired
public HaVipProps getProps();
- Type: HaVipProps