Skip to content

CenVbrHealthCheck

This class encapsulates and extends the ROS resource type ALIYUN::CEN::CenVbrHealthCheck, which is used to enable the health check feature or modify the health check configuration for a virtual border router (VBR).

Initializers 

import { CenVbrHealthCheck } from '@alicloud/ros-cdk-cen'
new CenVbrHealthCheck(scope: Construct, id: string, props: CenVbrHealthCheckProps, enableResourcePropertyConstraint?: boolean)
Name Type Description
scope @alicloud/ros-cdk-core.Construct No description.
id string No description.
props CenVbrHealthCheckProps No description.
enableResourcePropertyConstraint boolean No description.

scopeRequired

  • Type: @alicloud/ros-cdk-core.Construct

idRequired

  • Type: string

propsRequired

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

sessionRequired

  • Type: @alicloud/ros-cdk-core.ISynthesisSession

The synthesis session.

addCondition 

public addCondition(condition: RosCondition): void

conditionRequired

  • Type: @alicloud/ros-cdk-core.RosCondition

addCount 

public addCount(count: number | IResolvable): void

countRequired

  • Type: number | @alicloud/ros-cdk-core.IResolvable

addDependency 

public addDependency(resource: Resource): void

resourceRequired

  • Type: @alicloud/ros-cdk-core.Resource

addResourceDesc 

public addResourceDesc(desc: string): void

descRequired

  • Type: string

applyRemovalPolicy 

public applyRemovalPolicy(policy: RemovalPolicy): void

policyRequired

  • Type: @alicloud/ros-cdk-core.RemovalPolicy

getAtt 

public getAtt(name: string): IResolvable

nameRequired

  • Type: string

setMetadata 

public setMetadata(key: string, value: any): void

keyRequired

  • Type: string

valueRequired

  • Type: any

Static Functions

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

isConstruct 

import { CenVbrHealthCheck } from '@alicloud/ros-cdk-cen'
CenVbrHealthCheck.isConstruct(x: any)

Return whether the given object is a Construct.

xRequired

  • Type: any

Properties

Name Type Description
node @alicloud/ros-cdk-core.ConstructNode The construct tree node associated with this construct.
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.
attrCenId @alicloud/ros-cdk-core.IResolvable Attribute CenId: The ID of the CEN instance.
attrHealthCheckInterval @alicloud/ros-cdk-core.IResolvable Attribute HealthCheckInterval: Specifies the time interval at which probe packets are sent during the health check.
attrHealthCheckSourceIp @alicloud/ros-cdk-core.IResolvable Attribute HealthCheckSourceIp: You can use either of the following methods to specify the source IP address of the health check.
attrHealthCheckTargetIp @alicloud/ros-cdk-core.IResolvable Attribute HealthCheckTargetIp: Specifies the destination IP address of the health check.
attrHealthyThreshold @alicloud/ros-cdk-core.IResolvable Attribute HealthyThreshold: Specifies the number of probe packets to be sent during the health check.
attrVbrInstanceId @alicloud/ros-cdk-core.IResolvable Attribute VbrInstanceId: The ID of the VBR instance.
attrVbrInstanceOwnerId @alicloud/ros-cdk-core.IResolvable Attribute VbrInstanceOwnerId: The User ID (UID) of the account to which the VBR instance belongs.
attrVbrInstanceRegionId @alicloud/ros-cdk-core.IResolvable Attribute VbrInstanceRegionId: The ID of the region where the VBR instance is deployed.

nodeRequired 

public readonly node: ConstructNode;
  • Type: @alicloud/ros-cdk-core.ConstructNode

The construct tree node associated with this construct.

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

attrCenIdRequired 

public readonly attrCenId: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute CenId: The ID of the CEN instance.

attrHealthCheckIntervalRequired 

public readonly attrHealthCheckInterval: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute HealthCheckInterval: Specifies the time interval at which probe packets are sent during the health check.

Default value: 2. Valid values: 2 to 3. Unit: second.

attrHealthCheckSourceIpRequired 

public readonly attrHealthCheckSourceIp: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute HealthCheckSourceIp: You can use either of the following methods to specify the source IP address of the health check.

Automatic IP Address: The system automatically assigns an IP address within the CIDR block 100.96.0.0/16 (recommended). Custom IP Address: You can specify a source IP address that is available within the CIDR block 10.0.0.0/8, 192.168.0.0/16, or 172.16.0.0/12. The specified source IP address must not overlap with the IP addresses of the Alibaba Cloud-facing and client-facing interfaces on the VBR instance, or the IP addresses of the instances with which the VBR instance needs to communicate in the CEN.

attrHealthCheckTargetIpRequired 

public readonly attrHealthCheckTargetIp: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute HealthCheckTargetIp: Specifies the destination IP address of the health check.

The destination IP address is the IP address of the client-facing interface on the VBR instance.

attrHealthyThresholdRequired 

public readonly attrHealthyThreshold: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute HealthyThreshold: Specifies the number of probe packets to be sent during the health check.

Default value: 8. Valid values: 3 to 8. Unit: packet.

attrVbrInstanceIdRequired 

public readonly attrVbrInstanceId: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute VbrInstanceId: The ID of the VBR instance.

attrVbrInstanceOwnerIdRequired 

public readonly attrVbrInstanceOwnerId: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute VbrInstanceOwnerId: The User ID (UID) of the account to which the VBR instance belongs.

attrVbrInstanceRegionIdRequired 

public readonly attrVbrInstanceRegionId: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute VbrInstanceRegionId: The ID of the region where the VBR instance is deployed.

You can call the DescribeRegionsoperation to query region IDs.