@Generated(value="software.amazon.awssdk:codegen") public final class AssumeRoleWithWebIdentityResponse extends StsResponse implements ToCopyableBuilder<AssumeRoleWithWebIdentityResponse.Builder,AssumeRoleWithWebIdentityResponse>
Contains the response to a successful AssumeRoleWithWebIdentity request, including temporary Amazon Web Services credentials that can be used to make Amazon Web Services requests.
Modifier and Type | Class and Description |
---|---|
static interface |
AssumeRoleWithWebIdentityResponse.Builder |
Modifier and Type | Method and Description |
---|---|
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.
|
String |
audience()
The intended audience (also known as client ID) of the web identity token.
|
static AssumeRoleWithWebIdentityResponse.Builder |
builder() |
Credentials |
credentials()
The temporary security credentials, which include an access key ID, a secret access key, and a security token.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
Integer |
packedPolicySize()
A percentage value that indicates the packed size of the session policies and session tags combined passed in the
request.
|
String |
provider()
The issuing authority of the web identity token presented.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends AssumeRoleWithWebIdentityResponse.Builder> |
serializableBuilderClass() |
String |
sourceIdentity()
The value of the source identity that is returned in the JSON web token (JWT) from the identity provider.
|
String |
subjectFromWebIdentityToken()
The unique user identifier that is returned by the identity provider.
|
AssumeRoleWithWebIdentityResponse.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
responseMetadata
sdkHttpResponse
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
copy
public final Credentials credentials()
The temporary security credentials, which include an access key ID, a secret access key, and a security token.
The size of the security token that STS API operations return is not fixed. We strongly recommend that you make no assumptions about the maximum size.
The size of the security token that STS API operations return is not fixed. We strongly recommend that you make no assumptions about the maximum size.
public final String subjectFromWebIdentityToken()
The unique user identifier that is returned by the identity provider. This identifier is associated with the
WebIdentityToken
that was submitted with the AssumeRoleWithWebIdentity
call. The
identifier is typically unique to the user and the application that acquired the WebIdentityToken
(pairwise identifier). For OpenID Connect ID tokens, this field contains the value returned by the identity
provider as the token's sub
(Subject) claim.
WebIdentityToken
that was submitted with the AssumeRoleWithWebIdentity
call. The identifier is typically unique to the user and the application that acquired the
WebIdentityToken
(pairwise identifier). For OpenID Connect ID tokens, this field contains
the value returned by the identity provider as the token's sub
(Subject) claim.public final 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 called AssumeRole
.
RoleSessionName
that you specified when you called AssumeRole
.public final Integer packedPolicySize()
A percentage value that indicates the packed size of the session policies and session tags combined passed in the request. The request fails if the packed size is greater than 100 percent, which means the policies and tags exceeded the allowed space.
public final 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 the
ProviderId
parameter that was passed in the AssumeRoleWithWebIdentity
request.
iss
field. For OAuth 2.0 access tokens, this contains the value of the
ProviderId
parameter that was passed in the AssumeRoleWithWebIdentity
request.public final 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.
public final String sourceIdentity()
The value of the source identity that is returned in the JSON web token (JWT) from the identity provider.
You can require users to set a source identity value when they assume a role. You do this by using the
sts:SourceIdentity
condition key in a role trust policy. That way, actions that are taken with the
role are associated with that user. After the source identity is set, the value cannot be changed. It is present
in the request for all actions that are taken by the role and persists across chained role sessions. You can configure your identity provider to use an attribute associated with your
users, like user name or email, as the source identity when calling AssumeRoleWithWebIdentity
. You
do this by adding a claim to the JSON web token. To learn more about OIDC tokens and claims, see Using Tokens with User Pools in the Amazon Cognito Developer Guide. For more information about using
source identity, see Monitor
and control actions taken with assumed roles in the IAM User Guide.
The regex used to validate this parameter is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@-
You can require users to set a source identity value when they assume a role. You do this by using the
sts:SourceIdentity
condition key in a role trust policy. That way, actions that are taken
with the role are associated with that user. After the source identity is set, the value cannot be
changed. It is present in the request for all actions that are taken by the role and persists across chained role sessions. You can configure your identity provider to use an attribute associated with
your users, like user name or email, as the source identity when calling
AssumeRoleWithWebIdentity
. You do this by adding a claim to the JSON web token. To learn
more about OIDC tokens and claims, see Using Tokens with User Pools in the Amazon Cognito Developer Guide. For more information
about using source identity, see Monitor and control actions taken with assumed roles in the IAM User Guide.
The regex used to validate this parameter is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@-
public AssumeRoleWithWebIdentityResponse.Builder toBuilder()
toBuilder
in interface ToCopyableBuilder<AssumeRoleWithWebIdentityResponse.Builder,AssumeRoleWithWebIdentityResponse>
toBuilder
in class AwsResponse
public static AssumeRoleWithWebIdentityResponse.Builder builder()
public static Class<? extends AssumeRoleWithWebIdentityResponse.Builder> serializableBuilderClass()
public final int hashCode()
hashCode
in class AwsResponse
public final boolean equals(Object obj)
equals
in class AwsResponse
public final boolean equalsBySdkFields(Object obj)
equalsBySdkFields
in interface SdkPojo
public final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField
in class SdkResponse
Copyright © 2022. All rights reserved.