Package software.amazon.awscdk.services.iam

Class CfnUser

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.iam.CfnUser
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:57.278Z") @Stability(Stable) public class CfnUser extends CfnResource implements IInspectable
A CloudFormation AWS::IAM::User.

Creates a new IAM user for your AWS account .

For information about quotas for the number of IAM users you can create, see IAM and AWS STS quotas in the IAM User Guide .

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.iam.*;
 Object policyDocument;
 CfnUser cfnUser = CfnUser.Builder.create(this, "MyCfnUser")
         .groups(List.of("groups"))
         .loginProfile(LoginProfileProperty.builder()
                 .password("password")
                 // the properties below are optional
                 .passwordResetRequired(false)
                 .build())
         .managedPolicyArns(List.of("managedPolicyArns"))
         .path("path")
         .permissionsBoundary("permissionsBoundary")
         .policies(List.of(PolicyProperty.builder()
                 .policyDocument(policyDocument)
                 .policyName("policyName")
                 .build()))
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .userName("userName")
         .build();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnUser

      protected CfnUser(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnUser

      protected CfnUser(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnUser

      @Stability(Stable) public CfnUser(@NotNull Construct scope, @NotNull String id, @Nullable CfnUserProps props)
      Create a new AWS::IAM::User.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.

    • CfnUser

      @Stability(Stable) public CfnUser(@NotNull Construct scope, @NotNull String id)
      Create a new AWS::IAM::User.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector -
      • tree inspector to collect and process attributes.
      This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      Returns the Amazon Resource Name (ARN) for the specified AWS::IAM::User resource.

      For example: arn:aws:iam::123456789012:user/mystack-myuser-1CCXAFG2H2U4D .

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      A list of tags that you want to attach to the new user.

      Each tag consists of a key name and an associated value. For more information about tagging, see Tagging IAM resources in the IAM User Guide .

      If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created.

    • getGroups

      @Stability(Stable) @Nullable public List<String> getGroups()
      A list of group names to which you want to add the user.

    • setGroups

      @Stability(Stable) public void setGroups(@Nullable List<String> value)
      A list of group names to which you want to add the user.

    • getLoginProfile

      @Stability(Stable) @Nullable public Object getLoginProfile()
      Creates a password for the specified IAM user.

      A password allows an IAM user to access AWS services through the AWS Management Console .

      You can use the AWS CLI , the AWS API, or the Users page in the IAM console to create a password for any IAM user. Use ChangePassword to update your own existing password in the My Security Credentials page in the AWS Management Console .

      For more information about managing passwords, see Managing passwords in the IAM User Guide .

    • setLoginProfile

      @Stability(Stable) public void setLoginProfile(@Nullable IResolvable value)
      Creates a password for the specified IAM user.

      A password allows an IAM user to access AWS services through the AWS Management Console .

      You can use the AWS CLI , the AWS API, or the Users page in the IAM console to create a password for any IAM user. Use ChangePassword to update your own existing password in the My Security Credentials page in the AWS Management Console .

      For more information about managing passwords, see Managing passwords in the IAM User Guide .

    • setLoginProfile

      @Stability(Stable) public void setLoginProfile(@Nullable CfnUser.LoginProfileProperty value)
      Creates a password for the specified IAM user.

      A password allows an IAM user to access AWS services through the AWS Management Console .

      You can use the AWS CLI , the AWS API, or the Users page in the IAM console to create a password for any IAM user. Use ChangePassword to update your own existing password in the My Security Credentials page in the AWS Management Console .

      For more information about managing passwords, see Managing passwords in the IAM User Guide .

    • getManagedPolicyArns

      @Stability(Stable) @Nullable public List<String> getManagedPolicyArns()
      A list of Amazon Resource Names (ARNs) of the IAM managed policies that you want to attach to the user.

      For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference .

    • setManagedPolicyArns

      @Stability(Stable) public void setManagedPolicyArns(@Nullable List<String> value)
      A list of Amazon Resource Names (ARNs) of the IAM managed policies that you want to attach to the user.

      For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference .

    • getPath

      @Stability(Stable) @Nullable public String getPath()
      The path for the user name.

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

      This parameter is optional. If it is not included, it defaults to a slash (/).

      This parameter allows (through its regex pattern ) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! ( \ u0021 ) through the DEL character ( \ u007F ), including most punctuation characters, digits, and upper and lowercased letters.

    • setPath

      @Stability(Stable) public void setPath(@Nullable String value)
      The path for the user name.

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

      This parameter is optional. If it is not included, it defaults to a slash (/).

      This parameter allows (through its regex pattern ) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! ( \ u0021 ) through the DEL character ( \ u007F ), including most punctuation characters, digits, and upper and lowercased letters.

    • getPermissionsBoundary

      @Stability(Stable) @Nullable public String getPermissionsBoundary()
      The ARN of the managed policy that is used to set the permissions boundary for the user.

      A permissions boundary policy defines the maximum permissions that identity-based policies can grant to an entity, but does not grant permissions. Permissions boundaries do not define the maximum permissions that a resource-based policy can grant to an entity. To learn more, see Permissions boundaries for IAM entities in the IAM User Guide .

      For more information about policy types, see Policy types in the IAM User Guide .

    • setPermissionsBoundary

      @Stability(Stable) public void setPermissionsBoundary(@Nullable String value)
      The ARN of the managed policy that is used to set the permissions boundary for the user.

      A permissions boundary policy defines the maximum permissions that identity-based policies can grant to an entity, but does not grant permissions. Permissions boundaries do not define the maximum permissions that a resource-based policy can grant to an entity. To learn more, see Permissions boundaries for IAM entities in the IAM User Guide .

      For more information about policy types, see Policy types in the IAM User Guide .

    • getPolicies

      @Stability(Stable) @Nullable public Object getPolicies()
      Adds or updates an inline policy document that is embedded in the specified IAM user.

      To view AWS::IAM::User snippets, see Declaring an IAM User Resource .

      The name of each policy for a role, user, or group must be unique. If you don't choose unique names, updates to the IAM identity will fail.

      For information about limits on the number of inline policies that you can embed in a user, see Limitations on IAM Entities in the IAM User Guide .

    • setPolicies

      @Stability(Stable) public void setPolicies(@Nullable IResolvable value)
      Adds or updates an inline policy document that is embedded in the specified IAM user.

      To view AWS::IAM::User snippets, see Declaring an IAM User Resource .

      The name of each policy for a role, user, or group must be unique. If you don't choose unique names, updates to the IAM identity will fail.

      For information about limits on the number of inline policies that you can embed in a user, see Limitations on IAM Entities in the IAM User Guide .

    • setPolicies

      @Stability(Stable) public void setPolicies(@Nullable List<Object> value)
      Adds or updates an inline policy document that is embedded in the specified IAM user.

      To view AWS::IAM::User snippets, see Declaring an IAM User Resource .

      The name of each policy for a role, user, or group must be unique. If you don't choose unique names, updates to the IAM identity will fail.

      For information about limits on the number of inline policies that you can embed in a user, see Limitations on IAM Entities in the IAM User Guide .

    • getUserName

      @Stability(Stable) @Nullable public String getUserName()
      The name of the user to create. Do not include the path in this value.

      This parameter allows (per its regex pattern ) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-. The user name must be unique within the account. User names are not distinguished by case. For example, you cannot create users named both "John" and "john".

      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 must specify the CAPABILITY_NAMED_IAM value to acknowledge your template's capabilities. For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates .

      Naming an IAM resource can cause an unrecoverable error if you reuse the same template in multiple Regions. To prevent this, we recommend using Fn::Join and AWS::Region to create a Region-specific name, as in the following example: {"Fn::Join": ["", [{"Ref": "AWS::Region"}, {"Ref": "MyResourceName"}]]} .

    • setUserName

      @Stability(Stable) public void setUserName(@Nullable String value)
      The name of the user to create. Do not include the path in this value.

      This parameter allows (per its regex pattern ) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-. The user name must be unique within the account. User names are not distinguished by case. For example, you cannot create users named both "John" and "john".

      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 must specify the CAPABILITY_NAMED_IAM value to acknowledge your template's capabilities. For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates .

      Naming an IAM resource can cause an unrecoverable error if you reuse the same template in multiple Regions. To prevent this, we recommend using Fn::Join and AWS::Region to create a Region-specific name, as in the following example: {"Fn::Join": ["", [{"Ref": "AWS::Region"}, {"Ref": "MyResourceName"}]]} .