Class CfnUser
A CloudFormation AWS::IAM::User.
public class CfnUser : CfnResource, IInspectable- Inheritance
-
CfnUser
- Implements
-
IInspectable
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.IAM;
var policyDocument;
var cfnUser = new CfnUser(this, "MyCfnUser", new CfnUserProps {
Groups = new [] { "groups" },
LoginProfile = new LoginProfileProperty {
Password = "password",
// the properties below are optional
PasswordResetRequired = false
},
ManagedPolicyArns = new [] { "managedPolicyArns" },
Path = "path",
PermissionsBoundary = "permissionsBoundary",
Policies = new [] { new PolicyProperty {
PolicyDocument = policyDocument,
PolicyName = "policyName"
} },
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} },
UserName = "userName"
});Remarks
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 .
CloudformationResource: AWS::IAM::User
Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user.html
ExampleMetadata: fixture=_generated
Constructors
CfnUser(Construct, string, ICfnUserProps?)
Create a new AWS::IAM::User.
public CfnUser(Construct scope, string id, ICfnUserProps? props = null)Parameters
scopeConstruct- scope in which this resource is defined.
idstring- scoped id of the resource.
propsICfnUserProps- resource properties.
Properties
AttrArn
Returns the Amazon Resource Name (ARN) for the specified AWS::IAM::User resource.
public virtual string AttrArn { get; }Property Value
Remarks
For example: arn:aws:iam::123456789012:user/mystack-myuser-1CCXAFG2H2U4D .
CloudformationAttribute: Arn
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }Property Value
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }Property Value
Groups
A list of group names to which you want to add the user.
public virtual string[]? Groups { get; set; }Property Value
- string[]
Remarks
LoginProfile
Creates a password for the specified IAM user.
public virtual object? LoginProfile { get; set; }Property Value
Remarks
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 .
ManagedPolicyArns
A list of Amazon Resource Names (ARNs) of the IAM managed policies that you want to attach to the user.
public virtual string[]? ManagedPolicyArns { get; set; }Property Value
- string[]
Remarks
For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference .
Path
The path for the user name.
public virtual string? Path { get; set; }Property Value
Remarks
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.
PermissionsBoundary
The ARN of the managed policy that is used to set the permissions boundary for the user.
public virtual string? PermissionsBoundary { get; set; }Property Value
Remarks
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 .
Policies
Adds or updates an inline policy document that is embedded in the specified IAM user.
public virtual object? Policies { get; set; }Property Value
Remarks
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 .
Tags
A list of tags that you want to attach to the new user.
public virtual TagManager Tags { get; }Property Value
- TagManager
Remarks
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.
UserName
The name of the user to create. Do not include the path in this value.
public virtual string? UserName { get; set; }Property Value
Remarks
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 <code>Fn::Join</code> and <code>AWS::Region</code> to create a Region-specific name, as in the following example: <code>{"Fn::Join": ["", [{"Ref": "AWS::Region"}, {"Ref": "MyResourceName"}]]}</code> .
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)Parameters
inspectorTreeInspector- tree inspector to collect and process attributes.
RenderProperties(IDictionary<string, object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)Parameters
propsIDictionary<string, object>