awx 0.29.1, Apr 14 25

awx 0.29.1 published on Monday, Apr 14, 2025 by denouche

awx.User

Explore with Pulumi AI

awx 0.29.1 published on Monday, Apr 14, 2025 by denouche

Create User Resource

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

Constructor syntax

new User(name: string, args: UserArgs, opts?: CustomResourceOptions);

@overload
def User(resource_name: str,
         args: UserArgs,
         opts: Optional[ResourceOptions] = None)

@overload
def User(resource_name: str,
         opts: Optional[ResourceOptions] = None,
         password: Optional[str] = None,
         username: Optional[str] = None,
         email: Optional[str] = None,
         first_name: Optional[str] = None,
         is_superuser: Optional[bool] = None,
         is_system_auditor: Optional[bool] = None,
         last_name: Optional[str] = None,
         role_entitlements: Optional[Sequence[UserRoleEntitlementArgs]] = None,
         user_id: Optional[str] = None)

func NewUser(ctx *Context, name string, args UserArgs, opts ...ResourceOption) (*User, error)

public User(string name, UserArgs args, CustomResourceOptions? opts = null)

public User(String name, UserArgs args)
public User(String name, UserArgs args, CustomResourceOptions options)

type: awx:User
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 UserArgs: 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 UserArgs: 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 UserArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args UserArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args UserArgs: 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 userResource = new Awx.User("userResource", new()
{
    Password = "string",
    Username = "string",
    Email = "string",
    FirstName = "string",
    IsSuperuser = false,
    IsSystemAuditor = false,
    LastName = "string",
    RoleEntitlements = new[]
    {
        new Awx.Inputs.UserRoleEntitlementArgs
        {
            RoleId = 0,
        },
    },
    UserId = "string",
});

example, err := awx.NewUser(ctx, "userResource", &awx.UserArgs{
	Password:        pulumi.String("string"),
	Username:        pulumi.String("string"),
	Email:           pulumi.String("string"),
	FirstName:       pulumi.String("string"),
	IsSuperuser:     pulumi.Bool(false),
	IsSystemAuditor: pulumi.Bool(false),
	LastName:        pulumi.String("string"),
	RoleEntitlements: awx.UserRoleEntitlementArray{
		&awx.UserRoleEntitlementArgs{
			RoleId: pulumi.Float64(0),
		},
	},
	UserId: pulumi.String("string"),
})

var userResource = new User("userResource", UserArgs.builder()
    .password("string")
    .username("string")
    .email("string")
    .firstName("string")
    .isSuperuser(false)
    .isSystemAuditor(false)
    .lastName("string")
    .roleEntitlements(UserRoleEntitlementArgs.builder()
        .roleId(0)
        .build())
    .userId("string")
    .build());

user_resource = awx.User("userResource",
    password="string",
    username="string",
    email="string",
    first_name="string",
    is_superuser=False,
    is_system_auditor=False,
    last_name="string",
    role_entitlements=[{
        "role_id": 0,
    }],
    user_id="string")

const userResource = new awx.User("userResource", {
    password: "string",
    username: "string",
    email: "string",
    firstName: "string",
    isSuperuser: false,
    isSystemAuditor: false,
    lastName: "string",
    roleEntitlements: [{
        roleId: 0,
    }],
    userId: "string",
});

type: awx:User
properties:
    email: string
    firstName: string
    isSuperuser: false
    isSystemAuditor: false
    lastName: string
    password: string
    roleEntitlements:
        - roleId: 0
    userId: string
    username: string

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

Password string
Username string
Email string
FirstName string
IsSuperuser bool
IsSystemAuditor bool
LastName string
RoleEntitlements List<UserRoleEntitlement>: Set of role IDs of the role entitlements
UserId string

Password string
Username string
Email string
FirstName string
IsSuperuser bool
IsSystemAuditor bool
LastName string
RoleEntitlements []UserRoleEntitlementArgs: Set of role IDs of the role entitlements
UserId string

password String
username String
email String
firstName String
isSuperuser Boolean
isSystemAuditor Boolean
lastName String
roleEntitlements List<UserRoleEntitlement>: Set of role IDs of the role entitlements
userId String

password string
username string
email string
firstName string
isSuperuser boolean
isSystemAuditor boolean
lastName string
roleEntitlements UserRoleEntitlement[]: Set of role IDs of the role entitlements
userId string

password str
username str
email str
first_name str
is_superuser bool
is_system_auditor bool
last_name str
role_entitlements Sequence[UserRoleEntitlementArgs]: Set of role IDs of the role entitlements
user_id str

password String
username String
email String
firstName String
isSuperuser Boolean
isSystemAuditor Boolean
lastName String
roleEntitlements List<Property Map>: Set of role IDs of the role entitlements
userId String

Outputs

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

Get an existing User 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?: UserState, opts?: CustomResourceOptions): User

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        email: Optional[str] = None,
        first_name: Optional[str] = None,
        is_superuser: Optional[bool] = None,
        is_system_auditor: Optional[bool] = None,
        last_name: Optional[str] = None,
        password: Optional[str] = None,
        role_entitlements: Optional[Sequence[UserRoleEntitlementArgs]] = None,
        user_id: Optional[str] = None,
        username: Optional[str] = None) -> User

func GetUser(ctx *Context, name string, id IDInput, state *UserState, opts ...ResourceOption) (*User, error)

public static User Get(string name, Input<string> id, UserState? state, CustomResourceOptions? opts = null)

public static User get(String name, Output<String> id, UserState state, CustomResourceOptions options)

resources:  _:    type: awx:User    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:

Email string
FirstName string
IsSuperuser bool
IsSystemAuditor bool
LastName string
Password string
RoleEntitlements List<UserRoleEntitlement>: Set of role IDs of the role entitlements
UserId string
Username string

Email string
FirstName string
IsSuperuser bool
IsSystemAuditor bool
LastName string
Password string
RoleEntitlements []UserRoleEntitlementArgs: Set of role IDs of the role entitlements
UserId string
Username string

email String
firstName String
isSuperuser Boolean
isSystemAuditor Boolean
lastName String
password String
roleEntitlements List<UserRoleEntitlement>: Set of role IDs of the role entitlements
userId String
username String

email string
firstName string
isSuperuser boolean
isSystemAuditor boolean
lastName string
password string
roleEntitlements UserRoleEntitlement[]: Set of role IDs of the role entitlements
userId string
username string

email str
first_name str
is_superuser bool
is_system_auditor bool
last_name str
password str
role_entitlements Sequence[UserRoleEntitlementArgs]: Set of role IDs of the role entitlements
user_id str
username str

email String
firstName String
isSuperuser Boolean
isSystemAuditor Boolean
lastName String
password String
roleEntitlements List<Property Map>: Set of role IDs of the role entitlements
userId String
username String

Supporting Types

UserRoleEntitlement, UserRoleEntitlementArgs

RoleId double

RoleId float64

roleId Double

roleId number

role_id float

roleId Number

Package Details

Repository: awx denouche/terraform-provider-awx
License
Notes: This Pulumi package is based on the awx Terraform Provider.

awx 0.29.1 published on Monday, Apr 14, 2025 by denouche

denouche/terraform-provider-awx

awx.User

On this page

On this page

Create User Resource

Constructor syntax

Parameters

Constructor example

User Resource Properties

Inputs

Outputs

Look up Existing User Resource

Supporting Types

UserRoleEntitlement, UserRoleEntitlementArgs

Package Details

On this page

On this page