Package com.pulumi.openstack.vpnaas

Class SiteConnection

  • public class SiteConnection
extends com.pulumi.resources.CustomResource
    Manages a V2 Neutron IPSec site connection resource within OpenStack. ## Example Usage ```java package generated_program; import com.pulumi.Context; import com.pulumi.Pulumi; import com.pulumi.core.Output; import com.pulumi.openstack.vpnaas.SiteConnection; import com.pulumi.openstack.vpnaas.SiteConnectionArgs; import com.pulumi.openstack.vpnaas.inputs.SiteConnectionDpdArgs; 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 conn1 = new SiteConnection("conn1", SiteConnectionArgs.builder() .ikepolicyId(openstack_vpnaas_ike_policy_v2.policy_2().id()) .ipsecpolicyId(openstack_vpnaas_ipsec_policy_v2.policy_1().id()) .vpnserviceId(openstack_vpnaas_service_v2.service_1().id()) .psk("secret") .peerAddress("192.168.10.1") .localEpGroupId(openstack_vpnaas_endpoint_group_v2.group_2().id()) .peerEpGroupId(openstack_vpnaas_endpoint_group_v2.group_1().id()) .dpds(SiteConnectionDpdArgs.builder() .action("restart") .timeout(42) .interval(21) .build()) .build()); } } ``` ## Import Site Connections can be imported using the `id`, e.g. ```sh $ pulumi import openstack:vpnaas/siteConnection:SiteConnection conn_1 832cb7f3-59fe-40cf-8f64-8350ffc03272 ```

    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

        com.pulumi.resources.CustomResource.CustomResourceInternal

      • Nested classes/interfaces inherited from class com.pulumi.resources.Resource

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal

    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> adminStateUp()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> description()  
      com.pulumi.core.Output<java.util.List<SiteConnectionDpd>> dpds()  
      static SiteConnection get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, SiteConnectionState state, com.pulumi.resources.CustomResourceOptions options)
      Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
      com.pulumi.core.Output<java.lang.String> ikepolicyId()  
      com.pulumi.core.Output<java.lang.String> initiator()  
      com.pulumi.core.Output<java.lang.String> ipsecpolicyId()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> localEpGroupId()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> localId()  
      com.pulumi.core.Output<java.lang.Integer> mtu()  
      com.pulumi.core.Output<java.lang.String> name()  
      com.pulumi.core.Output<java.lang.String> peerAddress()  
      com.pulumi.core.Output<java.util.Optional<java.util.List<java.lang.String>>> peerCidrs()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> peerEpGroupId()  
      com.pulumi.core.Output<java.lang.String> peerId()  
      com.pulumi.core.Output<java.lang.String> psk()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.lang.String> tenantId()  
      com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.Object>>> valueSpecs()  
      com.pulumi.core.Output<java.lang.String> vpnserviceId()  

      • Methods inherited from class com.pulumi.resources.CustomResource

        getId, id, idFuture

      • Methods inherited from class com.pulumi.resources.Resource

        getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • SiteConnection

        public SiteConnection​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.

      • SiteConnection

        public SiteConnection​(java.lang.String name,
                      SiteConnectionArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.

      • SiteConnection

        public SiteConnection​(java.lang.String name,
                      SiteConnectionArgs args,
                      @Nullable
                      com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.

    • Method Detail

      • adminStateUp

        public com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> adminStateUp()
        Returns:
        The administrative state of the resource. Can either be up(true) or down(false). Changing this updates the administrative state of the existing connection.

      • description

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> description()
        Returns:
        The human-readable description for the connection. Changing this updates the description of the existing connection.

      • dpds

        public com.pulumi.core.Output<java.util.List<SiteConnectionDpd>> dpds()
        Returns:
        A dictionary with dead peer detection (DPD) protocol controls.

      • ikepolicyId

        public com.pulumi.core.Output<java.lang.String> ikepolicyId()
        Returns:
        The ID of the IKE policy. Changing this creates a new connection.

      • initiator

        public com.pulumi.core.Output<java.lang.String> initiator()
        Returns:
        A valid value is response-only or bi-directional. Default is bi-directional.

      • ipsecpolicyId

        public com.pulumi.core.Output<java.lang.String> ipsecpolicyId()
        Returns:
        The ID of the IPsec policy. Changing this creates a new connection.

      • localEpGroupId

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> localEpGroupId()
        Returns:
        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.

      • localId

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> localId()
        Returns:
        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.

      • mtu

        public com.pulumi.core.Output<java.lang.Integer> mtu()
        Returns:
        The maximum transmission unit (MTU) value to address fragmentation. Minimum value is 68 for IPv4, and 1280 for IPv6.

      • name

        public com.pulumi.core.Output<java.lang.String> name()
        Returns:
        The name of the connection. Changing this updates the name of the existing connection.

      • peerAddress

        public com.pulumi.core.Output<java.lang.String> peerAddress()
        Returns:
        The peer gateway public IPv4 or IPv6 address or FQDN.

      • peerCidrs

        public com.pulumi.core.Output<java.util.Optional<java.util.List<java.lang.String>>> peerCidrs()
        Returns:
        Unique list of valid peer private CIDRs in the form < net_address > / < prefix > .

      • peerEpGroupId

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> peerEpGroupId()
        Returns:
        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.

      • peerId

        public com.pulumi.core.Output<java.lang.String> peerId()
        Returns:
        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.

      • psk

        public com.pulumi.core.Output<java.lang.String> psk()
        Returns:
        The pre-shared key. A valid value is any string.

      • region

        public com.pulumi.core.Output<java.lang.String> region()
        Returns:
        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.

      • tenantId

        public com.pulumi.core.Output<java.lang.String> tenantId()
        Returns:
        The owner of the connection. Required if admin wants to create a connection for another project. Changing this creates a new connection.

      • valueSpecs

        public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.Object>>> valueSpecs()
        Returns:
        Map of additional options.

      • vpnserviceId

        public com.pulumi.core.Output<java.lang.String> vpnserviceId()
        Returns:
        The ID of the VPN service. Changing this creates a new connection.

      • get

        public static SiteConnection get​(java.lang.String name,
                                 com.pulumi.core.Output<java.lang.String> id,
                                 @Nullable
                                 SiteConnectionState state,
                                 @Nullable
                                 com.pulumi.resources.CustomResourceOptions options)
        Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
        Parameters:
        name - The _unique_ name of the resulting resource.
        id - The _unique_ provider ID of the resource to lookup.
        state -
        options - Optional settings to control the behavior of the CustomResource.