software.amazon.awscdk.services.iam

Class IRole.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.iam.IRole.Jsii$Proxy

All Implemented Interfaces:

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

Enclosing interface:

IRole

public static final class IRole.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements IRole.Jsii$Default

A proxy class which represents a concrete javascript instance of this type.

Nested Class Summary

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

IRole.Jsii$Default, IRole.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
void	addManagedPolicy(IManagedPolicy policy) Attaches a managed policy to this principal.
java.lang.Boolean	addToPolicy(PolicyStatement statement) Deprecated. Use `addToPrincipalPolicy` instead.
AddToPrincipalPolicyResult	addToPrincipalPolicy(PolicyStatement statement) Add to the policy of this principal.
void	applyRemovalPolicy(RemovalPolicy policy) Apply the given removal policy to this resource.
void	attachInlinePolicy(Policy policy) Attaches an inline policy to this principal.
java.lang.String	getAssumeRoleAction() When this Principal is used in an AssumeRole policy, the action to use.
ResourceEnvironment	getEnv() The environment this resource belongs to.
IPrincipal	getGrantPrincipal() The principal to grant permissions to.
ConstructNode	getNode() The construct tree node for this construct.
PrincipalPolicyFragment	getPolicyFragment() Return the policy fragment that identifies this principal in a Policy.
java.lang.String	getPrincipalAccount() The AWS account ID of this principal.
java.lang.String	getRoleArn() Returns the ARN of this role.
java.lang.String	getRoleName() Returns the name of this role.
Stack	getStack() The stack in which this resource is defined.
Grant	grant(IPrincipal grantee, java.lang.String... actions) Grant the actions defined in actions to the identity Principal on this resource.
Grant	grantAssumeRole(IPrincipal grantee) Grant permissions to the given principal to assume this role.
Grant	grantPassRole(IPrincipal grantee) Grant permissions to the given principal to pass this role.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Method Detail

getGrantPrincipal

public final 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

Specified by:

getGrantPrincipal in interface IRole.Jsii$Default

getAssumeRoleAction

public final 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

Specified by:

getAssumeRoleAction in interface IRole.Jsii$Default

getPolicyFragment

public final 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

Specified by:

getPolicyFragment in interface IRole.Jsii$Default

getPrincipalAccount

public final 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

Specified by:

getPrincipalAccount in interface IRole.Jsii$Default

getNode

public final 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 IResource.Jsii$Default

Specified by:

getNode in interface IIdentity.Jsii$Default

Specified by:

getNode in interface IRole.Jsii$Default

getEnv

public final 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 IResource

Specified by:

getEnv in interface IResource.Jsii$Default

Specified by:

getEnv in interface IIdentity.Jsii$Default

Specified by:

getEnv in interface IRole.Jsii$Default

getStack

public final Stack getStack()

The stack in which this resource is defined.

Specified by:

getStack in interface IResource

Specified by:

getStack in interface IResource.Jsii$Default

Specified by:

getStack in interface IIdentity.Jsii$Default

Specified by:

getStack in interface IRole.Jsii$Default

getRoleArn

public final java.lang.String getRoleArn()

Returns the ARN of this role.

Specified by:

getRoleArn in interface IRole

Specified by:

getRoleArn in interface IRole.Jsii$Default

getRoleName

public final java.lang.String getRoleName()

Returns the name of this role.

Specified by:

getRoleName in interface IRole

Specified by:

getRoleName in interface IRole.Jsii$Default

addToPolicy

@Deprecated
public final 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

Specified by:

addToPolicy in interface IRole.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

public final 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

Specified by:

addToPrincipalPolicy in interface IRole.Jsii$Default

Parameters:

statement - This parameter is required.

applyRemovalPolicy

public final 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 IResource

Specified by:

applyRemovalPolicy in interface IResource.Jsii$Default

Specified by:

applyRemovalPolicy in interface IIdentity.Jsii$Default

Specified by:

applyRemovalPolicy in interface IRole.Jsii$Default

Parameters:

policy - This parameter is required.

addManagedPolicy

public final 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

Specified by:

addManagedPolicy in interface IRole.Jsii$Default

Parameters:

policy - The managed policy. This parameter is required.

attachInlinePolicy

public final 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

Specified by:

attachInlinePolicy in interface IRole.Jsii$Default

Parameters:

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

grant

public final Grant grant(IPrincipal grantee,
                         java.lang.String... actions)

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

Specified by:

grant in interface IRole

Specified by:

grant in interface IRole.Jsii$Default

Parameters:

grantee - This parameter is required.

actions - This parameter is required.

grantAssumeRole

public final Grant grantAssumeRole(IPrincipal grantee)

Grant permissions to the given principal to assume this role.

Specified by:

grantAssumeRole in interface IRole

Specified by:

grantAssumeRole in interface IRole.Jsii$Default

Parameters:

grantee - This parameter is required.

grantPassRole

public final Grant grantPassRole(IPrincipal grantee)

Grant permissions to the given principal to pass this role.

Specified by:

grantPassRole in interface IRole

Specified by:

grantPassRole in interface IRole.Jsii$Default

Parameters:

grantee - This parameter is required.