1. Packages
  2. Nomad Provider
  3. API Docs
  4. AclRole
Viewing docs for Nomad v2.5.5
published on Thursday, Feb 26, 2026 by Pulumi
nomad logo
Viewing docs for Nomad v2.5.5
published on Thursday, Feb 26, 2026 by Pulumi

    Manages an ACL Role in Nomad.

    Example Usage

    Creating an ALC Role linked to an ACL policy also created by Terraform:

    import * as pulumi from "@pulumi/pulumi";
    import * as nomad from "@pulumi/nomad";
    
    const myNomadAclPolicy = new nomad.AclPolicy("my_nomad_acl_policy", {
        name: "my-nomad-acl-policy",
        rulesHcl: `namespace \"default\" {
      policy       = \"read\"
      capabilities = [\"submit-job\"]
    }
    `,
    });
    const myNomadAclRole = new nomad.AclRole("my_nomad_acl_role", {
        name: "my-nomad-acl-role",
        description: "An ACL Role for cluster developers",
        policies: [{
            name: myNomadAclPolicy.name,
        }],
    });
    
    import pulumi
    import pulumi_nomad as nomad
    
    my_nomad_acl_policy = nomad.AclPolicy("my_nomad_acl_policy",
        name="my-nomad-acl-policy",
        rules_hcl="""namespace \"default\" {
      policy       = \"read\"
      capabilities = [\"submit-job\"]
    }
    """)
    my_nomad_acl_role = nomad.AclRole("my_nomad_acl_role",
        name="my-nomad-acl-role",
        description="An ACL Role for cluster developers",
        policies=[{
            "name": my_nomad_acl_policy.name,
        }])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-nomad/sdk/v2/go/nomad"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		myNomadAclPolicy, err := nomad.NewAclPolicy(ctx, "my_nomad_acl_policy", &nomad.AclPolicyArgs{
    			Name:     pulumi.String("my-nomad-acl-policy"),
    			RulesHcl: pulumi.Sprintf("namespace \\\"default\\\" {\n  policy       = \\\"read\\\"\n  capabilities = [\\\"submit-job\\\"]\n}\n"),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = nomad.NewAclRole(ctx, "my_nomad_acl_role", &nomad.AclRoleArgs{
    			Name:        pulumi.String("my-nomad-acl-role"),
    			Description: pulumi.String("An ACL Role for cluster developers"),
    			Policies: nomad.AclRolePolicyArray{
    				&nomad.AclRolePolicyArgs{
    					Name: myNomadAclPolicy.Name,
    				},
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Nomad = Pulumi.Nomad;
    
    return await Deployment.RunAsync(() => 
    {
        var myNomadAclPolicy = new Nomad.AclPolicy("my_nomad_acl_policy", new()
        {
            Name = "my-nomad-acl-policy",
            RulesHcl = @"namespace \""default\"" {
      policy       = \""read\""
      capabilities = [\""submit-job\""]
    }
    ",
        });
    
        var myNomadAclRole = new Nomad.AclRole("my_nomad_acl_role", new()
        {
            Name = "my-nomad-acl-role",
            Description = "An ACL Role for cluster developers",
            Policies = new[]
            {
                new Nomad.Inputs.AclRolePolicyArgs
                {
                    Name = myNomadAclPolicy.Name,
                },
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.nomad.AclPolicy;
    import com.pulumi.nomad.AclPolicyArgs;
    import com.pulumi.nomad.AclRole;
    import com.pulumi.nomad.AclRoleArgs;
    import com.pulumi.nomad.inputs.AclRolePolicyArgs;
    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 myNomadAclPolicy = new AclPolicy("myNomadAclPolicy", AclPolicyArgs.builder()
                .name("my-nomad-acl-policy")
                .rulesHcl("""
    namespace \"default\" {
      policy       = \"read\"
      capabilities = [\"submit-job\"]
    }
                """)
                .build());
    
            var myNomadAclRole = new AclRole("myNomadAclRole", AclRoleArgs.builder()
                .name("my-nomad-acl-role")
                .description("An ACL Role for cluster developers")
                .policies(AclRolePolicyArgs.builder()
                    .name(myNomadAclPolicy.name())
                    .build())
                .build());
    
        }
    }
    
    resources:
      myNomadAclPolicy:
        type: nomad:AclPolicy
        name: my_nomad_acl_policy
        properties:
          name: my-nomad-acl-policy
          rulesHcl: |
            namespace \"default\" {
              policy       = \"read\"
              capabilities = [\"submit-job\"]
            }
      myNomadAclRole:
        type: nomad:AclRole
        name: my_nomad_acl_role
        properties:
          name: my-nomad-acl-role
          description: An ACL Role for cluster developers
          policies:
            - name: ${myNomadAclPolicy.name}
    

    Create AclRole Resource

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

    Constructor syntax

    new AclRole(name: string, args: AclRoleArgs, opts?: CustomResourceOptions);
    @overload
    def AclRole(resource_name: str,
                args: AclRoleArgs,
                opts: Optional[ResourceOptions] = None)
    
    @overload
    def AclRole(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                policies: Optional[Sequence[AclRolePolicyArgs]] = None,
                description: Optional[str] = None,
                name: Optional[str] = None)
    func NewAclRole(ctx *Context, name string, args AclRoleArgs, opts ...ResourceOption) (*AclRole, error)
    public AclRole(string name, AclRoleArgs args, CustomResourceOptions? opts = null)
    public AclRole(String name, AclRoleArgs args)
    public AclRole(String name, AclRoleArgs args, CustomResourceOptions options)
    
    type: nomad:AclRole
    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 AclRoleArgs
    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 AclRoleArgs
    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 AclRoleArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AclRoleArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AclRoleArgs
    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 aclRoleResource = new Nomad.AclRole("aclRoleResource", new()
    {
        Policies = new[]
        {
            new Nomad.Inputs.AclRolePolicyArgs
            {
                Name = "string",
            },
        },
        Description = "string",
        Name = "string",
    });
    
    example, err := nomad.NewAclRole(ctx, "aclRoleResource", &nomad.AclRoleArgs{
    	Policies: nomad.AclRolePolicyArray{
    		&nomad.AclRolePolicyArgs{
    			Name: pulumi.String("string"),
    		},
    	},
    	Description: pulumi.String("string"),
    	Name:        pulumi.String("string"),
    })
    
    var aclRoleResource = new AclRole("aclRoleResource", AclRoleArgs.builder()
        .policies(AclRolePolicyArgs.builder()
            .name("string")
            .build())
        .description("string")
        .name("string")
        .build());
    
    acl_role_resource = nomad.AclRole("aclRoleResource",
        policies=[{
            "name": "string",
        }],
        description="string",
        name="string")
    
    const aclRoleResource = new nomad.AclRole("aclRoleResource", {
        policies: [{
            name: "string",
        }],
        description: "string",
        name: "string",
    });
    
    type: nomad:AclRole
    properties:
        description: string
        name: string
        policies:
            - name: string
    

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

    Policies List<AclRolePolicy>
    (set: <required>) - A set of policy names to associate with this ACL Role. It may be used multiple times.
    Description string
    (string: "") - A description of the ACL Role.
    Name string
    (string: <required>) - A human-friendly name for this ACL Role.
    Policies []AclRolePolicyArgs
    (set: <required>) - A set of policy names to associate with this ACL Role. It may be used multiple times.
    Description string
    (string: "") - A description of the ACL Role.
    Name string
    (string: <required>) - A human-friendly name for this ACL Role.
    policies List<AclRolePolicy>
    (set: <required>) - A set of policy names to associate with this ACL Role. It may be used multiple times.
    description String
    (string: "") - A description of the ACL Role.
    name String
    (string: <required>) - A human-friendly name for this ACL Role.
    policies AclRolePolicy[]
    (set: <required>) - A set of policy names to associate with this ACL Role. It may be used multiple times.
    description string
    (string: "") - A description of the ACL Role.
    name string
    (string: <required>) - A human-friendly name for this ACL Role.
    policies Sequence[AclRolePolicyArgs]
    (set: <required>) - A set of policy names to associate with this ACL Role. It may be used multiple times.
    description str
    (string: "") - A description of the ACL Role.
    name str
    (string: <required>) - A human-friendly name for this ACL Role.
    policies List<Property Map>
    (set: <required>) - A set of policy names to associate with this ACL Role. It may be used multiple times.
    description String
    (string: "") - A description of the ACL Role.
    name String
    (string: <required>) - A human-friendly name for this ACL Role.

    Outputs

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

    Get an existing AclRole 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?: AclRoleState, opts?: CustomResourceOptions): AclRole
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            description: Optional[str] = None,
            name: Optional[str] = None,
            policies: Optional[Sequence[AclRolePolicyArgs]] = None) -> AclRole
    func GetAclRole(ctx *Context, name string, id IDInput, state *AclRoleState, opts ...ResourceOption) (*AclRole, error)
    public static AclRole Get(string name, Input<string> id, AclRoleState? state, CustomResourceOptions? opts = null)
    public static AclRole get(String name, Output<String> id, AclRoleState state, CustomResourceOptions options)
    resources:  _:    type: nomad:AclRole    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:
    Description string
    (string: "") - A description of the ACL Role.
    Name string
    (string: <required>) - A human-friendly name for this ACL Role.
    Policies List<AclRolePolicy>
    (set: <required>) - A set of policy names to associate with this ACL Role. It may be used multiple times.
    Description string
    (string: "") - A description of the ACL Role.
    Name string
    (string: <required>) - A human-friendly name for this ACL Role.
    Policies []AclRolePolicyArgs
    (set: <required>) - A set of policy names to associate with this ACL Role. It may be used multiple times.
    description String
    (string: "") - A description of the ACL Role.
    name String
    (string: <required>) - A human-friendly name for this ACL Role.
    policies List<AclRolePolicy>
    (set: <required>) - A set of policy names to associate with this ACL Role. It may be used multiple times.
    description string
    (string: "") - A description of the ACL Role.
    name string
    (string: <required>) - A human-friendly name for this ACL Role.
    policies AclRolePolicy[]
    (set: <required>) - A set of policy names to associate with this ACL Role. It may be used multiple times.
    description str
    (string: "") - A description of the ACL Role.
    name str
    (string: <required>) - A human-friendly name for this ACL Role.
    policies Sequence[AclRolePolicyArgs]
    (set: <required>) - A set of policy names to associate with this ACL Role. It may be used multiple times.
    description String
    (string: "") - A description of the ACL Role.
    name String
    (string: <required>) - A human-friendly name for this ACL Role.
    policies List<Property Map>
    (set: <required>) - A set of policy names to associate with this ACL Role. It may be used multiple times.

    Supporting Types

    AclRolePolicy, AclRolePolicyArgs

    Name string
    (string: <required>) - A human-friendly name for this ACL Role.
    Name string
    (string: <required>) - A human-friendly name for this ACL Role.
    name String
    (string: <required>) - A human-friendly name for this ACL Role.
    name string
    (string: <required>) - A human-friendly name for this ACL Role.
    name str
    (string: <required>) - A human-friendly name for this ACL Role.
    name String
    (string: <required>) - A human-friendly name for this ACL Role.

    Package Details

    Repository
    HashiCorp Nomad pulumi/pulumi-nomad
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the nomad Terraform Provider.
    nomad logo
    Viewing docs for Nomad v2.5.5
    published on Thursday, Feb 26, 2026 by Pulumi
      Try Pulumi Cloud free. Your team will thank you.