Class UserLoginProfile

Manages an IAM User Login Profile with limited support for password creation during this provider resource creation. Uses PGP to encrypt the password for safe transport to the user. PGP keys can be obtained from Keybase.

To reset an IAM User login password via this provider, you can use delete and recreate this resource or change any of the arguments.

Example Usage

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
public MyStack()
{
    var exampleUser = new Aws.Iam.User("exampleUser", new Aws.Iam.UserArgs
    {
        ForceDestroy = true,
        Path = "/",
    });
    var exampleUserLoginProfile = new Aws.Iam.UserLoginProfile("exampleUserLoginProfile", new Aws.Iam.UserLoginProfileArgs
    {
        PgpKey = "keybase:some_person_that_exists",
        User = exampleUser.Name,
    });
    this.Password = exampleUserLoginProfile.EncryptedPassword;
}

[Output("password")]
public Output<string> Password { get; set; }
}

Inheritance

System.Object

Resource

CustomResource

UserLoginProfile

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Aws.Iam

Assembly: Pulumi.Aws.dll

Syntax

public class UserLoginProfile : CustomResource

Constructors

UserLoginProfile(String, UserLoginProfileArgs, CustomResourceOptions)

Create a UserLoginProfile resource with the given unique name, arguments, and options.

Declaration

public UserLoginProfile(string name, UserLoginProfileArgs args, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
UserLoginProfileArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

EncryptedPassword

The encrypted password, base64 encoded. Only available if password was handled on this provider resource creation, not import.

Declaration

public Output<string> EncryptedPassword { get; }

Property Value

Type	Description
Output<System.String>

KeyFingerprint

The fingerprint of the PGP key used to encrypt the password. Only available if password was handled on this provider resource creation, not import.

Declaration

public Output<string> KeyFingerprint { get; }

Property Value

Type	Description
Output<System.String>

PasswordLength

The length of the generated password on resource creation. Only applies on resource creation. Drift detection is not possible with this argument.

Declaration

public Output<int?> PasswordLength { get; }

Property Value

Type	Description
Output<System.Nullable<System.Int32>>

PasswordResetRequired

Whether the user should be forced to reset the generated password on resource creation. Only applies on resource creation. Drift detection is not possible with this argument.

Declaration

public Output<bool?> PasswordResetRequired { get; }

Property Value

Type	Description
Output<System.Nullable<System.Boolean>>

PgpKey

Either a base-64 encoded PGP public key, or a keybase username in the form keybase:username. Only applies on resource creation. Drift detection is not possible with this argument.

Declaration

public Output<string> PgpKey { get; }

Property Value

Type	Description
Output<System.String>

User

The IAM user's name.

Declaration

public Output<string> User { get; }

Property Value

Type	Description
Output<System.String>

Methods

Get(String, Input<String>, UserLoginProfileState, CustomResourceOptions)

Get an existing UserLoginProfile resource's state with the given name, ID, and optional extra properties used to qualify the lookup.

Declaration

public static UserLoginProfile Get(string name, Input<string> id, UserLoginProfileState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
UserLoginProfileState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
UserLoginProfile