HaVip
- Implements: @alicloud/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 { datasource } from '@alicloud/ros-cdk-vpc'
new datasource.HaVip(scope: Construct, id: string, props: HaVipProps, enableResourcePropertyConstraint?: boolean)
| Name | Type | Description |
|---|---|---|
scope | @alicloud/ros-cdk-core.Construct | No description. |
id | string | No description. |
props | HaVipProps | No description. |
enableResourcePropertyConstraint | boolean | No description. |
scopeRequired
- Type: @alicloud/ros-cdk-core.Construct
idRequired
- Type: string
propsRequired
- Type: HaVipProps
enableResourcePropertyConstraintOptional
- Type: boolean
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 toString(): string
Returns a string representation of this construct.
synthesize
public synthesize(session: ISynthesisSession): void
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: @alicloud/ros-cdk-core.ISynthesisSession
The synthesis session.
addCondition
public addCondition(condition: RosCondition): void
- Type: @alicloud/ros-cdk-core.RosCondition
addCount
public addCount(count: number | IResolvable): void
- Type: number | @alicloud/ros-cdk-core.IResolvable
addDependency
public addDependency(resource: Resource): void
- Type: @alicloud/ros-cdk-core.Resource
addResourceDesc
public addResourceDesc(desc: string): void
- Type: string
applyRemovalPolicy
public applyRemovalPolicy(policy: RemovalPolicy): void
- Type: @alicloud/ros-cdk-core.RemovalPolicy
fetchCondition
public fetchCondition(): RosCondition
fetchDependency
public fetchDependency(): string[]
fetchResourceDesc
public fetchResourceDesc(): string
getAtt
public getAtt(name: string): IResolvable
- Type: string
setMetadata
public setMetadata(key: string, value: any): void
- Type: string
- Type: any
Static Functions
| Name | Description |
|---|---|
isConstruct | Return whether the given object is a Construct. |
isConstruct
import { datasource } from '@alicloud/ros-cdk-vpc'
datasource.HaVip.isConstruct(x: any)
Return whether the given object is a Construct.
- Type: any
Properties
| Name | Type | Description |
|---|---|---|
node | @alicloud/ros-cdk-core.ConstructNode | The construct tree node associated with this construct. |
env | @alicloud/ros-cdk-core.IResourceEnvironment | The environment this resource belongs to. |
ref | string | No description. |
stack | @alicloud/ros-cdk-core.Stack | The stack in which this resource is defined. |
resource | @alicloud/ros-cdk-core.RosResource | No description. |
attrAssociatedEipAddresses | string | @alicloud/ros-cdk-core.IResolvable | Attribute AssociatedEipAddresses: EIP bound to HaVip. |
attrAssociatedInstances | string | @alicloud/ros-cdk-core.IResolvable | Attribute AssociatedInstances: An ECS instance that is bound to HaVip. |
attrAssociatedInstanceType | string | @alicloud/ros-cdk-core.IResolvable | Attribute AssociatedInstanceType: The type of the instance that is bound to the VIIP. |
attrCreateTime | string | @alicloud/ros-cdk-core.IResolvable | Attribute CreateTime: The creation time of the resource. |
attrDescription | string | @alicloud/ros-cdk-core.IResolvable | Attribute Description: Dependence of a HaVip instance. |
attrHaVipId | string | @alicloud/ros-cdk-core.IResolvable | Attribute HaVipId: The ID of the resource. |
attrHaVipName | string | @alicloud/ros-cdk-core.IResolvable | Attribute HaVipName: The name of the HaVip instance. |
attrIpAddress | string | @alicloud/ros-cdk-core.IResolvable | Attribute IpAddress: IP address of private network. |
attrMasterInstanceId | string | @alicloud/ros-cdk-core.IResolvable | Attribute MasterInstanceId: The primary instance ID bound to HaVip. |
attrVpcId | string | @alicloud/ros-cdk-core.IResolvable | Attribute VpcId: The VPC ID to which the HaVip instance belongs. |
attrVSwitchId | string | @alicloud/ros-cdk-core.IResolvable | Attribute VSwitchId: The switch ID to which the HaVip instance belongs. |
props | HaVipProps | No description. |
nodeRequired
public readonly node: ConstructNode;
- Type: @alicloud/ros-cdk-core.ConstructNode
The construct tree node associated with this construct.
envRequired
public readonly env: IResourceEnvironment;
- Type: @alicloud/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 readonly ref: string;
- Type: string
stackRequired
public readonly stack: Stack;
- Type: @alicloud/ros-cdk-core.Stack
The stack in which this resource is defined.
resourceOptional
public readonly resource: RosResource;
- Type: @alicloud/ros-cdk-core.RosResource
attrAssociatedEipAddressesRequired
public readonly attrAssociatedEipAddresses: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute AssociatedEipAddresses: EIP bound to HaVip.
attrAssociatedInstancesRequired
public readonly attrAssociatedInstances: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute AssociatedInstances: An ECS instance that is bound to HaVip.
attrAssociatedInstanceTypeRequired
public readonly attrAssociatedInstanceType: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute AssociatedInstanceType: The type of the instance that is bound to the VIIP.
attrCreateTimeRequired
public readonly attrCreateTime: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute CreateTime: The creation time of the resource.
attrDescriptionRequired
public readonly attrDescription: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute Description: Dependence of a HaVip instance.
attrHaVipIdRequired
public readonly attrHaVipId: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute HaVipId: The ID of the resource.
attrHaVipNameRequired
public readonly attrHaVipName: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute HaVipName: The name of the HaVip instance.
attrIpAddressRequired
public readonly attrIpAddress: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute IpAddress: IP address of private network.
attrMasterInstanceIdRequired
public readonly attrMasterInstanceId: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute MasterInstanceId: The primary instance ID bound to HaVip.
attrVpcIdRequired
public readonly attrVpcId: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute VpcId: The VPC ID to which the HaVip instance belongs.
attrVSwitchIdRequired
public readonly attrVSwitchId: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute VSwitchId: The switch ID to which the HaVip instance belongs.
propsRequired
public readonly props: HaVipProps;
- Type: HaVipProps