Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Etcd Provider
  3. API Docs
  4. Role
etcd 0.10.0 published on Tuesday, Apr 15, 2025 by ferlab-ste-justine
ferlab-ste-justine/terraform-provider-etcd

etcd.Role

Explore with Pulumi AI

etcd logo
etcd 0.10.0 published on Tuesday, Apr 15, 2025 by ferlab-ste-justine
ferlab-ste-justine/terraform-provider-etcd

    User role for etcd to define access control.

    Example Usage

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

const confFiles = etcd.getPrefixRangeEnd({
    key: "/confs/",
});
const configurator = new etcd.Role("configurator", {permissions: [
    {
        permission: "readwrite",
        key: confFiles.then(confFiles => confFiles.key),
        rangeEnd: confFiles.then(confFiles => confFiles.rangeEnd),
    },
    {
        permission: "read",
        key: "/summary.txt",
        rangeEnd: "/summary.txt",
    },
]});

    import pulumi
import pulumi_etcd as etcd

conf_files = etcd.get_prefix_range_end(key="/confs/")
configurator = etcd.Role("configurator", permissions=[
    {
        "permission": "readwrite",
        "key": conf_files.key,
        "range_end": conf_files.range_end,
    },
    {
        "permission": "read",
        "key": "/summary.txt",
        "range_end": "/summary.txt",
    },
])

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/etcd/etcd"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		confFiles, err := etcd.GetPrefixRangeEnd(ctx, &etcd.GetPrefixRangeEndArgs{
			Key: "/confs/",
		}, nil)
		if err != nil {
			return err
		}
		_, err = etcd.NewRole(ctx, "configurator", &etcd.RoleArgs{
			Permissions: etcd.RolePermissionArray{
				&etcd.RolePermissionArgs{
					Permission: pulumi.String("readwrite"),
					Key:        pulumi.String(confFiles.Key),
					RangeEnd:   pulumi.String(confFiles.RangeEnd),
				},
				&etcd.RolePermissionArgs{
					Permission: pulumi.String("read"),
					Key:        pulumi.String("/summary.txt"),
					RangeEnd:   pulumi.String("/summary.txt"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Etcd = Pulumi.Etcd;

return await Deployment.RunAsync(() => 
{
    var confFiles = Etcd.GetPrefixRangeEnd.Invoke(new()
    {
        Key = "/confs/",
    });

    var configurator = new Etcd.Role("configurator", new()
    {
        Permissions = new[]
        {
            new Etcd.Inputs.RolePermissionArgs
            {
                Permission = "readwrite",
                Key = confFiles.Apply(getPrefixRangeEndResult => getPrefixRangeEndResult.Key),
                RangeEnd = confFiles.Apply(getPrefixRangeEndResult => getPrefixRangeEndResult.RangeEnd),
            },
            new Etcd.Inputs.RolePermissionArgs
            {
                Permission = "read",
                Key = "/summary.txt",
                RangeEnd = "/summary.txt",
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.etcd.EtcdFunctions;
import com.pulumi.etcd.inputs.GetPrefixRangeEndArgs;
import com.pulumi.etcd.Role;
import com.pulumi.etcd.RoleArgs;
import com.pulumi.etcd.inputs.RolePermissionArgs;
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) {
        final var confFiles = EtcdFunctions.getPrefixRangeEnd(GetPrefixRangeEndArgs.builder()
            .key("/confs/")
            .build());

        var configurator = new Role("configurator", RoleArgs.builder()
            .permissions(            
                RolePermissionArgs.builder()
                    .permission("readwrite")
                    .key(confFiles.applyValue(getPrefixRangeEndResult -> getPrefixRangeEndResult.key()))
                    .rangeEnd(confFiles.applyValue(getPrefixRangeEndResult -> getPrefixRangeEndResult.rangeEnd()))
                    .build(),
                RolePermissionArgs.builder()
                    .permission("read")
                    .key("/summary.txt")
                    .rangeEnd("/summary.txt")
                    .build())
            .build());

    }
}

    resources:
  configurator:
    type: etcd:Role
    properties:
      permissions:
        - permission: readwrite
          key: ${confFiles.key}
          rangeEnd: ${confFiles.rangeEnd}
        - permission: read
          key: /summary.txt
          rangeEnd: /summary.txt
variables:
  confFiles:
    fn::invoke:
      function: etcd:getPrefixRangeEnd
      arguments:
        key: /confs/

    Create Role Resource

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

    Constructor syntax

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

@overload
def Role(resource_name: str,
         opts: Optional[ResourceOptions] = None,
         name: Optional[str] = None,
         permissions: Optional[Sequence[RolePermissionArgs]] = None,
         role_id: Optional[str] = None)
    func NewRole(ctx *Context, name string, args *RoleArgs, opts ...ResourceOption) (*Role, error)
    public Role(string name, RoleArgs? args = null, CustomResourceOptions? opts = null)
    public Role(String name, RoleArgs args)
public Role(String name, RoleArgs args, CustomResourceOptions options)

    type: etcd:Role
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 RoleArgs
    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 RoleArgs
    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 RoleArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args RoleArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args RoleArgs
    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 roleResource = new Etcd.Role("roleResource", new()
{
    Name = "string",
    Permissions = new[]
    {
        new Etcd.Inputs.RolePermissionArgs
        {
            Key = "string",
            RangeEnd = "string",
            Permission = "string",
        },
    },
    RoleId = "string",
});

    example, err := etcd.NewRole(ctx, "roleResource", &etcd.RoleArgs{
	Name: pulumi.String("string"),
	Permissions: etcd.RolePermissionArray{
		&etcd.RolePermissionArgs{
			Key:        pulumi.String("string"),
			RangeEnd:   pulumi.String("string"),
			Permission: pulumi.String("string"),
		},
	},
	RoleId: pulumi.String("string"),
})

    var roleResource = new Role("roleResource", RoleArgs.builder()
    .name("string")
    .permissions(RolePermissionArgs.builder()
        .key("string")
        .rangeEnd("string")
        .permission("string")
        .build())
    .roleId("string")
    .build());

    role_resource = etcd.Role("roleResource",
    name="string",
    permissions=[{
        "key": "string",
        "range_end": "string",
        "permission": "string",
    }],
    role_id="string")

    const roleResource = new etcd.Role("roleResource", {
    name: "string",
    permissions: [{
        key: "string",
        rangeEnd: "string",
        permission: "string",
    }],
    roleId: "string",
});

    type: etcd:Role
properties:
    name: string
    permissions:
        - key: string
          permission: string
          rangeEnd: string
    roleId: string

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

    Name string
    Name of the role. Changing this will delete the role and create a new one.
    Permissions List<RolePermission>
    Permissions to grant to the role on various etcd key ranges.
    RoleId string
    The ID of this resource.
    Name string
    Name of the role. Changing this will delete the role and create a new one.
    Permissions []RolePermissionArgs
    Permissions to grant to the role on various etcd key ranges.
    RoleId string
    The ID of this resource.
    name String
    Name of the role. Changing this will delete the role and create a new one.
    permissions List<RolePermission>
    Permissions to grant to the role on various etcd key ranges.
    roleId String
    The ID of this resource.
    name string
    Name of the role. Changing this will delete the role and create a new one.
    permissions RolePermission[]
    Permissions to grant to the role on various etcd key ranges.
    roleId string
    The ID of this resource.
    name str
    Name of the role. Changing this will delete the role and create a new one.
    permissions Sequence[RolePermissionArgs]
    Permissions to grant to the role on various etcd key ranges.
    role_id str
    The ID of this resource.
    name String
    Name of the role. Changing this will delete the role and create a new one.
    permissions List<Property Map>
    Permissions to grant to the role on various etcd key ranges.
    roleId String
    The ID of this resource.

    Outputs

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

    Get an existing Role 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?: RoleState, opts?: CustomResourceOptions): Role
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        name: Optional[str] = None,
        permissions: Optional[Sequence[RolePermissionArgs]] = None,
        role_id: Optional[str] = None) -> Role
    func GetRole(ctx *Context, name string, id IDInput, state *RoleState, opts ...ResourceOption) (*Role, error)
    public static Role Get(string name, Input<string> id, RoleState? state, CustomResourceOptions? opts = null)
    public static Role get(String name, Output<String> id, RoleState state, CustomResourceOptions options)
    resources:  _:    type: etcd:Role    get:      id: ${id}
    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:
    Name string
    Name of the role. Changing this will delete the role and create a new one.
    Permissions List<RolePermission>
    Permissions to grant to the role on various etcd key ranges.
    RoleId string
    The ID of this resource.
    Name string
    Name of the role. Changing this will delete the role and create a new one.
    Permissions []RolePermissionArgs
    Permissions to grant to the role on various etcd key ranges.
    RoleId string
    The ID of this resource.
    name String
    Name of the role. Changing this will delete the role and create a new one.
    permissions List<RolePermission>
    Permissions to grant to the role on various etcd key ranges.
    roleId String
    The ID of this resource.
    name string
    Name of the role. Changing this will delete the role and create a new one.
    permissions RolePermission[]
    Permissions to grant to the role on various etcd key ranges.
    roleId string
    The ID of this resource.
    name str
    Name of the role. Changing this will delete the role and create a new one.
    permissions Sequence[RolePermissionArgs]
    Permissions to grant to the role on various etcd key ranges.
    role_id str
    The ID of this resource.
    name String
    Name of the role. Changing this will delete the role and create a new one.
    permissions List<Property Map>
    Permissions to grant to the role on various etcd key ranges.
    roleId String
    The ID of this resource.

    Supporting Types

    RolePermission, RolePermissionArgs

    Key string
    Key specifying the beginning of the key range.
    RangeEnd string
    Key specifying the end of the key range (exclusive). To you set it to the value of the key to grant permission on a single key. If you would like the range to be anything prefixed by the key, you can use the etcdprefixrange_end data helper.
    Permission string
    Permissions to grant to the role on the given key range. Can be: read, write or readwrite
    Key string
    Key specifying the beginning of the key range.
    RangeEnd string
    Key specifying the end of the key range (exclusive). To you set it to the value of the key to grant permission on a single key. If you would like the range to be anything prefixed by the key, you can use the etcdprefixrange_end data helper.
    Permission string
    Permissions to grant to the role on the given key range. Can be: read, write or readwrite
    key String
    Key specifying the beginning of the key range.
    rangeEnd String
    Key specifying the end of the key range (exclusive). To you set it to the value of the key to grant permission on a single key. If you would like the range to be anything prefixed by the key, you can use the etcdprefixrange_end data helper.
    permission String
    Permissions to grant to the role on the given key range. Can be: read, write or readwrite
    key string
    Key specifying the beginning of the key range.
    rangeEnd string
    Key specifying the end of the key range (exclusive). To you set it to the value of the key to grant permission on a single key. If you would like the range to be anything prefixed by the key, you can use the etcdprefixrange_end data helper.
    permission string
    Permissions to grant to the role on the given key range. Can be: read, write or readwrite
    key str
    Key specifying the beginning of the key range.
    range_end str
    Key specifying the end of the key range (exclusive). To you set it to the value of the key to grant permission on a single key. If you would like the range to be anything prefixed by the key, you can use the etcdprefixrange_end data helper.
    permission str
    Permissions to grant to the role on the given key range. Can be: read, write or readwrite
    key String
    Key specifying the beginning of the key range.
    rangeEnd String
    Key specifying the end of the key range (exclusive). To you set it to the value of the key to grant permission on a single key. If you would like the range to be anything prefixed by the key, you can use the etcdprefixrange_end data helper.
    permission String
    Permissions to grant to the role on the given key range. Can be: read, write or readwrite

    Package Details

    Repository
    etcd ferlab-ste-justine/terraform-provider-etcd
    License
    Notes
    This Pulumi package is based on the etcd Terraform Provider.
    etcd logo
    etcd 0.10.0 published on Tuesday, Apr 15, 2025 by ferlab-ste-justine
    ferlab-ste-justine/terraform-provider-etcd