Class AssumeRoleWithWebIdentityResponse
- All Implemented Interfaces:
SdkPojo
,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.
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal 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.final String
audience()
The intended audience (also known as client ID) of the web identity token.builder()
final Credentials
The temporary security credentials, which include an access key ID, a secret access key, and a security token.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkResponse
.final int
hashCode()
final Integer
A percentage value that indicates the packed size of the session policies and session tags combined passed in the request.final String
provider()
The issuing authority of the web identity token presented.static Class
<? extends AssumeRoleWithWebIdentityResponse.Builder> final String
The value of the source identity that is returned in the JSON web token (JWT) from the identity provider.final String
The unique user identifier that is returned by the identity provider.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.services.sts.model.StsResponse
responseMetadata
Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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.
- Returns:
- 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.
-
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.- 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.
-
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
.- 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
.
-
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.
- Returns:
- 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.
-
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.- 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.
-
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:
- 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.
-
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 callingAssumeRoleWithWebIdentity
. 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: =,.@-
- Returns:
- 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 callingAssumeRoleWithWebIdentity
. 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: =,.@-
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<AssumeRoleWithWebIdentityResponse.Builder,
AssumeRoleWithWebIdentityResponse> - Specified by:
toBuilder
in classAwsResponse
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsResponse
-
equals
- Overrides:
equals
in classAwsResponse
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
Description copied from class:SdkResponse
Used to retrieve the value of a field from any class that extendsSdkResponse
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkResponse.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkResponse
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-