Class AssumeRoleWithWebIdentityResult
- java.lang.Object
-
- com.amazonaws.services.securitytoken.model.AssumeRoleWithWebIdentityResult
-
- All Implemented Interfaces:
Serializable
,Cloneable
public class AssumeRoleWithWebIdentityResult extends Object implements Serializable, Cloneable
Contains the response to a successful AssumeRoleWithWebIdentity request, including temporary AWS credentials that can be used to make AWS requests.
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description AssumeRoleWithWebIdentityResult()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description AssumeRoleWithWebIdentityResult
clone()
boolean
equals(Object obj)
AssumedRoleUser
getAssumedRoleUser()
The Amazon Resource Name (ARN) and the assumed role ID, which are identifiers that you can use to refer to the resulting temporary security credentials.String
getAudience()
The intended audience (also known as client ID) of the web identity token.Credentials
getCredentials()
The temporary security credentials, which include an access key ID, a secret access key, and a security token.Integer
getPackedPolicySize()
A percentage value that indicates the size of the policy in packed form.String
getProvider()
The issuing authority of the web identity token presented.String
getSubjectFromWebIdentityToken()
The unique user identifier that is returned by the identity provider.int
hashCode()
void
setAssumedRoleUser(AssumedRoleUser assumedRoleUser)
The Amazon Resource Name (ARN) and the assumed role ID, which are identifiers that you can use to refer to the resulting temporary security credentials.void
setAudience(String audience)
The intended audience (also known as client ID) of the web identity token.void
setCredentials(Credentials credentials)
The temporary security credentials, which include an access key ID, a secret access key, and a security token.void
setPackedPolicySize(Integer packedPolicySize)
A percentage value that indicates the size of the policy in packed form.void
setProvider(String provider)
The issuing authority of the web identity token presented.void
setSubjectFromWebIdentityToken(String subjectFromWebIdentityToken)
The unique user identifier that is returned by the identity provider.String
toString()
Returns a string representation of this object; useful for testing and debugging.AssumeRoleWithWebIdentityResult
withAssumedRoleUser(AssumedRoleUser assumedRoleUser)
The Amazon Resource Name (ARN) and the assumed role ID, which are identifiers that you can use to refer to the resulting temporary security credentials.AssumeRoleWithWebIdentityResult
withAudience(String audience)
The intended audience (also known as client ID) of the web identity token.AssumeRoleWithWebIdentityResult
withCredentials(Credentials credentials)
The temporary security credentials, which include an access key ID, a secret access key, and a security token.AssumeRoleWithWebIdentityResult
withPackedPolicySize(Integer packedPolicySize)
A percentage value that indicates the size of the policy in packed form.AssumeRoleWithWebIdentityResult
withProvider(String provider)
The issuing authority of the web identity token presented.AssumeRoleWithWebIdentityResult
withSubjectFromWebIdentityToken(String subjectFromWebIdentityToken)
The unique user identifier that is returned by the identity provider.
-
-
-
Method Detail
-
setCredentials
public void setCredentials(Credentials credentials)
The temporary security credentials, which include an access key ID, a secret access key, and a security token.
Note: The size of the security token that STS APIs return is not fixed. We strongly recommend that you make no assumptions about the maximum size. As of this writing, the typical size is less than 4096 bytes, but that can vary. Also, future updates to AWS might require larger sizes.
- Parameters:
credentials
- The temporary security credentials, which include an access key ID, a secret access key, and a security token.Note: The size of the security token that STS APIs return is not fixed. We strongly recommend that you make no assumptions about the maximum size. As of this writing, the typical size is less than 4096 bytes, but that can vary. Also, future updates to AWS might require larger sizes.
-
getCredentials
public Credentials getCredentials()
The temporary security credentials, which include an access key ID, a secret access key, and a security token.
Note: The size of the security token that STS APIs return is not fixed. We strongly recommend that you make no assumptions about the maximum size. As of this writing, the typical size is less than 4096 bytes, but that can vary. Also, future updates to AWS might require larger sizes.
- Returns:
- The temporary security credentials, which include an access key
ID, a secret access key, and a security token.
Note: The size of the security token that STS APIs return is not fixed. We strongly recommend that you make no assumptions about the maximum size. As of this writing, the typical size is less than 4096 bytes, but that can vary. Also, future updates to AWS might require larger sizes.
-
withCredentials
public AssumeRoleWithWebIdentityResult withCredentials(Credentials credentials)
The temporary security credentials, which include an access key ID, a secret access key, and a security token.
Note: The size of the security token that STS APIs return is not fixed. We strongly recommend that you make no assumptions about the maximum size. As of this writing, the typical size is less than 4096 bytes, but that can vary. Also, future updates to AWS might require larger sizes.
- Parameters:
credentials
- The temporary security credentials, which include an access key ID, a secret access key, and a security token.Note: The size of the security token that STS APIs return is not fixed. We strongly recommend that you make no assumptions about the maximum size. As of this writing, the typical size is less than 4096 bytes, but that can vary. Also, future updates to AWS might require larger sizes.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setSubjectFromWebIdentityToken
public void setSubjectFromWebIdentityToken(String subjectFromWebIdentityToken)
The unique user identifier that is returned by the identity provider. This identifier is associated with the
WebIdentityToken
that was submitted with theAssumeRoleWithWebIdentity
call. The identifier is typically unique to the user and the application that acquired theWebIdentityToken
(pairwise identifier). For OpenID Connect ID tokens, this field contains the value returned by the identity provider as the token'ssub
(Subject) claim.- Parameters:
subjectFromWebIdentityToken
- The unique user identifier that is returned by the identity provider. This identifier is associated with theWebIdentityToken
that was submitted with theAssumeRoleWithWebIdentity
call. The identifier is typically unique to the user and the application that acquired theWebIdentityToken
(pairwise identifier). For OpenID Connect ID tokens, this field contains the value returned by the identity provider as the token'ssub
(Subject) claim.
-
getSubjectFromWebIdentityToken
public String getSubjectFromWebIdentityToken()
The unique user identifier that is returned by the identity provider. This identifier is associated with the
WebIdentityToken
that was submitted with theAssumeRoleWithWebIdentity
call. The identifier is typically unique to the user and the application that acquired theWebIdentityToken
(pairwise identifier). For OpenID Connect ID tokens, this field contains the value returned by the identity provider as the token'ssub
(Subject) claim.- Returns:
- The unique user identifier that is returned by the identity
provider. This identifier is associated with the
WebIdentityToken
that was submitted with theAssumeRoleWithWebIdentity
call. The identifier is typically unique to the user and the application that acquired theWebIdentityToken
(pairwise identifier). For OpenID Connect ID tokens, this field contains the value returned by the identity provider as the token'ssub
(Subject) claim.
-
withSubjectFromWebIdentityToken
public AssumeRoleWithWebIdentityResult withSubjectFromWebIdentityToken(String subjectFromWebIdentityToken)
The unique user identifier that is returned by the identity provider. This identifier is associated with the
WebIdentityToken
that was submitted with theAssumeRoleWithWebIdentity
call. The identifier is typically unique to the user and the application that acquired theWebIdentityToken
(pairwise identifier). For OpenID Connect ID tokens, this field contains the value returned by the identity provider as the token'ssub
(Subject) claim.- Parameters:
subjectFromWebIdentityToken
- The unique user identifier that is returned by the identity provider. This identifier is associated with theWebIdentityToken
that was submitted with theAssumeRoleWithWebIdentity
call. The identifier is typically unique to the user and the application that acquired theWebIdentityToken
(pairwise identifier). For OpenID Connect ID tokens, this field contains the value returned by the identity provider as the token'ssub
(Subject) claim.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setAssumedRoleUser
public void setAssumedRoleUser(AssumedRoleUser assumedRoleUser)
The Amazon Resource Name (ARN) and the assumed role ID, which are identifiers that you can use to refer to the resulting temporary security credentials. For example, you can reference these credentials as a principal in a resource-based policy by using the ARN or assumed role ID. The ARN and ID include the
RoleSessionName
that you specified when you calledAssumeRole
.- Parameters:
assumedRoleUser
- The Amazon Resource Name (ARN) and the assumed role ID, which are identifiers that you can use to refer to the resulting temporary security credentials. For example, you can reference these credentials as a principal in a resource-based policy by using the ARN or assumed role ID. The ARN and ID include theRoleSessionName
that you specified when you calledAssumeRole
.
-
getAssumedRoleUser
public AssumedRoleUser getAssumedRoleUser()
The Amazon Resource Name (ARN) and the assumed role ID, which are identifiers that you can use to refer to the resulting temporary security credentials. For example, you can reference these credentials as a principal in a resource-based policy by using the ARN or assumed role ID. The ARN and ID include the
RoleSessionName
that you specified when you calledAssumeRole
.- Returns:
- The Amazon Resource Name (ARN) and the assumed role ID, which are
identifiers that you can use to refer to the resulting temporary
security credentials. For example, you can reference these
credentials as a principal in a resource-based policy by using
the ARN or assumed role ID. The ARN and ID include the
RoleSessionName
that you specified when you calledAssumeRole
.
-
withAssumedRoleUser
public AssumeRoleWithWebIdentityResult withAssumedRoleUser(AssumedRoleUser assumedRoleUser)
The Amazon Resource Name (ARN) and the assumed role ID, which are identifiers that you can use to refer to the resulting temporary security credentials. For example, you can reference these credentials as a principal in a resource-based policy by using the ARN or assumed role ID. The ARN and ID include the
RoleSessionName
that you specified when you calledAssumeRole
.- Parameters:
assumedRoleUser
- The Amazon Resource Name (ARN) and the assumed role ID, which are identifiers that you can use to refer to the resulting temporary security credentials. For example, you can reference these credentials as a principal in a resource-based policy by using the ARN or assumed role ID. The ARN and ID include theRoleSessionName
that you specified when you calledAssumeRole
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setPackedPolicySize
public void setPackedPolicySize(Integer packedPolicySize)
A percentage value that indicates the size of the policy in packed form. The service rejects any policy with a packed size greater than 100 percent, which means the policy exceeded the allowed space.
- Parameters:
packedPolicySize
- A percentage value that indicates the size of the policy in packed form. The service rejects any policy with a packed size greater than 100 percent, which means the policy exceeded the allowed space.
-
getPackedPolicySize
public Integer getPackedPolicySize()
A percentage value that indicates the size of the policy in packed form. The service rejects any policy with a packed size greater than 100 percent, which means the policy exceeded the allowed space.
- Returns:
- A percentage value that indicates the size of the policy in packed form. The service rejects any policy with a packed size greater than 100 percent, which means the policy exceeded the allowed space.
-
withPackedPolicySize
public AssumeRoleWithWebIdentityResult withPackedPolicySize(Integer packedPolicySize)
A percentage value that indicates the size of the policy in packed form. The service rejects any policy with a packed size greater than 100 percent, which means the policy exceeded the allowed space.
- Parameters:
packedPolicySize
- A percentage value that indicates the size of the policy in packed form. The service rejects any policy with a packed size greater than 100 percent, which means the policy exceeded the allowed space.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setProvider
public void setProvider(String provider)
The issuing authority of the web identity token presented. For OpenID Connect ID Tokens this contains the value of the
iss
field. For OAuth 2.0 access tokens, this contains the value of theProviderId
parameter that was passed in theAssumeRoleWithWebIdentity
request.- Parameters:
provider
- The issuing authority of the web identity token presented. For OpenID Connect ID Tokens this contains the value of theiss
field. For OAuth 2.0 access tokens, this contains the value of theProviderId
parameter that was passed in theAssumeRoleWithWebIdentity
request.
-
getProvider
public String getProvider()
The issuing authority of the web identity token presented. For OpenID Connect ID Tokens this contains the value of the
iss
field. For OAuth 2.0 access tokens, this contains the value of theProviderId
parameter that was passed in theAssumeRoleWithWebIdentity
request.- Returns:
- The issuing authority of the web identity token presented. For
OpenID Connect ID Tokens this contains the value of the
iss
field. For OAuth 2.0 access tokens, this contains the value of theProviderId
parameter that was passed in theAssumeRoleWithWebIdentity
request.
-
withProvider
public AssumeRoleWithWebIdentityResult withProvider(String provider)
The issuing authority of the web identity token presented. For OpenID Connect ID Tokens this contains the value of the
iss
field. For OAuth 2.0 access tokens, this contains the value of theProviderId
parameter that was passed in theAssumeRoleWithWebIdentity
request.- Parameters:
provider
- The issuing authority of the web identity token presented. For OpenID Connect ID Tokens this contains the value of theiss
field. For OAuth 2.0 access tokens, this contains the value of theProviderId
parameter that was passed in theAssumeRoleWithWebIdentity
request.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setAudience
public void setAudience(String audience)
The intended audience (also known as client ID) of the web identity token. This is traditionally the client identifier issued to the application that requested the web identity token.
- Parameters:
audience
- The intended audience (also known as client ID) of the web identity token. This is traditionally the client identifier issued to the application that requested the web identity token.
-
getAudience
public String getAudience()
The intended audience (also known as client ID) of the web identity token. This is traditionally the client identifier issued to the application that requested the web identity token.
- Returns:
- The intended audience (also known as client ID) of the web identity token. This is traditionally the client identifier issued to the application that requested the web identity token.
-
withAudience
public AssumeRoleWithWebIdentityResult withAudience(String audience)
The intended audience (also known as client ID) of the web identity token. This is traditionally the client identifier issued to the application that requested the web identity token.
- Parameters:
audience
- The intended audience (also known as client ID) of the web identity token. This is traditionally the client identifier issued to the application that requested the web identity token.- 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()
-
clone
public AssumeRoleWithWebIdentityResult clone()
-
-