1. Docs
  2. Reference
  3. API
  4. Consul
  5. GetAclRole

GetAclRole

The consul..AclRole data source returns the information related to a Consul ACL Role.

Example Usage

using Pulumi;
using Consul = Pulumi.Consul;

class MyStack : Stack
{
    public MyStack()
    {
        var test = Output.Create(Consul.GetAclRole.InvokeAsync(new Consul.GetAclRoleArgs
        {
            Name = "example-role",
        }));
        this.ConsulAclRole = test.Apply(test => test.Id);
    }

    [Output("consulAclRole")]
    public Output<string> ConsulAclRole { get; set; }
}

Coming soon!

import pulumi
import pulumi_consul as consul

test = consul.get_acl_role(name="example-role")
pulumi.export("consulAclRole", test.id)
import * as pulumi from "@pulumi/pulumi";
import * as consul from "@pulumi/consul";

const test = consul.getAclRole({
    name: "example-role",
});
export const consulAclRole = test.then(test => test.id);

Using GetAclRole

function getAclRole(args: GetAclRoleArgs, opts?: InvokeOptions): Promise<GetAclRoleResult>
function  get_acl_role(description=None, name=None, namespace=None, policies=None, service_identities=None, opts=None)
func LookupAclRole(ctx *Context, args *LookupAclRoleArgs, opts ...InvokeOption) (*LookupAclRoleResult, error)

Note: This function is named LookupAclRole in the Go SDK.

public static class GetAclRole {
    public static Task<GetAclRoleResult> InvokeAsync(GetAclRoleArgs args, InvokeOptions? opts = null)
}

The following arguments are supported:

Name string

The name of the ACL Role.

Description string

The description of the ACL Role.

Namespace string

The namespace to lookup the role.

Policies List<GetAclRolePolicyArgs>

The list of policies associated with the ACL Role. Each entry has an id and a name attribute.

ServiceIdentities List<GetAclRoleServiceIdentityArgs>

The list of service identities associated with the ACL Role. Each entry has a service_name attribute and a list of datacenters.

Name string

The name of the ACL Role.

Description string

The description of the ACL Role.

Namespace string

The namespace to lookup the role.

Policies []GetAclRolePolicy

The list of policies associated with the ACL Role. Each entry has an id and a name attribute.

ServiceIdentities []GetAclRoleServiceIdentity

The list of service identities associated with the ACL Role. Each entry has a service_name attribute and a list of datacenters.

name string

The name of the ACL Role.

description string

The description of the ACL Role.

namespace string

The namespace to lookup the role.

policies GetAclRolePolicy[]

The list of policies associated with the ACL Role. Each entry has an id and a name attribute.

serviceIdentities GetAclRoleServiceIdentity[]

The list of service identities associated with the ACL Role. Each entry has a service_name attribute and a list of datacenters.

name str

The name of the ACL Role.

description str

The description of the ACL Role.

namespace str

The namespace to lookup the role.

policies List[GetAclRolePolicy]

The list of policies associated with the ACL Role. Each entry has an id and a name attribute.

service_identities List[GetAclRoleServiceIdentity]

The list of service identities associated with the ACL Role. Each entry has a service_name attribute and a list of datacenters.

GetAclRole Result

The following output properties are available:

Id string

The provider-assigned unique ID for this managed resource.

Name string
Description string

The description of the ACL Role.

Namespace string
Policies List<GetAclRolePolicy>

The list of policies associated with the ACL Role. Each entry has an id and a name attribute.

ServiceIdentities List<GetAclRoleServiceIdentity>

The list of service identities associated with the ACL Role. Each entry has a service_name attribute and a list of datacenters.

Id string

The provider-assigned unique ID for this managed resource.

Name string
Description string

The description of the ACL Role.

Namespace string
Policies []GetAclRolePolicy

The list of policies associated with the ACL Role. Each entry has an id and a name attribute.

ServiceIdentities []GetAclRoleServiceIdentity

The list of service identities associated with the ACL Role. Each entry has a service_name attribute and a list of datacenters.

id string

The provider-assigned unique ID for this managed resource.

name string
description string

The description of the ACL Role.

namespace string
policies GetAclRolePolicy[]

The list of policies associated with the ACL Role. Each entry has an id and a name attribute.

serviceIdentities GetAclRoleServiceIdentity[]

The list of service identities associated with the ACL Role. Each entry has a service_name attribute and a list of datacenters.

id str

The provider-assigned unique ID for this managed resource.

name str
description str

The description of the ACL Role.

namespace str
policies List[GetAclRolePolicy]

The list of policies associated with the ACL Role. Each entry has an id and a name attribute.

service_identities List[GetAclRoleServiceIdentity]

The list of service identities associated with the ACL Role. Each entry has a service_name attribute and a list of datacenters.

Supporting Types

GetAclRolePolicy

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

Id string
Name string

The name of the ACL Role.

Id string
Name string

The name of the ACL Role.

id string
name string

The name of the ACL Role.

id str
name str

The name of the ACL Role.

GetAclRoleServiceIdentity

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

Datacenters List<string>
ServiceName string
Datacenters []string
ServiceName string
datacenters string[]
serviceName string
datacenters List[str]
serviceName str

Package Details

Repository
https://github.com/pulumi/pulumi-consul
License
Apache-2.0
Notes
This Pulumi package is based on the consul Terraform Provider.