Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Vcd Provider
  3. API Docs
  4. Role
vcd 3.14.1 published on Monday, Apr 14, 2025 by vmware
vmware/terraform-provider-vcd

vcd.Role

Explore with Pulumi AI

vcd logo
vcd 3.14.1 published on Monday, Apr 14, 2025 by vmware
vmware/terraform-provider-vcd

    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: RoleArgs,
         opts: Optional[ResourceOptions] = None)

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

    type: vcd: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 Vcd.Role("roleResource", new()
{
    Description = "string",
    Name = "string",
    Org = "string",
    Rights = new[]
    {
        "string",
    },
    RoleId = "string",
});

    example, err := vcd.NewRole(ctx, "roleResource", &vcd.RoleArgs{
	Description: pulumi.String("string"),
	Name:        pulumi.String("string"),
	Org:         pulumi.String("string"),
	Rights: pulumi.StringArray{
		pulumi.String("string"),
	},
	RoleId: pulumi.String("string"),
})

    var roleResource = new Role("roleResource", RoleArgs.builder()
    .description("string")
    .name("string")
    .org("string")
    .rights("string")
    .roleId("string")
    .build());

    role_resource = vcd.Role("roleResource",
    description="string",
    name="string",
    org="string",
    rights=["string"],
    role_id="string")

    const roleResource = new vcd.Role("roleResource", {
    description: "string",
    name: "string",
    org: "string",
    rights: ["string"],
    roleId: "string",
});

    type: vcd:Role
properties:
    description: string
    name: string
    org: string
    rights:
        - 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:

    Description string
    A description of the role
    Name string
    The name of the role.
    Org string
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
    Rights List<string>
    Set of rights assigned to this role
    RoleId string
    Description string
    A description of the role
    Name string
    The name of the role.
    Org string
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
    Rights []string
    Set of rights assigned to this role
    RoleId string
    description String
    A description of the role
    name String
    The name of the role.
    org String
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
    rights List<String>
    Set of rights assigned to this role
    roleId String
    description string
    A description of the role
    name string
    The name of the role.
    org string
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
    rights string[]
    Set of rights assigned to this role
    roleId string
    description str
    A description of the role
    name str
    The name of the role.
    org str
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
    rights Sequence[str]
    Set of rights assigned to this role
    role_id str
    description String
    A description of the role
    name String
    The name of the role.
    org String
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
    rights List<String>
    Set of rights assigned to this role
    roleId String

    Outputs

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

    BundleKey string
    Key used for internationalization
    Id string
    The provider-assigned unique ID for this managed resource.
    ReadOnly bool
    Whether this role is read-only
    BundleKey string
    Key used for internationalization
    Id string
    The provider-assigned unique ID for this managed resource.
    ReadOnly bool
    Whether this role is read-only
    bundleKey String
    Key used for internationalization
    id String
    The provider-assigned unique ID for this managed resource.
    readOnly Boolean
    Whether this role is read-only
    bundleKey string
    Key used for internationalization
    id string
    The provider-assigned unique ID for this managed resource.
    readOnly boolean
    Whether this role is read-only
    bundle_key str
    Key used for internationalization
    id str
    The provider-assigned unique ID for this managed resource.
    read_only bool
    Whether this role is read-only
    bundleKey String
    Key used for internationalization
    id String
    The provider-assigned unique ID for this managed resource.
    readOnly Boolean
    Whether this role is read-only

    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,
        bundle_key: Optional[str] = None,
        description: Optional[str] = None,
        name: Optional[str] = None,
        org: Optional[str] = None,
        read_only: Optional[bool] = None,
        rights: Optional[Sequence[str]] = 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: vcd: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:
    BundleKey string
    Key used for internationalization
    Description string
    A description of the role
    Name string
    The name of the role.
    Org string
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
    ReadOnly bool
    Whether this role is read-only
    Rights List<string>
    Set of rights assigned to this role
    RoleId string
    BundleKey string
    Key used for internationalization
    Description string
    A description of the role
    Name string
    The name of the role.
    Org string
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
    ReadOnly bool
    Whether this role is read-only
    Rights []string
    Set of rights assigned to this role
    RoleId string
    bundleKey String
    Key used for internationalization
    description String
    A description of the role
    name String
    The name of the role.
    org String
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
    readOnly Boolean
    Whether this role is read-only
    rights List<String>
    Set of rights assigned to this role
    roleId String
    bundleKey string
    Key used for internationalization
    description string
    A description of the role
    name string
    The name of the role.
    org string
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
    readOnly boolean
    Whether this role is read-only
    rights string[]
    Set of rights assigned to this role
    roleId string
    bundle_key str
    Key used for internationalization
    description str
    A description of the role
    name str
    The name of the role.
    org str
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
    read_only bool
    Whether this role is read-only
    rights Sequence[str]
    Set of rights assigned to this role
    role_id str
    bundleKey String
    Key used for internationalization
    description String
    A description of the role
    name String
    The name of the role.
    org String
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
    readOnly Boolean
    Whether this role is read-only
    rights List<String>
    Set of rights assigned to this role
    roleId String

    Package Details

    Repository
    vcd vmware/terraform-provider-vcd
    License
    Notes
    This Pulumi package is based on the vcd Terraform Provider.
    vcd logo
    vcd 3.14.1 published on Monday, Apr 14, 2025 by vmware
    vmware/terraform-provider-vcd