CfnUserPropsMixin

class aws_cdk.mixins_preview.aws_iam.mixins.CfnUserPropsMixin(props, *, strategy=None)

Bases: Mixin

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 .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-user.html
CloudformationResource:: AWS::IAM::User
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_iam import mixins as iam_mixins

# policy_document: Any

cfn_user_props_mixin = iam_mixins.CfnUserPropsMixin(iam_mixins.CfnUserMixinProps(
    groups=["groups"],
    login_profile=iam_mixins.CfnUserPropsMixin.LoginProfileProperty(
        password="password",
        password_reset_required=False
    ),
    managed_policy_arns=["managedPolicyArns"],
    path="path",
    permissions_boundary="permissionsBoundary",
    policies=[iam_mixins.CfnUserPropsMixin.PolicyProperty(
        policy_document=policy_document,
        policy_name="policyName"
    )],
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    user_name="userName"
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::IAM::User.

Parameters:

props (Union[CfnUserMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['groups', 'loginProfile', 'managedPolicyArns', 'path', 'permissionsBoundary', 'policies', 'tags', 'userName']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

LoginProfileProperty

class CfnUserPropsMixin.LoginProfileProperty(*, password=None, password_reset_required=None)

Bases: object

Creates a password for the specified user, giving the user the ability to access AWS services through the the console .

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

Parameters:

password (Optional[str]) – The user’s password.
password_reset_required (Union[bool, IResolvable, None]) – Specifies whether the user is required to set a new password on next sign-in.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user-loginprofile.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_iam import mixins as iam_mixins

login_profile_property = iam_mixins.CfnUserPropsMixin.LoginProfileProperty(
    password="password",
    password_reset_required=False
)

Attributes

password

The user’s password.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user-loginprofile.html#cfn-iam-user-loginprofile-password

password_reset_required

Specifies whether the user is required to set a new password on next sign-in.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user-loginprofile.html#cfn-iam-user-loginprofile-passwordresetrequired

PolicyProperty

class CfnUserPropsMixin.PolicyProperty(*, policy_document=None, policy_name=None)

Bases: object

Contains information about an attached policy.

An attached policy is a managed policy that has been attached to a user, group, or role.

For more information about managed policies, refer to Managed Policies and Inline Policies in the IAM User Guide .

Parameters:

policy_document (Any) – The entire contents of the policy that defines permissions. For more information, see Overview of JSON policies .
policy_name (Optional[str]) – The friendly name (not ARN) identifying the policy.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user-policy.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_iam import mixins as iam_mixins

# policy_document: Any

policy_property = iam_mixins.CfnUserPropsMixin.PolicyProperty(
    policy_document=policy_document,
    policy_name="policyName"
)

Attributes

policy_document

The entire contents of the policy that defines permissions.

For more information, see Overview of JSON policies .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user-policy.html#cfn-iam-user-policy-policydocument

policy_name

The friendly name (not ARN) identifying the policy.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user-policy.html#cfn-iam-user-policy-policyname