Package 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.84.0 (build 5404dcf)", date="2023-06-19T16:29:57.382Z") @Stability(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.unsafePlainText("1234")).build();
 Group group = new Group(this, "MyGroup");
 Policy policy = new Policy(this, "MyPolicy");
 policy.attachToUser(user);
 group.attachInlinePolicy(policy);

  • Method Details

    • getGroups

      @Stability(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(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(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(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(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(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(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(Stable) static UserProps.Builder builder()
      Returns:
      a UserProps.Builder of UserProps