Interface AssumeRoleWithWebIdentityResponse.Builder
-
- All Superinterfaces:
AwsResponse.Builder
,Buildable
,CopyableBuilder<AssumeRoleWithWebIdentityResponse.Builder,AssumeRoleWithWebIdentityResponse>
,SdkBuilder<AssumeRoleWithWebIdentityResponse.Builder,AssumeRoleWithWebIdentityResponse>
,SdkPojo
,SdkResponse.Builder
,StsResponse.Builder
- Enclosing class:
- AssumeRoleWithWebIdentityResponse
public static interface AssumeRoleWithWebIdentityResponse.Builder extends StsResponse.Builder, SdkPojo, CopyableBuilder<AssumeRoleWithWebIdentityResponse.Builder,AssumeRoleWithWebIdentityResponse>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description default AssumeRoleWithWebIdentityResponse.Builder
assumedRoleUser(Consumer<AssumedRoleUser.Builder> 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.AssumeRoleWithWebIdentityResponse.Builder
assumedRoleUser(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.AssumeRoleWithWebIdentityResponse.Builder
audience(String audience)
The intended audience (also known as client ID) of the web identity token.default AssumeRoleWithWebIdentityResponse.Builder
credentials(Consumer<Credentials.Builder> credentials)
The temporary security credentials, which include an access key ID, a secret access key, and a security token.AssumeRoleWithWebIdentityResponse.Builder
credentials(Credentials credentials)
The temporary security credentials, which include an access key ID, a secret access key, and a security token.AssumeRoleWithWebIdentityResponse.Builder
packedPolicySize(Integer packedPolicySize)
A percentage value that indicates the packed size of the session policies and session tags combined passed in the request.AssumeRoleWithWebIdentityResponse.Builder
provider(String provider)
The issuing authority of the web identity token presented.AssumeRoleWithWebIdentityResponse.Builder
sourceIdentity(String sourceIdentity)
The value of the source identity that is returned in the JSON web token (JWT) from the identity provider.AssumeRoleWithWebIdentityResponse.Builder
subjectFromWebIdentityToken(String subjectFromWebIdentityToken)
The unique user identifier that is returned by the identity provider.-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder
sdkHttpResponse, sdkHttpResponse
-
Methods inherited from interface software.amazon.awssdk.services.sts.model.StsResponse.Builder
build, responseMetadata, responseMetadata
-
-
-
-
Method Detail
-
credentials
AssumeRoleWithWebIdentityResponse.Builder credentials(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.
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
credentials
default AssumeRoleWithWebIdentityResponse.Builder credentials(Consumer<Credentials.Builder> 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.
Credentials.Builder
avoiding the need to create one manually viaCredentials.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tocredentials(Credentials)
.- Parameters:
credentials
- a consumer that will call methods onCredentials.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
credentials(Credentials)
-
subjectFromWebIdentityToken
AssumeRoleWithWebIdentityResponse.Builder subjectFromWebIdentityToken(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.
-
assumedRoleUser
AssumeRoleWithWebIdentityResponse.Builder assumedRoleUser(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.
-
assumedRoleUser
default AssumeRoleWithWebIdentityResponse.Builder assumedRoleUser(Consumer<AssumedRoleUser.Builder> 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
This is a convenience method that creates an instance of theRoleSessionName
that you specified when you calledAssumeRole
.AssumedRoleUser.Builder
avoiding the need to create one manually viaAssumedRoleUser.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toassumedRoleUser(AssumedRoleUser)
.- Parameters:
assumedRoleUser
- a consumer that will call methods onAssumedRoleUser.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
assumedRoleUser(AssumedRoleUser)
-
packedPolicySize
AssumeRoleWithWebIdentityResponse.Builder packedPolicySize(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.
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
provider
AssumeRoleWithWebIdentityResponse.Builder provider(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.
-
audience
AssumeRoleWithWebIdentityResponse.Builder audience(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.
-
sourceIdentity
AssumeRoleWithWebIdentityResponse.Builder sourceIdentity(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 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: =,.@-
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
-