1. Pulumi Registry
  2. Alibaba Cloud
  3. API Docs
  4. cen
  5. VbrHealthCheck
alicloud logo
Alibaba Cloud v3.34.0, Mar 17 23

alicloud.cen.VbrHealthCheck

This topic describes how to configure the health check feature for a Cloud Enterprise Network (CEN) instance. After you attach a Virtual Border Router (VBR) to the CEN instance and configure the health check feature, you can monitor the network conditions of the on-premises data center connected to the VBR.

For information about CEN VBR HealthCheck and how to use it, see Manage CEN VBR HealthCheck.

NOTE: Available in 1.88.0+

Example Usage

Basic Usage

using System.Collections.Generic;
using Pulumi;
using AliCloud = Pulumi.AliCloud;

return await Deployment.RunAsync(() => 
{
    // Create a cen vbr HealrhCheck resource and use it.
    var defaultInstance = new AliCloud.Cen.Instance("defaultInstance", new()
    {
        CenInstanceName = "test_name",
    });

    var defaultInstanceAttachment = new AliCloud.Cen.InstanceAttachment("defaultInstanceAttachment", new()
    {
        InstanceId = defaultInstance.Id,
        ChildInstanceId = "vbr-xxxxx",
        ChildInstanceType = "VBR",
        ChildInstanceRegionId = "cn-hangzhou",
    });

    var defaultVbrHealthCheck = new AliCloud.Cen.VbrHealthCheck("defaultVbrHealthCheck", new()
    {
        CenId = defaultInstance.Id,
        HealthCheckSourceIp = "192.168.1.2",
        HealthCheckTargetIp = "10.0.0.2",
        VbrInstanceId = "vbr-xxxxx",
        VbrInstanceRegionId = "cn-hangzhou",
        HealthCheckInterval = 2,
        HealthyThreshold = 8,
    }, new CustomResourceOptions
    {
        DependsOn = new[]
        {
            defaultInstanceAttachment,
        },
    });

});

package main

import (
	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/cen"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		defaultInstance, err := cen.NewInstance(ctx, "defaultInstance", &cen.InstanceArgs{
			CenInstanceName: pulumi.String("test_name"),
		})
		if err != nil {
			return err
		}
		defaultInstanceAttachment, err := cen.NewInstanceAttachment(ctx, "defaultInstanceAttachment", &cen.InstanceAttachmentArgs{
			InstanceId:            defaultInstance.ID(),
			ChildInstanceId:       pulumi.String("vbr-xxxxx"),
			ChildInstanceType:     pulumi.String("VBR"),
			ChildInstanceRegionId: pulumi.String("cn-hangzhou"),
		})
		if err != nil {
			return err
		}
		_, err = cen.NewVbrHealthCheck(ctx, "defaultVbrHealthCheck", &cen.VbrHealthCheckArgs{
			CenId:               defaultInstance.ID(),
			HealthCheckSourceIp: pulumi.String("192.168.1.2"),
			HealthCheckTargetIp: pulumi.String("10.0.0.2"),
			VbrInstanceId:       pulumi.String("vbr-xxxxx"),
			VbrInstanceRegionId: pulumi.String("cn-hangzhou"),
			HealthCheckInterval: pulumi.Int(2),
			HealthyThreshold:    pulumi.Int(8),
		}, pulumi.DependsOn([]pulumi.Resource{
			defaultInstanceAttachment,
		}))
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.alicloud.cen.Instance;
import com.pulumi.alicloud.cen.InstanceArgs;
import com.pulumi.alicloud.cen.InstanceAttachment;
import com.pulumi.alicloud.cen.InstanceAttachmentArgs;
import com.pulumi.alicloud.cen.VbrHealthCheck;
import com.pulumi.alicloud.cen.VbrHealthCheckArgs;
import com.pulumi.resources.CustomResourceOptions;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var defaultInstance = new Instance("defaultInstance", InstanceArgs.builder()        
            .cenInstanceName("test_name")
            .build());

        var defaultInstanceAttachment = new InstanceAttachment("defaultInstanceAttachment", InstanceAttachmentArgs.builder()        
            .instanceId(defaultInstance.id())
            .childInstanceId("vbr-xxxxx")
            .childInstanceType("VBR")
            .childInstanceRegionId("cn-hangzhou")
            .build());

        var defaultVbrHealthCheck = new VbrHealthCheck("defaultVbrHealthCheck", VbrHealthCheckArgs.builder()        
            .cenId(defaultInstance.id())
            .healthCheckSourceIp("192.168.1.2")
            .healthCheckTargetIp("10.0.0.2")
            .vbrInstanceId("vbr-xxxxx")
            .vbrInstanceRegionId("cn-hangzhou")
            .healthCheckInterval(2)
            .healthyThreshold(8)
            .build(), CustomResourceOptions.builder()
                .dependsOn(defaultInstanceAttachment)
                .build());

    }
}

import pulumi
import pulumi_alicloud as alicloud

# Create a cen vbr HealrhCheck resource and use it.
default_instance = alicloud.cen.Instance("defaultInstance", cen_instance_name="test_name")
default_instance_attachment = alicloud.cen.InstanceAttachment("defaultInstanceAttachment",
    instance_id=default_instance.id,
    child_instance_id="vbr-xxxxx",
    child_instance_type="VBR",
    child_instance_region_id="cn-hangzhou")
default_vbr_health_check = alicloud.cen.VbrHealthCheck("defaultVbrHealthCheck",
    cen_id=default_instance.id,
    health_check_source_ip="192.168.1.2",
    health_check_target_ip="10.0.0.2",
    vbr_instance_id="vbr-xxxxx",
    vbr_instance_region_id="cn-hangzhou",
    health_check_interval=2,
    healthy_threshold=8,
    opts=pulumi.ResourceOptions(depends_on=[default_instance_attachment]))

import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";

// Create a cen vbr HealrhCheck resource and use it.
const defaultInstance = new alicloud.cen.Instance("defaultInstance", {cenInstanceName: "test_name"});
const defaultInstanceAttachment = new alicloud.cen.InstanceAttachment("defaultInstanceAttachment", {
    instanceId: defaultInstance.id,
    childInstanceId: "vbr-xxxxx",
    childInstanceType: "VBR",
    childInstanceRegionId: "cn-hangzhou",
});
const defaultVbrHealthCheck = new alicloud.cen.VbrHealthCheck("defaultVbrHealthCheck", {
    cenId: defaultInstance.id,
    healthCheckSourceIp: "192.168.1.2",
    healthCheckTargetIp: "10.0.0.2",
    vbrInstanceId: "vbr-xxxxx",
    vbrInstanceRegionId: "cn-hangzhou",
    healthCheckInterval: 2,
    healthyThreshold: 8,
}, {
    dependsOn: [defaultInstanceAttachment],
});

resources:
  # Create a cen vbr HealrhCheck resource and use it.
  defaultInstance:
    type: alicloud:cen:Instance
    properties:
      cenInstanceName: test_name
  defaultInstanceAttachment:
    type: alicloud:cen:InstanceAttachment
    properties:
      instanceId: ${defaultInstance.id}
      childInstanceId: vbr-xxxxx
      childInstanceType: VBR
      childInstanceRegionId: cn-hangzhou
  defaultVbrHealthCheck:
    type: alicloud:cen:VbrHealthCheck
    properties:
      cenId: ${defaultInstance.id}
      healthCheckSourceIp: 192.168.1.2
      healthCheckTargetIp: 10.0.0.2
      vbrInstanceId: vbr-xxxxx
      vbrInstanceRegionId: cn-hangzhou
      healthCheckInterval: 2
      healthyThreshold: 8
    options:
      dependson:
        - ${defaultInstanceAttachment}

Create VbrHealthCheck Resource

new VbrHealthCheck(name: string, args: VbrHealthCheckArgs, opts?: CustomResourceOptions);
@overload
def VbrHealthCheck(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   cen_id: Optional[str] = None,
                   health_check_interval: Optional[int] = None,
                   health_check_source_ip: Optional[str] = None,
                   health_check_target_ip: Optional[str] = None,
                   healthy_threshold: Optional[int] = None,
                   vbr_instance_id: Optional[str] = None,
                   vbr_instance_owner_id: Optional[int] = None,
                   vbr_instance_region_id: Optional[str] = None)
@overload
def VbrHealthCheck(resource_name: str,
                   args: VbrHealthCheckArgs,
                   opts: Optional[ResourceOptions] = None)
func NewVbrHealthCheck(ctx *Context, name string, args VbrHealthCheckArgs, opts ...ResourceOption) (*VbrHealthCheck, error)
public VbrHealthCheck(string name, VbrHealthCheckArgs args, CustomResourceOptions? opts = null)
public VbrHealthCheck(String name, VbrHealthCheckArgs args)
public VbrHealthCheck(String name, VbrHealthCheckArgs args, CustomResourceOptions options)

type: alicloud:cen:VbrHealthCheck
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
name string
The unique name of the resource.
args VbrHealthCheckArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args VbrHealthCheckArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args VbrHealthCheckArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args VbrHealthCheckArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args VbrHealthCheckArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

VbrHealthCheck Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The VbrHealthCheck resource accepts the following input properties:

CenId string

The ID of the CEN instance.

HealthCheckTargetIp string

The destination IP address of health checks.

VbrInstanceId string

The ID of the VBR.

VbrInstanceRegionId string

The ID of the region to which the VBR belongs.

HealthCheckInterval int

Specifies the interval at which the health check sends continuous detection packets. Default value: 2. Value range: 2 to 3.

HealthCheckSourceIp string

The source IP address of health checks.

HealthyThreshold int

Specifies the number of probe messages sent by the health check. Default value: 8. Value range: 3 to 8.

VbrInstanceOwnerId int

The ID of the account to which the VBR belongs.

CenId string

The ID of the CEN instance.

HealthCheckTargetIp string

The destination IP address of health checks.

VbrInstanceId string

The ID of the VBR.

VbrInstanceRegionId string

The ID of the region to which the VBR belongs.

HealthCheckInterval int

Specifies the interval at which the health check sends continuous detection packets. Default value: 2. Value range: 2 to 3.

HealthCheckSourceIp string

The source IP address of health checks.

HealthyThreshold int

Specifies the number of probe messages sent by the health check. Default value: 8. Value range: 3 to 8.

VbrInstanceOwnerId int

The ID of the account to which the VBR belongs.

cenId String

The ID of the CEN instance.

healthCheckTargetIp String

The destination IP address of health checks.

vbrInstanceId String

The ID of the VBR.

vbrInstanceRegionId String

The ID of the region to which the VBR belongs.

healthCheckInterval Integer

Specifies the interval at which the health check sends continuous detection packets. Default value: 2. Value range: 2 to 3.

healthCheckSourceIp String

The source IP address of health checks.

healthyThreshold Integer

Specifies the number of probe messages sent by the health check. Default value: 8. Value range: 3 to 8.

vbrInstanceOwnerId Integer

The ID of the account to which the VBR belongs.

cenId string

The ID of the CEN instance.

healthCheckTargetIp string

The destination IP address of health checks.

vbrInstanceId string

The ID of the VBR.

vbrInstanceRegionId string

The ID of the region to which the VBR belongs.

healthCheckInterval number

Specifies the interval at which the health check sends continuous detection packets. Default value: 2. Value range: 2 to 3.

healthCheckSourceIp string

The source IP address of health checks.

healthyThreshold number

Specifies the number of probe messages sent by the health check. Default value: 8. Value range: 3 to 8.

vbrInstanceOwnerId number

The ID of the account to which the VBR belongs.

cen_id str

The ID of the CEN instance.

health_check_target_ip str

The destination IP address of health checks.

vbr_instance_id str

The ID of the VBR.

vbr_instance_region_id str

The ID of the region to which the VBR belongs.

health_check_interval int

Specifies the interval at which the health check sends continuous detection packets. Default value: 2. Value range: 2 to 3.

health_check_source_ip str

The source IP address of health checks.

healthy_threshold int

Specifies the number of probe messages sent by the health check. Default value: 8. Value range: 3 to 8.

vbr_instance_owner_id int

The ID of the account to which the VBR belongs.

cenId String

The ID of the CEN instance.

healthCheckTargetIp String

The destination IP address of health checks.

vbrInstanceId String

The ID of the VBR.

vbrInstanceRegionId String

The ID of the region to which the VBR belongs.

healthCheckInterval Number

Specifies the interval at which the health check sends continuous detection packets. Default value: 2. Value range: 2 to 3.

healthCheckSourceIp String

The source IP address of health checks.

healthyThreshold Number

Specifies the number of probe messages sent by the health check. Default value: 8. Value range: 3 to 8.

vbrInstanceOwnerId Number

The ID of the account to which the VBR belongs.

Outputs

All input properties are implicitly available as output properties. Additionally, the VbrHealthCheck resource produces the following output properties:

Id string

The provider-assigned unique ID for this managed resource.

Id string

The provider-assigned unique ID for this managed resource.

id String

The provider-assigned unique ID for this managed resource.

id string

The provider-assigned unique ID for this managed resource.

id str

The provider-assigned unique ID for this managed resource.

id String

The provider-assigned unique ID for this managed resource.

Look up Existing VbrHealthCheck Resource

Get an existing VbrHealthCheck resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: VbrHealthCheckState, opts?: CustomResourceOptions): VbrHealthCheck
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        cen_id: Optional[str] = None,
        health_check_interval: Optional[int] = None,
        health_check_source_ip: Optional[str] = None,
        health_check_target_ip: Optional[str] = None,
        healthy_threshold: Optional[int] = None,
        vbr_instance_id: Optional[str] = None,
        vbr_instance_owner_id: Optional[int] = None,
        vbr_instance_region_id: Optional[str] = None) -> VbrHealthCheck
func GetVbrHealthCheck(ctx *Context, name string, id IDInput, state *VbrHealthCheckState, opts ...ResourceOption) (*VbrHealthCheck, error)
public static VbrHealthCheck Get(string name, Input<string> id, VbrHealthCheckState? state, CustomResourceOptions? opts = null)
public static VbrHealthCheck get(String name, Output<String> id, VbrHealthCheckState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
CenId string

The ID of the CEN instance.

HealthCheckInterval int

Specifies the interval at which the health check sends continuous detection packets. Default value: 2. Value range: 2 to 3.

HealthCheckSourceIp string

The source IP address of health checks.

HealthCheckTargetIp string

The destination IP address of health checks.

HealthyThreshold int

Specifies the number of probe messages sent by the health check. Default value: 8. Value range: 3 to 8.

VbrInstanceId string

The ID of the VBR.

VbrInstanceOwnerId int

The ID of the account to which the VBR belongs.

VbrInstanceRegionId string

The ID of the region to which the VBR belongs.

CenId string

The ID of the CEN instance.

HealthCheckInterval int

Specifies the interval at which the health check sends continuous detection packets. Default value: 2. Value range: 2 to 3.

HealthCheckSourceIp string

The source IP address of health checks.

HealthCheckTargetIp string

The destination IP address of health checks.

HealthyThreshold int

Specifies the number of probe messages sent by the health check. Default value: 8. Value range: 3 to 8.

VbrInstanceId string

The ID of the VBR.

VbrInstanceOwnerId int

The ID of the account to which the VBR belongs.

VbrInstanceRegionId string

The ID of the region to which the VBR belongs.

cenId String

The ID of the CEN instance.

healthCheckInterval Integer

Specifies the interval at which the health check sends continuous detection packets. Default value: 2. Value range: 2 to 3.

healthCheckSourceIp String

The source IP address of health checks.

healthCheckTargetIp String

The destination IP address of health checks.

healthyThreshold Integer

Specifies the number of probe messages sent by the health check. Default value: 8. Value range: 3 to 8.

vbrInstanceId String

The ID of the VBR.

vbrInstanceOwnerId Integer

The ID of the account to which the VBR belongs.

vbrInstanceRegionId String

The ID of the region to which the VBR belongs.

cenId string

The ID of the CEN instance.

healthCheckInterval number

Specifies the interval at which the health check sends continuous detection packets. Default value: 2. Value range: 2 to 3.

healthCheckSourceIp string

The source IP address of health checks.

healthCheckTargetIp string

The destination IP address of health checks.

healthyThreshold number

Specifies the number of probe messages sent by the health check. Default value: 8. Value range: 3 to 8.

vbrInstanceId string

The ID of the VBR.

vbrInstanceOwnerId number

The ID of the account to which the VBR belongs.

vbrInstanceRegionId string

The ID of the region to which the VBR belongs.

cen_id str

The ID of the CEN instance.

health_check_interval int

Specifies the interval at which the health check sends continuous detection packets. Default value: 2. Value range: 2 to 3.

health_check_source_ip str

The source IP address of health checks.

health_check_target_ip str

The destination IP address of health checks.

healthy_threshold int

Specifies the number of probe messages sent by the health check. Default value: 8. Value range: 3 to 8.

vbr_instance_id str

The ID of the VBR.

vbr_instance_owner_id int

The ID of the account to which the VBR belongs.

vbr_instance_region_id str

The ID of the region to which the VBR belongs.

cenId String

The ID of the CEN instance.

healthCheckInterval Number

Specifies the interval at which the health check sends continuous detection packets. Default value: 2. Value range: 2 to 3.

healthCheckSourceIp String

The source IP address of health checks.

healthCheckTargetIp String

The destination IP address of health checks.

healthyThreshold Number

Specifies the number of probe messages sent by the health check. Default value: 8. Value range: 3 to 8.

vbrInstanceId String

The ID of the VBR.

vbrInstanceOwnerId Number

The ID of the account to which the VBR belongs.

vbrInstanceRegionId String

The ID of the region to which the VBR belongs.

Import

CEN VBR HealthCheck can be imported using the id, e.g.

 $ pulumi import alicloud:cen/vbrHealthCheck:VbrHealthCheck example vbr-xxxxx:cn-hangzhou

Package Details

Repository
Alibaba Cloud pulumi/pulumi-alicloud
License
Apache-2.0
Notes

This Pulumi package is based on the alicloud Terraform Provider.