software.amazon.awscdk.services.iam

Interface UserProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

UserProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:39.791Z")
 @Stability(value=Stable)
public interface UserProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining an IAM user.

Example:

 User user = User.Builder.create(this, "MyUser").password(SecretValue.plainText("1234")).build();
 Group group = new Group(this, "MyGroup");
 Policy policy = new Policy(this, "MyPolicy");
 policy.attachToUser(user);
 group.attachInlinePolicy(policy);
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	UserProps.Builder A builder for UserProps
static class	UserProps.Jsii$Proxy An implementation for UserProps

Method Summary

Modifier and Type	Method and Description
static UserProps.Builder	builder()
default List<IGroup>	getGroups() Groups to add this user to.
default List<IManagedPolicy>	getManagedPolicies() A list of managed policies associated with this role.
default SecretValue	getPassword() The password for the user.
default Boolean	getPasswordResetRequired() Specifies whether the user is required to set a new password the next time the user logs in to the AWS Management Console.
default String	getPath() The path for the user name.
default IManagedPolicy	getPermissionsBoundary() AWS supports permissions boundaries for IAM entities (users or roles).
default String	getUserName() A name for the IAM user.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getGroups

@Stability(value=Stable)
 @Nullable
default List<IGroup> getGroups()

Groups to add this user to.

You can also use addToGroup to add this user to a group.

Default: - No groups.

getManagedPolicies

@Stability(value=Stable)
 @Nullable
default List<IManagedPolicy> getManagedPolicies()

A list of managed policies associated with this role.

You can add managed policies later using addManagedPolicy(ManagedPolicy.fromAwsManagedPolicyName(policyName)).

Default: - No managed policies.

getPassword

@Stability(value=Stable)
 @Nullable
default SecretValue getPassword()

The password for the user. This is required so the user can access the AWS Management Console.

You can use SecretValue.unsafePlainText to specify a password in plain text or use secretsmanager.Secret.fromSecretAttributes to reference a secret in Secrets Manager.

Default: - User won't be able to access the management console without a password.

getPasswordResetRequired

@Stability(value=Stable)
 @Nullable
default Boolean getPasswordResetRequired()

Specifies whether the user is required to set a new password the next time the user logs in to the AWS Management Console.

If this is set to 'true', you must also specify "initialPassword".

Default: false

getPath

@Stability(value=Stable)
 @Nullable
default String getPath()

The path for the user name.

For more information about paths, see IAM Identifiers in the IAM User Guide.

Default: /

getPermissionsBoundary

@Stability(value=Stable)
 @Nullable
default IManagedPolicy getPermissionsBoundary()

AWS supports permissions boundaries for IAM entities (users or roles).

A permissions boundary is an advanced feature for using a managed policy to set the maximum permissions that an identity-based policy can grant to an IAM entity. An entity's permissions boundary allows it to perform only the actions that are allowed by both its identity-based policies and its permissions boundaries.

Default: - No permissions boundary.

getUserName

@Stability(value=Stable)
 @Nullable
default String getUserName()

A name for the IAM user.

For valid values, see the UserName parameter for the CreateUser action in the IAM API Reference. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the user name.

If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.

If you specify a name, you must specify the CAPABILITY_NAMED_IAM value to acknowledge your template's capabilities. For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.

Default: - Generated by CloudFormation (recommended)

builder

@Stability(value=Stable)
static UserProps.Builder builder()

Returns:

a UserProps.Builder of UserProps