Connection

Create a Connection Resource

new Connection(name: string, args: ConnectionArgs, opts?: CustomResourceOptions);

def Connection(resource_name, opts=None, customer_gateway_id=None, effect_immediately=None, ike_configs=None, ipsec_configs=None, local_subnets=None, name=None, remote_subnets=None, vpn_gateway_id=None, __props__=None);

func NewConnection(ctx *Context, name string, args ConnectionArgs, opts ...ResourceOption) (*Connection, error)

public Connection(string name, ConnectionArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args ConnectionArgs: 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 ConnectionArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args ConnectionArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

Connection Resource Properties

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

Inputs

The Connection resource accepts the following input properties:

CustomerGatewayId string: The ID of the customer gateway.
LocalSubnets List<string>: The CIDR block of the VPC to be connected with the local data center. This parameter is used for phase-two negotiation.
RemoteSubnets List<string>: The CIDR block of the local data center. This parameter is used for phase-two negotiation.
VpnGatewayId string: The ID of the VPN gateway.
EffectImmediately bool: Whether to delete a successfully negotiated IPsec tunnel and initiate a negotiation again. Valid value:true,false.
IkeConfigs List<Pulumi.AliCloud.Vpn.Inputs.ConnectionIkeConfigArgs>: The configurations of phase-one negotiation.
IpsecConfigs List<Pulumi.AliCloud.Vpn.Inputs.ConnectionIpsecConfigArgs>: The configurations of phase-two negotiation.
Name string: The name of the IPsec connection.

CustomerGatewayId string: The ID of the customer gateway.
LocalSubnets []string: The CIDR block of the VPC to be connected with the local data center. This parameter is used for phase-two negotiation.
RemoteSubnets []string: The CIDR block of the local data center. This parameter is used for phase-two negotiation.
VpnGatewayId string: The ID of the VPN gateway.
EffectImmediately bool: Whether to delete a successfully negotiated IPsec tunnel and initiate a negotiation again. Valid value:true,false.
IkeConfigs []ConnectionIkeConfig: The configurations of phase-one negotiation.
IpsecConfigs []ConnectionIpsecConfig: The configurations of phase-two negotiation.
Name string: The name of the IPsec connection.

customerGatewayId string: The ID of the customer gateway.
localSubnets string[]: The CIDR block of the VPC to be connected with the local data center. This parameter is used for phase-two negotiation.
remoteSubnets string[]: The CIDR block of the local data center. This parameter is used for phase-two negotiation.
vpnGatewayId string: The ID of the VPN gateway.
effectImmediately boolean: Whether to delete a successfully negotiated IPsec tunnel and initiate a negotiation again. Valid value:true,false.
ikeConfigs ConnectionIkeConfig[]: The configurations of phase-one negotiation.
ipsecConfigs ConnectionIpsecConfig[]: The configurations of phase-two negotiation.
name string: The name of the IPsec connection.

customer_gateway_id str: The ID of the customer gateway.
local_subnets List[str]: The CIDR block of the VPC to be connected with the local data center. This parameter is used for phase-two negotiation.
remote_subnets List[str]: The CIDR block of the local data center. This parameter is used for phase-two negotiation.
vpn_gateway_id str: The ID of the VPN gateway.
effect_immediately bool: Whether to delete a successfully negotiated IPsec tunnel and initiate a negotiation again. Valid value:true,false.
ike_configs List[ConnectionIkeConfig]: The configurations of phase-one negotiation.
ipsec_configs List[ConnectionIpsecConfig]: The configurations of phase-two negotiation.
name str: The name of the IPsec connection.

Outputs

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

Id string: The provider-assigned unique ID for this managed resource.
Status string: The status of VPN connection.

Id string: The provider-assigned unique ID for this managed resource.
Status string: The status of VPN connection.

id string: The provider-assigned unique ID for this managed resource.
status string: The status of VPN connection.

id str: The provider-assigned unique ID for this managed resource.
status str: The status of VPN connection.

Look up an Existing Connection Resource

Get an existing Connection 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?: ConnectionState, opts?: CustomResourceOptions): Connection

static get(resource_name, id, opts=None, customer_gateway_id=None, effect_immediately=None, ike_configs=None, ipsec_configs=None, local_subnets=None, name=None, remote_subnets=None, status=None, vpn_gateway_id=None, __props__=None);

func GetConnection(ctx *Context, name string, id IDInput, state *ConnectionState, opts ...ResourceOption) (*Connection, error)

public static Connection Get(string name, Input<string> id, ConnectionState? 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:

CustomerGatewayId string: The ID of the customer gateway.
EffectImmediately bool: Whether to delete a successfully negotiated IPsec tunnel and initiate a negotiation again. Valid value:true,false.
IkeConfigs List<Pulumi.AliCloud.Vpn.Inputs.ConnectionIkeConfigArgs>: The configurations of phase-one negotiation.
IpsecConfigs List<Pulumi.AliCloud.Vpn.Inputs.ConnectionIpsecConfigArgs>: The configurations of phase-two negotiation.
LocalSubnets List<string>: The CIDR block of the VPC to be connected with the local data center. This parameter is used for phase-two negotiation.
Name string: The name of the IPsec connection.
RemoteSubnets List<string>: The CIDR block of the local data center. This parameter is used for phase-two negotiation.
Status string: The status of VPN connection.
VpnGatewayId string: The ID of the VPN gateway.

CustomerGatewayId string: The ID of the customer gateway.
EffectImmediately bool: Whether to delete a successfully negotiated IPsec tunnel and initiate a negotiation again. Valid value:true,false.
IkeConfigs []ConnectionIkeConfig: The configurations of phase-one negotiation.
IpsecConfigs []ConnectionIpsecConfig: The configurations of phase-two negotiation.
LocalSubnets []string: The CIDR block of the VPC to be connected with the local data center. This parameter is used for phase-two negotiation.
Name string: The name of the IPsec connection.
RemoteSubnets []string: The CIDR block of the local data center. This parameter is used for phase-two negotiation.
Status string: The status of VPN connection.
VpnGatewayId string: The ID of the VPN gateway.

customerGatewayId string: The ID of the customer gateway.
effectImmediately boolean: Whether to delete a successfully negotiated IPsec tunnel and initiate a negotiation again. Valid value:true,false.
ikeConfigs ConnectionIkeConfig[]: The configurations of phase-one negotiation.
ipsecConfigs ConnectionIpsecConfig[]: The configurations of phase-two negotiation.
localSubnets string[]: The CIDR block of the VPC to be connected with the local data center. This parameter is used for phase-two negotiation.
name string: The name of the IPsec connection.
remoteSubnets string[]: The CIDR block of the local data center. This parameter is used for phase-two negotiation.
status string: The status of VPN connection.
vpnGatewayId string: The ID of the VPN gateway.

customer_gateway_id str: The ID of the customer gateway.
effect_immediately bool: Whether to delete a successfully negotiated IPsec tunnel and initiate a negotiation again. Valid value:true,false.
ike_configs List[ConnectionIkeConfig]: The configurations of phase-one negotiation.
ipsec_configs List[ConnectionIpsecConfig]: The configurations of phase-two negotiation.
local_subnets List[str]: The CIDR block of the VPC to be connected with the local data center. This parameter is used for phase-two negotiation.
name str: The name of the IPsec connection.
remote_subnets List[str]: The CIDR block of the local data center. This parameter is used for phase-two negotiation.
status str: The status of VPN connection.
vpn_gateway_id str: The ID of the VPN gateway.

Supporting Types

ConnectionIkeConfig

See the input and output API doc for this type.

IkeAuthAlg string: The authentication algorithm of phase-one negotiation. Valid value: md5 | sha1 | sha256 | sha384 | sha512 |. Default value: sha1
IkeEncAlg string: The encryption algorithm of phase-one negotiation. Valid value: aes | aes192 | aes256 | des | 3des. Default Valid value: aes
IkeLifetime int: The SA lifecycle as the result of phase-one negotiation. The valid value of n is [0, 86400], the unit is second and the default value is 86400.
IkeLocalId string: The identification of the VPN gateway.
IkeMode string: The negotiation mode of IKE V1. Valid value: main (main mode) | aggressive (aggressive mode). Default value: main
IkePfs string: The Diffie-Hellman key exchange algorithm used by phase-one negotiation. Valid value: group1 | group2 | group5 | group14 | group24. Default value: group2
IkeRemoteId string: The identification of the customer gateway.
IkeVersion string: The version of the IKE protocol. Valid value: ikev1 | ikev2. Default value: ikev1
Psk string: Used for authentication between the IPsec VPN gateway and the customer gateway.

IkeAuthAlg string: The authentication algorithm of phase-one negotiation. Valid value: md5 | sha1 | sha256 | sha384 | sha512 |. Default value: sha1
IkeEncAlg string: The encryption algorithm of phase-one negotiation. Valid value: aes | aes192 | aes256 | des | 3des. Default Valid value: aes
IkeLifetime int: The SA lifecycle as the result of phase-one negotiation. The valid value of n is [0, 86400], the unit is second and the default value is 86400.
IkeLocalId string: The identification of the VPN gateway.
IkeMode string: The negotiation mode of IKE V1. Valid value: main (main mode) | aggressive (aggressive mode). Default value: main
IkePfs string: The Diffie-Hellman key exchange algorithm used by phase-one negotiation. Valid value: group1 | group2 | group5 | group14 | group24. Default value: group2
IkeRemoteId string: The identification of the customer gateway.
IkeVersion string: The version of the IKE protocol. Valid value: ikev1 | ikev2. Default value: ikev1
Psk string: Used for authentication between the IPsec VPN gateway and the customer gateway.

ikeAuthAlg string: The authentication algorithm of phase-one negotiation. Valid value: md5 | sha1 | sha256 | sha384 | sha512 |. Default value: sha1
ikeEncAlg string: The encryption algorithm of phase-one negotiation. Valid value: aes | aes192 | aes256 | des | 3des. Default Valid value: aes
ikeLifetime number: The SA lifecycle as the result of phase-one negotiation. The valid value of n is [0, 86400], the unit is second and the default value is 86400.
ikeLocalId string: The identification of the VPN gateway.
ikeMode string: The negotiation mode of IKE V1. Valid value: main (main mode) | aggressive (aggressive mode). Default value: main
ikePfs string: The Diffie-Hellman key exchange algorithm used by phase-one negotiation. Valid value: group1 | group2 | group5 | group14 | group24. Default value: group2
ikeRemoteId string: The identification of the customer gateway.
ikeVersion string: The version of the IKE protocol. Valid value: ikev1 | ikev2. Default value: ikev1
psk string: Used for authentication between the IPsec VPN gateway and the customer gateway.

ikeAuthAlg str: The authentication algorithm of phase-one negotiation. Valid value: md5 | sha1 | sha256 | sha384 | sha512 |. Default value: sha1
ikeEncAlg str: The encryption algorithm of phase-one negotiation. Valid value: aes | aes192 | aes256 | des | 3des. Default Valid value: aes
ikeLifetime float: The SA lifecycle as the result of phase-one negotiation. The valid value of n is [0, 86400], the unit is second and the default value is 86400.
ikeLocalId str: The identification of the VPN gateway.
ikeMode str: The negotiation mode of IKE V1. Valid value: main (main mode) | aggressive (aggressive mode). Default value: main
ikePfs str: The Diffie-Hellman key exchange algorithm used by phase-one negotiation. Valid value: group1 | group2 | group5 | group14 | group24. Default value: group2
ikeRemoteId str: The identification of the customer gateway.
ikeVersion str: The version of the IKE protocol. Valid value: ikev1 | ikev2. Default value: ikev1
psk str: Used for authentication between the IPsec VPN gateway and the customer gateway.

ConnectionIpsecConfig

See the input and output API doc for this type.

IpsecAuthAlg string: The authentication algorithm of phase-two negotiation. Valid value: md5 | sha1 | sha256 | sha384 | sha512 |. Default value: sha1
IpsecEncAlg string: The encryption algorithm of phase-two negotiation. Valid value: aes | aes192 | aes256 | des | 3des. Default value: aes
IpsecLifetime int: The SA lifecycle as the result of phase-two negotiation. The valid value is [0, 86400], the unit is second and the default value is 86400.
IpsecPfs string: The Diffie-Hellman key exchange algorithm used by phase-two negotiation. Valid value: group1 | group2 | group5 | group14 | group24| disabled. Default value: group2

IpsecAuthAlg string: The authentication algorithm of phase-two negotiation. Valid value: md5 | sha1 | sha256 | sha384 | sha512 |. Default value: sha1
IpsecEncAlg string: The encryption algorithm of phase-two negotiation. Valid value: aes | aes192 | aes256 | des | 3des. Default value: aes
IpsecLifetime int: The SA lifecycle as the result of phase-two negotiation. The valid value is [0, 86400], the unit is second and the default value is 86400.
IpsecPfs string: The Diffie-Hellman key exchange algorithm used by phase-two negotiation. Valid value: group1 | group2 | group5 | group14 | group24| disabled. Default value: group2

ipsecAuthAlg string: The authentication algorithm of phase-two negotiation. Valid value: md5 | sha1 | sha256 | sha384 | sha512 |. Default value: sha1
ipsecEncAlg string: The encryption algorithm of phase-two negotiation. Valid value: aes | aes192 | aes256 | des | 3des. Default value: aes
ipsecLifetime number: The SA lifecycle as the result of phase-two negotiation. The valid value is [0, 86400], the unit is second and the default value is 86400.
ipsecPfs string: The Diffie-Hellman key exchange algorithm used by phase-two negotiation. Valid value: group1 | group2 | group5 | group14 | group24| disabled. Default value: group2

ipsecAuthAlg str: The authentication algorithm of phase-two negotiation. Valid value: md5 | sha1 | sha256 | sha384 | sha512 |. Default value: sha1
ipsecEncAlg str: The encryption algorithm of phase-two negotiation. Valid value: aes | aes192 | aes256 | des | 3des. Default value: aes
ipsecLifetime float: The SA lifecycle as the result of phase-two negotiation. The valid value is [0, 86400], the unit is second and the default value is 86400.
ipsecPfs str: The Diffie-Hellman key exchange algorithm used by phase-two negotiation. Valid value: group1 | group2 | group5 | group14 | group24| disabled. Default value: group2

Package Details

Repository: https://github.com/pulumi/pulumi-alicloud
License: Apache-2.0
Notes: This Pulumi package is based on the alicloud Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud