software.amazon.awscdk.services.iam

Interface IUser.Jsii$Default

All Superinterfaces:

IConstruct, IConstruct.Jsii$Default, IDependable, IDependable.Jsii$Default, IGrantable, IGrantable.Jsii$Default, IIdentity, IIdentity.Jsii$Default, IPrincipal, IPrincipal.Jsii$Default, IResource, IResource.Jsii$Default, IUser

All Known Implementing Classes:

IUser.Jsii$Proxy

Enclosing interface:

IUser

public static interface IUser.Jsii$Default
extends IUser, IIdentity.Jsii$Default

Internal default implementation for IUser.

Nested Class Summary

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.iam.IUser

IUser.Jsii$Default, IUser.Jsii$Proxy

Method Summary

Modifier and Type	Method and Description
default void	addManagedPolicy(IManagedPolicy policy) Attaches a managed policy to this principal.
default void	addToGroup(IGroup group) Adds this user to a group.
default java.lang.Boolean	addToPolicy(PolicyStatement statement) Deprecated. Use `addToPrincipalPolicy` instead.
default AddToPrincipalPolicyResult	addToPrincipalPolicy(PolicyStatement statement) Add to the policy of this principal.
default void	applyRemovalPolicy(RemovalPolicy policy) Apply the given removal policy to this resource.
default void	attachInlinePolicy(Policy policy) Attaches an inline policy to this principal.
default java.lang.String	getAssumeRoleAction() When this Principal is used in an AssumeRole policy, the action to use.
default ResourceEnvironment	getEnv() The environment this resource belongs to.
default IPrincipal	getGrantPrincipal() The principal to grant permissions to.
default ConstructNode	getNode() The construct tree node for this construct.
default PrincipalPolicyFragment	getPolicyFragment() Return the policy fragment that identifies this principal in a Policy.
default java.lang.String	getPrincipalAccount() The AWS account ID of this principal.
default Stack	getStack() The stack in which this resource is defined.
default java.lang.String	getUserArn() The user's ARN.
default java.lang.String	getUserName() The user's name.

Method Detail

getGrantPrincipal

default IPrincipal getGrantPrincipal()

The principal to grant permissions to.

Specified by:

getGrantPrincipal in interface IGrantable

Specified by:

getGrantPrincipal in interface IGrantable.Jsii$Default

Specified by:

getGrantPrincipal in interface IIdentity.Jsii$Default

Specified by:

getGrantPrincipal in interface IPrincipal.Jsii$Default

getAssumeRoleAction

default java.lang.String getAssumeRoleAction()

When this Principal is used in an AssumeRole policy, the action to use.

Specified by:

getAssumeRoleAction in interface IIdentity.Jsii$Default

Specified by:

getAssumeRoleAction in interface IPrincipal

Specified by:

getAssumeRoleAction in interface IPrincipal.Jsii$Default

getPolicyFragment

default PrincipalPolicyFragment getPolicyFragment()

Return the policy fragment that identifies this principal in a Policy.

Specified by:

getPolicyFragment in interface IIdentity.Jsii$Default

Specified by:

getPolicyFragment in interface IPrincipal

Specified by:

getPolicyFragment in interface IPrincipal.Jsii$Default

getPrincipalAccount

default java.lang.String getPrincipalAccount()

The AWS account ID of this principal.

Can be undefined when the account is not known (for example, for service principals). Can be a Token - in that case, it's assumed to be AWS::AccountId.

Specified by:

getPrincipalAccount in interface IIdentity.Jsii$Default

Specified by:

getPrincipalAccount in interface IPrincipal

Specified by:

getPrincipalAccount in interface IPrincipal.Jsii$Default

getNode

default ConstructNode getNode()

The construct tree node for this construct.

Specified by:

getNode in interface IConstruct

Specified by:

getNode in interface IConstruct.Jsii$Default

Specified by:

getNode in interface IIdentity.Jsii$Default

Specified by:

getNode in interface IResource.Jsii$Default

getEnv

default ResourceEnvironment getEnv()

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

Specified by:

getEnv in interface IIdentity.Jsii$Default

Specified by:

getEnv in interface IResource

Specified by:

getEnv in interface IResource.Jsii$Default

getStack

default Stack getStack()

The stack in which this resource is defined.

Specified by:

getStack in interface IIdentity.Jsii$Default

Specified by:

getStack in interface IResource

Specified by:

getStack in interface IResource.Jsii$Default

getUserArn

default java.lang.String getUserArn()

The user's ARN.

Specified by:

getUserArn in interface IUser

getUserName

default java.lang.String getUserName()

The user's name.

Specified by:

getUserName in interface IUser

addToPolicy

@Deprecated
default java.lang.Boolean addToPolicy(PolicyStatement statement)

Deprecated. Use `addToPrincipalPolicy` instead.

(deprecated) Add to the policy of this principal.

Specified by:

addToPolicy in interface IIdentity.Jsii$Default

Specified by:

addToPolicy in interface IPrincipal

Specified by:

addToPolicy in interface IPrincipal.Jsii$Default

Parameters:

statement - This parameter is required.

Returns:

true if the statement was added, false if the principal in question does not have a policy document to add the statement to.

addToPrincipalPolicy

default AddToPrincipalPolicyResult addToPrincipalPolicy(PolicyStatement statement)

Add to the policy of this principal.

Specified by:

addToPrincipalPolicy in interface IIdentity.Jsii$Default

Specified by:

addToPrincipalPolicy in interface IPrincipal

Specified by:

addToPrincipalPolicy in interface IPrincipal.Jsii$Default

Parameters:

statement - This parameter is required.

applyRemovalPolicy

default void applyRemovalPolicy(RemovalPolicy policy)

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Specified by:

applyRemovalPolicy in interface IIdentity.Jsii$Default

Specified by:

applyRemovalPolicy in interface IResource

Specified by:

applyRemovalPolicy in interface IResource.Jsii$Default

Parameters:

policy - This parameter is required.

addManagedPolicy

default void addManagedPolicy(IManagedPolicy policy)

Attaches a managed policy to this principal.

Specified by:

addManagedPolicy in interface IIdentity

Specified by:

addManagedPolicy in interface IIdentity.Jsii$Default

Parameters:

policy - The managed policy. This parameter is required.

attachInlinePolicy

default void attachInlinePolicy(Policy policy)

Attaches an inline policy to this principal.

This is the same as calling policy.addToXxx(principal).

Specified by:

attachInlinePolicy in interface IIdentity

Specified by:

attachInlinePolicy in interface IIdentity.Jsii$Default

Parameters:

policy - The policy resource to attach to this principal [disable-awslint:ref-via-interface]. This parameter is required.

addToGroup

default void addToGroup(IGroup group)

Adds this user to a group.

Specified by:

addToGroup in interface IUser

Parameters:

group - This parameter is required.