OpenStack

v3.9.0 published on Thursday, Aug 4, 2022 by Pulumi

EndpointGroup

Manages a V2 Neutron Endpoint Group resource within OpenStack.

Example Usage

using Pulumi;
using OpenStack = Pulumi.OpenStack;

class MyStack : Stack
{
    public MyStack()
    {
        var group1 = new OpenStack.VPNaaS.EndpointGroup("group1", new OpenStack.VPNaaS.EndpointGroupArgs
        {
            Endpoints = 
            {
                "10.2.0.0/24",
                "10.3.0.0/24",
            },
            Type = "cidr",
        });
    }

}
package main

import (
	"github.com/pulumi/pulumi-openstack/sdk/v3/go/openstack/vpnaas"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := vpnaas.NewEndpointGroup(ctx, "group1", &vpnaas.EndpointGroupArgs{
			Endpoints: pulumi.StringArray{
				pulumi.String("10.2.0.0/24"),
				pulumi.String("10.3.0.0/24"),
			},
			Type: pulumi.String("cidr"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.openstack.vpnaas.EndpointGroup;
import com.pulumi.openstack.vpnaas.EndpointGroupArgs;
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 group1 = new EndpointGroup("group1", EndpointGroupArgs.builder()        
            .endpoints(            
                "10.2.0.0/24",
                "10.3.0.0/24")
            .type("cidr")
            .build());

    }
}
import pulumi
import pulumi_openstack as openstack

group1 = openstack.vpnaas.EndpointGroup("group1",
    endpoints=[
        "10.2.0.0/24",
        "10.3.0.0/24",
    ],
    type="cidr")
import * as pulumi from "@pulumi/pulumi";
import * as openstack from "@pulumi/openstack";

const group1 = new openstack.vpnaas.EndpointGroup("group_1", {
    endpoints: [
        "10.2.0.0/24",
        "10.3.0.0/24",
    ],
    type: "cidr",
});
resources:
  group1:
    type: openstack:vpnaas:EndpointGroup
    properties:
      endpoints:
        - 10.2.0.0/24
        - 10.3.0.0/24
      type: cidr

Create EndpointGroup Resource

new EndpointGroup(name: string, args?: EndpointGroupArgs, opts?: CustomResourceOptions);
@overload
def EndpointGroup(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  description: Optional[str] = None,
                  endpoints: Optional[Sequence[str]] = None,
                  name: Optional[str] = None,
                  region: Optional[str] = None,
                  tenant_id: Optional[str] = None,
                  type: Optional[str] = None,
                  value_specs: Optional[Mapping[str, Any]] = None)
@overload
def EndpointGroup(resource_name: str,
                  args: Optional[EndpointGroupArgs] = None,
                  opts: Optional[ResourceOptions] = None)
func NewEndpointGroup(ctx *Context, name string, args *EndpointGroupArgs, opts ...ResourceOption) (*EndpointGroup, error)
public EndpointGroup(string name, EndpointGroupArgs? args = null, CustomResourceOptions? opts = null)
public EndpointGroup(String name, EndpointGroupArgs args)
public EndpointGroup(String name, EndpointGroupArgs args, CustomResourceOptions options)
type: openstack:vpnaas:EndpointGroup
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args EndpointGroupArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args EndpointGroupArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args EndpointGroupArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args EndpointGroupArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args EndpointGroupArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

EndpointGroup Resource Properties

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

Inputs

The EndpointGroup resource accepts the following input properties:

Description string

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

Endpoints List<string>

List of endpoints of the same type, for the endpoint group. The values will depend on the type. Changing this creates a new group.

Name string

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

Region string

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

TenantId string

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

Type string

The type of the endpoints in the group. A valid value is subnet, cidr, network, router, or vlan. Changing this creates a new group.

ValueSpecs Dictionary<string, object>

Map of additional options.

Description string

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

Endpoints []string

List of endpoints of the same type, for the endpoint group. The values will depend on the type. Changing this creates a new group.

Name string

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

Region string

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

TenantId string

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

Type string

The type of the endpoints in the group. A valid value is subnet, cidr, network, router, or vlan. Changing this creates a new group.

ValueSpecs map[string]interface{}

Map of additional options.

description String

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

endpoints List<String>

List of endpoints of the same type, for the endpoint group. The values will depend on the type. Changing this creates a new group.

name String

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

region String

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

tenantId String

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

type String

The type of the endpoints in the group. A valid value is subnet, cidr, network, router, or vlan. Changing this creates a new group.

valueSpecs Map<String,Object>

Map of additional options.

description string

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

endpoints string[]

List of endpoints of the same type, for the endpoint group. The values will depend on the type. Changing this creates a new group.

name string

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

region string

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

tenantId string

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

type string

The type of the endpoints in the group. A valid value is subnet, cidr, network, router, or vlan. Changing this creates a new group.

valueSpecs {[key: string]: any}

Map of additional options.

description str

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

endpoints Sequence[str]

List of endpoints of the same type, for the endpoint group. The values will depend on the type. Changing this creates a new group.

name str

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

region str

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

tenant_id str

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

type str

The type of the endpoints in the group. A valid value is subnet, cidr, network, router, or vlan. Changing this creates a new group.

value_specs Mapping[str, Any]

Map of additional options.

description String

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

endpoints List<String>

List of endpoints of the same type, for the endpoint group. The values will depend on the type. Changing this creates a new group.

name String

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

region String

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

tenantId String

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

type String

The type of the endpoints in the group. A valid value is subnet, cidr, network, router, or vlan. Changing this creates a new group.

valueSpecs Map<Any>

Map of additional options.

Outputs

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

Id string

The provider-assigned unique ID for this managed resource.

Id string

The provider-assigned unique ID for this managed resource.

id String

The provider-assigned unique ID for this managed resource.

id string

The provider-assigned unique ID for this managed resource.

id str

The provider-assigned unique ID for this managed resource.

id String

The provider-assigned unique ID for this managed resource.

Look up Existing EndpointGroup Resource

Get an existing EndpointGroup 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?: EndpointGroupState, opts?: CustomResourceOptions): EndpointGroup
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        endpoints: Optional[Sequence[str]] = None,
        name: Optional[str] = None,
        region: Optional[str] = None,
        tenant_id: Optional[str] = None,
        type: Optional[str] = None,
        value_specs: Optional[Mapping[str, Any]] = None) -> EndpointGroup
func GetEndpointGroup(ctx *Context, name string, id IDInput, state *EndpointGroupState, opts ...ResourceOption) (*EndpointGroup, error)
public static EndpointGroup Get(string name, Input<string> id, EndpointGroupState? state, CustomResourceOptions? opts = null)
public static EndpointGroup get(String name, Output<String> id, EndpointGroupState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
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.
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:
Description string

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

Endpoints List<string>

List of endpoints of the same type, for the endpoint group. The values will depend on the type. Changing this creates a new group.

Name string

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

Region string

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

TenantId string

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

Type string

The type of the endpoints in the group. A valid value is subnet, cidr, network, router, or vlan. Changing this creates a new group.

ValueSpecs Dictionary<string, object>

Map of additional options.

Description string

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

Endpoints []string

List of endpoints of the same type, for the endpoint group. The values will depend on the type. Changing this creates a new group.

Name string

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

Region string

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

TenantId string

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

Type string

The type of the endpoints in the group. A valid value is subnet, cidr, network, router, or vlan. Changing this creates a new group.

ValueSpecs map[string]interface{}

Map of additional options.

description String

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

endpoints List<String>

List of endpoints of the same type, for the endpoint group. The values will depend on the type. Changing this creates a new group.

name String

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

region String

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

tenantId String

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

type String

The type of the endpoints in the group. A valid value is subnet, cidr, network, router, or vlan. Changing this creates a new group.

valueSpecs Map<String,Object>

Map of additional options.

description string

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

endpoints string[]

List of endpoints of the same type, for the endpoint group. The values will depend on the type. Changing this creates a new group.

name string

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

region string

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

tenantId string

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

type string

The type of the endpoints in the group. A valid value is subnet, cidr, network, router, or vlan. Changing this creates a new group.

valueSpecs {[key: string]: any}

Map of additional options.

description str

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

endpoints Sequence[str]

List of endpoints of the same type, for the endpoint group. The values will depend on the type. Changing this creates a new group.

name str

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

region str

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

tenant_id str

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

type str

The type of the endpoints in the group. A valid value is subnet, cidr, network, router, or vlan. Changing this creates a new group.

value_specs Mapping[str, Any]

Map of additional options.

description String

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

endpoints List<String>

List of endpoints of the same type, for the endpoint group. The values will depend on the type. Changing this creates a new group.

name String

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

region String

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

tenantId String

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

type String

The type of the endpoints in the group. A valid value is subnet, cidr, network, router, or vlan. Changing this creates a new group.

valueSpecs Map<Any>

Map of additional options.

Import

Groups can be imported using the id, e.g.

 $ pulumi import openstack:vpnaas/endpointGroup:EndpointGroup group_1 832cb7f3-59fe-40cf-8f64-8350ffc03272

Package Details

Repository
https://github.com/pulumi/pulumi-openstack
License
Apache-2.0
Notes

This Pulumi package is based on the openstack Terraform Provider.