Class SiteConnection

Manages a V2 Neutron IPSec site connection resource within OpenStack.

Example Usage

using Pulumi;
using OpenStack = Pulumi.OpenStack;

class MyStack : Stack
{
public MyStack()
{
    var conn1 = new OpenStack.VPNaaS.SiteConnection(&quot;conn1&quot;, new OpenStack.VPNaaS.SiteConnectionArgs
    {
        IkepolicyId = openstack_vpnaas_ike_policy_v2.Policy_2.Id,
        IpsecpolicyId = openstack_vpnaas_ipsec_policy_v2.Policy_1.Id,
        LocalEpGroupId = openstack_vpnaas_endpoint_group_v2.Group_2.Id,
        PeerAddress = &quot;192.168.10.1&quot;,
        PeerEpGroupId = openstack_vpnaas_endpoint_group_v2.Group_1.Id,
        Psk = &quot;secret&quot;,
        VpnserviceId = openstack_vpnaas_service_v2.Service_1.Id,
    });
}

}

Inheritance

System.Object

Resource

CustomResource

SiteConnection

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.OpenStack.VPNaaS

Assembly: Pulumi.OpenStack.dll

Syntax

public class SiteConnection : CustomResource

Constructors

View Source

SiteConnection(String, SiteConnectionArgs, CustomResourceOptions)

Create a SiteConnection resource with the given unique name, arguments, and options.

Declaration

public SiteConnection(string name, SiteConnectionArgs args, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
SiteConnectionArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

View Source

AdminStateUp

The administrative state of the resource. Can either be up(true) or down(false). Changing this updates the administrative state of the existing connection.

Declaration

public Output<bool?> AdminStateUp { get; }

Property Value

Type	Description
Output<System.Nullable<System.Boolean>>

View Source

Description

The human-readable description for the connection. Changing this updates the description of the existing connection.

Declaration

public Output<string> Description { get; }

Property Value

Type	Description
Output<System.String>

View Source

Dpds

A dictionary with dead peer detection (DPD) protocol controls.

action - (Optional) The dead peer detection (DPD) action. A valid value is clear, hold, restart, disabled, or restart-by-peer. Default value is hold.

Declaration

public Output<ImmutableArray<SiteConnectionDpd>> Dpds { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<SiteConnectionDpd>>

View Source

IkepolicyId

The ID of the IKE policy. Changing this creates a new connection.

Declaration

public Output<string> IkepolicyId { get; }

Property Value

Type	Description
Output<System.String>

View Source

Initiator

A valid value is response-only or bi-directional. Default is bi-directional.

Declaration

public Output<string> Initiator { get; }

Property Value

Type	Description
Output<System.String>

View Source

IpsecpolicyId

The ID of the IPsec policy. Changing this creates a new connection.

Declaration

public Output<string> IpsecpolicyId { get; }

Property Value

Type	Description
Output<System.String>

View Source

LocalEpGroupId

The ID for the endpoint group that contains private subnets for the local side of the connection. You must specify this parameter with the peer_ep_group_id parameter unless in backward- compatible mode where peer_cidrs is provided with a subnet_id for the VPN service. Changing this updates the existing connection.

Declaration

public Output<string> LocalEpGroupId { get; }

Property Value

Type	Description
Output<System.String>

View Source

LocalId

An ID to be used instead of the external IP address for a virtual router used in traffic between instances on different networks in east-west traffic. Most often, local ID would be domain name, email address, etc. If this is not configured then the external IP address will be used as the ID.

Declaration

public Output<string> LocalId { get; }

Property Value

Type	Description
Output<System.String>

View Source

Mtu

The maximum transmission unit (MTU) value to address fragmentation. Minimum value is 68 for IPv4, and 1280 for IPv6.

Declaration

public Output<int> Mtu { get; }

Property Value

Type	Description
Output<System.Int32>

View Source

Name

The name of the connection. Changing this updates the name of the existing connection.

Declaration

public Output<string> Name { get; }

Property Value

Type	Description
Output<System.String>

View Source

PeerAddress

The peer gateway public IPv4 or IPv6 address or FQDN.

Declaration

public Output<string> PeerAddress { get; }

Property Value

Type	Description
Output<System.String>

View Source

PeerCidrs

Unique list of valid peer private CIDRs in the form < net_address > / < prefix > .

Declaration

public Output<ImmutableArray<string>> PeerCidrs { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>

View Source

PeerEpGroupId

The ID for the endpoint group that contains private CIDRs in the form < net_address > / < prefix > for the peer side of the connection. You must specify this parameter with the local_ep_group_id parameter unless in backward-compatible mode where peer_cidrs is provided with a subnet_id for the VPN service.

Declaration

public Output<string> PeerEpGroupId { get; }

Property Value

Type	Description
Output<System.String>

View Source

PeerId

The peer router identity for authentication. A valid value is an IPv4 address, IPv6 address, e-mail address, key ID, or FQDN. Typically, this value matches the peer_address value. Changing this updates the existing policy.

Declaration

public Output<string> PeerId { get; }

Property Value

Type	Description
Output<System.String>

View Source

Psk

The pre-shared key. A valid value is any string.

Declaration

public Output<string> Psk { get; }

Property Value

Type	Description
Output<System.String>

View Source

Region

The region in which to obtain the V2 Networking client. A Networking client is needed to create an IPSec site connection. If omitted, the region argument of the provider is used. Changing this creates a new site connection.

Declaration

public Output<string> Region { get; }

Property Value

Type	Description
Output<System.String>

View Source

TenantId

The owner of the connection. Required if admin wants to create a connection for another project. Changing this creates a new connection.

Declaration

public Output<string> TenantId { get; }

Property Value

Type	Description
Output<System.String>

View Source

ValueSpecs

Map of additional options.

Declaration

public Output<ImmutableDictionary<string, object>> ValueSpecs { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableDictionary<System.String, System.Object>>

View Source

VpnserviceId

The ID of the VPN service. Changing this creates a new connection.

Declaration

public Output<string> VpnserviceId { get; }

Property Value

Type	Description
Output<System.String>

Methods

View Source

Get(String, Input<String>, SiteConnectionState, CustomResourceOptions)

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

Declaration

public static SiteConnection Get(string name, Input<string> id, SiteConnectionState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
SiteConnectionState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
SiteConnection