Package software.amazon.awscdk.services.iam

Interface IRole.Jsii$Default

All Superinterfaces:

IConstruct, software.constructs.IConstruct, IConstruct.Jsii$Default, software.constructs.IConstruct.Jsii$Default, IDependable, IDependable.Jsii$Default, IGrantable, IGrantable.Jsii$Default, IIdentity, IIdentity.Jsii$Default, IPrincipal, IPrincipal.Jsii$Default, IResource, IResource.Jsii$Default, IRole, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

IRole.Jsii$Proxy

Enclosing interface:

IRole

@Internal
public static interface IRole.Jsii$Default
extends IRole, IIdentity.Jsii$Default

Internal default implementation for IRole.

Nested Class Summary

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default, IConstruct.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default, software.constructs.IConstruct.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IDependable

IDependable.Jsii$Default, IDependable.Jsii$Proxy

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

IGrantable.Jsii$Default, IGrantable.Jsii$Proxy

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

IIdentity.Jsii$Default, IIdentity.Jsii$Proxy

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

IPrincipal.Jsii$Default, IPrincipal.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IResource

IResource.Jsii$Default, IResource.Jsii$Proxy

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

IRole.Jsii$Default, IRole.Jsii$Proxy

Method Summary

Modifier and Type	Method	Description
default void	addManagedPolicy(IManagedPolicy policy)	Attaches a managed policy to this principal.
default 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 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 String	getPrincipalAccount()	The AWS account ID of this principal.
default String	getRoleArn()	Returns the ARN of this role.
default String	getRoleName()	Returns the name of this role.
default Stack	getStack()	The stack in which this resource is defined.
default Grant	grant(IPrincipal grantee, @NotNull String... actions)	Grant the actions defined in actions to the identity Principal on this resource.
default Grant	grantAssumeRole(IPrincipal grantee)	Grant permissions to the given principal to assume this role.
default Grant	grantPassRole(IPrincipal grantee)	Grant permissions to the given principal to pass this role.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getGrantPrincipal

@Stability(Stable)
@NotNull
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

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

@Stability(Stable)
@NotNull
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

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

@Stability(Stable)
@NotNull
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

@Stability(Stable)
@NotNull
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

@Stability(Stable)
@NotNull
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

getRoleArn

@Stability(Stable)
@NotNull
default String getRoleArn()

Returns the ARN of this role.

Specified by:

getRoleArn in interface IRole

getRoleName

@Stability(Stable)
@NotNull
default String getRoleName()

Returns the name of this role.

Specified by:

getRoleName in interface IRole

addToPolicy

@Stability(Deprecated)
@Deprecated
@NotNull
default Boolean addToPolicy(@NotNull
 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

@Stability(Stable)
@NotNull
default AddToPrincipalPolicyResult addToPrincipalPolicy(@NotNull
 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

@Stability(Stable)
default void applyRemovalPolicy(@NotNull
 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

@Stability(Stable)
default void addManagedPolicy(@NotNull
 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

@Stability(Stable)
default void attachInlinePolicy(@NotNull
 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.

grant

@Stability(Stable)
@NotNull
default Grant grant(@NotNull
 IPrincipal grantee,
 @NotNull
 @NotNull String... actions)

Grant the actions defined in actions to the identity Principal on this resource.

Specified by:

grant in interface IRole

Parameters:

grantee - This parameter is required.

actions - This parameter is required.

grantAssumeRole

@Stability(Stable)
@NotNull
default Grant grantAssumeRole(@NotNull
 IPrincipal grantee)

Grant permissions to the given principal to assume this role.

Specified by:

grantAssumeRole in interface IRole

Parameters:

grantee - This parameter is required.

grantPassRole

@Stability(Stable)
@NotNull
default Grant grantPassRole(@NotNull
 IPrincipal grantee)

Grant permissions to the given principal to pass this role.

Specified by:

grantPassRole in interface IRole

Parameters:

grantee - This parameter is required.