Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Aquasec
  3. API Docs
  4. Role
Aquasec v0.8.29 published on Monday, Jul 22, 2024 by Pulumiverse
pulumiverse/pulumi-aquasec

aquasec.Role

Explore with Pulumi AI

aquasec logo
Aquasec v0.8.29 published on Monday, Jul 22, 2024 by Pulumiverse
pulumiverse/pulumi-aquasec

    The aquasec.Role resource manages your roles within Aqua.

    The roles created must have permission set and at least one Role Application Scope that is already present within Aqua.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as aquasec from "@pulumiverse/aquasec";

const iaC = new aquasec.Role("iaC", {
    description: "RoleIaC",
    permission: "PermissionIaC",
    roleName: "RoleIaC",
    scopes: ["Global"],
});

    import pulumi
import pulumiverse_aquasec as aquasec

ia_c = aquasec.Role("iaC",
    description="RoleIaC",
    permission="PermissionIaC",
    role_name="RoleIaC",
    scopes=["Global"])

    package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumiverse/pulumi-aquasec/sdk/go/aquasec"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := aquasec.NewRole(ctx, "iaC", &aquasec.RoleArgs{
			Description: pulumi.String("RoleIaC"),
			Permission:  pulumi.String("PermissionIaC"),
			RoleName:    pulumi.String("RoleIaC"),
			Scopes: pulumi.StringArray{
				pulumi.String("Global"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aquasec = Pulumiverse.Aquasec;

return await Deployment.RunAsync(() => 
{
    var iaC = new Aquasec.Role("iaC", new()
    {
        Description = "RoleIaC",
        Permission = "PermissionIaC",
        RoleName = "RoleIaC",
        Scopes = new[]
        {
            "Global",
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aquasec.Role;
import com.pulumi.aquasec.RoleArgs;
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 iaC = new Role("iaC", RoleArgs.builder()
            .description("RoleIaC")
            .permission("PermissionIaC")
            .roleName("RoleIaC")
            .scopes("Global")
            .build());

    }
}

    resources:
  iaC:
    type: aquasec:Role
    properties:
      description: RoleIaC
      permission: PermissionIaC
      roleName: RoleIaC
      scopes:
        - Global

    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,
         permission: Optional[str] = None,
         role_name: Optional[str] = None,
         scopes: Optional[Sequence[str]] = None,
         description: 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: aquasec: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 Aquasec.Role("roleResource", new()
{
    Permission = "string",
    RoleName = "string",
    Scopes = new[]
    {
        "string",
    },
    Description = "string",
});

    example, err := aquasec.NewRole(ctx, "roleResource", &aquasec.RoleArgs{
	Permission: pulumi.String("string"),
	RoleName:   pulumi.String("string"),
	Scopes: pulumi.StringArray{
		pulumi.String("string"),
	},
	Description: pulumi.String("string"),
})

    var roleResource = new Role("roleResource", RoleArgs.builder()
    .permission("string")
    .roleName("string")
    .scopes("string")
    .description("string")
    .build());

    role_resource = aquasec.Role("roleResource",
    permission="string",
    role_name="string",
    scopes=["string"],
    description="string")

    const roleResource = new aquasec.Role("roleResource", {
    permission: "string",
    roleName: "string",
    scopes: ["string"],
    description: "string",
});

    type: aquasec:Role
properties:
    description: string
    permission: string
    roleName: string
    scopes:
        - 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:

    Permission string
    The name of the Permission Set that will affect the users assigned to this specific Role.
    RoleName string
    The name of the role, comprised of alphanumeric characters and '-', '_', ' ', ':', '.', '@', '!', '^'.
    Scopes List<string>
    List of Application Scopes that will affect the users assigned to this specific Role.
    Description string
    Free text description for the role.
    Permission string
    The name of the Permission Set that will affect the users assigned to this specific Role.
    RoleName string
    The name of the role, comprised of alphanumeric characters and '-', '_', ' ', ':', '.', '@', '!', '^'.
    Scopes []string
    List of Application Scopes that will affect the users assigned to this specific Role.
    Description string
    Free text description for the role.
    permission String
    The name of the Permission Set that will affect the users assigned to this specific Role.
    roleName String
    The name of the role, comprised of alphanumeric characters and '-', '_', ' ', ':', '.', '@', '!', '^'.
    scopes List<String>
    List of Application Scopes that will affect the users assigned to this specific Role.
    description String
    Free text description for the role.
    permission string
    The name of the Permission Set that will affect the users assigned to this specific Role.
    roleName string
    The name of the role, comprised of alphanumeric characters and '-', '_', ' ', ':', '.', '@', '!', '^'.
    scopes string[]
    List of Application Scopes that will affect the users assigned to this specific Role.
    description string
    Free text description for the role.
    permission str
    The name of the Permission Set that will affect the users assigned to this specific Role.
    role_name str
    The name of the role, comprised of alphanumeric characters and '-', '_', ' ', ':', '.', '@', '!', '^'.
    scopes Sequence[str]
    List of Application Scopes that will affect the users assigned to this specific Role.
    description str
    Free text description for the role.
    permission String
    The name of the Permission Set that will affect the users assigned to this specific Role.
    roleName String
    The name of the role, comprised of alphanumeric characters and '-', '_', ' ', ':', '.', '@', '!', '^'.
    scopes List<String>
    List of Application Scopes that will affect the users assigned to this specific Role.
    description String
    Free text description for the role.

    Outputs

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

    Author string
    The name of the user who created the role. Only returned from the API for existing permissions, not part of the permission creation/modification structure.
    Id string
    The provider-assigned unique ID for this managed resource.
    UpdatedAt string
    The date of the last modification of the role.
    Author string
    The name of the user who created the role. Only returned from the API for existing permissions, not part of the permission creation/modification structure.
    Id string
    The provider-assigned unique ID for this managed resource.
    UpdatedAt string
    The date of the last modification of the role.
    author String
    The name of the user who created the role. Only returned from the API for existing permissions, not part of the permission creation/modification structure.
    id String
    The provider-assigned unique ID for this managed resource.
    updatedAt String
    The date of the last modification of the role.
    author string
    The name of the user who created the role. Only returned from the API for existing permissions, not part of the permission creation/modification structure.
    id string
    The provider-assigned unique ID for this managed resource.
    updatedAt string
    The date of the last modification of the role.
    author str
    The name of the user who created the role. Only returned from the API for existing permissions, not part of the permission creation/modification structure.
    id str
    The provider-assigned unique ID for this managed resource.
    updated_at str
    The date of the last modification of the role.
    author String
    The name of the user who created the role. Only returned from the API for existing permissions, not part of the permission creation/modification structure.
    id String
    The provider-assigned unique ID for this managed resource.
    updatedAt String
    The date of the last modification of the role.

    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,
        author: Optional[str] = None,
        description: Optional[str] = None,
        permission: Optional[str] = None,
        role_name: Optional[str] = None,
        scopes: Optional[Sequence[str]] = None,
        updated_at: 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)
    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:
    Author string
    The name of the user who created the role. Only returned from the API for existing permissions, not part of the permission creation/modification structure.
    Description string
    Free text description for the role.
    Permission string
    The name of the Permission Set that will affect the users assigned to this specific Role.
    RoleName string
    The name of the role, comprised of alphanumeric characters and '-', '_', ' ', ':', '.', '@', '!', '^'.
    Scopes List<string>
    List of Application Scopes that will affect the users assigned to this specific Role.
    UpdatedAt string
    The date of the last modification of the role.
    Author string
    The name of the user who created the role. Only returned from the API for existing permissions, not part of the permission creation/modification structure.
    Description string
    Free text description for the role.
    Permission string
    The name of the Permission Set that will affect the users assigned to this specific Role.
    RoleName string
    The name of the role, comprised of alphanumeric characters and '-', '_', ' ', ':', '.', '@', '!', '^'.
    Scopes []string
    List of Application Scopes that will affect the users assigned to this specific Role.
    UpdatedAt string
    The date of the last modification of the role.
    author String
    The name of the user who created the role. Only returned from the API for existing permissions, not part of the permission creation/modification structure.
    description String
    Free text description for the role.
    permission String
    The name of the Permission Set that will affect the users assigned to this specific Role.
    roleName String
    The name of the role, comprised of alphanumeric characters and '-', '_', ' ', ':', '.', '@', '!', '^'.
    scopes List<String>
    List of Application Scopes that will affect the users assigned to this specific Role.
    updatedAt String
    The date of the last modification of the role.
    author string
    The name of the user who created the role. Only returned from the API for existing permissions, not part of the permission creation/modification structure.
    description string
    Free text description for the role.
    permission string
    The name of the Permission Set that will affect the users assigned to this specific Role.
    roleName string
    The name of the role, comprised of alphanumeric characters and '-', '_', ' ', ':', '.', '@', '!', '^'.
    scopes string[]
    List of Application Scopes that will affect the users assigned to this specific Role.
    updatedAt string
    The date of the last modification of the role.
    author str
    The name of the user who created the role. Only returned from the API for existing permissions, not part of the permission creation/modification structure.
    description str
    Free text description for the role.
    permission str
    The name of the Permission Set that will affect the users assigned to this specific Role.
    role_name str
    The name of the role, comprised of alphanumeric characters and '-', '_', ' ', ':', '.', '@', '!', '^'.
    scopes Sequence[str]
    List of Application Scopes that will affect the users assigned to this specific Role.
    updated_at str
    The date of the last modification of the role.
    author String
    The name of the user who created the role. Only returned from the API for existing permissions, not part of the permission creation/modification structure.
    description String
    Free text description for the role.
    permission String
    The name of the Permission Set that will affect the users assigned to this specific Role.
    roleName String
    The name of the role, comprised of alphanumeric characters and '-', '_', ' ', ':', '.', '@', '!', '^'.
    scopes List<String>
    List of Application Scopes that will affect the users assigned to this specific Role.
    updatedAt String
    The date of the last modification of the role.

    Package Details

    Repository
    aquasec pulumiverse/pulumi-aquasec
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aquasec Terraform Provider.
    aquasec logo
    Aquasec v0.8.29 published on Monday, Jul 22, 2024 by Pulumiverse
    pulumiverse/pulumi-aquasec