RouterInterface
Create a RouterInterface Resource
new RouterInterface(name: string, args: RouterInterfaceArgs, opts?: CustomResourceOptions);def RouterInterface(resource_name, opts=None, description=None, health_check_source_ip=None, health_check_target_ip=None, instance_charge_type=None, name=None, opposite_access_point_id=None, opposite_region=None, period=None, role=None, router_id=None, router_type=None, specification=None, __props__=None);func NewRouterInterface(ctx *Context, name string, args RouterInterfaceArgs, opts ...ResourceOption) (*RouterInterface, error)public RouterInterface(string name, RouterInterfaceArgs args, CustomResourceOptions? opts = null)- name string
- The unique name of the resource.
- args RouterInterfaceArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- opts ResourceOptions
- A bag of options that control this resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args RouterInterfaceArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args RouterInterfaceArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
RouterInterface Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.
Inputs
The RouterInterface resource accepts the following input properties:
- Opposite
Region string The Region of peer side.
- Role string
The role the router interface plays. Optional value:
InitiatingSide,AcceptingSide.- Router
Id string The Router ID.
- Router
Type string Router Type. Optional value: VRouter, VBR. Accepting side router interface type only be VRouter.
- Description string
Description of the router interface. It can be 2-256 characters long or left blank. It cannot start with http:// and https://.
- Health
Check stringSource Ip Used as the Packet Source IP of health check for disaster recovery or ECMP. It is only valid when
router_typeisVBR. The IP must be an unused IP in the local VPC. It andhealth_check_target_ipmust be specified at the same time.- Health
Check stringTarget Ip Used as the Packet Target IP of health check for disaster recovery or ECMP. It is only valid when
router_typeisVBR. The IP must be an unused IP in the local VPC. It andhealth_check_source_ipmust be specified at the same time.- Instance
Charge stringType The billing method of the router interface. Valid values are “PrePaid” and “PostPaid”. Default to “PostPaid”. Router Interface doesn’t support “PrePaid” when region and opposite_region are the same.
- Name string
Name of the router interface. Length must be 2-80 characters long. Only Chinese characters, English letters, numbers, period (.), underline (_), or dash (-) are permitted. If it is not specified, the default value is interface ID. The name cannot start with http:// and https://.
- Opposite
Access stringPoint Id It has been deprecated from version 1.11.0.
- Period int
The duration that you will buy the resource, in month. It is valid when
instance_charge_typeisPrePaid. Default to 1. Valid values: [1-9, 12, 24, 36]. At present, the provider does not support modify “period” and you can do that via web console.- Specification string
Specification of router interfaces. It is valid when
roleisInitiatingSide. Accepting side’s role is default to set as ‘Negative’. For more about the specification, refer to Router interface specification.
- Opposite
Region string The Region of peer side.
- Role string
The role the router interface plays. Optional value:
InitiatingSide,AcceptingSide.- Router
Id string The Router ID.
- Router
Type string Router Type. Optional value: VRouter, VBR. Accepting side router interface type only be VRouter.
- Description string
Description of the router interface. It can be 2-256 characters long or left blank. It cannot start with http:// and https://.
- Health
Check stringSource Ip Used as the Packet Source IP of health check for disaster recovery or ECMP. It is only valid when
router_typeisVBR. The IP must be an unused IP in the local VPC. It andhealth_check_target_ipmust be specified at the same time.- Health
Check stringTarget Ip Used as the Packet Target IP of health check for disaster recovery or ECMP. It is only valid when
router_typeisVBR. The IP must be an unused IP in the local VPC. It andhealth_check_source_ipmust be specified at the same time.- Instance
Charge stringType The billing method of the router interface. Valid values are “PrePaid” and “PostPaid”. Default to “PostPaid”. Router Interface doesn’t support “PrePaid” when region and opposite_region are the same.
- Name string
Name of the router interface. Length must be 2-80 characters long. Only Chinese characters, English letters, numbers, period (.), underline (_), or dash (-) are permitted. If it is not specified, the default value is interface ID. The name cannot start with http:// and https://.
- Opposite
Access stringPoint Id It has been deprecated from version 1.11.0.
- Period int
The duration that you will buy the resource, in month. It is valid when
instance_charge_typeisPrePaid. Default to 1. Valid values: [1-9, 12, 24, 36]. At present, the provider does not support modify “period” and you can do that via web console.- Specification string
Specification of router interfaces. It is valid when
roleisInitiatingSide. Accepting side’s role is default to set as ‘Negative’. For more about the specification, refer to Router interface specification.
- opposite
Region string The Region of peer side.
- role string
The role the router interface plays. Optional value:
InitiatingSide,AcceptingSide.- router
Id string The Router ID.
- router
Type string Router Type. Optional value: VRouter, VBR. Accepting side router interface type only be VRouter.
- description string
Description of the router interface. It can be 2-256 characters long or left blank. It cannot start with http:// and https://.
- health
Check stringSource Ip Used as the Packet Source IP of health check for disaster recovery or ECMP. It is only valid when
router_typeisVBR. The IP must be an unused IP in the local VPC. It andhealth_check_target_ipmust be specified at the same time.- health
Check stringTarget Ip Used as the Packet Target IP of health check for disaster recovery or ECMP. It is only valid when
router_typeisVBR. The IP must be an unused IP in the local VPC. It andhealth_check_source_ipmust be specified at the same time.- instance
Charge stringType The billing method of the router interface. Valid values are “PrePaid” and “PostPaid”. Default to “PostPaid”. Router Interface doesn’t support “PrePaid” when region and opposite_region are the same.
- name string
Name of the router interface. Length must be 2-80 characters long. Only Chinese characters, English letters, numbers, period (.), underline (_), or dash (-) are permitted. If it is not specified, the default value is interface ID. The name cannot start with http:// and https://.
- opposite
Access stringPoint Id It has been deprecated from version 1.11.0.
- period number
The duration that you will buy the resource, in month. It is valid when
instance_charge_typeisPrePaid. Default to 1. Valid values: [1-9, 12, 24, 36]. At present, the provider does not support modify “period” and you can do that via web console.- specification string
Specification of router interfaces. It is valid when
roleisInitiatingSide. Accepting side’s role is default to set as ‘Negative’. For more about the specification, refer to Router interface specification.
- opposite_
region str The Region of peer side.
- role str
The role the router interface plays. Optional value:
InitiatingSide,AcceptingSide.- router_
id str The Router ID.
- router_
type str Router Type. Optional value: VRouter, VBR. Accepting side router interface type only be VRouter.
- description str
Description of the router interface. It can be 2-256 characters long or left blank. It cannot start with http:// and https://.
- health_
check_ strsource_ ip Used as the Packet Source IP of health check for disaster recovery or ECMP. It is only valid when
router_typeisVBR. The IP must be an unused IP in the local VPC. It andhealth_check_target_ipmust be specified at the same time.- health_
check_ strtarget_ ip Used as the Packet Target IP of health check for disaster recovery or ECMP. It is only valid when
router_typeisVBR. The IP must be an unused IP in the local VPC. It andhealth_check_source_ipmust be specified at the same time.- instance_
charge_ strtype The billing method of the router interface. Valid values are “PrePaid” and “PostPaid”. Default to “PostPaid”. Router Interface doesn’t support “PrePaid” when region and opposite_region are the same.
- name str
Name of the router interface. Length must be 2-80 characters long. Only Chinese characters, English letters, numbers, period (.), underline (_), or dash (-) are permitted. If it is not specified, the default value is interface ID. The name cannot start with http:// and https://.
- opposite_
access_ strpoint_ id It has been deprecated from version 1.11.0.
- period float
The duration that you will buy the resource, in month. It is valid when
instance_charge_typeisPrePaid. Default to 1. Valid values: [1-9, 12, 24, 36]. At present, the provider does not support modify “period” and you can do that via web console.- specification str
Specification of router interfaces. It is valid when
roleisInitiatingSide. Accepting side’s role is default to set as ‘Negative’. For more about the specification, refer to Router interface specification.
Outputs
All input properties are implicitly available as output properties. Additionally, the RouterInterface resource produces the following output properties:
- Access
Point stringId It has been deprecated from version 1.11.0.
- Id string
- The provider-assigned unique ID for this managed resource.
- Opposite
Interface stringId It has been deprecated from version 1.11.0. Use resource alicloud_router_interface_connection’s ‘opposite_router_id’ instead.
- Opposite
Interface stringOwner Id It has been deprecated from version 1.11.0. Use resource alicloud_router_interface_connection’s ‘opposite_interface_id’ instead.
- Opposite
Router stringId It has been deprecated from version 1.11.0. Use resource alicloud_router_interface_connection’s ‘opposite_router_id’ instead.
- Opposite
Router stringType It has been deprecated from version 1.11.0. resource alicloud_router_interface_connection’s ‘opposite_router_type’ instead.
- Access
Point stringId It has been deprecated from version 1.11.0.
- Id string
- The provider-assigned unique ID for this managed resource.
- Opposite
Interface stringId It has been deprecated from version 1.11.0. Use resource alicloud_router_interface_connection’s ‘opposite_router_id’ instead.
- Opposite
Interface stringOwner Id It has been deprecated from version 1.11.0. Use resource alicloud_router_interface_connection’s ‘opposite_interface_id’ instead.
- Opposite
Router stringId It has been deprecated from version 1.11.0. Use resource alicloud_router_interface_connection’s ‘opposite_router_id’ instead.
- Opposite
Router stringType It has been deprecated from version 1.11.0. resource alicloud_router_interface_connection’s ‘opposite_router_type’ instead.
- access
Point stringId It has been deprecated from version 1.11.0.
- id string
- The provider-assigned unique ID for this managed resource.
- opposite
Interface stringId It has been deprecated from version 1.11.0. Use resource alicloud_router_interface_connection’s ‘opposite_router_id’ instead.
- opposite
Interface stringOwner Id It has been deprecated from version 1.11.0. Use resource alicloud_router_interface_connection’s ‘opposite_interface_id’ instead.
- opposite
Router stringId It has been deprecated from version 1.11.0. Use resource alicloud_router_interface_connection’s ‘opposite_router_id’ instead.
- opposite
Router stringType It has been deprecated from version 1.11.0. resource alicloud_router_interface_connection’s ‘opposite_router_type’ instead.
- access_
point_ strid It has been deprecated from version 1.11.0.
- id str
- The provider-assigned unique ID for this managed resource.
- opposite_
interface_ strid It has been deprecated from version 1.11.0. Use resource alicloud_router_interface_connection’s ‘opposite_router_id’ instead.
- opposite_
interface_ strowner_ id It has been deprecated from version 1.11.0. Use resource alicloud_router_interface_connection’s ‘opposite_interface_id’ instead.
- opposite_
router_ strid It has been deprecated from version 1.11.0. Use resource alicloud_router_interface_connection’s ‘opposite_router_id’ instead.
- opposite_
router_ strtype It has been deprecated from version 1.11.0. resource alicloud_router_interface_connection’s ‘opposite_router_type’ instead.
Look up an Existing RouterInterface Resource
Get an existing RouterInterface 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?: RouterInterfaceState, opts?: CustomResourceOptions): RouterInterfacestatic get(resource_name, id, opts=None, access_point_id=None, description=None, health_check_source_ip=None, health_check_target_ip=None, instance_charge_type=None, name=None, opposite_access_point_id=None, opposite_interface_id=None, opposite_interface_owner_id=None, opposite_region=None, opposite_router_id=None, opposite_router_type=None, period=None, role=None, router_id=None, router_type=None, specification=None, __props__=None);func GetRouterInterface(ctx *Context, name string, id IDInput, state *RouterInterfaceState, opts ...ResourceOption) (*RouterInterface, error)public static RouterInterface Get(string name, Input<string> id, RouterInterfaceState? state, CustomResourceOptions? opts = null)- 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.
The following state arguments are supported:
- Access
Point stringId It has been deprecated from version 1.11.0.
- Description string
Description of the router interface. It can be 2-256 characters long or left blank. It cannot start with http:// and https://.
- Health
Check stringSource Ip Used as the Packet Source IP of health check for disaster recovery or ECMP. It is only valid when
router_typeisVBR. The IP must be an unused IP in the local VPC. It andhealth_check_target_ipmust be specified at the same time.- Health
Check stringTarget Ip Used as the Packet Target IP of health check for disaster recovery or ECMP. It is only valid when
router_typeisVBR. The IP must be an unused IP in the local VPC. It andhealth_check_source_ipmust be specified at the same time.- Instance
Charge stringType The billing method of the router interface. Valid values are “PrePaid” and “PostPaid”. Default to “PostPaid”. Router Interface doesn’t support “PrePaid” when region and opposite_region are the same.
- Name string
Name of the router interface. Length must be 2-80 characters long. Only Chinese characters, English letters, numbers, period (.), underline (_), or dash (-) are permitted. If it is not specified, the default value is interface ID. The name cannot start with http:// and https://.
- Opposite
Access stringPoint Id It has been deprecated from version 1.11.0.
- Opposite
Interface stringId It has been deprecated from version 1.11.0. Use resource alicloud_router_interface_connection’s ‘opposite_router_id’ instead.
- Opposite
Interface stringOwner Id It has been deprecated from version 1.11.0. Use resource alicloud_router_interface_connection’s ‘opposite_interface_id’ instead.
- Opposite
Region string The Region of peer side.
- Opposite
Router stringId It has been deprecated from version 1.11.0. Use resource alicloud_router_interface_connection’s ‘opposite_router_id’ instead.
- Opposite
Router stringType It has been deprecated from version 1.11.0. resource alicloud_router_interface_connection’s ‘opposite_router_type’ instead.
- Period int
The duration that you will buy the resource, in month. It is valid when
instance_charge_typeisPrePaid. Default to 1. Valid values: [1-9, 12, 24, 36]. At present, the provider does not support modify “period” and you can do that via web console.- Role string
The role the router interface plays. Optional value:
InitiatingSide,AcceptingSide.- Router
Id string The Router ID.
- Router
Type string Router Type. Optional value: VRouter, VBR. Accepting side router interface type only be VRouter.
- Specification string
Specification of router interfaces. It is valid when
roleisInitiatingSide. Accepting side’s role is default to set as ‘Negative’. For more about the specification, refer to Router interface specification.
- Access
Point stringId It has been deprecated from version 1.11.0.
- Description string
Description of the router interface. It can be 2-256 characters long or left blank. It cannot start with http:// and https://.
- Health
Check stringSource Ip Used as the Packet Source IP of health check for disaster recovery or ECMP. It is only valid when
router_typeisVBR. The IP must be an unused IP in the local VPC. It andhealth_check_target_ipmust be specified at the same time.- Health
Check stringTarget Ip Used as the Packet Target IP of health check for disaster recovery or ECMP. It is only valid when
router_typeisVBR. The IP must be an unused IP in the local VPC. It andhealth_check_source_ipmust be specified at the same time.- Instance
Charge stringType The billing method of the router interface. Valid values are “PrePaid” and “PostPaid”. Default to “PostPaid”. Router Interface doesn’t support “PrePaid” when region and opposite_region are the same.
- Name string
Name of the router interface. Length must be 2-80 characters long. Only Chinese characters, English letters, numbers, period (.), underline (_), or dash (-) are permitted. If it is not specified, the default value is interface ID. The name cannot start with http:// and https://.
- Opposite
Access stringPoint Id It has been deprecated from version 1.11.0.
- Opposite
Interface stringId It has been deprecated from version 1.11.0. Use resource alicloud_router_interface_connection’s ‘opposite_router_id’ instead.
- Opposite
Interface stringOwner Id It has been deprecated from version 1.11.0. Use resource alicloud_router_interface_connection’s ‘opposite_interface_id’ instead.
- Opposite
Region string The Region of peer side.
- Opposite
Router stringId It has been deprecated from version 1.11.0. Use resource alicloud_router_interface_connection’s ‘opposite_router_id’ instead.
- Opposite
Router stringType It has been deprecated from version 1.11.0. resource alicloud_router_interface_connection’s ‘opposite_router_type’ instead.
- Period int
The duration that you will buy the resource, in month. It is valid when
instance_charge_typeisPrePaid. Default to 1. Valid values: [1-9, 12, 24, 36]. At present, the provider does not support modify “period” and you can do that via web console.- Role string
The role the router interface plays. Optional value:
InitiatingSide,AcceptingSide.- Router
Id string The Router ID.
- Router
Type string Router Type. Optional value: VRouter, VBR. Accepting side router interface type only be VRouter.
- Specification string
Specification of router interfaces. It is valid when
roleisInitiatingSide. Accepting side’s role is default to set as ‘Negative’. For more about the specification, refer to Router interface specification.
- access
Point stringId It has been deprecated from version 1.11.0.
- description string
Description of the router interface. It can be 2-256 characters long or left blank. It cannot start with http:// and https://.
- health
Check stringSource Ip Used as the Packet Source IP of health check for disaster recovery or ECMP. It is only valid when
router_typeisVBR. The IP must be an unused IP in the local VPC. It andhealth_check_target_ipmust be specified at the same time.- health
Check stringTarget Ip Used as the Packet Target IP of health check for disaster recovery or ECMP. It is only valid when
router_typeisVBR. The IP must be an unused IP in the local VPC. It andhealth_check_source_ipmust be specified at the same time.- instance
Charge stringType The billing method of the router interface. Valid values are “PrePaid” and “PostPaid”. Default to “PostPaid”. Router Interface doesn’t support “PrePaid” when region and opposite_region are the same.
- name string
Name of the router interface. Length must be 2-80 characters long. Only Chinese characters, English letters, numbers, period (.), underline (_), or dash (-) are permitted. If it is not specified, the default value is interface ID. The name cannot start with http:// and https://.
- opposite
Access stringPoint Id It has been deprecated from version 1.11.0.
- opposite
Interface stringId It has been deprecated from version 1.11.0. Use resource alicloud_router_interface_connection’s ‘opposite_router_id’ instead.
- opposite
Interface stringOwner Id It has been deprecated from version 1.11.0. Use resource alicloud_router_interface_connection’s ‘opposite_interface_id’ instead.
- opposite
Region string The Region of peer side.
- opposite
Router stringId It has been deprecated from version 1.11.0. Use resource alicloud_router_interface_connection’s ‘opposite_router_id’ instead.
- opposite
Router stringType It has been deprecated from version 1.11.0. resource alicloud_router_interface_connection’s ‘opposite_router_type’ instead.
- period number
The duration that you will buy the resource, in month. It is valid when
instance_charge_typeisPrePaid. Default to 1. Valid values: [1-9, 12, 24, 36]. At present, the provider does not support modify “period” and you can do that via web console.- role string
The role the router interface plays. Optional value:
InitiatingSide,AcceptingSide.- router
Id string The Router ID.
- router
Type string Router Type. Optional value: VRouter, VBR. Accepting side router interface type only be VRouter.
- specification string
Specification of router interfaces. It is valid when
roleisInitiatingSide. Accepting side’s role is default to set as ‘Negative’. For more about the specification, refer to Router interface specification.
- access_
point_ strid It has been deprecated from version 1.11.0.
- description str
Description of the router interface. It can be 2-256 characters long or left blank. It cannot start with http:// and https://.
- health_
check_ strsource_ ip Used as the Packet Source IP of health check for disaster recovery or ECMP. It is only valid when
router_typeisVBR. The IP must be an unused IP in the local VPC. It andhealth_check_target_ipmust be specified at the same time.- health_
check_ strtarget_ ip Used as the Packet Target IP of health check for disaster recovery or ECMP. It is only valid when
router_typeisVBR. The IP must be an unused IP in the local VPC. It andhealth_check_source_ipmust be specified at the same time.- instance_
charge_ strtype The billing method of the router interface. Valid values are “PrePaid” and “PostPaid”. Default to “PostPaid”. Router Interface doesn’t support “PrePaid” when region and opposite_region are the same.
- name str
Name of the router interface. Length must be 2-80 characters long. Only Chinese characters, English letters, numbers, period (.), underline (_), or dash (-) are permitted. If it is not specified, the default value is interface ID. The name cannot start with http:// and https://.
- opposite_
access_ strpoint_ id It has been deprecated from version 1.11.0.
- opposite_
interface_ strid It has been deprecated from version 1.11.0. Use resource alicloud_router_interface_connection’s ‘opposite_router_id’ instead.
- opposite_
interface_ strowner_ id It has been deprecated from version 1.11.0. Use resource alicloud_router_interface_connection’s ‘opposite_interface_id’ instead.
- opposite_
region str The Region of peer side.
- opposite_
router_ strid It has been deprecated from version 1.11.0. Use resource alicloud_router_interface_connection’s ‘opposite_router_id’ instead.
- opposite_
router_ strtype It has been deprecated from version 1.11.0. resource alicloud_router_interface_connection’s ‘opposite_router_type’ instead.
- period float
The duration that you will buy the resource, in month. It is valid when
instance_charge_typeisPrePaid. Default to 1. Valid values: [1-9, 12, 24, 36]. At present, the provider does not support modify “period” and you can do that via web console.- role str
The role the router interface plays. Optional value:
InitiatingSide,AcceptingSide.- router_
id str The Router ID.
- router_
type str Router Type. Optional value: VRouter, VBR. Accepting side router interface type only be VRouter.
- specification str
Specification of router interfaces. It is valid when
roleisInitiatingSide. Accepting side’s role is default to set as ‘Negative’. For more about the specification, refer to Router interface specification.
Package Details
- Repository
- https://github.com/pulumi/pulumi-alicloud
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
alicloudTerraform Provider.