software.amazon.awscdk.services.iam

Class SessionTagsPrincipal

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.iam.PrincipalBase

software.amazon.awscdk.services.iam.SessionTagsPrincipal

All Implemented Interfaces:

IAssumeRolePrincipal, IComparablePrincipal, IGrantable, IPrincipal, software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:39.789Z")
 @Stability(value=Stable)
public class SessionTagsPrincipal
extends PrincipalBase

Enables session tags on role assumptions from a principal.

For more information on session tags, see: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_session-tags.html

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.iam.*;
 IPrincipal principal;
 SessionTagsPrincipal sessionTagsPrincipal = new SessionTagsPrincipal(principal);
 

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

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

IAssumeRolePrincipal.Jsii$Default

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

IComparablePrincipal.Jsii$Default

Constructor Summary

Constructors

Modifier	Constructor and Description
	SessionTagsPrincipal(IPrincipal principal)
protected	SessionTagsPrincipal(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	SessionTagsPrincipal(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
void	addToAssumeRolePolicy(PolicyDocument doc) Add the princpial to the AssumeRolePolicyDocument.
Boolean	addToPolicy(PolicyStatement statement) Add to the policy of this principal.
AddToPrincipalPolicyResult	addToPrincipalPolicy(PolicyStatement statement) Add to the policy of this principal.
protected String	appendDedupe(String append) Append the given string to the wrapped principal's dedupe string (if available).
String	dedupeString() Return whether or not this principal is equal to the given principal.
String	getAssumeRoleAction() When this Principal is used in an AssumeRole policy, the action to use.
PrincipalPolicyFragment	getPolicyFragment() Return the policy fragment that identifies this principal in a Policy.
String	getPrincipalAccount() The AWS account ID of this principal.

Methods inherited from class software.amazon.awscdk.services.iam.PrincipalBase

getGrantPrincipal, toJSON, toString, withConditions, withSessionTags

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Constructor Detail

SessionTagsPrincipal

protected SessionTagsPrincipal(software.amazon.jsii.JsiiObjectRef objRef)

SessionTagsPrincipal

protected SessionTagsPrincipal(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

SessionTagsPrincipal

@Stability(value=Stable)
public SessionTagsPrincipal(@NotNull
                                                     IPrincipal principal)

Parameters:

principal - This parameter is required.

Method Detail

addToAssumeRolePolicy

@Stability(value=Stable)
public void addToAssumeRolePolicy(@NotNull
                                                           PolicyDocument doc)

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

Overrides:

addToAssumeRolePolicy in class PrincipalBase

Parameters:

doc - This parameter is required.

addToPolicy

@Stability(value=Stable)
 @NotNull
public Boolean addToPolicy(@NotNull
                                                              PolicyStatement statement)

Add to the policy of this principal.

Overrides:

addToPolicy in class PrincipalBase

Parameters:

statement - This parameter is required.

addToPrincipalPolicy

@Stability(value=Stable)
 @NotNull
public AddToPrincipalPolicyResult addToPrincipalPolicy(@NotNull
                                                                                          PolicyStatement statement)

Add to the policy of this principal.

Specified by:

addToPrincipalPolicy in interface IPrincipal

Overrides:

addToPrincipalPolicy in class PrincipalBase

Parameters:

statement - This parameter is required.

appendDedupe

@Stability(value=Stable)
 @Nullable
protected String appendDedupe(@NotNull
                                                                  String append)

Append the given string to the wrapped principal's dedupe string (if available).

Parameters:

append - This parameter is required.

dedupeString

@Stability(value=Stable)
 @Nullable
public String dedupeString()

Return whether or not this principal is equal to the given principal.

Specified by:

dedupeString in interface IComparablePrincipal

Specified by:

dedupeString in class PrincipalBase

getAssumeRoleAction

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

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

Specified by:

getAssumeRoleAction in interface IPrincipal

Overrides:

getAssumeRoleAction in class PrincipalBase

getPolicyFragment

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

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

Specified by:

getPolicyFragment in interface IPrincipal

Specified by:

getPolicyFragment in class PrincipalBase

getPrincipalAccount

@Stability(value=Stable)
 @Nullable
public 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

Overrides:

getPrincipalAccount in class PrincipalBase