Class RoleInfo
- java.lang.Object
-
- com.amazonaws.auth.profile.internal.securitytoken.RoleInfo
-
-
Constructor Summary
Constructors Constructor Description RoleInfo()
Default constructor for RoleInfo object.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description RoleInfo
clone()
boolean
equals(Object obj)
String
getExternalId()
A unique identifier that is used by third parties when assuming roles in their customers' accounts.AWSCredentialsProvider
getLongLivedCredentialsProvider()
Provides the credentials that are used to assume the role.String
getRoleArn()
The Amazon Resource Name (ARN) of the role to assume.String
getRoleSessionName()
An identifier for the assumed role session.int
hashCode()
void
setExternalId(String externalId)
A unique identifier that is used by third parties when assuming roles in their customers' accounts.void
setLongLivedCredentialsProvider(AWSCredentialsProvider longLivedCredentialsProvider)
Provides the credentials that are used to assume the role.void
setRoleArn(String roleArn)
The Amazon Resource Name (ARN) of the role to assume.void
setRoleSessionName(String roleSessionName)
An identifier for the assumed role session.String
toString()
Returns a string representation of this object; useful for testing and debugging.RoleInfo
withExternalId(String externalId)
A unique identifier that is used by third parties when assuming roles in their customers' accounts.RoleInfo
withLongLivedCredentials(AWSCredentials longLivedCredentials)
Provides the credentials that are used to assume the role.RoleInfo
withLongLivedCredentialsProvider(AWSCredentialsProvider longLivedCredentialsProvider)
Provides the credentials that are used to assume the role.RoleInfo
withRoleArn(String roleArn)
The Amazon Resource Name (ARN) of the role to assume.RoleInfo
withRoleSessionName(String roleSessionName)
An identifier for the assumed role session.
-
-
-
Method Detail
-
setRoleArn
public void setRoleArn(String roleArn)
The Amazon Resource Name (ARN) of the role to assume.
- Parameters:
roleArn
- The Amazon Resource Name (ARN) of the role to assume.
-
getRoleArn
public String getRoleArn()
The Amazon Resource Name (ARN) of the role to assume.
- Returns:
- The Amazon Resource Name (ARN) of the role to assume.
-
withRoleArn
public RoleInfo withRoleArn(String roleArn)
The Amazon Resource Name (ARN) of the role to assume.
- Parameters:
roleArn
- The Amazon Resource Name (ARN) of the role to assume.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setRoleSessionName
public void setRoleSessionName(String roleSessionName)
An identifier for the assumed role session.
Use the role session name to uniquely identify a session when the same role is assumed by different principals or for different reasons. In cross-account scenarios, the role session name is visible to, and can be logged by the account that owns the role. The role session name is also used in the ARN of the assumed role principal. This means that subsequent cross-account API requests using the temporary security credentials will expose the role session name to the external account in their CloudTrail logs.
- Parameters:
roleSessionName
- An identifier for the assumed role session.Use the role session name to uniquely identify a session when the same role is assumed by different principals or for different reasons. In cross-account scenarios, the role session name is visible to, and can be logged by the account that owns the role. The role session name is also used in the ARN of the assumed role principal. This means that subsequent cross-account API requests using the temporary security credentials will expose the role session name to the external account in their CloudTrail logs.
-
getRoleSessionName
public String getRoleSessionName()
An identifier for the assumed role session.
Use the role session name to uniquely identify a session when the same role is assumed by different principals or for different reasons. In cross-account scenarios, the role session name is visible to, and can be logged by the account that owns the role. The role session name is also used in the ARN of the assumed role principal. This means that subsequent cross-account API requests using the temporary security credentials will expose the role session name to the external account in their CloudTrail logs.
- Returns:
- An identifier for the assumed role session.
Use the role session name to uniquely identify a session when the same role is assumed by different principals or for different reasons. In cross-account scenarios, the role session name is visible to, and can be logged by the account that owns the role. The role session name is also used in the ARN of the assumed role principal. This means that subsequent cross-account API requests using the temporary security credentials will expose the role session name to the external account in their CloudTrail logs.
-
withRoleSessionName
public RoleInfo withRoleSessionName(String roleSessionName)
An identifier for the assumed role session.
Use the role session name to uniquely identify a session when the same role is assumed by different principals or for different reasons. In cross-account scenarios, the role session name is visible to, and can be logged by the account that owns the role. The role session name is also used in the ARN of the assumed role principal. This means that subsequent cross-account API requests using the temporary security credentials will expose the role session name to the external account in their CloudTrail logs.
- Parameters:
roleSessionName
- An identifier for the assumed role session.Use the role session name to uniquely identify a session when the same role is assumed by different principals or for different reasons. In cross-account scenarios, the role session name is visible to, and can be logged by the account that owns the role. The role session name is also used in the ARN of the assumed role principal. This means that subsequent cross-account API requests using the temporary security credentials will expose the role session name to the external account in their CloudTrail logs.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setExternalId
public void setExternalId(String externalId)
A unique identifier that is used by third parties when assuming roles in their customers' accounts. For each role that the third party can assume, they should instruct their customers to ensure the role's trust policy checks for the external ID that the third party generated. Each time the third party assumes the role, they should pass the customer's external ID. The external ID is useful in order to help third parties bind a role to the customer who created it. For more information about the external ID, see How to Use an External ID When Granting Access to Your AWS Resources to a Third Party in the Using IAM.
- Parameters:
externalId
- A unique identifier that is used by third parties when assuming roles in their customers' accounts. For each role that the third party can assume, they should instruct their customers to ensure the role's trust policy checks for the external ID that the third party generated. Each time the third party assumes the role, they should pass the customer's external ID. The external ID is useful in order to help third parties bind a role to the customer who created it. For more information about the external ID, see How to Use an External ID When Granting Access to Your AWS Resources to a Third Party in the Using IAM.
-
getExternalId
public String getExternalId()
A unique identifier that is used by third parties when assuming roles in their customers' accounts. For each role that the third party can assume, they should instruct their customers to ensure the role's trust policy checks for the external ID that the third party generated. Each time the third party assumes the role, they should pass the customer's external ID. The external ID is useful in order to help third parties bind a role to the customer who created it. For more information about the external ID, see How to Use an External ID When Granting Access to Your AWS Resources to a Third Party in the Using IAM.
- Returns:
- A unique identifier that is used by third parties when assuming roles in their customers' accounts. For each role that the third party can assume, they should instruct their customers to ensure the role's trust policy checks for the external ID that the third party generated. Each time the third party assumes the role, they should pass the customer's external ID. The external ID is useful in order to help third parties bind a role to the customer who created it. For more information about the external ID, see How to Use an External ID When Granting Access to Your AWS Resources to a Third Party in the Using IAM.
-
withExternalId
public RoleInfo withExternalId(String externalId)
A unique identifier that is used by third parties when assuming roles in their customers' accounts. For each role that the third party can assume, they should instruct their customers to ensure the role's trust policy checks for the external ID that the third party generated. Each time the third party assumes the role, they should pass the customer's external ID. The external ID is useful in order to help third parties bind a role to the customer who created it. For more information about the external ID, see How to Use an External ID When Granting Access to Your AWS Resources to a Third Party in the Using IAM.
- Parameters:
externalId
- A unique identifier that is used by third parties when assuming roles in their customers' accounts. For each role that the third party can assume, they should instruct their customers to ensure the role's trust policy checks for the external ID that the third party generated. Each time the third party assumes the role, they should pass the customer's external ID. The external ID is useful in order to help third parties bind a role to the customer who created it. For more information about the external ID, see How to Use an External ID When Granting Access to Your AWS Resources to a Third Party in the Using IAM.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setLongLivedCredentialsProvider
public void setLongLivedCredentialsProvider(AWSCredentialsProvider longLivedCredentialsProvider)
Provides the credentials that are used to assume the role.
- Parameters:
longLivedCredentialsProvider
- long lived credentials provider
-
getLongLivedCredentialsProvider
public AWSCredentialsProvider getLongLivedCredentialsProvider()
Provides the credentials that are used to assume the role.
- Returns:
- long lived credentials provider
-
withLongLivedCredentialsProvider
public RoleInfo withLongLivedCredentialsProvider(AWSCredentialsProvider longLivedCredentialsProvider)
Provides the credentials that are used to assume the role.
- Parameters:
longLivedCredentialsProvider
- long lived credentials provider- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withLongLivedCredentials
public RoleInfo withLongLivedCredentials(AWSCredentials longLivedCredentials)
Provides the credentials that are used to assume the role.
- Parameters:
longLivedCredentials
- long lived credentials- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
toString
public String toString()
Returns a string representation of this object; useful for testing and debugging.- Overrides:
toString
in classObject
- Returns:
- A string representation of this object.
- See Also:
Object.toString()
-
-