1. Packages
  2. Alibaba Cloud Provider
  3. API Docs
  4. vpc
  5. VbrHa
Alibaba Cloud v3.76.0 published on Tuesday, Apr 8, 2025 by Pulumi

alicloud.vpc.VbrHa

Explore with Pulumi AI

Provides a VPC Vbr Ha resource.

For information about VPC Vbr Ha and how to use it, see What is Vbr Ha.

NOTE: Available since v1.151.0.

Create VbrHa Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new VbrHa(name: string, args: VbrHaArgs, opts?: CustomResourceOptions);
@overload
def VbrHa(resource_name: str,
          args: VbrHaArgs,
          opts: Optional[ResourceOptions] = None)

@overload
def VbrHa(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          peer_vbr_id: Optional[str] = None,
          vbr_id: Optional[str] = None,
          description: Optional[str] = None,
          dry_run: Optional[bool] = None,
          vbr_ha_name: Optional[str] = None)
func NewVbrHa(ctx *Context, name string, args VbrHaArgs, opts ...ResourceOption) (*VbrHa, error)
public VbrHa(string name, VbrHaArgs args, CustomResourceOptions? opts = null)
public VbrHa(String name, VbrHaArgs args)
public VbrHa(String name, VbrHaArgs args, CustomResourceOptions options)
type: alicloud:vpc:VbrHa
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. VbrHaArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. VbrHaArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. VbrHaArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. VbrHaArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. VbrHaArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var vbrHaResource = new AliCloud.Vpc.VbrHa("vbrHaResource", new()
{
    PeerVbrId = "string",
    VbrId = "string",
    Description = "string",
    DryRun = false,
    VbrHaName = "string",
});
Copy
example, err := vpc.NewVbrHa(ctx, "vbrHaResource", &vpc.VbrHaArgs{
	PeerVbrId:   pulumi.String("string"),
	VbrId:       pulumi.String("string"),
	Description: pulumi.String("string"),
	DryRun:      pulumi.Bool(false),
	VbrHaName:   pulumi.String("string"),
})
Copy
var vbrHaResource = new VbrHa("vbrHaResource", VbrHaArgs.builder()
    .peerVbrId("string")
    .vbrId("string")
    .description("string")
    .dryRun(false)
    .vbrHaName("string")
    .build());
Copy
vbr_ha_resource = alicloud.vpc.VbrHa("vbrHaResource",
    peer_vbr_id="string",
    vbr_id="string",
    description="string",
    dry_run=False,
    vbr_ha_name="string")
Copy
const vbrHaResource = new alicloud.vpc.VbrHa("vbrHaResource", {
    peerVbrId: "string",
    vbrId: "string",
    description: "string",
    dryRun: false,
    vbrHaName: "string",
});
Copy
type: alicloud:vpc:VbrHa
properties:
    description: string
    dryRun: false
    peerVbrId: string
    vbrHaName: string
    vbrId: string
Copy

VbrHa Resource Properties

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

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The VbrHa resource accepts the following input properties:

PeerVbrId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the other VBR in the VBR failover group.
VbrId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the VBR instance.
Description Changes to this property will trigger replacement. string
The description of the VBR switching group. It must be 2 to 256 characters in length and must start with a letter or Chinese, but cannot start with https:// or https://.
DryRun bool
The dry run.
VbrHaName Changes to this property will trigger replacement. string
The name of the VBR failover group.
PeerVbrId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the other VBR in the VBR failover group.
VbrId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the VBR instance.
Description Changes to this property will trigger replacement. string
The description of the VBR switching group. It must be 2 to 256 characters in length and must start with a letter or Chinese, but cannot start with https:// or https://.
DryRun bool
The dry run.
VbrHaName Changes to this property will trigger replacement. string
The name of the VBR failover group.
peerVbrId
This property is required.
Changes to this property will trigger replacement.
String
The ID of the other VBR in the VBR failover group.
vbrId
This property is required.
Changes to this property will trigger replacement.
String
The ID of the VBR instance.
description Changes to this property will trigger replacement. String
The description of the VBR switching group. It must be 2 to 256 characters in length and must start with a letter or Chinese, but cannot start with https:// or https://.
dryRun Boolean
The dry run.
vbrHaName Changes to this property will trigger replacement. String
The name of the VBR failover group.
peerVbrId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the other VBR in the VBR failover group.
vbrId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the VBR instance.
description Changes to this property will trigger replacement. string
The description of the VBR switching group. It must be 2 to 256 characters in length and must start with a letter or Chinese, but cannot start with https:// or https://.
dryRun boolean
The dry run.
vbrHaName Changes to this property will trigger replacement. string
The name of the VBR failover group.
peer_vbr_id
This property is required.
Changes to this property will trigger replacement.
str
The ID of the other VBR in the VBR failover group.
vbr_id
This property is required.
Changes to this property will trigger replacement.
str
The ID of the VBR instance.
description Changes to this property will trigger replacement. str
The description of the VBR switching group. It must be 2 to 256 characters in length and must start with a letter or Chinese, but cannot start with https:// or https://.
dry_run bool
The dry run.
vbr_ha_name Changes to this property will trigger replacement. str
The name of the VBR failover group.
peerVbrId
This property is required.
Changes to this property will trigger replacement.
String
The ID of the other VBR in the VBR failover group.
vbrId
This property is required.
Changes to this property will trigger replacement.
String
The ID of the VBR instance.
description Changes to this property will trigger replacement. String
The description of the VBR switching group. It must be 2 to 256 characters in length and must start with a letter or Chinese, but cannot start with https:// or https://.
dryRun Boolean
The dry run.
vbrHaName Changes to this property will trigger replacement. String
The name of the VBR failover group.

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
Status string
The state of the VBR failover group.
Id string
The provider-assigned unique ID for this managed resource.
Status string
The state of the VBR failover group.
id String
The provider-assigned unique ID for this managed resource.
status String
The state of the VBR failover group.
id string
The provider-assigned unique ID for this managed resource.
status string
The state of the VBR failover group.
id str
The provider-assigned unique ID for this managed resource.
status str
The state of the VBR failover group.
id String
The provider-assigned unique ID for this managed resource.
status String
The state of the VBR failover group.

Look up Existing VbrHa Resource

Get an existing VbrHa 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?: VbrHaState, opts?: CustomResourceOptions): VbrHa
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        dry_run: Optional[bool] = None,
        peer_vbr_id: Optional[str] = None,
        status: Optional[str] = None,
        vbr_ha_name: Optional[str] = None,
        vbr_id: Optional[str] = None) -> VbrHa
func GetVbrHa(ctx *Context, name string, id IDInput, state *VbrHaState, opts ...ResourceOption) (*VbrHa, error)
public static VbrHa Get(string name, Input<string> id, VbrHaState? state, CustomResourceOptions? opts = null)
public static VbrHa get(String name, Output<String> id, VbrHaState state, CustomResourceOptions options)
resources:  _:    type: alicloud:vpc:VbrHa    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
Description Changes to this property will trigger replacement. string
The description of the VBR switching group. It must be 2 to 256 characters in length and must start with a letter or Chinese, but cannot start with https:// or https://.
DryRun bool
The dry run.
PeerVbrId Changes to this property will trigger replacement. string
The ID of the other VBR in the VBR failover group.
Status string
The state of the VBR failover group.
VbrHaName Changes to this property will trigger replacement. string
The name of the VBR failover group.
VbrId Changes to this property will trigger replacement. string
The ID of the VBR instance.
Description Changes to this property will trigger replacement. string
The description of the VBR switching group. It must be 2 to 256 characters in length and must start with a letter or Chinese, but cannot start with https:// or https://.
DryRun bool
The dry run.
PeerVbrId Changes to this property will trigger replacement. string
The ID of the other VBR in the VBR failover group.
Status string
The state of the VBR failover group.
VbrHaName Changes to this property will trigger replacement. string
The name of the VBR failover group.
VbrId Changes to this property will trigger replacement. string
The ID of the VBR instance.
description Changes to this property will trigger replacement. String
The description of the VBR switching group. It must be 2 to 256 characters in length and must start with a letter or Chinese, but cannot start with https:// or https://.
dryRun Boolean
The dry run.
peerVbrId Changes to this property will trigger replacement. String
The ID of the other VBR in the VBR failover group.
status String
The state of the VBR failover group.
vbrHaName Changes to this property will trigger replacement. String
The name of the VBR failover group.
vbrId Changes to this property will trigger replacement. String
The ID of the VBR instance.
description Changes to this property will trigger replacement. string
The description of the VBR switching group. It must be 2 to 256 characters in length and must start with a letter or Chinese, but cannot start with https:// or https://.
dryRun boolean
The dry run.
peerVbrId Changes to this property will trigger replacement. string
The ID of the other VBR in the VBR failover group.
status string
The state of the VBR failover group.
vbrHaName Changes to this property will trigger replacement. string
The name of the VBR failover group.
vbrId Changes to this property will trigger replacement. string
The ID of the VBR instance.
description Changes to this property will trigger replacement. str
The description of the VBR switching group. It must be 2 to 256 characters in length and must start with a letter or Chinese, but cannot start with https:// or https://.
dry_run bool
The dry run.
peer_vbr_id Changes to this property will trigger replacement. str
The ID of the other VBR in the VBR failover group.
status str
The state of the VBR failover group.
vbr_ha_name Changes to this property will trigger replacement. str
The name of the VBR failover group.
vbr_id Changes to this property will trigger replacement. str
The ID of the VBR instance.
description Changes to this property will trigger replacement. String
The description of the VBR switching group. It must be 2 to 256 characters in length and must start with a letter or Chinese, but cannot start with https:// or https://.
dryRun Boolean
The dry run.
peerVbrId Changes to this property will trigger replacement. String
The ID of the other VBR in the VBR failover group.
status String
The state of the VBR failover group.
vbrHaName Changes to this property will trigger replacement. String
The name of the VBR failover group.
vbrId Changes to this property will trigger replacement. String
The ID of the VBR instance.

Import

VPC Vbr Ha can be imported using the id, e.g.

$ pulumi import alicloud:vpc/vbrHa:VbrHa example <id>
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
Alibaba Cloud pulumi/pulumi-alicloud
License
Apache-2.0
Notes
This Pulumi package is based on the alicloud Terraform Provider.