Package software.amazon.awscdk.services.iam

Interface CfnUserProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnUserProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.102.0 (build e354887)",
           date="2024-08-23T05:56:17.778Z")
@Stability(Stable)
public interface CfnUserProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnUser.

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;
 CfnUserProps cfnUserProps = CfnUserProps.builder()
         .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();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-user.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnUserProps.Builder	A builder for CfnUserProps
static final class	CfnUserProps.Jsii$Proxy	An implementation for CfnUserProps

Method Summary

Modifier and Type	Method	Description
static CfnUserProps.Builder	builder()
default List<String>	getGroups()	A list of group names to which you want to add the user.
default Object	getLoginProfile()	Creates a password for the specified IAM user.
default List<String>	getManagedPolicyArns()	A list of Amazon Resource Names (ARNs) of the IAM managed policies that you want to attach to the user.
default String	getPath()	The path for the user name.
default String	getPermissionsBoundary()	The ARN of the managed policy that is used to set the permissions boundary for the user.
default Object	getPolicies()	Adds or updates an inline policy document that is embedded in the specified IAM user.
default List<CfnTag>	getTags()	A list of tags that you want to attach to the new user.
default String	getUserName()	The name of the user to create.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getGroups

@Stability(Stable)
@Nullable
default List<String> getGroups()

A list of group names to which you want to add the user.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-user.html#cfn-iam-user-groups

getLoginProfile

@Stability(Stable)
@Nullable
default 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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-user.html#cfn-iam-user-loginprofile

getManagedPolicyArns

@Stability(Stable)
@Nullable
default 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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-user.html#cfn-iam-user-managedpolicyarns

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 .

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 ! ( ! ) through the DEL character (  ), including most punctuation characters, digits, and upper and lowercased letters.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-user.html#cfn-iam-user-path

getPermissionsBoundary

@Stability(Stable)
@Nullable
default 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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-user.html#cfn-iam-user-permissionsboundary

getPolicies

@Stability(Stable)
@Nullable
default 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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-user.html#cfn-iam-user-policies

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> 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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-user.html#cfn-iam-user-tags

getUserName

@Stability(Stable)
@Nullable
default 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"}]]} .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-user.html#cfn-iam-user-username

builder

@Stability(Stable)
static CfnUserProps.Builder builder()

Returns:

a CfnUserProps.Builder of CfnUserProps