Service

Manages a V2 Neutron VPN service resource within OpenStack.

Example Usage

using Pulumi;
using OpenStack = Pulumi.OpenStack;

class MyStack : Stack
{
    public MyStack()
    {
        var service1 = new OpenStack.VPNaaS.Service("service1", new OpenStack.VPNaaS.ServiceArgs
        {
            AdminStateUp = true,
            RouterId = "14a75700-fc03-4602-9294-26ee44f366b3",
        });
    }

}

Coming soon!

import pulumi
import pulumi_openstack as openstack

service1 = openstack.vpnaas.Service("service1",
    admin_state_up="true",
    router_id="14a75700-fc03-4602-9294-26ee44f366b3")

import * as pulumi from "@pulumi/pulumi";
import * as openstack from "@pulumi/openstack";

const service1 = new openstack.vpnaas.Service("service_1", {
    adminStateUp: true,
    routerId: "14a75700-fc03-4602-9294-26ee44f366b3",
});

Create a Service Resource

new Service(name: string, args: ServiceArgs, opts?: CustomResourceOptions);

def Service(resource_name, opts=None, admin_state_up=None, description=None, name=None, region=None, router_id=None, subnet_id=None, tenant_id=None, value_specs=None, __props__=None);

func NewService(ctx *Context, name string, args ServiceArgs, opts ...ResourceOption) (*Service, error)

public Service(string name, ServiceArgs args, CustomResourceOptions? opts = null)

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

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

Service Resource Properties

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

Inputs

The Service resource accepts the following input properties:

RouterId string: The ID of the router. Changing this creates a new service.
AdminStateUp bool: The administrative state of the resource. Can either be up(true) or down(false). Changing this updates the administrative state of the existing service.
Description string: The human-readable description for the service. Changing this updates the description of the existing service.
Name string: The name of the service. Changing this updates the name of the existing service.
Region string: The region in which to obtain the V2 Networking client. A Networking client is needed to create a VPN service. If omitted, the region argument of the provider is used. Changing this creates a new service.
SubnetId string: SubnetID is the ID of the subnet. Default is null.
TenantId string: The owner of the service. Required if admin wants to create a service for another project. Changing this creates a new service.
ValueSpecs Dictionary<string, object>: Map of additional options.

RouterId string: The ID of the router. Changing this creates a new service.
AdminStateUp bool: The administrative state of the resource. Can either be up(true) or down(false). Changing this updates the administrative state of the existing service.
Description string: The human-readable description for the service. Changing this updates the description of the existing service.
Name string: The name of the service. Changing this updates the name of the existing service.
Region string: The region in which to obtain the V2 Networking client. A Networking client is needed to create a VPN service. If omitted, the region argument of the provider is used. Changing this creates a new service.
SubnetId string: SubnetID is the ID of the subnet. Default is null.
TenantId string: The owner of the service. Required if admin wants to create a service for another project. Changing this creates a new service.
ValueSpecs map[string]interface{}: Map of additional options.

routerId string: The ID of the router. Changing this creates a new service.
adminStateUp boolean: The administrative state of the resource. Can either be up(true) or down(false). Changing this updates the administrative state of the existing service.
description string: The human-readable description for the service. Changing this updates the description of the existing service.
name string: The name of the service. Changing this updates the name of the existing service.
region string: The region in which to obtain the V2 Networking client. A Networking client is needed to create a VPN service. If omitted, the region argument of the provider is used. Changing this creates a new service.
subnetId string: SubnetID is the ID of the subnet. Default is null.
tenantId string: The owner of the service. Required if admin wants to create a service for another project. Changing this creates a new service.
valueSpecs {[key: string]: any}: Map of additional options.

router_id str: The ID of the router. Changing this creates a new service.
admin_state_up bool: The administrative state of the resource. Can either be up(true) or down(false). Changing this updates the administrative state of the existing service.
description str: The human-readable description for the service. Changing this updates the description of the existing service.
name str: The name of the service. Changing this updates the name of the existing service.
region str: The region in which to obtain the V2 Networking client. A Networking client is needed to create a VPN service. If omitted, the region argument of the provider is used. Changing this creates a new service.
subnet_id str: SubnetID is the ID of the subnet. Default is null.
tenant_id str: The owner of the service. Required if admin wants to create a service for another project. Changing this creates a new service.
value_specs Dict[str, Any]: Map of additional options.

Outputs

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

ExternalV4Ip string: The read-only external (public) IPv4 address that is used for the VPN service.
ExternalV6Ip string: The read-only external (public) IPv6 address that is used for the VPN service.
Id string: The provider-assigned unique ID for this managed resource.
Status string: Indicates whether IPsec VPN service is currently operational. Values are ACTIVE, DOWN, BUILD, ERROR, PENDING_CREATE, PENDING_UPDATE, or PENDING_DELETE.

ExternalV4Ip string: The read-only external (public) IPv4 address that is used for the VPN service.
ExternalV6Ip string: The read-only external (public) IPv6 address that is used for the VPN service.
Id string: The provider-assigned unique ID for this managed resource.
Status string: Indicates whether IPsec VPN service is currently operational. Values are ACTIVE, DOWN, BUILD, ERROR, PENDING_CREATE, PENDING_UPDATE, or PENDING_DELETE.

externalV4Ip string: The read-only external (public) IPv4 address that is used for the VPN service.
externalV6Ip string: The read-only external (public) IPv6 address that is used for the VPN service.
id string: The provider-assigned unique ID for this managed resource.
status string: Indicates whether IPsec VPN service is currently operational. Values are ACTIVE, DOWN, BUILD, ERROR, PENDING_CREATE, PENDING_UPDATE, or PENDING_DELETE.

external_v4_ip str: The read-only external (public) IPv4 address that is used for the VPN service.
external_v6_ip str: The read-only external (public) IPv6 address that is used for the VPN service.
id str: The provider-assigned unique ID for this managed resource.
status str: Indicates whether IPsec VPN service is currently operational. Values are ACTIVE, DOWN, BUILD, ERROR, PENDING_CREATE, PENDING_UPDATE, or PENDING_DELETE.

Look up an Existing Service Resource

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

static get(resource_name, id, opts=None, admin_state_up=None, description=None, external_v4_ip=None, external_v6_ip=None, name=None, region=None, router_id=None, status=None, subnet_id=None, tenant_id=None, value_specs=None, __props__=None);

func GetService(ctx *Context, name string, id IDInput, state *ServiceState, opts ...ResourceOption) (*Service, error)

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

AdminStateUp bool: The administrative state of the resource. Can either be up(true) or down(false). Changing this updates the administrative state of the existing service.
Description string: The human-readable description for the service. Changing this updates the description of the existing service.
ExternalV4Ip string: The read-only external (public) IPv4 address that is used for the VPN service.
ExternalV6Ip string: The read-only external (public) IPv6 address that is used for the VPN service.
Name string: The name of the service. Changing this updates the name of the existing service.
Region string: The region in which to obtain the V2 Networking client. A Networking client is needed to create a VPN service. If omitted, the region argument of the provider is used. Changing this creates a new service.
RouterId string: The ID of the router. Changing this creates a new service.
Status string: Indicates whether IPsec VPN service is currently operational. Values are ACTIVE, DOWN, BUILD, ERROR, PENDING_CREATE, PENDING_UPDATE, or PENDING_DELETE.
SubnetId string: SubnetID is the ID of the subnet. Default is null.
TenantId string: The owner of the service. Required if admin wants to create a service for another project. Changing this creates a new service.
ValueSpecs Dictionary<string, object>: Map of additional options.

AdminStateUp bool: The administrative state of the resource. Can either be up(true) or down(false). Changing this updates the administrative state of the existing service.
Description string: The human-readable description for the service. Changing this updates the description of the existing service.
ExternalV4Ip string: The read-only external (public) IPv4 address that is used for the VPN service.
ExternalV6Ip string: The read-only external (public) IPv6 address that is used for the VPN service.
Name string: The name of the service. Changing this updates the name of the existing service.
Region string: The region in which to obtain the V2 Networking client. A Networking client is needed to create a VPN service. If omitted, the region argument of the provider is used. Changing this creates a new service.
RouterId string: The ID of the router. Changing this creates a new service.
Status string: Indicates whether IPsec VPN service is currently operational. Values are ACTIVE, DOWN, BUILD, ERROR, PENDING_CREATE, PENDING_UPDATE, or PENDING_DELETE.
SubnetId string: SubnetID is the ID of the subnet. Default is null.
TenantId string: The owner of the service. Required if admin wants to create a service for another project. Changing this creates a new service.
ValueSpecs map[string]interface{}: Map of additional options.

adminStateUp boolean: The administrative state of the resource. Can either be up(true) or down(false). Changing this updates the administrative state of the existing service.
description string: The human-readable description for the service. Changing this updates the description of the existing service.
externalV4Ip string: The read-only external (public) IPv4 address that is used for the VPN service.
externalV6Ip string: The read-only external (public) IPv6 address that is used for the VPN service.
name string: The name of the service. Changing this updates the name of the existing service.
region string: The region in which to obtain the V2 Networking client. A Networking client is needed to create a VPN service. If omitted, the region argument of the provider is used. Changing this creates a new service.
routerId string: The ID of the router. Changing this creates a new service.
status string: Indicates whether IPsec VPN service is currently operational. Values are ACTIVE, DOWN, BUILD, ERROR, PENDING_CREATE, PENDING_UPDATE, or PENDING_DELETE.
subnetId string: SubnetID is the ID of the subnet. Default is null.
tenantId string: The owner of the service. Required if admin wants to create a service for another project. Changing this creates a new service.
valueSpecs {[key: string]: any}: Map of additional options.

admin_state_up bool: The administrative state of the resource. Can either be up(true) or down(false). Changing this updates the administrative state of the existing service.
description str: The human-readable description for the service. Changing this updates the description of the existing service.
external_v4_ip str: The read-only external (public) IPv4 address that is used for the VPN service.
external_v6_ip str: The read-only external (public) IPv6 address that is used for the VPN service.
name str: The name of the service. Changing this updates the name of the existing service.
region str: The region in which to obtain the V2 Networking client. A Networking client is needed to create a VPN service. If omitted, the region argument of the provider is used. Changing this creates a new service.
router_id str: The ID of the router. Changing this creates a new service.
status str: Indicates whether IPsec VPN service is currently operational. Values are ACTIVE, DOWN, BUILD, ERROR, PENDING_CREATE, PENDING_UPDATE, or PENDING_DELETE.
subnet_id str: SubnetID is the ID of the subnet. Default is null.
tenant_id str: The owner of the service. Required if admin wants to create a service for another project. Changing this creates a new service.
value_specs Dict[str, Any]: Map of additional options.

Package Details

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

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud