Modifier and Type | Method and Description |
---|---|
User |
build() |
static User.Builder |
create(software.constructs.Construct scope,
java.lang.String id) |
User.Builder |
groups(java.util.List<? extends IGroup> groups)
Groups to add this user to.
|
User.Builder |
managedPolicies(java.util.List<? extends IManagedPolicy> managedPolicies)
A list of managed policies associated with this role.
|
User.Builder |
password(SecretValue password)
The password for the user.
|
User.Builder |
passwordResetRequired(java.lang.Boolean passwordResetRequired)
Specifies whether the user is required to set a new password the next time the user logs in to the AWS Management Console.
|
User.Builder |
path(java.lang.String path)
The path for the user name.
|
User.Builder |
permissionsBoundary(IManagedPolicy permissionsBoundary)
AWS supports permissions boundaries for IAM entities (users or roles).
|
User.Builder |
userName(java.lang.String userName)
A name for the IAM user.
|
public static User.Builder create(software.constructs.Construct scope, java.lang.String id)
scope
- This parameter is required.id
- This parameter is required.User.Builder
.public User.Builder groups(java.util.List<? extends IGroup> groups)
You can also use addToGroup
to add this
user to a group.
Default: - No groups.
groups
- Groups to add this user to. This parameter is required.this
public User.Builder managedPolicies(java.util.List<? extends IManagedPolicy> managedPolicies)
You can add managed policies later using
addManagedPolicy(ManagedPolicy.fromAwsManagedPolicyName(policyName))
.
Default: - No managed policies.
managedPolicies
- A list of managed policies associated with this role. This parameter is required.this
public User.Builder password(SecretValue password)
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.
password
- The password for the user. This is required so the user can access the AWS Management Console. This parameter is required.this
public User.Builder passwordResetRequired(java.lang.Boolean passwordResetRequired)
If this is set to 'true', you must also specify "initialPassword".
Default: false
passwordResetRequired
- Specifies whether the user is required to set a new password the next time the user logs in to the AWS Management Console. This parameter is required.this
public User.Builder path(java.lang.String path)
For more information about paths, see IAM Identifiers in the IAM User Guide.
Default: /
path
- The path for the user name. This parameter is required.this
public User.Builder permissionsBoundary(IManagedPolicy permissionsBoundary)
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.
permissionsBoundary
- AWS supports permissions boundaries for IAM entities (users or roles). This parameter is required.this
public User.Builder userName(java.lang.String userName)
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)
userName
- A name for the IAM user. This parameter is required.this
public User build()