software.amazon.awscdk.services.iam

Interface IPrincipal.Jsii$Default

All Superinterfaces:

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

All Known Subinterfaces:

IAssumeRolePrincipal.Jsii$Default, IComparablePrincipal.Jsii$Default, IGroup.Jsii$Default, IIdentity.Jsii$Default, IRole.Jsii$Default, IUser.Jsii$Default

All Known Implementing Classes:

IAssumeRolePrincipal.Jsii$Proxy, IComparablePrincipal.Jsii$Proxy, IGroup.Jsii$Proxy, IIdentity.Jsii$Proxy, IPrincipal.Jsii$Proxy, IRole.Jsii$Proxy, IUser.Jsii$Proxy

Enclosing interface:

IPrincipal

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

Internal default implementation for IPrincipal.

Nested Class Summary

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

IPrincipal.Jsii$Default, IPrincipal.Jsii$Proxy

Method Summary

Modifier and Type	Method and Description
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 Detail

getGrantPrincipal

@Stability(value=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

getAssumeRoleAction

@Stability(value=Stable)
 @NotNull
default String getAssumeRoleAction()

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

Specified by:

getAssumeRoleAction in interface IPrincipal

getPolicyFragment

@Stability(value=Stable)
 @NotNull
default PrincipalPolicyFragment getPolicyFragment()

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

Specified by:

getPolicyFragment in interface IPrincipal

getPrincipalAccount

@Stability(value=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

addToPolicy

@Stability(value=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

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(value=Stable)
 @NotNull
default AddToPrincipalPolicyResult addToPrincipalPolicy(@NotNull
                                                                                           PolicyStatement statement)

Add to the policy of this principal.

Specified by:

addToPrincipalPolicy in interface IPrincipal

Parameters:

statement - This parameter is required.