1. Packages
  2. Openstack Provider
  3. API Docs
  4. identity
  5. EndpointV3
OpenStack v5.0.3 published on Wednesday, Feb 12, 2025 by Pulumi

openstack.identity.EndpointV3

Explore with Pulumi AI

Manages a V3 Endpoint resource within OpenStack Keystone.

Note: This usually requires admin privileges.

Example Usage

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

const service1 = new openstack.identity.ServiceV3("service_1", {
    name: "my-service",
    type: "my-service-type",
});
const endpoint1 = new openstack.identity.EndpointV3("endpoint_1", {
    name: "my-endpoint",
    serviceId: service1.id,
    endpointRegion: service1.region,
    url: "http://my-endpoint",
});
Copy
import pulumi
import pulumi_openstack as openstack

service1 = openstack.identity.ServiceV3("service_1",
    name="my-service",
    type="my-service-type")
endpoint1 = openstack.identity.EndpointV3("endpoint_1",
    name="my-endpoint",
    service_id=service1.id,
    endpoint_region=service1.region,
    url="http://my-endpoint")
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		service1, err := identity.NewServiceV3(ctx, "service_1", &identity.ServiceV3Args{
			Name: pulumi.String("my-service"),
			Type: pulumi.String("my-service-type"),
		})
		if err != nil {
			return err
		}
		_, err = identity.NewEndpointV3(ctx, "endpoint_1", &identity.EndpointV3Args{
			Name:           pulumi.String("my-endpoint"),
			ServiceId:      service1.ID(),
			EndpointRegion: service1.Region,
			Url:            pulumi.String("http://my-endpoint"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using OpenStack = Pulumi.OpenStack;

return await Deployment.RunAsync(() => 
{
    var service1 = new OpenStack.Identity.ServiceV3("service_1", new()
    {
        Name = "my-service",
        Type = "my-service-type",
    });

    var endpoint1 = new OpenStack.Identity.EndpointV3("endpoint_1", new()
    {
        Name = "my-endpoint",
        ServiceId = service1.Id,
        EndpointRegion = service1.Region,
        Url = "http://my-endpoint",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.openstack.identity.ServiceV3;
import com.pulumi.openstack.identity.ServiceV3Args;
import com.pulumi.openstack.identity.EndpointV3;
import com.pulumi.openstack.identity.EndpointV3Args;
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 service1 = new ServiceV3("service1", ServiceV3Args.builder()
            .name("my-service")
            .type("my-service-type")
            .build());

        var endpoint1 = new EndpointV3("endpoint1", EndpointV3Args.builder()
            .name("my-endpoint")
            .serviceId(service1.id())
            .endpointRegion(service1.region())
            .url("http://my-endpoint")
            .build());

    }
}
Copy
resources:
  service1:
    type: openstack:identity:ServiceV3
    name: service_1
    properties:
      name: my-service
      type: my-service-type
  endpoint1:
    type: openstack:identity:EndpointV3
    name: endpoint_1
    properties:
      name: my-endpoint
      serviceId: ${service1.id}
      endpointRegion: ${service1.region}
      url: http://my-endpoint
Copy

Create EndpointV3 Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new EndpointV3(name: string, args: EndpointV3Args, opts?: CustomResourceOptions);
@overload
def EndpointV3(resource_name: str,
               args: EndpointV3Args,
               opts: Optional[ResourceOptions] = None)

@overload
def EndpointV3(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               endpoint_region: Optional[str] = None,
               service_id: Optional[str] = None,
               url: Optional[str] = None,
               interface: Optional[str] = None,
               name: Optional[str] = None,
               region: Optional[str] = None)
func NewEndpointV3(ctx *Context, name string, args EndpointV3Args, opts ...ResourceOption) (*EndpointV3, error)
public EndpointV3(string name, EndpointV3Args args, CustomResourceOptions? opts = null)
public EndpointV3(String name, EndpointV3Args args)
public EndpointV3(String name, EndpointV3Args args, CustomResourceOptions options)
type: openstack:identity:EndpointV3
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

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

Constructor example

The following reference example uses placeholder values for all input properties.

var endpointV3Resource = new OpenStack.Identity.EndpointV3("endpointV3Resource", new()
{
    EndpointRegion = "string",
    ServiceId = "string",
    Url = "string",
    Interface = "string",
    Name = "string",
    Region = "string",
});
Copy
example, err := identity.NewEndpointV3(ctx, "endpointV3Resource", &identity.EndpointV3Args{
	EndpointRegion: pulumi.String("string"),
	ServiceId:      pulumi.String("string"),
	Url:            pulumi.String("string"),
	Interface:      pulumi.String("string"),
	Name:           pulumi.String("string"),
	Region:         pulumi.String("string"),
})
Copy
var endpointV3Resource = new EndpointV3("endpointV3Resource", EndpointV3Args.builder()
    .endpointRegion("string")
    .serviceId("string")
    .url("string")
    .interface_("string")
    .name("string")
    .region("string")
    .build());
Copy
endpoint_v3_resource = openstack.identity.EndpointV3("endpointV3Resource",
    endpoint_region="string",
    service_id="string",
    url="string",
    interface="string",
    name="string",
    region="string")
Copy
const endpointV3Resource = new openstack.identity.EndpointV3("endpointV3Resource", {
    endpointRegion: "string",
    serviceId: "string",
    url: "string",
    "interface": "string",
    name: "string",
    region: "string",
});
Copy
type: openstack:identity:EndpointV3
properties:
    endpointRegion: string
    interface: string
    name: string
    region: string
    serviceId: string
    url: string
Copy

EndpointV3 Resource Properties

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

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The EndpointV3 resource accepts the following input properties:

EndpointRegion This property is required. string
The endpoint region. The region and endpoint_region can be different.
ServiceId This property is required. string
The endpoint service ID.
Url This property is required. string
The endpoint url.
Interface string
The endpoint interface. Valid values are public, internal and admin. Default value is public
Name string
The endpoint name.
Region Changes to this property will trigger replacement. string
The region in which to obtain the V3 Keystone client. If omitted, the region argument of the provider is used.
EndpointRegion This property is required. string
The endpoint region. The region and endpoint_region can be different.
ServiceId This property is required. string
The endpoint service ID.
Url This property is required. string
The endpoint url.
Interface string
The endpoint interface. Valid values are public, internal and admin. Default value is public
Name string
The endpoint name.
Region Changes to this property will trigger replacement. string
The region in which to obtain the V3 Keystone client. If omitted, the region argument of the provider is used.
endpointRegion This property is required. String
The endpoint region. The region and endpoint_region can be different.
serviceId This property is required. String
The endpoint service ID.
url This property is required. String
The endpoint url.
interface_ String
The endpoint interface. Valid values are public, internal and admin. Default value is public
name String
The endpoint name.
region Changes to this property will trigger replacement. String
The region in which to obtain the V3 Keystone client. If omitted, the region argument of the provider is used.
endpointRegion This property is required. string
The endpoint region. The region and endpoint_region can be different.
serviceId This property is required. string
The endpoint service ID.
url This property is required. string
The endpoint url.
interface string
The endpoint interface. Valid values are public, internal and admin. Default value is public
name string
The endpoint name.
region Changes to this property will trigger replacement. string
The region in which to obtain the V3 Keystone client. If omitted, the region argument of the provider is used.
endpoint_region This property is required. str
The endpoint region. The region and endpoint_region can be different.
service_id This property is required. str
The endpoint service ID.
url This property is required. str
The endpoint url.
interface str
The endpoint interface. Valid values are public, internal and admin. Default value is public
name str
The endpoint name.
region Changes to this property will trigger replacement. str
The region in which to obtain the V3 Keystone client. If omitted, the region argument of the provider is used.
endpointRegion This property is required. String
The endpoint region. The region and endpoint_region can be different.
serviceId This property is required. String
The endpoint service ID.
url This property is required. String
The endpoint url.
interface String
The endpoint interface. Valid values are public, internal and admin. Default value is public
name String
The endpoint name.
region Changes to this property will trigger replacement. String
The region in which to obtain the V3 Keystone client. If omitted, the region argument of the provider is used.

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
ServiceName string
The service name of the endpoint.
ServiceType string
The service type of the endpoint.
Id string
The provider-assigned unique ID for this managed resource.
ServiceName string
The service name of the endpoint.
ServiceType string
The service type of the endpoint.
id String
The provider-assigned unique ID for this managed resource.
serviceName String
The service name of the endpoint.
serviceType String
The service type of the endpoint.
id string
The provider-assigned unique ID for this managed resource.
serviceName string
The service name of the endpoint.
serviceType string
The service type of the endpoint.
id str
The provider-assigned unique ID for this managed resource.
service_name str
The service name of the endpoint.
service_type str
The service type of the endpoint.
id String
The provider-assigned unique ID for this managed resource.
serviceName String
The service name of the endpoint.
serviceType String
The service type of the endpoint.

Look up Existing EndpointV3 Resource

Get an existing EndpointV3 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?: EndpointV3State, opts?: CustomResourceOptions): EndpointV3
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        endpoint_region: Optional[str] = None,
        interface: Optional[str] = None,
        name: Optional[str] = None,
        region: Optional[str] = None,
        service_id: Optional[str] = None,
        service_name: Optional[str] = None,
        service_type: Optional[str] = None,
        url: Optional[str] = None) -> EndpointV3
func GetEndpointV3(ctx *Context, name string, id IDInput, state *EndpointV3State, opts ...ResourceOption) (*EndpointV3, error)
public static EndpointV3 Get(string name, Input<string> id, EndpointV3State? state, CustomResourceOptions? opts = null)
public static EndpointV3 get(String name, Output<String> id, EndpointV3State state, CustomResourceOptions options)
resources:  _:    type: openstack:identity:EndpointV3    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
EndpointRegion string
The endpoint region. The region and endpoint_region can be different.
Interface string
The endpoint interface. Valid values are public, internal and admin. Default value is public
Name string
The endpoint name.
Region Changes to this property will trigger replacement. string
The region in which to obtain the V3 Keystone client. If omitted, the region argument of the provider is used.
ServiceId string
The endpoint service ID.
ServiceName string
The service name of the endpoint.
ServiceType string
The service type of the endpoint.
Url string
The endpoint url.
EndpointRegion string
The endpoint region. The region and endpoint_region can be different.
Interface string
The endpoint interface. Valid values are public, internal and admin. Default value is public
Name string
The endpoint name.
Region Changes to this property will trigger replacement. string
The region in which to obtain the V3 Keystone client. If omitted, the region argument of the provider is used.
ServiceId string
The endpoint service ID.
ServiceName string
The service name of the endpoint.
ServiceType string
The service type of the endpoint.
Url string
The endpoint url.
endpointRegion String
The endpoint region. The region and endpoint_region can be different.
interface_ String
The endpoint interface. Valid values are public, internal and admin. Default value is public
name String
The endpoint name.
region Changes to this property will trigger replacement. String
The region in which to obtain the V3 Keystone client. If omitted, the region argument of the provider is used.
serviceId String
The endpoint service ID.
serviceName String
The service name of the endpoint.
serviceType String
The service type of the endpoint.
url String
The endpoint url.
endpointRegion string
The endpoint region. The region and endpoint_region can be different.
interface string
The endpoint interface. Valid values are public, internal and admin. Default value is public
name string
The endpoint name.
region Changes to this property will trigger replacement. string
The region in which to obtain the V3 Keystone client. If omitted, the region argument of the provider is used.
serviceId string
The endpoint service ID.
serviceName string
The service name of the endpoint.
serviceType string
The service type of the endpoint.
url string
The endpoint url.
endpoint_region str
The endpoint region. The region and endpoint_region can be different.
interface str
The endpoint interface. Valid values are public, internal and admin. Default value is public
name str
The endpoint name.
region Changes to this property will trigger replacement. str
The region in which to obtain the V3 Keystone client. If omitted, the region argument of the provider is used.
service_id str
The endpoint service ID.
service_name str
The service name of the endpoint.
service_type str
The service type of the endpoint.
url str
The endpoint url.
endpointRegion String
The endpoint region. The region and endpoint_region can be different.
interface String
The endpoint interface. Valid values are public, internal and admin. Default value is public
name String
The endpoint name.
region Changes to this property will trigger replacement. String
The region in which to obtain the V3 Keystone client. If omitted, the region argument of the provider is used.
serviceId String
The endpoint service ID.
serviceName String
The service name of the endpoint.
serviceType String
The service type of the endpoint.
url String
The endpoint url.

Import

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

$ pulumi import openstack:identity/endpointV3:EndpointV3 endpoint_1 5392472b-106a-4845-90c6-7c8445f18770
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
OpenStack pulumi/pulumi-openstack
License
Apache-2.0
Notes
This Pulumi package is based on the openstack Terraform Provider.