Class AssumeRoleWithWebIdentityResult
- All Implemented Interfaces:
Serializable
,Cloneable
Contains the response to a successful AssumeRoleWithWebIdentity request, including temporary AWS credentials that can be used to make AWS requests.
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
boolean
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.The intended audience (also known as client ID) of the web identity token.The temporary security credentials, which include an access key ID, a secret access key, and a security token.A percentage value that indicates the size of the policy in packed form.The issuing authority of the web identity token presented.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.toString()
Returns a string representation of this object; useful for testing and debugging.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.withAudience
(String audience) The intended audience (also known as client ID) of the web identity token.withCredentials
(Credentials credentials) The temporary security credentials, which include an access key ID, a secret access key, and a security token.withPackedPolicySize
(Integer packedPolicySize) A percentage value that indicates the size of the policy in packed form.withProvider
(String provider) The issuing authority of the web identity token presented.withSubjectFromWebIdentityToken
(String subjectFromWebIdentityToken) The unique user identifier that is returned by the identity provider.
-
Constructor Details
-
AssumeRoleWithWebIdentityResult
public AssumeRoleWithWebIdentityResult()
-
-
Method Details
-
setCredentials
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
clone
-