1. Packages
  2. Openstack Provider
  3. API Docs
  4. identity
  5. GroupV3
OpenStack v4.1.3 published on Wednesday, Aug 21, 2024 by Pulumi

openstack.identity.GroupV3

Explore with Pulumi AI

openstack logo
OpenStack v4.1.3 published on Wednesday, Aug 21, 2024 by Pulumi

    Manages a V3 group resource within OpenStack Keystone.

    Note: You must have admin privileges in your OpenStack cloud to use this resource.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as openstack from "@pulumi/openstack";
    
    const group1 = new openstack.identity.GroupV3("group_1", {
        name: "group_1",
        description: "group 1",
    });
    
    import pulumi
    import pulumi_openstack as openstack
    
    group1 = openstack.identity.GroupV3("group_1",
        name="group_1",
        description="group 1")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-openstack/sdk/v4/go/openstack/identity"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := identity.NewGroupV3(ctx, "group_1", &identity.GroupV3Args{
    			Name:        pulumi.String("group_1"),
    			Description: pulumi.String("group 1"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using OpenStack = Pulumi.OpenStack;
    
    return await Deployment.RunAsync(() => 
    {
        var group1 = new OpenStack.Identity.GroupV3("group_1", new()
        {
            Name = "group_1",
            Description = "group 1",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.openstack.identity.GroupV3;
    import com.pulumi.openstack.identity.GroupV3Args;
    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 GroupV3("group1", GroupV3Args.builder()
                .name("group_1")
                .description("group 1")
                .build());
    
        }
    }
    
    resources:
      group1:
        type: openstack:identity:GroupV3
        name: group_1
        properties:
          name: group_1
          description: group 1
    

    Create GroupV3 Resource

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

    Constructor syntax

    new GroupV3(name: string, args?: GroupV3Args, opts?: CustomResourceOptions);
    @overload
    def GroupV3(resource_name: str,
                args: Optional[GroupV3Args] = None,
                opts: Optional[ResourceOptions] = None)
    
    @overload
    def GroupV3(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                description: Optional[str] = None,
                domain_id: Optional[str] = None,
                name: Optional[str] = None,
                region: Optional[str] = None)
    func NewGroupV3(ctx *Context, name string, args *GroupV3Args, opts ...ResourceOption) (*GroupV3, error)
    public GroupV3(string name, GroupV3Args? args = null, CustomResourceOptions? opts = null)
    public GroupV3(String name, GroupV3Args args)
    public GroupV3(String name, GroupV3Args args, CustomResourceOptions options)
    
    type: openstack:identity:GroupV3
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args GroupV3Args
    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 GroupV3Args
    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 GroupV3Args
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args GroupV3Args
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args GroupV3Args
    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 groupV3Resource = new OpenStack.Identity.GroupV3("groupV3Resource", new()
    {
        Description = "string",
        DomainId = "string",
        Name = "string",
        Region = "string",
    });
    
    example, err := identity.NewGroupV3(ctx, "groupV3Resource", &identity.GroupV3Args{
    	Description: pulumi.String("string"),
    	DomainId:    pulumi.String("string"),
    	Name:        pulumi.String("string"),
    	Region:      pulumi.String("string"),
    })
    
    var groupV3Resource = new GroupV3("groupV3Resource", GroupV3Args.builder()
        .description("string")
        .domainId("string")
        .name("string")
        .region("string")
        .build());
    
    group_v3_resource = openstack.identity.GroupV3("groupV3Resource",
        description="string",
        domain_id="string",
        name="string",
        region="string")
    
    const groupV3Resource = new openstack.identity.GroupV3("groupV3Resource", {
        description: "string",
        domainId: "string",
        name: "string",
        region: "string",
    });
    
    type: openstack:identity:GroupV3
    properties:
        description: string
        domainId: string
        name: string
        region: string
    

    GroupV3 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 GroupV3 resource accepts the following input properties:

    Description string
    A description of the group.
    DomainId string
    The domain the group belongs to.
    Name string
    The name of the group.
    Region string
    The region in which to obtain the V3 Keystone client. If omitted, the region argument of the provider is used. Changing this creates a new group.
    Description string
    A description of the group.
    DomainId string
    The domain the group belongs to.
    Name string
    The name of the group.
    Region string
    The region in which to obtain the V3 Keystone client. If omitted, the region argument of the provider is used. Changing this creates a new group.
    description String
    A description of the group.
    domainId String
    The domain the group belongs to.
    name String
    The name of the group.
    region String
    The region in which to obtain the V3 Keystone client. If omitted, the region argument of the provider is used. Changing this creates a new group.
    description string
    A description of the group.
    domainId string
    The domain the group belongs to.
    name string
    The name of the group.
    region string
    The region in which to obtain the V3 Keystone client. If omitted, the region argument of the provider is used. Changing this creates a new group.
    description str
    A description of the group.
    domain_id str
    The domain the group belongs to.
    name str
    The name of the group.
    region str
    The region in which to obtain the V3 Keystone client. If omitted, the region argument of the provider is used. Changing this creates a new group.
    description String
    A description of the group.
    domainId String
    The domain the group belongs to.
    name String
    The name of the group.
    region String
    The region in which to obtain the V3 Keystone client. If omitted, the region argument of the provider is used. Changing this creates a new group.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the GroupV3 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 GroupV3 Resource

    Get an existing GroupV3 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?: GroupV3State, opts?: CustomResourceOptions): GroupV3
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            description: Optional[str] = None,
            domain_id: Optional[str] = None,
            name: Optional[str] = None,
            region: Optional[str] = None) -> GroupV3
    func GetGroupV3(ctx *Context, name string, id IDInput, state *GroupV3State, opts ...ResourceOption) (*GroupV3, error)
    public static GroupV3 Get(string name, Input<string> id, GroupV3State? state, CustomResourceOptions? opts = null)
    public static GroupV3 get(String name, Output<String> id, GroupV3State 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
    A description of the group.
    DomainId string
    The domain the group belongs to.
    Name string
    The name of the group.
    Region string
    The region in which to obtain the V3 Keystone client. If omitted, the region argument of the provider is used. Changing this creates a new group.
    Description string
    A description of the group.
    DomainId string
    The domain the group belongs to.
    Name string
    The name of the group.
    Region string
    The region in which to obtain the V3 Keystone client. If omitted, the region argument of the provider is used. Changing this creates a new group.
    description String
    A description of the group.
    domainId String
    The domain the group belongs to.
    name String
    The name of the group.
    region String
    The region in which to obtain the V3 Keystone client. If omitted, the region argument of the provider is used. Changing this creates a new group.
    description string
    A description of the group.
    domainId string
    The domain the group belongs to.
    name string
    The name of the group.
    region string
    The region in which to obtain the V3 Keystone client. If omitted, the region argument of the provider is used. Changing this creates a new group.
    description str
    A description of the group.
    domain_id str
    The domain the group belongs to.
    name str
    The name of the group.
    region str
    The region in which to obtain the V3 Keystone client. If omitted, the region argument of the provider is used. Changing this creates a new group.
    description String
    A description of the group.
    domainId String
    The domain the group belongs to.
    name String
    The name of the group.
    region String
    The region in which to obtain the V3 Keystone client. If omitted, the region argument of the provider is used. Changing this creates a new group.

    Import

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

    $ pulumi import openstack:identity/groupV3:GroupV3 group_1 89c60255-9bd6-460c-822a-e2b959ede9d2
    

    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.
    openstack logo
    OpenStack v4.1.3 published on Wednesday, Aug 21, 2024 by Pulumi