Package software.amazon.awscdk.services.iam

Interface IAssumeRolePrincipal.Jsii$Default

All Superinterfaces:

IAssumeRolePrincipal, IGrantable, IGrantable.Jsii$Default, IPrincipal, IPrincipal.Jsii$Default, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

IAssumeRolePrincipal.Jsii$Proxy

Enclosing interface:

IAssumeRolePrincipal

@Internal
public static interface IAssumeRolePrincipal.Jsii$Default
extends IAssumeRolePrincipal, IPrincipal.Jsii$Default

Internal default implementation for IAssumeRolePrincipal.

Nested Class Summary

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

IAssumeRolePrincipal.Jsii$Default, IAssumeRolePrincipal.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.IPrincipal

IPrincipal.Jsii$Default, IPrincipal.Jsii$Proxy

Method Summary

Modifier and Type	Method	Description
default void	addToAssumeRolePolicy(PolicyDocument document)	Add the princpial to the AssumeRolePolicyDocument.
default Boolean	addToPolicy(PolicyStatement statement)	Deprecated. Use addToPrincipalPolicy instead.
default AddToPrincipalPolicyResult	addToPrincipalPolicy(PolicyStatement statement)	Add to the policy of this principal.
default String	getAssumeRoleAction()	When this Principal is used in an AssumeRole policy, the action to use.
default IPrincipal	getGrantPrincipal()	The principal to grant permissions to.
default PrincipalPolicyFragment	getPolicyFragment()	Return the policy fragment that identifies this principal in a Policy.
default String	getPrincipalAccount()	The AWS account ID of this principal.

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 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 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 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 IPrincipal

Specified by:

getPrincipalAccount in interface IPrincipal.Jsii$Default

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 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 IPrincipal

Specified by:

addToPrincipalPolicy in interface IPrincipal.Jsii$Default

Parameters:

statement - This parameter is required.

addToAssumeRolePolicy

@Stability(Stable)
default void addToAssumeRolePolicy(@NotNull
 PolicyDocument document)

Add the princpial to the AssumeRolePolicyDocument.

Add the statements to the AssumeRolePolicyDocument necessary to give this principal permissions to assume the given role.

Specified by:

addToAssumeRolePolicy in interface IAssumeRolePrincipal

Parameters:

document - This parameter is required.