@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)", date="2023-03-22T19:35:36.590Z") public class CfnUser extends CfnResource implements IInspectable
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();
Modifier and Type | Class and Description |
---|---|
static class |
CfnUser.Builder
A fluent builder for
CfnUser . |
static interface |
CfnUser.LoginProfileProperty
Creates a password for the specified user, giving the user the ability to access AWS services through the AWS Management Console .
|
static interface |
CfnUser.PolicyProperty
Contains information about an attached policy.
|
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
Modifier | Constructor and Description |
---|---|
|
CfnUser(Construct scope,
java.lang.String id)
Create a new `AWS::IAM::User`.
|
|
CfnUser(Construct scope,
java.lang.String id,
CfnUserProps props)
Create a new `AWS::IAM::User`.
|
protected |
CfnUser(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) |
protected |
CfnUser(software.amazon.jsii.JsiiObjectRef objRef) |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getAttrArn()
Returns the Amazon Resource Name (ARN) for the specified `AWS::IAM::User` resource.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
getCfnProperties() |
java.util.List<java.lang.String> |
getGroups()
A list of group names to which you want to add the user.
|
java.lang.Object |
getLoginProfile()
Creates a password for the specified IAM user.
|
java.util.List<java.lang.String> |
getManagedPolicyArns()
A list of Amazon Resource Names (ARNs) of the IAM managed policies that you want to attach to the user.
|
java.lang.String |
getPath()
The path for the user name.
|
java.lang.String |
getPermissionsBoundary()
The ARN of the managed policy that is used to set the permissions boundary for the user.
|
java.lang.Object |
getPolicies()
Adds or updates an inline policy document that is embedded in the specified IAM user.
|
TagManager |
getTags()
A list of tags that you want to attach to the new user.
|
java.lang.String |
getUserName()
The name of the user to create.
|
void |
inspect(TreeInspector inspector)
Examines the CloudFormation resource and discloses attributes.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
renderProperties(java.util.Map<java.lang.String,java.lang.Object> props) |
void |
setGroups(java.util.List<java.lang.String> value)
A list of group names to which you want to add the user.
|
void |
setLoginProfile(CfnUser.LoginProfileProperty value)
Creates a password for the specified IAM user.
|
void |
setLoginProfile(IResolvable value)
Creates a password for the specified IAM user.
|
void |
setManagedPolicyArns(java.util.List<java.lang.String> value)
A list of Amazon Resource Names (ARNs) of the IAM managed policies that you want to attach to the user.
|
void |
setPath(java.lang.String value)
The path for the user name.
|
void |
setPermissionsBoundary(java.lang.String value)
The ARN of the managed policy that is used to set the permissions boundary for the user.
|
void |
setPolicies(IResolvable value)
Adds or updates an inline policy document that is embedded in the specified IAM user.
|
void |
setPolicies(java.util.List<java.lang.Object> value)
Adds or updates an inline policy document that is embedded in the specified IAM user.
|
void |
setUserName(java.lang.String value)
The name of the user to create.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnUser(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnUser(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnUser(Construct scope, java.lang.String id, CfnUserProps props)
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.public CfnUser(Construct scope, java.lang.String id)
scope
- - scope in which this resource is defined. This parameter is required.id
- - scoped id of the resource. This parameter is required.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.public java.lang.String getAttrArn()
For example: arn:aws:iam::123456789012:user/mystack-myuser-1CCXAFG2H2U4D
.
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public TagManager getTags()
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.
public java.util.List<java.lang.String> getGroups()
public void setGroups(java.util.List<java.lang.String> value)
public java.lang.Object getLoginProfile()
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 .
public void setLoginProfile(IResolvable value)
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 .
public void setLoginProfile(CfnUser.LoginProfileProperty value)
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 .
public java.util.List<java.lang.String> getManagedPolicyArns()
For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference .
public void setManagedPolicyArns(java.util.List<java.lang.String> value)
For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference .
public java.lang.String getPath()
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.
public void setPath(java.lang.String value)
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.
public java.lang.String getPermissionsBoundary()
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 .
public void setPermissionsBoundary(java.lang.String value)
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 .
public java.lang.Object getPolicies()
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 .
public void setPolicies(IResolvable value)
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 .
public void setPolicies(java.util.List<java.lang.Object> value)
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 .
public java.lang.String getUserName()
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
andAWS::Region
to create a Region-specific name, as in the following example:{"Fn::Join": ["", [{"Ref": "AWS::Region"}, {"Ref": "MyResourceName"}]]}
.
public void setUserName(java.lang.String 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
andAWS::Region
to create a Region-specific name, as in the following example:{"Fn::Join": ["", [{"Ref": "AWS::Region"}, {"Ref": "MyResourceName"}]]}
.